Amazonka.NetworkManager.AssociateCustomerGateway

Associates a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device.

You can only associate customer gateways that are connected to a VPN attachment on a transit gateway or core network registered in your global network. When you register a transit gateway or core network, customer gateways that are connected to the transit gateway are automatically included in the global network. To list customer gateways that are connected to a transit gateway, use the DescribeVpnConnections EC2 API and filter by transit-gateway-id.

You cannot associate a customer gateway with more than one device and link.

Creating a Request

data AssociateCustomerGateway

See: newAssociateCustomerGateway smart constructor.

Constructors

AssociateCustomerGateway'

Fields

• linkId :: Maybe Text

  The ID of the link.

• customerGatewayArn :: Text

  The Amazon Resource Name (ARN) of the customer gateway.

• globalNetworkId :: Text

  The ID of the global network.

• deviceId :: Text

  The ID of the device.

Instances

ToJSON AssociateCustomerGateway

Defined in Amazonka.NetworkManager.AssociateCustomerGateway

Methods

toJSON :: AssociateCustomerGateway -> Value

toEncoding :: AssociateCustomerGateway -> Encoding

toJSONList :: [AssociateCustomerGateway] -> Value

toEncodingList :: [AssociateCustomerGateway] -> Encoding

ToHeaders AssociateCustomerGateway

Defined in Amazonka.NetworkManager.AssociateCustomerGateway

Methods

toHeaders :: AssociateCustomerGateway -> [Header]

ToPath AssociateCustomerGateway

Defined in Amazonka.NetworkManager.AssociateCustomerGateway

Methods

toPath :: AssociateCustomerGateway -> ByteString

ToQuery AssociateCustomerGateway

Defined in Amazonka.NetworkManager.AssociateCustomerGateway

Methods

toQuery :: AssociateCustomerGateway -> QueryString

AWSRequest AssociateCustomerGateway

Defined in Amazonka.NetworkManager.AssociateCustomerGateway

Associated Types

type AWSResponse AssociateCustomerGateway

Methods

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

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

Generic AssociateCustomerGateway

Defined in Amazonka.NetworkManager.AssociateCustomerGateway

Associated Types

type Rep AssociateCustomerGateway :: Type -> Type

Methods

from :: AssociateCustomerGateway -> Rep AssociateCustomerGateway x

to :: Rep AssociateCustomerGateway x -> AssociateCustomerGateway

Read AssociateCustomerGateway

Defined in Amazonka.NetworkManager.AssociateCustomerGateway

Methods

readsPrec :: Int -> ReadS AssociateCustomerGateway

readList :: ReadS [AssociateCustomerGateway]

readPrec :: ReadPrec AssociateCustomerGateway

readListPrec :: ReadPrec [AssociateCustomerGateway]

Show AssociateCustomerGateway

Defined in Amazonka.NetworkManager.AssociateCustomerGateway

Methods

showsPrec :: Int -> AssociateCustomerGateway -> ShowS

show :: AssociateCustomerGateway -> String

showList :: [AssociateCustomerGateway] -> ShowS

NFData AssociateCustomerGateway

Defined in Amazonka.NetworkManager.AssociateCustomerGateway

Methods

rnf :: AssociateCustomerGateway -> ()

Eq AssociateCustomerGateway

Defined in Amazonka.NetworkManager.AssociateCustomerGateway

Methods

(==) :: AssociateCustomerGateway -> AssociateCustomerGateway -> Bool

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

Hashable AssociateCustomerGateway

Defined in Amazonka.NetworkManager.AssociateCustomerGateway

Methods

hashWithSalt :: Int -> AssociateCustomerGateway -> Int

hash :: AssociateCustomerGateway -> Int

type AWSResponse AssociateCustomerGateway

Defined in Amazonka.NetworkManager.AssociateCustomerGateway

type AWSResponse AssociateCustomerGateway = AssociateCustomerGatewayResponse

type Rep AssociateCustomerGateway

Defined in Amazonka.NetworkManager.AssociateCustomerGateway

