1. Docs
  2. Reference
  3. API
  4. AWS
  5. directconnect
  6. Gateway

Gateway

Provides a Direct Connect Gateway.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.DirectConnect.Gateway("example", new Aws.DirectConnect.GatewayArgs
        {
            AmazonSideAsn = "64512",
        });
    }

}

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.NewGateway(ctx, "example", &directconnect.GatewayArgs{
            AmazonSideAsn: pulumi.String("64512"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aws as aws

example = aws.directconnect.Gateway("example", amazon_side_asn="64512")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.directconnect.Gateway("example", {
    amazonSideAsn: "64512",
});

Create a Gateway Resource

new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);
def Gateway(resource_name, opts=None, amazon_side_asn=None, name=None, __props__=None);
func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)
public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args GatewayArgs
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 GatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Gateway Resource Properties

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

Inputs

The Gateway resource accepts the following input properties:

AmazonSideAsn string

The ASN to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294.

Name string

The name of the connection.

AmazonSideAsn string

The ASN to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294.

Name string

The name of the connection.

amazonSideAsn string

The ASN to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294.

name string

The name of the connection.

amazon_side_asn str

The ASN to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294.

name str

The name of the connection.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
OwnerAccountId string

AWS Account ID of the gateway.

Id string
The provider-assigned unique ID for this managed resource.
OwnerAccountId string

AWS Account ID of the gateway.

id string
The provider-assigned unique ID for this managed resource.
ownerAccountId string

AWS Account ID of the gateway.

id str
The provider-assigned unique ID for this managed resource.
owner_account_id str

AWS Account ID of the gateway.

Look up an Existing Gateway Resource

Get an existing Gateway 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?: GatewayState, opts?: CustomResourceOptions): Gateway
static get(resource_name, id, opts=None, amazon_side_asn=None, name=None, owner_account_id=None, __props__=None);
func GetGateway(ctx *Context, name string, id IDInput, state *GatewayState, opts ...ResourceOption) (*Gateway, error)
public static Gateway Get(string name, Input<string> id, GatewayState? 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:

AmazonSideAsn string

The ASN to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294.

Name string

The name of the connection.

OwnerAccountId string

AWS Account ID of the gateway.

AmazonSideAsn string

The ASN to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294.

Name string

The name of the connection.

OwnerAccountId string

AWS Account ID of the gateway.

amazonSideAsn string

The ASN to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294.

name string

The name of the connection.

ownerAccountId string

AWS Account ID of the gateway.

amazon_side_asn str

The ASN to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294.

name str

The name of the connection.

owner_account_id str

AWS Account ID of the gateway.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.