Amazonka.EC2.ModifyVpnConnection

Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To modify the target gateway, the following migration options are available:

• An existing virtual private gateway to a new virtual private gateway
• An existing virtual private gateway to a transit gateway
• An existing transit gateway to a new transit gateway
• An existing transit gateway to a virtual private gateway

Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.

This step is required when you migrate from a virtual private gateway with static routes to a transit gateway.

You must delete the static routes before you migrate to the new gateway.

Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.

After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in Update VPC route tables in the Amazon Web Services Site-to-Site VPN User Guide.

When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.

If you deleted VPN static routes, you must add the static routes to the transit gateway route table.

After you perform this operation, the VPN endpoint's IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.

Creating a Request

data ModifyVpnConnection

See: newModifyVpnConnection smart constructor.

Constructors

ModifyVpnConnection'

Fields

• customerGatewayId :: Maybe Text

  The ID of the customer gateway at your end of the VPN connection.

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

• transitGatewayId :: Maybe Text

  The ID of the transit gateway.

• vpnGatewayId :: Maybe Text

  The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.

• vpnConnectionId :: Text

  The ID of the VPN connection.

Instances

ToHeaders ModifyVpnConnection

Defined in Amazonka.EC2.ModifyVpnConnection

Methods

toHeaders :: ModifyVpnConnection -> [Header]

ToPath ModifyVpnConnection

Defined in Amazonka.EC2.ModifyVpnConnection

Methods

toPath :: ModifyVpnConnection -> ByteString

ToQuery ModifyVpnConnection

Defined in Amazonka.EC2.ModifyVpnConnection

Methods

toQuery :: ModifyVpnConnection -> QueryString

AWSRequest ModifyVpnConnection

Defined in Amazonka.EC2.ModifyVpnConnection

Associated Types

type AWSResponse ModifyVpnConnection

Methods

request :: (Service -> Service) -> ModifyVpnConnection -> Request ModifyVpnConnection

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyVpnConnection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyVpnConnection)))

Generic ModifyVpnConnection

Defined in Amazonka.EC2.ModifyVpnConnection

Associated Types

type Rep ModifyVpnConnection :: Type -> Type

Methods

from :: ModifyVpnConnection -> Rep ModifyVpnConnection x

to :: Rep ModifyVpnConnection x -> ModifyVpnConnection

Read ModifyVpnConnection

Defined in Amazonka.EC2.ModifyVpnConnection

Methods

readsPrec :: Int -> ReadS ModifyVpnConnection

readList :: ReadS [ModifyVpnConnection]

readPrec :: ReadPrec ModifyVpnConnection

readListPrec :: ReadPrec [ModifyVpnConnection]

Show ModifyVpnConnection

Defined in Amazonka.EC2.ModifyVpnConnection

Methods

showsPrec :: Int -> ModifyVpnConnection -> ShowS

show :: ModifyVpnConnection -> String

showList :: [ModifyVpnConnection] -> ShowS

NFData ModifyVpnConnection

Defined in Amazonka.EC2.ModifyVpnConnection

Methods

rnf :: ModifyVpnConnection -> ()

Eq ModifyVpnConnection

Defined in Amazonka.EC2.ModifyVpnConnection

Methods

(==) :: ModifyVpnConnection -> ModifyVpnConnection -> Bool

(/=) :: ModifyVpnConnection -> ModifyVpnConnection -> Bool

Hashable ModifyVpnConnection

Defined in Amazonka.EC2.ModifyVpnConnection

Methods

hashWithSalt :: Int -> ModifyVpnConnection -> Int

hash :: ModifyVpnConnection -> Int

type AWSResponse ModifyVpnConnection

Defined in Amazonka.EC2.ModifyVpnConnection

type AWSResponse ModifyVpnConnection = ModifyVpnConnectionResponse

type Rep ModifyVpnConnection

Defined in Amazonka.EC2.ModifyVpnConnection

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

newModifyVpnConnection

Arguments

