elasticloadbalancingv2/aws.sdk.kotlin.services.elasticloadbalancingv2

Package-level declarations

Types

interface ElasticLoadBalancingV2Client : SdkClient

A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

addListenerCertificates

inline suspend fun ElasticLoadBalancingV2Client.addListenerCertificates(crossinline block: AddListenerCertificatesRequest.Builder.() -> Unit): AddListenerCertificatesResponse

Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.

addTags

inline suspend fun ElasticLoadBalancingV2Client.addTags(crossinline block: AddTagsRequest.Builder.() -> Unit): AddTagsResponse

Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, trust stores, listeners, and rules.

addTrustStoreRevocations

inline suspend fun ElasticLoadBalancingV2Client.addTrustStoreRevocations(crossinline block: AddTrustStoreRevocationsRequest.Builder.() -> Unit): AddTrustStoreRevocationsResponse

Adds the specified revocation file to the specified trust store.

createListener

inline suspend fun ElasticLoadBalancingV2Client.createListener(crossinline block: CreateListenerRequest.Builder.() -> Unit): CreateListenerResponse

Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

createLoadBalancer

inline suspend fun ElasticLoadBalancingV2Client.createLoadBalancer(crossinline block: CreateLoadBalancerRequest.Builder.() -> Unit): CreateLoadBalancerResponse

Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

createRule

inline suspend fun ElasticLoadBalancingV2Client.createRule(crossinline block: CreateRuleRequest.Builder.() -> Unit): CreateRuleResponse

Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.

createTargetGroup

inline suspend fun ElasticLoadBalancingV2Client.createTargetGroup(crossinline block: CreateTargetGroupRequest.Builder.() -> Unit): CreateTargetGroupResponse

Creates a target group.

createTrustStore

inline suspend fun ElasticLoadBalancingV2Client.createTrustStore(crossinline block: CreateTrustStoreRequest.Builder.() -> Unit): CreateTrustStoreResponse

Creates a trust store.

deleteListener

inline suspend fun ElasticLoadBalancingV2Client.deleteListener(crossinline block: DeleteListenerRequest.Builder.() -> Unit): DeleteListenerResponse

Deletes the specified listener.

deleteLoadBalancer

inline suspend fun ElasticLoadBalancingV2Client.deleteLoadBalancer(crossinline block: DeleteLoadBalancerRequest.Builder.() -> Unit): DeleteLoadBalancerResponse

Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. Deleting a load balancer also deletes its listeners.

deleteRule

inline suspend fun ElasticLoadBalancingV2Client.deleteRule(crossinline block: DeleteRuleRequest.Builder.() -> Unit): DeleteRuleResponse

Deletes the specified rule.

deleteSharedTrustStoreAssociation

inline suspend fun ElasticLoadBalancingV2Client.deleteSharedTrustStoreAssociation(crossinline block: DeleteSharedTrustStoreAssociationRequest.Builder.() -> Unit): DeleteSharedTrustStoreAssociationResponse

Deletes a shared trust store association.

deleteTargetGroup

inline suspend fun ElasticLoadBalancingV2Client.deleteTargetGroup(crossinline block: DeleteTargetGroupRequest.Builder.() -> Unit): DeleteTargetGroupResponse

Deletes the specified target group.

deleteTrustStore

inline suspend fun ElasticLoadBalancingV2Client.deleteTrustStore(crossinline block: DeleteTrustStoreRequest.Builder.() -> Unit): DeleteTrustStoreResponse

Deletes a trust store.

deregisterTargets

inline suspend fun ElasticLoadBalancingV2Client.deregisterTargets(crossinline block: DeregisterTargetsRequest.Builder.() -> Unit): DeregisterTargetsResponse

Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.

describeAccountLimits

inline suspend fun ElasticLoadBalancingV2Client.describeAccountLimits(crossinline block: DescribeAccountLimitsRequest.Builder.() -> Unit): DescribeAccountLimitsResponse

Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account.

describeCapacityReservation

inline suspend fun ElasticLoadBalancingV2Client.describeCapacityReservation(crossinline block: DescribeCapacityReservationRequest.Builder.() -> Unit): DescribeCapacityReservationResponse

Describes the capacity reservation status for the specified load balancer.

describeListenerAttributes

inline suspend fun ElasticLoadBalancingV2Client.describeListenerAttributes(crossinline block: DescribeListenerAttributesRequest.Builder.() -> Unit): DescribeListenerAttributesResponse

Describes the attributes for the specified listener.

describeListenerCertificates

