Skip to content

EC2  >  Operations  >  associate_client_vpn_target_network

associate_client_vpn_target_network

Operation

associate_client_vpn_target_network async 

associate_client_vpn_target_network(input: AssociateClientVpnTargetNetworkInput, plugins: list[Plugin] | None = None) -> AssociateClientVpnTargetNetworkOutput

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 (ModifyClientVpnEndpoint) and change the VPC that's associated with it.

Parameters:

Name Type Description Default
input AssociateClientVpnTargetNetworkInput

An instance of AssociateClientVpnTargetNetworkInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
AssociateClientVpnTargetNetworkOutput

An instance of AssociateClientVpnTargetNetworkOutput.

Input

AssociateClientVpnTargetNetworkInput dataclass

Bases: _SerdeShape

Dataclass for AssociateClientVpnTargetNetworkInput structure.

Attributes

availability_zone class-attribute instance-attribute 
availability_zone: str | None = ...

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.

availability_zone_id class-attribute instance-attribute 
availability_zone_id: str | None = ...

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.

client_token class-attribute instance-attribute 
client_token: str | None = ...

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

This field is autopopulated if not provided.

client_vpn_endpoint_id class-attribute instance-attribute 
client_vpn_endpoint_id: str | None = ...

The ID of the Client VPN endpoint.

dry_run class-attribute instance-attribute 
dry_run: bool | None = ...

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.

subnet_id class-attribute instance-attribute 
subnet_id: str | None = ...

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.

Output

AssociateClientVpnTargetNetworkOutput dataclass

Bases: _SerdeShape

Dataclass for AssociateClientVpnTargetNetworkOutput structure.

Attributes

association_id class-attribute instance-attribute 
association_id: str | None = ...

The unique ID of the target network association.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

status class-attribute instance-attribute 
status: AssociationStatus | None = ...

The current state of the target network association.