:: Text

ModifyVpnConnection

-> ModifyVpnConnection

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

ModifyVpnConnection, modifyVpnConnection_customerGatewayId - The ID of the customer gateway at your end of the VPN connection.

$sel:dryRun:ModifyVpnConnection', modifyVpnConnection_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.

ModifyVpnConnection, modifyVpnConnection_transitGatewayId - The ID of the transit gateway.

ModifyVpnConnection, modifyVpnConnection_vpnGatewayId - The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.

ModifyVpnConnection, modifyVpnConnection_vpnConnectionId - The ID of the VPN connection.

Request Lenses

modifyVpnConnection_customerGatewayId :: Lens' ModifyVpnConnection (Maybe Text)

The ID of the customer gateway at your end of the VPN connection.

modifyVpnConnection_dryRun :: Lens' ModifyVpnConnection (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.

modifyVpnConnection_transitGatewayId :: Lens' ModifyVpnConnection (Maybe Text)

The ID of the transit gateway.

modifyVpnConnection_vpnGatewayId :: Lens' ModifyVpnConnection (Maybe Text)

The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.

modifyVpnConnection_vpnConnectionId :: Lens' ModifyVpnConnection Text

The ID of the VPN connection.

Destructuring the Response

data ModifyVpnConnectionResponse

See: newModifyVpnConnectionResponse smart constructor.

Constructors

ModifyVpnConnectionResponse'

Fields

• vpnConnection :: Maybe VpnConnection

  Information about the VPN connection.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ModifyVpnConnectionResponse

Defined in Amazonka.EC2.ModifyVpnConnection

Associated Types

type Rep ModifyVpnConnectionResponse :: Type -> Type

Methods

from :: ModifyVpnConnectionResponse -> Rep ModifyVpnConnectionResponse x

to :: Rep ModifyVpnConnectionResponse x -> ModifyVpnConnectionResponse

Read ModifyVpnConnectionResponse

Defined in Amazonka.EC2.ModifyVpnConnection

Methods

readsPrec :: Int -> ReadS ModifyVpnConnectionResponse

readList :: ReadS [ModifyVpnConnectionResponse]

readPrec :: ReadPrec ModifyVpnConnectionResponse

readListPrec :: ReadPrec [ModifyVpnConnectionResponse]

Show ModifyVpnConnectionResponse

Defined in Amazonka.EC2.ModifyVpnConnection

Methods

showsPrec :: Int -> ModifyVpnConnectionResponse -> ShowS

show :: ModifyVpnConnectionResponse -> String

showList :: [ModifyVpnConnectionResponse] -> ShowS

NFData ModifyVpnConnectionResponse

Defined in Amazonka.EC2.ModifyVpnConnection

Methods

rnf :: ModifyVpnConnectionResponse -> ()

Eq ModifyVpnConnectionResponse

Defined in Amazonka.EC2.ModifyVpnConnection

Methods

(==) :: ModifyVpnConnectionResponse -> ModifyVpnConnectionResponse -> Bool

(/=) :: ModifyVpnConnectionResponse -> ModifyVpnConnectionResponse -> Bool

type Rep ModifyVpnConnectionResponse

Defined in Amazonka.EC2.ModifyVpnConnection

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

newModifyVpnConnectionResponse

Arguments

:: Int

$sel:httpStatus:ModifyVpnConnectionResponse'

-> ModifyVpnConnectionResponse

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

ModifyVpnConnectionResponse, modifyVpnConnectionResponse_vpnConnection - Information about the VPN connection.

$sel:httpStatus:ModifyVpnConnectionResponse', modifyVpnConnectionResponse_httpStatus - The response's http status code.

Response Lenses

modifyVpnConnectionResponse_vpnConnection :: Lens' ModifyVpnConnectionResponse (Maybe VpnConnection)

Information about the VPN connection.

modifyVpnConnectionResponse_httpStatus :: Lens' ModifyVpnConnectionResponse Int

The response's http status code.