inline suspend fun ElasticLoadBalancingV2Client.describeListenerCertificates(crossinline block: DescribeListenerCertificatesRequest.Builder.() -> Unit): DescribeListenerCertificatesResponse

Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.

describeListeners

inline suspend fun ElasticLoadBalancingV2Client.describeListeners(crossinline block: DescribeListenersRequest.Builder.() -> Unit): DescribeListenersResponse

Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. You must specify either a load balancer or one or more listeners.

describeLoadBalancerAttributes

inline suspend fun ElasticLoadBalancingV2Client.describeLoadBalancerAttributes(crossinline block: DescribeLoadBalancerAttributesRequest.Builder.() -> Unit): DescribeLoadBalancerAttributesResponse

Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

describeLoadBalancers

inline suspend fun ElasticLoadBalancingV2Client.describeLoadBalancers(crossinline block: DescribeLoadBalancersRequest.Builder.() -> Unit): DescribeLoadBalancersResponse

Describes the specified load balancers or all of your load balancers.

describeRules

inline suspend fun ElasticLoadBalancingV2Client.describeRules(crossinline block: DescribeRulesRequest.Builder.() -> Unit): DescribeRulesResponse

Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.

describeSslPolicies

inline suspend fun ElasticLoadBalancingV2Client.describeSslPolicies(crossinline block: DescribeSslPoliciesRequest.Builder.() -> Unit): DescribeSslPoliciesResponse

Describes the specified policies or all policies used for SSL negotiation.

describeTags

inline suspend fun ElasticLoadBalancingV2Client.describeTags(crossinline block: DescribeTagsRequest.Builder.() -> Unit): DescribeTagsResponse

Describes the tags for the specified Elastic Load Balancing resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.

describeTargetGroupAttributes

inline suspend fun ElasticLoadBalancingV2Client.describeTargetGroupAttributes(crossinline block: DescribeTargetGroupAttributesRequest.Builder.() -> Unit): DescribeTargetGroupAttributesResponse

Describes the attributes for the specified target group.

describeTargetGroups

inline suspend fun ElasticLoadBalancingV2Client.describeTargetGroups(crossinline block: DescribeTargetGroupsRequest.Builder.() -> Unit): DescribeTargetGroupsResponse

Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.

describeTargetHealth

inline suspend fun ElasticLoadBalancingV2Client.describeTargetHealth(crossinline block: DescribeTargetHealthRequest.Builder.() -> Unit): DescribeTargetHealthResponse

Describes the health of the specified targets or all of your targets.

describeTrustStoreAssociations

inline suspend fun ElasticLoadBalancingV2Client.describeTrustStoreAssociations(crossinline block: DescribeTrustStoreAssociationsRequest.Builder.() -> Unit): DescribeTrustStoreAssociationsResponse

Describes all resources associated with the specified trust store.

describeTrustStoreRevocations

inline suspend fun ElasticLoadBalancingV2Client.describeTrustStoreRevocations(crossinline block: DescribeTrustStoreRevocationsRequest.Builder.() -> Unit): DescribeTrustStoreRevocationsResponse

Describes the revocation files in use by the specified trust store or revocation files.

describeTrustStores

inline suspend fun ElasticLoadBalancingV2Client.describeTrustStores(crossinline block: DescribeTrustStoresRequest.Builder.() -> Unit): DescribeTrustStoresResponse

Describes all trust stores for the specified account.

getResourcePolicy

inline suspend fun ElasticLoadBalancingV2Client.getResourcePolicy(crossinline block: GetResourcePolicyRequest.Builder.() -> Unit): GetResourcePolicyResponse

Retrieves the resource policy for a specified resource.

getTrustStoreCaCertificatesBundle

inline suspend fun ElasticLoadBalancingV2Client.getTrustStoreCaCertificatesBundle(crossinline block: GetTrustStoreCaCertificatesBundleRequest.Builder.() -> Unit): GetTrustStoreCaCertificatesBundleResponse

Retrieves the ca certificate bundle.

getTrustStoreRevocationContent

inline suspend fun ElasticLoadBalancingV2Client.getTrustStoreRevocationContent(crossinline block: GetTrustStoreRevocationContentRequest.Builder.() -> Unit): GetTrustStoreRevocationContentResponse

Retrieves the specified revocation file.

modifyCapacityReservation

inline suspend fun ElasticLoadBalancingV2Client.modifyCapacityReservation(crossinline block: ModifyCapacityReservationRequest.Builder.() -> Unit): ModifyCapacityReservationResponse

Modifies the capacity reservation of the specified load balancer.

modifyIpPools

