1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. networkmanager
  5. CustomerGatewayAssociation

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

aws-native.networkmanager.CustomerGatewayAssociation

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

The AWS::NetworkManager::CustomerGatewayAssociation type associates a customer gateway with a device and optionally, with a link.

Create CustomerGatewayAssociation Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new CustomerGatewayAssociation(name: string, args: CustomerGatewayAssociationArgs, opts?: CustomResourceOptions);
@overload
def CustomerGatewayAssociation(resource_name: str,
                               args: CustomerGatewayAssociationArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def CustomerGatewayAssociation(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               customer_gateway_arn: Optional[str] = None,
                               device_id: Optional[str] = None,
                               global_network_id: Optional[str] = None,
                               link_id: Optional[str] = None)
func NewCustomerGatewayAssociation(ctx *Context, name string, args CustomerGatewayAssociationArgs, opts ...ResourceOption) (*CustomerGatewayAssociation, error)
public CustomerGatewayAssociation(string name, CustomerGatewayAssociationArgs args, CustomResourceOptions? opts = null)
public CustomerGatewayAssociation(String name, CustomerGatewayAssociationArgs args)
public CustomerGatewayAssociation(String name, CustomerGatewayAssociationArgs args, CustomResourceOptions options)
type: aws-native:networkmanager:CustomerGatewayAssociation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CustomerGatewayAssociationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CustomerGatewayAssociationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CustomerGatewayAssociationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CustomerGatewayAssociationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CustomerGatewayAssociationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

CustomerGatewayAssociation Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The CustomerGatewayAssociation resource accepts the following input properties:

CustomerGatewayArn This property is required. string
The Amazon Resource Name (ARN) of the customer gateway.
DeviceId This property is required. string
The ID of the device
GlobalNetworkId This property is required. string
The ID of the global network.
LinkId string
The ID of the link
CustomerGatewayArn This property is required. string
The Amazon Resource Name (ARN) of the customer gateway.
DeviceId This property is required. string
The ID of the device
GlobalNetworkId This property is required. string
The ID of the global network.
LinkId string
The ID of the link
customerGatewayArn This property is required. String
The Amazon Resource Name (ARN) of the customer gateway.
deviceId This property is required. String
The ID of the device
globalNetworkId This property is required. String
The ID of the global network.
linkId String
The ID of the link
customerGatewayArn This property is required. string
The Amazon Resource Name (ARN) of the customer gateway.
deviceId This property is required. string
The ID of the device
globalNetworkId This property is required. string
The ID of the global network.
linkId string
The ID of the link
customer_gateway_arn This property is required. str
The Amazon Resource Name (ARN) of the customer gateway.
device_id This property is required. str
The ID of the device
global_network_id This property is required. str
The ID of the global network.
link_id str
The ID of the link
customerGatewayArn This property is required. String
The Amazon Resource Name (ARN) of the customer gateway.
deviceId This property is required. String
The ID of the device
globalNetworkId This property is required. String
The ID of the global network.
linkId String
The ID of the link

Outputs

All input properties are implicitly available as output properties. Additionally, the CustomerGatewayAssociation resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi