aws-elixir

View Source AWS.VPCLattice (aws-elixir v1.0.4)

Amazon VPC Lattice is a fully managed application networking service that you use to connect, secure, and monitor all of your services across multiple accounts and virtual private clouds (VPCs).

Amazon VPC Lattice interconnects your microservices and legacy services within a logical boundary, so that you can discover and manage them more efficiently. For more information, see the Amazon VPC Lattice User Guide

Link to this section Summary

Functions

batch_update_rule(client, listener_identifier, service_identifier, input, options \\ [])

Updates the listener rules in a batch.

create_access_log_subscription(client, input, options \\ [])

Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose.

create_listener(client, service_identifier, input, options \\ [])

Creates a listener for a service.

create_resource_configuration(client, input, options \\ [])

Creates a resource configuration.

create_resource_gateway(client, input, options \\ [])

Creates a resource gateway.

create_rule(client, listener_identifier, service_identifier, input, options \\ [])

Creates a listener rule.

create_service(client, input, options \\ [])

Creates a service.

create_service_network(client, input, options \\ [])

Creates a service network.

create_service_network_resource_association(client, input, options \\ [])

Associates the specified service network with the specified resource configuration.

create_service_network_service_association(client, input, options \\ [])

Associates the specified service with the specified service network.

create_service_network_vpc_association(client, input, options \\ [])

Associates a VPC with a service network.

create_target_group(client, input, options \\ [])

Creates a target group.

delete_access_log_subscription(client, access_log_subscription_identifier, input, options \\ [])

Deletes the specified access log subscription.

delete_auth_policy(client, resource_identifier, input, options \\ [])

Deletes the specified auth policy.

delete_listener(client, listener_identifier, service_identifier, input, options \\ [])

Deletes the specified listener.

delete_resource_configuration(client, resource_configuration_identifier, input, options \\ [])

Deletes the specified resource configuration.

delete_resource_endpoint_association(client, resource_endpoint_association_identifier, input, options \\ [])

Disassociates the resource configuration from the resource VPC endpoint.

delete_resource_gateway(client, resource_gateway_identifier, input, options \\ [])

Deletes the specified resource gateway.

delete_resource_policy(client, resource_arn, input, options \\ [])

Deletes the specified resource policy.

delete_rule(client, listener_identifier, rule_identifier, service_identifier, input, options \\ [])

Deletes a listener rule.

delete_service(client, service_identifier, input, options \\ [])

Deletes a service.

delete_service_network(client, service_network_identifier, input, options \\ [])

Deletes a service network.

delete_service_network_resource_association(client, service_network_resource_association_identifier, input, options \\ [])

Deletes the association between a service network and a resource configuration.

delete_service_network_service_association(client, service_network_service_association_identifier, input, options \\ [])

Deletes the association between a service and a service network.

delete_service_network_vpc_association(client, service_network_vpc_association_identifier, input, options \\ [])

Disassociates the VPC from the service network.

delete_target_group(client, target_group_identifier, input, options \\ [])

Deletes a target group.

deregister_targets(client, target_group_identifier, input, options \\ [])

Deregisters the specified targets from the specified target group.

get_access_log_subscription(client, access_log_subscription_identifier, options \\ [])

Retrieves information about the specified access log subscription.

get_auth_policy(client, resource_identifier, options \\ [])

Retrieves information about the auth policy for the specified service or service network.

get_listener(client, listener_identifier, service_identifier, options \\ [])

Retrieves information about the specified listener for the specified service.

get_resource_configuration(client, resource_configuration_identifier, options \\ [])

Retrieves information about the specified resource configuration.

get_resource_gateway(client, resource_gateway_identifier, options \\ [])

Retrieves information about the specified resource gateway.

get_resource_policy(client, resource_arn, options \\ [])

Retrieves information about the specified resource policy.

get_rule(client, listener_identifier, rule_identifier, service_identifier, options \\ [])

Retrieves information about the specified listener rules.

get_service(client, service_identifier, options \\ [])

Retrieves information about the specified service.

get_service_network(client, service_network_identifier, options \\ [])

Retrieves information about the specified service network.

get_service_network_resource_association(client, service_network_resource_association_identifier, options \\ [])

Retrieves information about the specified association between a service network and a resource configuration.

get_service_network_service_association(client, service_network_service_association_identifier, options \\ [])

Retrieves information about the specified association between a service network and a service.

get_service_network_vpc_association(client, service_network_vpc_association_identifier, options \\ [])

Retrieves information about the specified association between a service network and a VPC.

get_target_group(client, target_group_identifier, options \\ [])

Retrieves information about the specified target group.

list_access_log_subscriptions(client, max_results \\ nil, next_token \\ nil, resource_identifier, options \\ [])

Lists the access log subscriptions for the specified service network or service.

list_listeners(client, service_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the listeners for the specified service.

list_resource_configurations(client, max_results \\ nil, next_token \\ nil, resource_configuration_group_identifier \\ nil, resource_gateway_identifier \\ nil, options \\ [])

Lists the resource configurations owned by or shared with this account.

list_resource_endpoint_associations(client, max_results \\ nil, next_token \\ nil, resource_configuration_identifier, resource_endpoint_association_identifier \\ nil, vpc_endpoint_id \\ nil, vpc_endpoint_owner \\ nil, options \\ [])

Lists the associations for the specified VPC endpoint.

list_resource_gateways(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the resource gateways that you own or that were shared with you.

list_rules(client, listener_identifier, service_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the rules for the specified listener.

list_service_network_resource_associations(client, max_results \\ nil, next_token \\ nil, resource_configuration_identifier \\ nil, service_network_identifier \\ nil, options \\ [])

Lists the associations between a service network and a resource configuration.

list_service_network_service_associations(client, max_results \\ nil, next_token \\ nil, service_identifier \\ nil, service_network_identifier \\ nil, options \\ [])

Lists the associations between a service network and a service.

list_service_network_vpc_associations(client, max_results \\ nil, next_token \\ nil, service_network_identifier \\ nil, vpc_identifier \\ nil, options \\ [])

Lists the associations between a service network and a VPC.

list_service_network_vpc_endpoint_associations(client, max_results \\ nil, next_token \\ nil, service_network_identifier, options \\ [])

Lists the associations between a service network and a VPC endpoint.

list_service_networks(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the service networks owned by or shared with this account.

list_services(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the services owned by the caller account or shared with the caller account.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags for the specified resource.

list_target_groups(client, max_results \\ nil, next_token \\ nil, target_group_type \\ nil, vpc_identifier \\ nil, options \\ [])

Lists your target groups.

list_targets(client, target_group_identifier, input, options \\ [])

Lists the targets for the target group.

metadata()
put_auth_policy(client, resource_identifier, input, options \\ [])

Creates or updates the auth policy.

put_resource_policy(client, resource_arn, input, options \\ [])

Attaches a resource-based permission policy to a service or service network.

register_targets(client, target_group_identifier, input, options \\ [])

Registers the targets with the target group.

tag_resource(client, resource_arn, input, options \\ [])

Adds the specified tags to the specified resource.

untag_resource(client, resource_arn, input, options \\ [])

Removes the specified tags from the specified resource.

update_access_log_subscription(client, access_log_subscription_identifier, input, options \\ [])

Updates the specified access log subscription.

update_listener(client, listener_identifier, service_identifier, input, options \\ [])

Updates the specified listener for the specified service.

update_resource_configuration(client, resource_configuration_identifier, input, options \\ [])

Updates the specified resource configuration.

update_resource_gateway(client, resource_gateway_identifier, input, options \\ [])

Updates the specified resource gateway.

update_rule(client, listener_identifier, rule_identifier, service_identifier, input, options \\ [])

Updates a specified rule for the listener.

update_service(client, service_identifier, input, options \\ [])

Updates the specified service.

update_service_network(client, service_network_identifier, input, options \\ [])

Updates the specified service network.

update_service_network_vpc_association(client, service_network_vpc_association_identifier, input, options \\ [])

Updates the service network and VPC association.

update_target_group(client, target_group_identifier, input, options \\ [])

Updates the specified target group.

Link to this section Functions

Link to this function

batch_update_rule(client, listener_identifier, service_identifier, input, options \\ [])

View Source

Updates the listener rules in a batch.

You can use this operation to change the priority of listener rules. This can be useful when bulk updating or swapping rule priority.

required-permissions

 Required permissions:

vpc-lattice:UpdateRule

For more information, see How Amazon VPC Lattice works with IAM in the Amazon VPC Lattice User Guide.

Link to this function

create_access_log_subscription(client, input, options \\ [])

View Source

Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose.

The service network owner can use the access logs to audit the services in the network. The service network owner can only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network. For more information, see Access logs in the Amazon VPC Lattice User Guide.

Link to this function

create_listener(client, service_identifier, input, options \\ [])

View Source

Creates a listener for a service.

Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide.

Link to this function

create_resource_configuration(client, input, options \\ [])

View Source

Creates a resource configuration.

A resource configuration defines a specific resource. You can associate a resource configuration with a service network or a VPC endpoint.

Link to this function

create_resource_gateway(client, input, options \\ [])

View Source

Creates a resource gateway.

Link to this function

create_rule(client, listener_identifier, service_identifier, input, options \\ [])

View Source

Creates a listener rule.

Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. For more information, see Listener rules in the Amazon VPC Lattice User Guide.

Link to this function

create_service(client, input, options \\ [])

View Source

Creates a service.

A service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC).

For more information, see Services in the Amazon VPC Lattice User Guide.

Link to this function

create_service_network(client, input, options \\ [])

View Source

Creates a service network.

A service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network.

For more information, see Service networks in the Amazon VPC Lattice User Guide.

Link to this function

create_service_network_resource_association(client, input, options \\ [])

View Source

Associates the specified service network with the specified resource configuration.

This allows the resource configuration to receive connections through the service network, including through a service network VPC endpoint.

Link to this function

create_service_network_service_association(client, input, options \\ [])

View Source

Associates the specified service with the specified service network.

For more information, see Manage service associations in the Amazon VPC Lattice User Guide.

You can't use this operation if the service and service network are already associated or if there is a disassociation or deletion in progress. If the association fails, you can retry the operation by deleting the association and recreating it.

You cannot associate a service and service network that are shared with a caller. The caller must own either the service or the service network.

As a result of this operation, the association is created in the service network account and the association owner account.

Link to this function

create_service_network_vpc_association(client, input, options \\ [])

View Source

Associates a VPC with a service network.

When you associate a VPC with the service network, it enables all the resources within that VPC to be clients and communicate with other services in the service network. For more information, see Manage VPC associations in the Amazon VPC Lattice User Guide.

You can't use this operation if there is a disassociation in progress. If the association fails, retry by deleting the association and recreating it.

As a result of this operation, the association gets created in the service network account and the VPC owner account.

If you add a security group to the service network and VPC association, the association must continue to always have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and recreate it without security groups.

Link to this function

create_target_group(client, input, options \\ [])

View Source

Creates a target group.

A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service.

For more information, see Target groups in the Amazon VPC Lattice User Guide.

Link to this function

delete_access_log_subscription(client, access_log_subscription_identifier, input, options \\ [])

View Source

Deletes the specified access log subscription.

Link to this function

delete_auth_policy(client, resource_identifier, input, options \\ [])

View Source

Deletes the specified auth policy.

If an auth is set to AWS_IAM and the auth policy is deleted, all requests are denied. If you are trying to remove the auth policy completely, you must set the auth type to NONE. If auth is enabled on the resource, but no auth policy is set, all requests are denied.

Link to this function

delete_listener(client, listener_identifier, service_identifier, input, options \\ [])

View Source

Deletes the specified listener.

Link to this function

delete_resource_configuration(client, resource_configuration_identifier, input, options \\ [])

View Source

Deletes the specified resource configuration.

Link to this function

delete_resource_endpoint_association(client, resource_endpoint_association_identifier, input, options \\ [])

View Source

Disassociates the resource configuration from the resource VPC endpoint.

Link to this function

delete_resource_gateway(client, resource_gateway_identifier, input, options \\ [])

View Source

Deletes the specified resource gateway.

Link to this function

delete_resource_policy(client, resource_arn, input, options \\ [])

View Source

Deletes the specified resource policy.

Link to this function

delete_rule(client, listener_identifier, rule_identifier, service_identifier, input, options \\ [])

View Source

Deletes a listener rule.

Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. You can delete additional listener rules, but you cannot delete the default rule.

For more information, see Listener rules in the Amazon VPC Lattice User Guide.

Link to this function

delete_service(client, service_identifier, input, options \\ [])

View Source

Deletes a service.

A service can't be deleted if it's associated with a service network. If you delete a service, all resources related to the service, such as the resource policy, auth policy, listeners, listener rules, and access log subscriptions, are also deleted. For more information, see Delete a service in the Amazon VPC Lattice User Guide.

Link to this function

delete_service_network(client, service_network_identifier, input, options \\ [])

View Source

Deletes a service network.

You can only delete the service network if there is no service or VPC associated with it. If you delete a service network, all resources related to the service network, such as the resource policy, auth policy, and access log subscriptions, are also deleted. For more information, see Delete a service network in the Amazon VPC Lattice User Guide.

Link to this function

delete_service_network_resource_association(client, service_network_resource_association_identifier, input, options \\ [])

View Source

Deletes the association between a service network and a resource configuration.

Link to this function

delete_service_network_service_association(client, service_network_service_association_identifier, input, options \\ [])

View Source

Deletes the association between a service and a service network.

This operation fails if an association is still in progress.

Link to this function

delete_service_network_vpc_association(client, service_network_vpc_association_identifier, input, options \\ [])

View Source

Disassociates the VPC from the service network.

You can't disassociate the VPC if there is a create or update association in progress.

Link to this function

delete_target_group(client, target_group_identifier, input, options \\ [])

View Source

Deletes a target group.

You can't delete a target group if it is used in a listener rule or if the target group creation is in progress.

Link to this function

deregister_targets(client, target_group_identifier, input, options \\ [])

View Source

Deregisters the specified targets from the specified target group.

Link to this function

get_access_log_subscription(client, access_log_subscription_identifier, options \\ [])

View Source

Retrieves information about the specified access log subscription.

Link to this function

get_auth_policy(client, resource_identifier, options \\ [])

View Source

Retrieves information about the auth policy for the specified service or service network.

Link to this function

get_listener(client, listener_identifier, service_identifier, options \\ [])

View Source

Retrieves information about the specified listener for the specified service.

Link to this function

get_resource_configuration(client, resource_configuration_identifier, options \\ [])

View Source

Retrieves information about the specified resource configuration.

Link to this function

get_resource_gateway(client, resource_gateway_identifier, options \\ [])

View Source

Retrieves information about the specified resource gateway.

Link to this function

get_resource_policy(client, resource_arn, options \\ [])

View Source

Retrieves information about the specified resource policy.

The resource policy is an IAM policy created on behalf of the resource owner when they share a resource.

Link to this function

get_rule(client, listener_identifier, rule_identifier, service_identifier, options \\ [])

View Source

Retrieves information about the specified listener rules.

You can also retrieve information about the default listener rule. For more information, see Listener rules in the Amazon VPC Lattice User Guide.

Link to this function

get_service(client, service_identifier, options \\ [])

View Source

Retrieves information about the specified service.

Link to this function

get_service_network(client, service_network_identifier, options \\ [])

View Source

Retrieves information about the specified service network.

Link to this function

get_service_network_resource_association(client, service_network_resource_association_identifier, options \\ [])

View Source

Retrieves information about the specified association between a service network and a resource configuration.

Link to this function

get_service_network_service_association(client, service_network_service_association_identifier, options \\ [])

View Source

Retrieves information about the specified association between a service network and a service.

Link to this function

get_service_network_vpc_association(client, service_network_vpc_association_identifier, options \\ [])

View Source

Retrieves information about the specified association between a service network and a VPC.

Link to this function

get_target_group(client, target_group_identifier, options \\ [])

View Source

Retrieves information about the specified target group.

Link to this function

list_access_log_subscriptions(client, max_results \\ nil, next_token \\ nil, resource_identifier, options \\ [])

View Source

Lists the access log subscriptions for the specified service network or service.

Link to this function

list_listeners(client, service_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the listeners for the specified service.

Link to this function

list_resource_configurations(client, max_results \\ nil, next_token \\ nil, resource_configuration_group_identifier \\ nil, resource_gateway_identifier \\ nil, options \\ [])

View Source

Lists the resource configurations owned by or shared with this account.

Link to this function

list_resource_endpoint_associations(client, max_results \\ nil, next_token \\ nil, resource_configuration_identifier, resource_endpoint_association_identifier \\ nil, vpc_endpoint_id \\ nil, vpc_endpoint_owner \\ nil, options \\ [])

View Source

Lists the associations for the specified VPC endpoint.

Link to this function

list_resource_gateways(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the resource gateways that you own or that were shared with you.

Link to this function

list_rules(client, listener_identifier, service_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the rules for the specified listener.

Link to this function

list_service_network_resource_associations(client, max_results \\ nil, next_token \\ nil, resource_configuration_identifier \\ nil, service_network_identifier \\ nil, options \\ [])

View Source

Lists the associations between a service network and a resource configuration.

Link to this function

list_service_network_service_associations(client, max_results \\ nil, next_token \\ nil, service_identifier \\ nil, service_network_identifier \\ nil, options \\ [])

View Source

Lists the associations between a service network and a service.

You can filter the list either by service or service network. You must provide either the service network identifier or the service identifier.

Every association in Amazon VPC Lattice has a unique Amazon Resource Name (ARN), such as when a service network is associated with a VPC or when a service is associated with a service network. If the association is for a resource is shared with another account, the association includes the local account ID as the prefix in the ARN.

Link to this function

list_service_network_vpc_associations(client, max_results \\ nil, next_token \\ nil, service_network_identifier \\ nil, vpc_identifier \\ nil, options \\ [])

View Source

Lists the associations between a service network and a VPC.

You can filter the list either by VPC or service network. You must provide either the ID of the service network identifier or the ID of the VPC.

Link to this function

list_service_network_vpc_endpoint_associations(client, max_results \\ nil, next_token \\ nil, service_network_identifier, options \\ [])

View Source

Lists the associations between a service network and a VPC endpoint.

Link to this function

list_service_networks(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the service networks owned by or shared with this account.

The account ID in the ARN shows which account owns the service network.

Link to this function

list_services(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the services owned by the caller account or shared with the caller account.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the tags for the specified resource.

Link to this function

list_target_groups(client, max_results \\ nil, next_token \\ nil, target_group_type \\ nil, vpc_identifier \\ nil, options \\ [])

View Source

Lists your target groups.

You can narrow your search by using the filters below in your request.

Link to this function

list_targets(client, target_group_identifier, input, options \\ [])

View Source

Lists the targets for the target group.

By default, all targets are included. You can use this API to check the health status of targets. You can also filter the results by target.

Link to this function

metadata()

View Source
Link to this function

put_auth_policy(client, resource_identifier, input, options \\ [])

View Source

Creates or updates the auth policy.

The policy string in JSON must not contain newlines or blank lines.

For more information, see Auth policies in the Amazon VPC Lattice User Guide.

Link to this function

put_resource_policy(client, resource_arn, input, options \\ [])

View Source

Attaches a resource-based permission policy to a service or service network.

The policy must contain the same actions and condition statements as the Amazon Web Services Resource Access Manager permission for sharing services and service networks.

Link to this function

register_targets(client, target_group_identifier, input, options \\ [])

View Source

Registers the targets with the target group.

If it's a Lambda target, you can only have one target in a target group.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds the specified tags to the specified resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes the specified tags from the specified resource.

Link to this function

update_access_log_subscription(client, access_log_subscription_identifier, input, options \\ [])

View Source

Updates the specified access log subscription.

Link to this function

update_listener(client, listener_identifier, service_identifier, input, options \\ [])

View Source

Updates the specified listener for the specified service.

Link to this function

update_resource_configuration(client, resource_configuration_identifier, input, options \\ [])

View Source

Updates the specified resource configuration.

Link to this function

update_resource_gateway(client, resource_gateway_identifier, input, options \\ [])

View Source

Updates the specified resource gateway.

Link to this function

update_rule(client, listener_identifier, rule_identifier, service_identifier, input, options \\ [])

View Source

Updates a specified rule for the listener.

You can't modify a default listener rule. To modify a default listener rule, use UpdateListener.

Link to this function

update_service(client, service_identifier, input, options \\ [])

View Source

Updates the specified service.

Link to this function

update_service_network(client, service_network_identifier, input, options \\ [])

View Source

Updates the specified service network.

Link to this function

update_service_network_vpc_association(client, service_network_vpc_association_identifier, input, options \\ [])

View Source

Updates the service network and VPC association.

If you add a security group to the service network and VPC association, the association must continue to have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and then recreate it without security groups.

Link to this function

update_target_group(client, target_group_identifier, input, options \\ [])

View Source

Updates the specified target group.