inline suspend fun ElasticLoadBalancingV2Client.modifyIpPools(crossinline block: ModifyIpPoolsRequest.Builder.() -> Unit): ModifyIpPoolsResponse

[Application Load Balancers] Modify the IP pool associated to a load balancer.

modifyListener

inline suspend fun ElasticLoadBalancingV2Client.modifyListener(crossinline block: ModifyListenerRequest.Builder.() -> Unit): ModifyListenerResponse

Replaces the specified properties of the specified listener. Any properties that you do not specify remain unchanged.

modifyListenerAttributes

inline suspend fun ElasticLoadBalancingV2Client.modifyListenerAttributes(crossinline block: ModifyListenerAttributesRequest.Builder.() -> Unit): ModifyListenerAttributesResponse

Modifies the specified attributes of the specified listener.

modifyLoadBalancerAttributes

inline suspend fun ElasticLoadBalancingV2Client.modifyLoadBalancerAttributes(crossinline block: ModifyLoadBalancerAttributesRequest.Builder.() -> Unit): ModifyLoadBalancerAttributesResponse

Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

modifyRule

inline suspend fun ElasticLoadBalancingV2Client.modifyRule(crossinline block: ModifyRuleRequest.Builder.() -> Unit): ModifyRuleResponse

Replaces the specified properties of the specified rule. Any properties that you do not specify are unchanged.

modifyTargetGroup

inline suspend fun ElasticLoadBalancingV2Client.modifyTargetGroup(crossinline block: ModifyTargetGroupRequest.Builder.() -> Unit): ModifyTargetGroupResponse

Modifies the health checks used when evaluating the health state of the targets in the specified target group.

modifyTargetGroupAttributes

inline suspend fun ElasticLoadBalancingV2Client.modifyTargetGroupAttributes(crossinline block: ModifyTargetGroupAttributesRequest.Builder.() -> Unit): ModifyTargetGroupAttributesResponse

Modifies the specified attributes of the specified target group.

modifyTrustStore

inline suspend fun ElasticLoadBalancingV2Client.modifyTrustStore(crossinline block: ModifyTrustStoreRequest.Builder.() -> Unit): ModifyTrustStoreResponse

Update the ca certificate bundle for the specified trust store.

registerTargets

inline suspend fun ElasticLoadBalancingV2Client.registerTargets(crossinline block: RegisterTargetsRequest.Builder.() -> Unit): RegisterTargetsResponse

Registers the specified targets with the specified target group.

removeListenerCertificates

inline suspend fun ElasticLoadBalancingV2Client.removeListenerCertificates(crossinline block: RemoveListenerCertificatesRequest.Builder.() -> Unit): RemoveListenerCertificatesResponse

Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.

removeTags

inline suspend fun ElasticLoadBalancingV2Client.removeTags(crossinline block: RemoveTagsRequest.Builder.() -> Unit): RemoveTagsResponse

Removes the specified tags from the specified Elastic Load Balancing resources. You can remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.

removeTrustStoreRevocations

inline suspend fun ElasticLoadBalancingV2Client.removeTrustStoreRevocations(crossinline block: RemoveTrustStoreRevocationsRequest.Builder.() -> Unit): RemoveTrustStoreRevocationsResponse

Removes the specified revocation file from the specified trust store.

setIpAddressType

inline suspend fun ElasticLoadBalancingV2Client.setIpAddressType(crossinline block: SetIpAddressTypeRequest.Builder.() -> Unit): SetIpAddressTypeResponse

Sets the type of IP addresses used by the subnets of the specified load balancer.

setRulePriorities

inline suspend fun ElasticLoadBalancingV2Client.setRulePriorities(crossinline block: SetRulePrioritiesRequest.Builder.() -> Unit): SetRulePrioritiesResponse

Sets the priorities of the specified rules.

setSecurityGroups

inline suspend fun ElasticLoadBalancingV2Client.setSecurityGroups(crossinline block: SetSecurityGroupsRequest.Builder.() -> Unit): SetSecurityGroupsResponse

Associates the specified security groups with the specified Application Load Balancer or Network Load Balancer. The specified security groups override the previously associated security groups.

setSubnets

inline suspend fun ElasticLoadBalancingV2Client.setSubnets(crossinline block: SetSubnetsRequest.Builder.() -> Unit): SetSubnetsResponse

Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer, Network Load Balancer or Gateway Load Balancer. The specified subnets replace the previously enabled subnets.

withConfig

fun ElasticLoadBalancingV2Client.withConfig(block: ElasticLoadBalancingV2Client.Config.Builder.() -> Unit): ElasticLoadBalancingV2Client

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.