1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. directconnect
  5. DirectConnectGatewayAssociation

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

Viewing docs for AWS Cloud Control v1.57.0
published on Monday, Mar 9, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.directconnect.DirectConnectGatewayAssociation

aws-native logo

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

Viewing docs for AWS Cloud Control v1.57.0
published on Monday, Mar 9, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::DirectConnect::DirectConnectGatewayAssociation

    Create DirectConnectGatewayAssociation Resource

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

    Constructor syntax

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

@overload
def DirectConnectGatewayAssociation(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    associated_gateway_id: Optional[str] = None,
                                    direct_connect_gateway_id: Optional[str] = None,
                                    accept_direct_connect_gateway_association_proposal_role_arn: Optional[str] = None,
                                    allowed_prefixes_to_direct_connect_gateway: Optional[Sequence[str]] = None)
    func NewDirectConnectGatewayAssociation(ctx *Context, name string, args DirectConnectGatewayAssociationArgs, opts ...ResourceOption) (*DirectConnectGatewayAssociation, error)
    public DirectConnectGatewayAssociation(string name, DirectConnectGatewayAssociationArgs args, CustomResourceOptions? opts = null)
    public DirectConnectGatewayAssociation(String name, DirectConnectGatewayAssociationArgs args)
public DirectConnectGatewayAssociation(String name, DirectConnectGatewayAssociationArgs args, CustomResourceOptions options)

    type: aws-native:directconnect:DirectConnectGatewayAssociation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

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

    DirectConnectGatewayAssociation 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 DirectConnectGatewayAssociation resource accepts the following input properties:

    AssociatedGatewayId string
    The ID or ARN of the virtual private gateway or transit gateway.
    DirectConnectGatewayId string
    The ID or ARN of the Direct Connect gateway.
    AcceptDirectConnectGatewayAssociationProposalRoleArn string
    The Amazon Resource Name (ARN) of the role to accept the Direct Connect Gateway association proposal. Needs directconnect:AcceptDirectConnectGatewayAssociationProposal permissions.
    AllowedPrefixesToDirectConnectGateway List<string>
    The Amazon VPC prefixes to advertise to the Direct Connect gateway. This parameter is required when you create an association to a transit gateway.
    AssociatedGatewayId string
    The ID or ARN of the virtual private gateway or transit gateway.
    DirectConnectGatewayId string
    The ID or ARN of the Direct Connect gateway.
    AcceptDirectConnectGatewayAssociationProposalRoleArn string
    The Amazon Resource Name (ARN) of the role to accept the Direct Connect Gateway association proposal. Needs directconnect:AcceptDirectConnectGatewayAssociationProposal permissions.
    AllowedPrefixesToDirectConnectGateway []string
    The Amazon VPC prefixes to advertise to the Direct Connect gateway. This parameter is required when you create an association to a transit gateway.
    associatedGatewayId String
    The ID or ARN of the virtual private gateway or transit gateway.
    directConnectGatewayId String
    The ID or ARN of the Direct Connect gateway.
    acceptDirectConnectGatewayAssociationProposalRoleArn String
    The Amazon Resource Name (ARN) of the role to accept the Direct Connect Gateway association proposal. Needs directconnect:AcceptDirectConnectGatewayAssociationProposal permissions.
    allowedPrefixesToDirectConnectGateway List<String>
    The Amazon VPC prefixes to advertise to the Direct Connect gateway. This parameter is required when you create an association to a transit gateway.
    associatedGatewayId string
    The ID or ARN of the virtual private gateway or transit gateway.
    directConnectGatewayId string
    The ID or ARN of the Direct Connect gateway.
    acceptDirectConnectGatewayAssociationProposalRoleArn string
    The Amazon Resource Name (ARN) of the role to accept the Direct Connect Gateway association proposal. Needs directconnect:AcceptDirectConnectGatewayAssociationProposal permissions.
    allowedPrefixesToDirectConnectGateway string[]
    The Amazon VPC prefixes to advertise to the Direct Connect gateway. This parameter is required when you create an association to a transit gateway.
    associated_gateway_id str
    The ID or ARN of the virtual private gateway or transit gateway.
    direct_connect_gateway_id str
    The ID or ARN of the Direct Connect gateway.
    accept_direct_connect_gateway_association_proposal_role_arn str
    The Amazon Resource Name (ARN) of the role to accept the Direct Connect Gateway association proposal. Needs directconnect:AcceptDirectConnectGatewayAssociationProposal permissions.
    allowed_prefixes_to_direct_connect_gateway Sequence[str]
    The Amazon VPC prefixes to advertise to the Direct Connect gateway. This parameter is required when you create an association to a transit gateway.
    associatedGatewayId String
    The ID or ARN of the virtual private gateway or transit gateway.
    directConnectGatewayId String
    The ID or ARN of the Direct Connect gateway.
    acceptDirectConnectGatewayAssociationProposalRoleArn String
    The Amazon Resource Name (ARN) of the role to accept the Direct Connect Gateway association proposal. Needs directconnect:AcceptDirectConnectGatewayAssociationProposal permissions.
    allowedPrefixesToDirectConnectGateway List<String>
    The Amazon VPC prefixes to advertise to the Direct Connect gateway. This parameter is required when you create an association to a transit gateway.

    Outputs

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

    AssociationId string
    The ID of the Direct Connect gateway association.
    Id string
    The provider-assigned unique ID for this managed resource.
    AssociationId string
    The ID of the Direct Connect gateway association.
    Id string
    The provider-assigned unique ID for this managed resource.
    associationId String
    The ID of the Direct Connect gateway association.
    id String
    The provider-assigned unique ID for this managed resource.
    associationId string
    The ID of the Direct Connect gateway association.
    id string
    The provider-assigned unique ID for this managed resource.
    association_id str
    The ID of the Direct Connect gateway association.
    id str
    The provider-assigned unique ID for this managed resource.
    associationId String
    The ID of the Direct Connect gateway association.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

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

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

    Viewing docs for AWS Cloud Control v1.57.0
    published on Monday, Mar 9, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Try Pulumi Cloud free. Your team will thank you.