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

Description

Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.

Synopsis

Creating a Request

data DeleteClientVpnRoute Source #

See: newDeleteClientVpnRoute smart constructor.

Constructors

DeleteClientVpnRoute' 

Fields

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

  • targetVpcSubnetId :: Maybe Text

    The ID of the target subnet used by the route.

  • clientVpnEndpointId :: Text

    The ID of the Client VPN endpoint from which the route is to be deleted.

  • destinationCidrBlock :: Text

    The IPv4 address range, in CIDR notation, of the route to be deleted.

Instances

Instances details
ToHeaders DeleteClientVpnRoute Source # 
Instance details

Defined in Amazonka.EC2.DeleteClientVpnRoute

ToPath DeleteClientVpnRoute Source # 
Instance details

Defined in Amazonka.EC2.DeleteClientVpnRoute

ToQuery DeleteClientVpnRoute Source # 
Instance details

Defined in Amazonka.EC2.DeleteClientVpnRoute

AWSRequest DeleteClientVpnRoute Source # 
Instance details

Defined in Amazonka.EC2.DeleteClientVpnRoute

Associated Types

type AWSResponse DeleteClientVpnRoute #

Generic DeleteClientVpnRoute Source # 
Instance details

Defined in Amazonka.EC2.DeleteClientVpnRoute

Associated Types

type Rep DeleteClientVpnRoute :: Type -> Type #

Read DeleteClientVpnRoute Source # 
Instance details

Defined in Amazonka.EC2.DeleteClientVpnRoute

Show DeleteClientVpnRoute Source # 
Instance details

Defined in Amazonka.EC2.DeleteClientVpnRoute

NFData DeleteClientVpnRoute Source # 
Instance details

Defined in Amazonka.EC2.DeleteClientVpnRoute

Methods

rnf :: DeleteClientVpnRoute -> () #

Eq DeleteClientVpnRoute Source # 
Instance details

Defined in Amazonka.EC2.DeleteClientVpnRoute

Hashable DeleteClientVpnRoute Source # 
Instance details

Defined in Amazonka.EC2.DeleteClientVpnRoute

type AWSResponse DeleteClientVpnRoute Source # 
Instance details

Defined in Amazonka.EC2.DeleteClientVpnRoute

type Rep DeleteClientVpnRoute Source # 
Instance details

Defined in Amazonka.EC2.DeleteClientVpnRoute

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

newDeleteClientVpnRoute Source #

Create a value of DeleteClientVpnRoute 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:

$sel:dryRun:DeleteClientVpnRoute', deleteClientVpnRoute_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.

$sel:targetVpcSubnetId:DeleteClientVpnRoute', deleteClientVpnRoute_targetVpcSubnetId - The ID of the target subnet used by the route.

DeleteClientVpnRoute, deleteClientVpnRoute_clientVpnEndpointId - The ID of the Client VPN endpoint from which the route is to be deleted.

DeleteClientVpnRoute, deleteClientVpnRoute_destinationCidrBlock - The IPv4 address range, in CIDR notation, of the route to be deleted.

Request Lenses

deleteClientVpnRoute_dryRun :: Lens' DeleteClientVpnRoute (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.

deleteClientVpnRoute_targetVpcSubnetId :: Lens' DeleteClientVpnRoute (Maybe Text) Source #

The ID of the target subnet used by the route.

deleteClientVpnRoute_clientVpnEndpointId :: Lens' DeleteClientVpnRoute Text Source #

The ID of the Client VPN endpoint from which the route is to be deleted.

deleteClientVpnRoute_destinationCidrBlock :: Lens' DeleteClientVpnRoute Text Source #

The IPv4 address range, in CIDR notation, of the route to be deleted.

Destructuring the Response

data DeleteClientVpnRouteResponse Source #

See: newDeleteClientVpnRouteResponse smart constructor.

Constructors

DeleteClientVpnRouteResponse' 

Fields

Instances

Instances details
Generic DeleteClientVpnRouteResponse Source # 
Instance details

Defined in Amazonka.EC2.DeleteClientVpnRoute

Associated Types

type Rep DeleteClientVpnRouteResponse :: Type -> Type #

Read DeleteClientVpnRouteResponse Source # 
Instance details

Defined in Amazonka.EC2.DeleteClientVpnRoute

Show DeleteClientVpnRouteResponse Source # 
Instance details

Defined in Amazonka.EC2.DeleteClientVpnRoute

NFData DeleteClientVpnRouteResponse Source # 
Instance details

Defined in Amazonka.EC2.DeleteClientVpnRoute

Eq DeleteClientVpnRouteResponse Source # 
Instance details

Defined in Amazonka.EC2.DeleteClientVpnRoute

type Rep DeleteClientVpnRouteResponse Source # 
Instance details

Defined in Amazonka.EC2.DeleteClientVpnRoute

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

newDeleteClientVpnRouteResponse Source #

Create a value of DeleteClientVpnRouteResponse 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:

DeleteClientVpnRouteResponse, deleteClientVpnRouteResponse_status - The current state of the route.

$sel:httpStatus:DeleteClientVpnRouteResponse', deleteClientVpnRouteResponse_httpStatus - The response's http status code.

Response Lenses