GatewayAssociationProposal class

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

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

const example = new aws.directconnect.GatewayAssociationProposal("example", {
    dxGatewayId: exampleAwsDxGateway.id,
    dxGatewayOwnerAccountId: exampleAwsDxGateway.ownerAccountId,
    associatedGatewayId: exampleAwsVpnGateway.id,
});
import pulumi
import pulumi_aws as aws

example = aws.directconnect.GatewayAssociationProposal("example",
    dx_gateway_id=example_aws_dx_gateway["id"],
    dx_gateway_owner_account_id=example_aws_dx_gateway["ownerAccountId"],
    associated_gateway_id=example_aws_vpn_gateway["id"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.DirectConnect.GatewayAssociationProposal("example", new()
    {
        DxGatewayId = exampleAwsDxGateway.Id,
        DxGatewayOwnerAccountId = exampleAwsDxGateway.OwnerAccountId,
        AssociatedGatewayId = exampleAwsVpnGateway.Id,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := directconnect.NewGatewayAssociationProposal(ctx, "example", &directconnect.GatewayAssociationProposalArgs{
			DxGatewayId:             pulumi.Any(exampleAwsDxGateway.Id),
			DxGatewayOwnerAccountId: pulumi.Any(exampleAwsDxGateway.OwnerAccountId),
			AssociatedGatewayId:     pulumi.Any(exampleAwsVpnGateway.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_directconnect_gatewayassociationproposal" "example" {
  dx_gateway_id               = exampleAwsDxGateway.id
  dx_gateway_owner_account_id = exampleAwsDxGateway.ownerAccountId
  associated_gateway_id       = exampleAwsVpnGateway.id
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.directconnect.GatewayAssociationProposal;
import com.pulumi.aws.directconnect.GatewayAssociationProposalArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new GatewayAssociationProposal("example", GatewayAssociationProposalArgs.builder()
            .dxGatewayId(exampleAwsDxGateway.id())
            .dxGatewayOwnerAccountId(exampleAwsDxGateway.ownerAccountId())
            .associatedGatewayId(exampleAwsVpnGateway.id())
            .build());

    }
}
resources:
  example:
    type: aws:directconnect:GatewayAssociationProposal
    properties:
      dxGatewayId: ${exampleAwsDxGateway.id}
      dxGatewayOwnerAccountId: ${exampleAwsDxGateway.ownerAccountId}
      associatedGatewayId: ${exampleAwsVpnGateway.id}

Import

Using a proposal ID, Direct Connect Gateway ID and associated gateway ID separated by /:

With pulumi import, import Direct Connect Gateway Association Proposals using either a proposal ID or proposal ID, Direct Connect Gateway ID and associated gateway ID separated by /. For example:

Using a proposal ID:

$ pulumi import aws:directconnect/gatewayAssociationProposal:GatewayAssociationProposal example ac90e981-b718-4364-872d-65478c84fafe

Using a proposal ID, Direct Connect Gateway ID and associated gateway ID separated by /:

$ pulumi import aws:directconnect/gatewayAssociationProposal:GatewayAssociationProposal example ac90e981-b718-4364-872d-65478c84fafe/abcd1234-dcba-5678-be23-cdef9876ab45/vgw-12345678

The latter case is useful when a previous proposal has been accepted and deleted by AWS. The aws.directconnect.GatewayAssociationProposal resource will then represent a pseudo-proposal for the same Direct Connect Gateway and associated gateway. If no previous proposal is available, use a tool like uuidgen to generate a new random pseudo-proposal ID.

Constructors

GatewayAssociationProposal(String name, {GatewayAssociationProposalArgs? args, CustomResourceOptions? options})
Creates a new GatewayAssociationProposal. name The Pulumi resource name. args Arguments used to configure this GatewayAssociationProposal. The set of arguments for GatewayAssociationProposal. options Resource options controlling this resource's behavior.
GatewayAssociationProposal.reference(String urn)
Creates a typed reference to an existing GatewayAssociationProposal resource.

Properties

allowedPrefixes ↔ Output<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.
latefinal
associatedGatewayId ↔ Output<String>
The ID of the VGW or transit gateway with which to associate the Direct Connect gateway.
latefinal
associatedGatewayOwnerAccountId ↔ Output<String>
The ID of the AWS account that owns the VGW or transit gateway with which to associate the Direct Connect gateway.
latefinal
associatedGatewayType ↔ Output<String>
The type of the associated gateway, transitGateway or virtualPrivateGateway.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
dxGatewayId ↔ Output<String>
Direct Connect Gateway identifier.
latefinal
dxGatewayOwnerAccountId ↔ Output<String>
AWS Account identifier of the Direct Connect Gateway's owner.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {GatewayAssociationProposalState? state, CustomResourceOptions? options}) → GatewayAssociationProposal
Gets an existing GatewayAssociationProposal resource's state with the given name and id.