type Rep AssociateCustomerGateway = D1 ('MetaData "AssociateCustomerGateway" "Amazonka.NetworkManager.AssociateCustomerGateway" "amazonka-networkmanager-2.0-4HNcDlBc00x67cUJWWz3sw" 'False) (C1 ('MetaCons "AssociateCustomerGateway'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "linkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "customerGatewayArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "globalNetworkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "deviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newAssociateCustomerGateway

Arguments

:: Text

AssociateCustomerGateway

-> Text

AssociateCustomerGateway

-> Text

AssociateCustomerGateway

-> AssociateCustomerGateway

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

AssociateCustomerGateway, associateCustomerGateway_linkId - The ID of the link.

AssociateCustomerGateway, associateCustomerGateway_customerGatewayArn - The Amazon Resource Name (ARN) of the customer gateway.

AssociateCustomerGateway, associateCustomerGateway_globalNetworkId - The ID of the global network.

AssociateCustomerGateway, associateCustomerGateway_deviceId - The ID of the device.

Request Lenses

associateCustomerGateway_linkId :: Lens' AssociateCustomerGateway (Maybe Text)

The ID of the link.

associateCustomerGateway_customerGatewayArn :: Lens' AssociateCustomerGateway Text

The Amazon Resource Name (ARN) of the customer gateway.

associateCustomerGateway_globalNetworkId :: Lens' AssociateCustomerGateway Text

The ID of the global network.

associateCustomerGateway_deviceId :: Lens' AssociateCustomerGateway Text

The ID of the device.

Destructuring the Response

data AssociateCustomerGatewayResponse

See: newAssociateCustomerGatewayResponse smart constructor.

Constructors

AssociateCustomerGatewayResponse'

Fields

• customerGatewayAssociation :: Maybe CustomerGatewayAssociation

  The customer gateway association.

• httpStatus :: Int

  The response's http status code.

Instances

Generic AssociateCustomerGatewayResponse

Defined in Amazonka.NetworkManager.AssociateCustomerGateway

Associated Types

type Rep AssociateCustomerGatewayResponse :: Type -> Type

Methods

from :: AssociateCustomerGatewayResponse -> Rep AssociateCustomerGatewayResponse x

to :: Rep AssociateCustomerGatewayResponse x -> AssociateCustomerGatewayResponse

Read AssociateCustomerGatewayResponse

Defined in Amazonka.NetworkManager.AssociateCustomerGateway

Methods

readsPrec :: Int -> ReadS AssociateCustomerGatewayResponse

readList :: ReadS [AssociateCustomerGatewayResponse]

readPrec :: ReadPrec AssociateCustomerGatewayResponse

readListPrec :: ReadPrec [AssociateCustomerGatewayResponse]

Show AssociateCustomerGatewayResponse

Defined in Amazonka.NetworkManager.AssociateCustomerGateway

Methods

showsPrec :: Int -> AssociateCustomerGatewayResponse -> ShowS

show :: AssociateCustomerGatewayResponse -> String

showList :: [AssociateCustomerGatewayResponse] -> ShowS

NFData AssociateCustomerGatewayResponse

Defined in Amazonka.NetworkManager.AssociateCustomerGateway

Methods

rnf :: AssociateCustomerGatewayResponse -> ()

Eq AssociateCustomerGatewayResponse

Defined in Amazonka.NetworkManager.AssociateCustomerGateway

Methods

(==) :: AssociateCustomerGatewayResponse -> AssociateCustomerGatewayResponse -> Bool

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

type Rep AssociateCustomerGatewayResponse

Defined in Amazonka.NetworkManager.AssociateCustomerGateway

type Rep AssociateCustomerGatewayResponse = D1 ('MetaData "AssociateCustomerGatewayResponse" "Amazonka.NetworkManager.AssociateCustomerGateway" "amazonka-networkmanager-2.0-4HNcDlBc00x67cUJWWz3sw" 'False) (C1 ('MetaCons "AssociateCustomerGatewayResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "customerGatewayAssociation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomerGatewayAssociation)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAssociateCustomerGatewayResponse

Arguments

:: Int

$sel:httpStatus:AssociateCustomerGatewayResponse'

-> AssociateCustomerGatewayResponse

Create a value of AssociateCustomerGatewayResponse 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:customerGatewayAssociation:AssociateCustomerGatewayResponse', associateCustomerGatewayResponse_customerGatewayAssociation - The customer gateway association.

$sel:httpStatus:AssociateCustomerGatewayResponse', associateCustomerGatewayResponse_httpStatus - The response's http status code.

Response Lenses

associateCustomerGatewayResponse_customerGatewayAssociation :: Lens' AssociateCustomerGatewayResponse (Maybe CustomerGatewayAssociation)

The customer gateway association.

associateCustomerGatewayResponse_httpStatus :: Lens' AssociateCustomerGatewayResponse Int

The response's http status code.