| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.NetworkManager.AssociateCustomerGateway
Description
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. The transit gateway must be registered
in your global network. When you register a transit gateway, 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.
Synopsis
- data AssociateCustomerGateway = AssociateCustomerGateway' {
- linkId :: Maybe Text
- customerGatewayArn :: Text
- globalNetworkId :: Text
- deviceId :: Text
- newAssociateCustomerGateway :: Text -> Text -> Text -> AssociateCustomerGateway
- associateCustomerGateway_linkId :: Lens' AssociateCustomerGateway (Maybe Text)
- associateCustomerGateway_customerGatewayArn :: Lens' AssociateCustomerGateway Text
- associateCustomerGateway_globalNetworkId :: Lens' AssociateCustomerGateway Text
- associateCustomerGateway_deviceId :: Lens' AssociateCustomerGateway Text
- data AssociateCustomerGatewayResponse = AssociateCustomerGatewayResponse' {}
- newAssociateCustomerGatewayResponse :: Int -> AssociateCustomerGatewayResponse
- associateCustomerGatewayResponse_customerGatewayAssociation :: Lens' AssociateCustomerGatewayResponse (Maybe CustomerGatewayAssociation)
- associateCustomerGatewayResponse_httpStatus :: Lens' AssociateCustomerGatewayResponse Int
Creating a Request
data AssociateCustomerGateway Source #
See: newAssociateCustomerGateway smart constructor.
Constructors
| AssociateCustomerGateway' | |
Fields
| |
Instances
newAssociateCustomerGateway Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> 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:
$sel:linkId:AssociateCustomerGateway', associateCustomerGateway_linkId - The ID of the link.
$sel:customerGatewayArn:AssociateCustomerGateway', associateCustomerGateway_customerGatewayArn - The Amazon Resource Name (ARN) of the customer gateway. For more
information, see
Resources Defined by Amazon EC2.
$sel:globalNetworkId:AssociateCustomerGateway', associateCustomerGateway_globalNetworkId - The ID of the global network.
$sel:deviceId:AssociateCustomerGateway', associateCustomerGateway_deviceId - The ID of the device.
Request Lenses
associateCustomerGateway_linkId :: Lens' AssociateCustomerGateway (Maybe Text) Source #
The ID of the link.
associateCustomerGateway_customerGatewayArn :: Lens' AssociateCustomerGateway Text Source #
The Amazon Resource Name (ARN) of the customer gateway. For more information, see Resources Defined by Amazon EC2.
associateCustomerGateway_globalNetworkId :: Lens' AssociateCustomerGateway Text Source #
The ID of the global network.
associateCustomerGateway_deviceId :: Lens' AssociateCustomerGateway Text Source #
The ID of the device.
Destructuring the Response
data AssociateCustomerGatewayResponse Source #
See: newAssociateCustomerGatewayResponse smart constructor.
Constructors
| AssociateCustomerGatewayResponse' | |
Fields
| |
Instances
newAssociateCustomerGatewayResponse Source #
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) Source #
The customer gateway association.
associateCustomerGatewayResponse_httpStatus :: Lens' AssociateCustomerGatewayResponse Int Source #
The response's http status code.