GatewayAssociationProposal

Manages a Direct Connect Gateway Association Proposal, typically for enabling cross-account associations. For single account associations, see the aws.directconnect.GatewayAssociation resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.DirectConnect.GatewayAssociationProposal("example", new Aws.DirectConnect.GatewayAssociationProposalArgs
        {
            AssociatedGatewayId = aws_vpn_gateway.Example.Id,
            DxGatewayId = aws_dx_gateway.Example.Id,
            DxGatewayOwnerAccountId = aws_dx_gateway.Example.Owner_account_id,
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/directconnect"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := directconnect.NewGatewayAssociationProposal(ctx, "example", &directconnect.GatewayAssociationProposalArgs{
            AssociatedGatewayId:     pulumi.String(aws_vpn_gateway.Example.Id),
            DxGatewayId:             pulumi.String(aws_dx_gateway.Example.Id),
            DxGatewayOwnerAccountId: pulumi.String(aws_dx_gateway.Example.Owner_account_id),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.directconnect.GatewayAssociationProposal("example",
    associated_gateway_id=aws_vpn_gateway["example"]["id"],
    dx_gateway_id=aws_dx_gateway["example"]["id"],
    dx_gateway_owner_account_id=aws_dx_gateway["example"]["owner_account_id"])

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.directconnect.GatewayAssociationProposal("example", {
    associatedGatewayId: aws_vpn_gateway_example.id,
    dxGatewayId: aws_dx_gateway_example.id,
    dxGatewayOwnerAccountId: aws_dx_gateway_example.ownerAccountId,
});

Create a GatewayAssociationProposal Resource

new GatewayAssociationProposal(name: string, args: GatewayAssociationProposalArgs, opts?: CustomResourceOptions);

def GatewayAssociationProposal(resource_name, opts=None, allowed_prefixes=None, associated_gateway_id=None, dx_gateway_id=None, dx_gateway_owner_account_id=None, vpn_gateway_id=None, __props__=None);

func NewGatewayAssociationProposal(ctx *Context, name string, args GatewayAssociationProposalArgs, opts ...ResourceOption) (*GatewayAssociationProposal, error)

public GatewayAssociationProposal(string name, GatewayAssociationProposalArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args GatewayAssociationProposalArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args GatewayAssociationProposalArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GatewayAssociationProposalArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

GatewayAssociationProposal Resource Properties

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

Inputs

The GatewayAssociationProposal resource accepts the following input properties:

DxGatewayId string

Direct Connect Gateway identifier.

DxGatewayOwnerAccountId string

AWS Account identifier of the Direct Connect Gateway’s owner.

AllowedPrefixes List<string>

VPC prefixes (CIDRs) to advertise to the Direct Connect gateway. Defaults to the CIDR block of the VPC associated with the Virtual Gateway. To enable drift detection, must be configured.

AssociatedGatewayId string

The ID of the VGW or transit gateway with which to associate the Direct Connect gateway.

VpnGatewayId string

Deprecated: Use associated_gateway_id instead. Virtual Gateway identifier to associate with the Direct Connect Gateway.

Deprecated: use 'associated_gateway_id' argument instead

DxGatewayId string

Direct Connect Gateway identifier.

DxGatewayOwnerAccountId string

AWS Account identifier of the Direct Connect Gateway’s owner.

AllowedPrefixes []string

VPC prefixes (CIDRs) to advertise to the Direct Connect gateway. Defaults to the CIDR block of the VPC associated with the Virtual Gateway. To enable drift detection, must be configured.

AssociatedGatewayId string

The ID of the VGW or transit gateway with which to associate the Direct Connect gateway.

VpnGatewayId string

Deprecated: Use associated_gateway_id instead. Virtual Gateway identifier to associate with the Direct Connect Gateway.

Deprecated: use 'associated_gateway_id' argument instead

dxGatewayId string

Direct Connect Gateway identifier.

dxGatewayOwnerAccountId string

AWS Account identifier of the Direct Connect Gateway’s owner.

allowedPrefixes string[]

VPC prefixes (CIDRs) to advertise to the Direct Connect gateway. Defaults to the CIDR block of the VPC associated with the Virtual Gateway. To enable drift detection, must be configured.

associatedGatewayId string

The ID of the VGW or transit gateway with which to associate the Direct Connect gateway.

vpnGatewayId string

Deprecated: Use associated_gateway_id instead. Virtual Gateway identifier to associate with the Direct Connect Gateway.

Deprecated: use 'associated_gateway_id' argument instead

dx_gateway_id str

Direct Connect Gateway identifier.

dx_gateway_owner_account_id str

AWS Account identifier of the Direct Connect Gateway’s owner.

allowed_prefixes List[str]

VPC prefixes (CIDRs) to advertise to the Direct Connect gateway. Defaults to the CIDR block of the VPC associated with the Virtual Gateway. To enable drift detection, must be configured.

associated_gateway_id str

The ID of the VGW or transit gateway with which to associate the Direct Connect gateway.

vpn_gateway_id str

Deprecated: Use associated_gateway_id instead. Virtual Gateway identifier to associate with the Direct Connect Gateway.

Deprecated: use 'associated_gateway_id' argument instead

Outputs

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

AssociatedGatewayOwnerAccountId string: The ID of the AWS account that owns the VGW or transit gateway with which to associate the Direct Connect gateway.
AssociatedGatewayType string: The type of the associated gateway, transitGateway or virtualPrivateGateway.
Id string: The provider-assigned unique ID for this managed resource.

AssociatedGatewayOwnerAccountId string: The ID of the AWS account that owns the VGW or transit gateway with which to associate the Direct Connect gateway.
AssociatedGatewayType string: The type of the associated gateway, transitGateway or virtualPrivateGateway.
Id string: The provider-assigned unique ID for this managed resource.

associatedGatewayOwnerAccountId string: The ID of the AWS account that owns the VGW or transit gateway with which to associate the Direct Connect gateway.
associatedGatewayType string: The type of the associated gateway, transitGateway or virtualPrivateGateway.
id string: The provider-assigned unique ID for this managed resource.

associated_gateway_owner_account_id str: The ID of the AWS account that owns the VGW or transit gateway with which to associate the Direct Connect gateway.
associated_gateway_type str: The type of the associated gateway, transitGateway or virtualPrivateGateway.
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing GatewayAssociationProposal Resource

Get an existing GatewayAssociationProposal resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GatewayAssociationProposalState, opts?: CustomResourceOptions): GatewayAssociationProposal

static get(resource_name, id, opts=None, allowed_prefixes=None, associated_gateway_id=None, associated_gateway_owner_account_id=None, associated_gateway_type=None, dx_gateway_id=None, dx_gateway_owner_account_id=None, vpn_gateway_id=None, __props__=None);

func GetGatewayAssociationProposal(ctx *Context, name string, id IDInput, state *GatewayAssociationProposalState, opts ...ResourceOption) (*GatewayAssociationProposal, error)

public static GatewayAssociationProposal Get(string name, Input<string> id, GatewayAssociationProposalState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AllowedPrefixes List<string>

VPC prefixes (CIDRs) to advertise to the Direct Connect gateway. Defaults to the CIDR block of the VPC associated with the Virtual Gateway. To enable drift detection, must be configured.

AssociatedGatewayId string

The ID of the VGW or transit gateway with which to associate the Direct Connect gateway.

AssociatedGatewayOwnerAccountId string

The ID of the AWS account that owns the VGW or transit gateway with which to associate the Direct Connect gateway.

AssociatedGatewayType string

The type of the associated gateway, transitGateway or virtualPrivateGateway.

DxGatewayId string

Direct Connect Gateway identifier.

DxGatewayOwnerAccountId string

AWS Account identifier of the Direct Connect Gateway’s owner.

VpnGatewayId string

Deprecated: Use associated_gateway_id instead. Virtual Gateway identifier to associate with the Direct Connect Gateway.

Deprecated: use 'associated_gateway_id' argument instead

AllowedPrefixes []string

VPC prefixes (CIDRs) to advertise to the Direct Connect gateway. Defaults to the CIDR block of the VPC associated with the Virtual Gateway. To enable drift detection, must be configured.

AssociatedGatewayId string

The ID of the VGW or transit gateway with which to associate the Direct Connect gateway.

AssociatedGatewayOwnerAccountId string

The ID of the AWS account that owns the VGW or transit gateway with which to associate the Direct Connect gateway.

AssociatedGatewayType string

The type of the associated gateway, transitGateway or virtualPrivateGateway.

DxGatewayId string

Direct Connect Gateway identifier.

DxGatewayOwnerAccountId string

AWS Account identifier of the Direct Connect Gateway’s owner.

VpnGatewayId string

Deprecated: Use associated_gateway_id instead. Virtual Gateway identifier to associate with the Direct Connect Gateway.

Deprecated: use 'associated_gateway_id' argument instead

allowedPrefixes string[]

VPC prefixes (CIDRs) to advertise to the Direct Connect gateway. Defaults to the CIDR block of the VPC associated with the Virtual Gateway. To enable drift detection, must be configured.

associatedGatewayId string

The ID of the VGW or transit gateway with which to associate the Direct Connect gateway.

associatedGatewayOwnerAccountId string

The ID of the AWS account that owns the VGW or transit gateway with which to associate the Direct Connect gateway.

associatedGatewayType string

The type of the associated gateway, transitGateway or virtualPrivateGateway.

dxGatewayId string

Direct Connect Gateway identifier.

dxGatewayOwnerAccountId string

AWS Account identifier of the Direct Connect Gateway’s owner.

vpnGatewayId string

Deprecated: Use associated_gateway_id instead. Virtual Gateway identifier to associate with the Direct Connect Gateway.

Deprecated: use 'associated_gateway_id' argument instead

allowed_prefixes List[str]

VPC prefixes (CIDRs) to advertise to the Direct Connect gateway. Defaults to the CIDR block of the VPC associated with the Virtual Gateway. To enable drift detection, must be configured.

associated_gateway_id str

The ID of the VGW or transit gateway with which to associate the Direct Connect gateway.

associated_gateway_owner_account_id str