Skip to content

Associates a target network with a Client VPN endpoint

Description

Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.

If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (modify_client_vpn_endpoint) and change the VPC that's associated with it.

Usage

ec2_associate_client_vpn_target_network(ClientVpnEndpointId, SubnetId,
  ClientToken, DryRun, AvailabilityZone, AvailabilityZoneId)

Arguments

  • ClientVpnEndpointId

    [required] The ID of the Client VPN endpoint.

  • SubnetId

    The ID of the subnet to associate with the Client VPN endpoint. Required for VPC-based endpoints. For Transit Gateway-based endpoints, use AvailabilityZone or AvailabilityZoneId instead.

  • ClientToken

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

  • DryRun

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • AvailabilityZone

    The Availability Zone name for the Transit Gateway association. Required if when associating an Availability Zone with a Client VPN endpoint that uses a Transit Gateway. You cannot specify both SubnetId and AvailabilityZone.

  • AvailabilityZoneId

    The Availability Zone ID for the Transit Gateway association. Required if when associating an Availability Zone with a Client VPN endpoint that uses a Transit Gateway. You cannot specify both AvailabilityZone and AvailabilityZoneId.

Value

A list with the following syntax:

list(
  AssociationId = "string",
  Status = list(
    Code = "associating"|"associated"|"association-failed"|"disassociating"|"disassociated",
    Message = "string"
  )
)

Request syntax

svc$associate_client_vpn_target_network(
  ClientVpnEndpointId = "string",
  SubnetId = "string",
  ClientToken = "string",
  DryRun = TRUE|FALSE,
  AvailabilityZone = "string",
  AvailabilityZoneId = "string"
)