@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
143 lines (142 loc) • 5.17 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a Network Manager Customer Gateway Association.
*
* Use this resource to associate a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.networkmanager.GlobalNetwork("example", {description: "example"});
* const exampleSite = new aws.networkmanager.Site("example", {globalNetworkId: example.id});
* const exampleDevice = new aws.networkmanager.Device("example", {
* globalNetworkId: example.id,
* siteId: exampleSite.id,
* });
* const exampleCustomerGateway = new aws.ec2.CustomerGateway("example", {
* bgpAsn: "65000",
* ipAddress: "172.83.124.10",
* type: "ipsec.1",
* });
* const exampleTransitGateway = new aws.ec2transitgateway.TransitGateway("example", {});
* const exampleVpnConnection = new aws.ec2.VpnConnection("example", {
* customerGatewayId: exampleCustomerGateway.id,
* transitGatewayId: exampleTransitGateway.id,
* type: exampleCustomerGateway.type,
* staticRoutesOnly: true,
* });
* const exampleTransitGatewayRegistration = new aws.networkmanager.TransitGatewayRegistration("example", {
* globalNetworkId: example.id,
* transitGatewayArn: exampleTransitGateway.arn,
* }, {
* dependsOn: [exampleVpnConnection],
* });
* const exampleCustomerGatewayAssociation = new aws.networkmanager.CustomerGatewayAssociation("example", {
* globalNetworkId: example.id,
* customerGatewayArn: exampleCustomerGateway.arn,
* deviceId: exampleDevice.id,
* }, {
* dependsOn: [exampleTransitGatewayRegistration],
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import `aws_networkmanager_customer_gateway_association` using the global network ID and customer gateway ARN. For example:
*
* ```sh
* $ pulumi import aws:networkmanager/customerGatewayAssociation:CustomerGatewayAssociation example global-network-0d47f6t230mz46dy4,arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-123abc05e04123abc
* ```
*/
export declare class CustomerGatewayAssociation extends pulumi.CustomResource {
/**
* Get an existing CustomerGatewayAssociation resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CustomerGatewayAssociationState, opts?: pulumi.CustomResourceOptions): CustomerGatewayAssociation;
/**
* Returns true if the given object is an instance of CustomerGatewayAssociation. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is CustomerGatewayAssociation;
/**
* ARN of the customer gateway.
*/
readonly customerGatewayArn: pulumi.Output<string>;
/**
* ID of the device.
*/
readonly deviceId: pulumi.Output<string>;
/**
* ID of the global network.
*
* The following arguments are optional:
*/
readonly globalNetworkId: pulumi.Output<string>;
/**
* ID of the link.
*/
readonly linkId: pulumi.Output<string | undefined>;
/**
* Create a CustomerGatewayAssociation resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: CustomerGatewayAssociationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering CustomerGatewayAssociation resources.
*/
export interface CustomerGatewayAssociationState {
/**
* ARN of the customer gateway.
*/
customerGatewayArn?: pulumi.Input<string>;
/**
* ID of the device.
*/
deviceId?: pulumi.Input<string>;
/**
* ID of the global network.
*
* The following arguments are optional:
*/
globalNetworkId?: pulumi.Input<string>;
/**
* ID of the link.
*/
linkId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a CustomerGatewayAssociation resource.
*/
export interface CustomerGatewayAssociationArgs {
/**
* ARN of the customer gateway.
*/
customerGatewayArn: pulumi.Input<string>;
/**
* ID of the device.
*/
deviceId: pulumi.Input<string>;
/**
* ID of the global network.
*
* The following arguments are optional:
*/
globalNetworkId: pulumi.Input<string>;
/**
* ID of the link.
*/
linkId?: pulumi.Input<string>;
}