VpcLatticeClient

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

Properties

Link copied to clipboard
abstract override val config: VpcLatticeClient.Config

VpcLatticeClient's configuration

Functions

Link copied to clipboard

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.

Link copied to clipboard

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 will 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 copied to clipboard

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 copied to clipboard
abstract suspend fun createRule(input: CreateRuleRequest): CreateRuleResponse

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 copied to clipboard

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).

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Deletes the specified access log subscription.

Link copied to clipboard

Deletes the specified auth policy. If an auth is set to Amazon Web Services_IAM and the auth policy is deleted, all requests will be denied by default. 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 will be denied.

Link copied to clipboard

Deletes the specified listener.

Link copied to clipboard

Deletes the specified resource policy.

Link copied to clipboard
abstract suspend fun deleteRule(input: DeleteRuleRequest): DeleteRuleResponse

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.

Link copied to clipboard

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 copied to clipboard

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 copied to clipboard

Deletes the association between a specified service and the specific service network. This request will fail if an association is still in progress.

Link copied to clipboard

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

Link copied to clipboard

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 copied to clipboard

Deregisters the specified targets from the specified target group.

Link copied to clipboard

Retrieves information about the specified access log subscription.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun getListener(input: GetListenerRequest): GetListenerResponse

Retrieves information about the specified listener for the specified service.

Link copied to clipboard

Retrieves information about the resource policy. The resource policy is an IAM policy created by AWS RAM on behalf of the resource owner when they share a resource.

Link copied to clipboard
abstract suspend fun getRule(input: GetRuleRequest): GetRuleResponse

Retrieves information about 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 copied to clipboard
abstract suspend fun getService(input: GetServiceRequest): GetServiceResponse

Retrieves information about the specified service.

Link copied to clipboard

Retrieves information about the specified service network.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Retrieves information about the specified target group.

Link copied to clipboard

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

Link copied to clipboard

Lists the listeners for the specified service.

Link copied to clipboard
abstract suspend fun listRules(input: ListRulesRequest): ListRulesResponse

Lists the rules for the listener.

Link copied to clipboard
abstract suspend fun listServiceNetworks(input: ListServiceNetworksRequest = ListServiceNetworksRequest { }): ListServiceNetworksResponse

Lists the service networks owned by the caller account or shared with the caller account. Also includes the account ID in the ARN to show which account owns the service network.

Link copied to clipboard

Lists the associations between the service network and the service. You can filter the list either by service or service network. You must provide either the service network identifier or the service identifier.

Link copied to clipboard
abstract suspend fun listServiceNetworkVpcAssociations(input: ListServiceNetworkVpcAssociationsRequest = ListServiceNetworkVpcAssociationsRequest { }): ListServiceNetworkVpcAssociationsResponse

Lists the service network and VPC associations. You can filter the list either by VPC or service network. You must provide either the service network identifier or the VPC identifier.

Link copied to clipboard
abstract suspend fun listServices(input: ListServicesRequest = ListServicesRequest { }): ListServicesResponse

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

Link copied to clipboard

Lists the tags for the specified resource.

Link copied to clipboard
abstract suspend fun listTargetGroups(input: ListTargetGroupsRequest = ListTargetGroupsRequest { }): ListTargetGroupsResponse

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

Link copied to clipboard
abstract suspend fun listTargets(input: ListTargetsRequest): ListTargetsResponse

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 copied to clipboard

Creates or updates the auth policy.

Link copied to clipboard

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 copied to clipboard

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

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds the specified tags to the specified resource.

Link copied to clipboard

Removes the specified tags from the specified resource.

Link copied to clipboard

Updates the specified access log subscription.

Link copied to clipboard

Updates the specified listener for the specified service.

Link copied to clipboard
abstract suspend fun updateRule(input: UpdateRuleRequest): UpdateRuleResponse

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

Link copied to clipboard

Updates the specified service.

Link copied to clipboard

Updates the specified service network.

Link copied to clipboard

Updates the service network and VPC association. Once you add a security group, it cannot be removed.

Link copied to clipboard

Updates the specified target group.

Inherited functions

Link copied to clipboard

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.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

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 will 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 copied to clipboard

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 copied to clipboard
inline suspend fun VpcLatticeClient.createRule(crossinline block: CreateRuleRequest.Builder.() -> Unit): CreateRuleResponse

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 copied to clipboard

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).

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Deletes the specified access log subscription.

Link copied to clipboard

Deletes the specified auth policy. If an auth is set to Amazon Web Services_IAM and the auth policy is deleted, all requests will be denied by default. 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 will be denied.

Link copied to clipboard

Deletes the specified listener.

Link copied to clipboard

Deletes the specified resource policy.

Link copied to clipboard
inline suspend fun VpcLatticeClient.deleteRule(crossinline block: DeleteRuleRequest.Builder.() -> Unit): DeleteRuleResponse

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.

Link copied to clipboard

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 copied to clipboard

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 copied to clipboard

Deletes the association between a specified service and the specific service network. This request will fail if an association is still in progress.

Link copied to clipboard

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

Link copied to clipboard

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 copied to clipboard

Deregisters the specified targets from the specified target group.

Link copied to clipboard

Retrieves information about the specified access log subscription.

Link copied to clipboard

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

Link copied to clipboard

Retrieves information about the specified listener for the specified service.

Link copied to clipboard

Retrieves information about the resource policy. The resource policy is an IAM policy created by AWS RAM on behalf of the resource owner when they share a resource.

Link copied to clipboard
inline suspend fun VpcLatticeClient.getRule(crossinline block: GetRuleRequest.Builder.() -> Unit): GetRuleResponse

Retrieves information about 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 copied to clipboard
inline suspend fun VpcLatticeClient.getService(crossinline block: GetServiceRequest.Builder.() -> Unit): GetServiceResponse

Retrieves information about the specified service.

Link copied to clipboard

Retrieves information about the specified service network.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Retrieves information about the specified target group.

Link copied to clipboard

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

Link copied to clipboard

Lists the listeners for the specified service.

Link copied to clipboard
inline suspend fun VpcLatticeClient.listRules(crossinline block: ListRulesRequest.Builder.() -> Unit): ListRulesResponse

Lists the rules for the listener.

Link copied to clipboard

Lists the service networks owned by the caller account or shared with the caller account. Also includes the account ID in the ARN to show which account owns the service network.

Link copied to clipboard

Lists the associations between the service network and the service. You can filter the list either by service or service network. You must provide either the service network identifier or the service identifier.

Link copied to clipboard

Lists the service network and VPC associations. You can filter the list either by VPC or service network. You must provide either the service network identifier or the VPC identifier.

Link copied to clipboard

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

Link copied to clipboard

Lists the tags for the specified resource.

Link copied to clipboard

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

Link copied to clipboard

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 copied to clipboard

Creates or updates the auth policy.

Link copied to clipboard

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 copied to clipboard

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

Link copied to clipboard

Adds the specified tags to the specified resource.

Link copied to clipboard

Removes the specified tags from the specified resource.

Link copied to clipboard

Updates the specified access log subscription.

Link copied to clipboard

Updates the specified listener for the specified service.

Link copied to clipboard
inline suspend fun VpcLatticeClient.updateRule(crossinline block: UpdateRuleRequest.Builder.() -> Unit): UpdateRuleResponse

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

Link copied to clipboard

Updates the specified service.

Link copied to clipboard

Updates the specified service network.

Link copied to clipboard

Updates the service network and VPC association. Once you add a security group, it cannot be removed.

Link copied to clipboard

Updates the specified target group.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.