amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.AssociateClientVpnTargetNetwork

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

Synopsis

Creating a Request

data AssociateClientVpnTargetNetwork Source #

See: newAssociateClientVpnTargetNetwork smart constructor.

Constructors

AssociateClientVpnTargetNetwork' 

Fields

  • clientToken :: Maybe Text

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

  • dryRun :: Maybe Bool

    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.

  • clientVpnEndpointId :: Text

    The ID of the Client VPN endpoint.

  • subnetId :: Text

    The ID of the subnet to associate with the Client VPN endpoint.

Instances

Instances details
ToHeaders AssociateClientVpnTargetNetwork Source # 
Instance details

Defined in Amazonka.EC2.AssociateClientVpnTargetNetwork

ToPath AssociateClientVpnTargetNetwork Source # 
Instance details

Defined in Amazonka.EC2.AssociateClientVpnTargetNetwork

ToQuery AssociateClientVpnTargetNetwork Source # 
Instance details

Defined in Amazonka.EC2.AssociateClientVpnTargetNetwork

AWSRequest AssociateClientVpnTargetNetwork Source # 
Instance details

Defined in Amazonka.EC2.AssociateClientVpnTargetNetwork

Generic AssociateClientVpnTargetNetwork Source # 
Instance details

Defined in Amazonka.EC2.AssociateClientVpnTargetNetwork

Associated Types

type Rep AssociateClientVpnTargetNetwork :: Type -> Type #

Read AssociateClientVpnTargetNetwork Source # 
Instance details

Defined in Amazonka.EC2.AssociateClientVpnTargetNetwork

Show AssociateClientVpnTargetNetwork Source # 
Instance details

Defined in Amazonka.EC2.AssociateClientVpnTargetNetwork

NFData AssociateClientVpnTargetNetwork Source # 
Instance details

Defined in Amazonka.EC2.AssociateClientVpnTargetNetwork

Eq AssociateClientVpnTargetNetwork Source # 
Instance details

Defined in Amazonka.EC2.AssociateClientVpnTargetNetwork

Hashable AssociateClientVpnTargetNetwork Source # 
Instance details

Defined in Amazonka.EC2.AssociateClientVpnTargetNetwork

type AWSResponse AssociateClientVpnTargetNetwork Source # 
Instance details

Defined in Amazonka.EC2.AssociateClientVpnTargetNetwork

type Rep AssociateClientVpnTargetNetwork Source # 
Instance details

Defined in Amazonka.EC2.AssociateClientVpnTargetNetwork

type Rep AssociateClientVpnTargetNetwork = D1 ('MetaData "AssociateClientVpnTargetNetwork" "Amazonka.EC2.AssociateClientVpnTargetNetwork" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "AssociateClientVpnTargetNetwork'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "clientVpnEndpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "subnetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newAssociateClientVpnTargetNetwork Source #

Create a value of AssociateClientVpnTargetNetwork with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:dryRun:AssociateClientVpnTargetNetwork', associateClientVpnTargetNetwork_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.

AssociateClientVpnTargetNetwork, associateClientVpnTargetNetwork_clientVpnEndpointId - The ID of the Client VPN endpoint.

AssociateClientVpnTargetNetwork, associateClientVpnTargetNetwork_subnetId - The ID of the subnet to associate with the Client VPN endpoint.

Request Lenses

associateClientVpnTargetNetwork_clientToken :: Lens' AssociateClientVpnTargetNetwork (Maybe Text) Source #

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

associateClientVpnTargetNetwork_dryRun :: Lens' AssociateClientVpnTargetNetwork (Maybe Bool) Source #

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.

associateClientVpnTargetNetwork_subnetId :: Lens' AssociateClientVpnTargetNetwork Text Source #

The ID of the subnet to associate with the Client VPN endpoint.

Destructuring the Response

data AssociateClientVpnTargetNetworkResponse Source #

Constructors

AssociateClientVpnTargetNetworkResponse' 

Fields

Instances

Instances details
Generic AssociateClientVpnTargetNetworkResponse Source # 
Instance details

Defined in Amazonka.EC2.AssociateClientVpnTargetNetwork

Read AssociateClientVpnTargetNetworkResponse Source # 
Instance details

Defined in Amazonka.EC2.AssociateClientVpnTargetNetwork

Show AssociateClientVpnTargetNetworkResponse Source # 
Instance details

Defined in Amazonka.EC2.AssociateClientVpnTargetNetwork

NFData AssociateClientVpnTargetNetworkResponse Source # 
Instance details

Defined in Amazonka.EC2.AssociateClientVpnTargetNetwork

Eq AssociateClientVpnTargetNetworkResponse Source # 
Instance details

Defined in Amazonka.EC2.AssociateClientVpnTargetNetwork

type Rep AssociateClientVpnTargetNetworkResponse Source # 
Instance details

Defined in Amazonka.EC2.AssociateClientVpnTargetNetwork

type Rep AssociateClientVpnTargetNetworkResponse = D1 ('MetaData "AssociateClientVpnTargetNetworkResponse" "Amazonka.EC2.AssociateClientVpnTargetNetwork" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "AssociateClientVpnTargetNetworkResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "associationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AssociationStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newAssociateClientVpnTargetNetworkResponse Source #

Create a value of AssociateClientVpnTargetNetworkResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

AssociateClientVpnTargetNetworkResponse, associateClientVpnTargetNetworkResponse_associationId - The unique ID of the target network association.

AssociateClientVpnTargetNetworkResponse, associateClientVpnTargetNetworkResponse_status - The current state of the target network association.

$sel:httpStatus:AssociateClientVpnTargetNetworkResponse', associateClientVpnTargetNetworkResponse_httpStatus - The response's http status code.

Response Lenses