CarrierGateway

Manages an EC2 Carrier Gateway. See the AWS documentation for more information.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Ec2.CarrierGateway("example", new Aws.Ec2.CarrierGatewayArgs
        {
            VpcId = aws_vpc.Example.Id,
            Tags = 
            {
                { "Name", "example-carrier-gateway" },
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewCarrierGateway(ctx, "example", &ec2.CarrierGatewayArgs{
			VpcId: pulumi.Any(aws_vpc.Example.Id),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example-carrier-gateway"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_aws as aws

example = aws.ec2.CarrierGateway("example",
    vpc_id=aws_vpc["example"]["id"],
    tags={
        "Name": "example-carrier-gateway",
    })
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ec2.CarrierGateway("example", {
    vpcId: aws_vpc.example.id,
    tags: {
        Name: "example-carrier-gateway",
    },
});

Create a CarrierGateway Resource

new CarrierGateway(name: string, args: CarrierGatewayArgs, opts?: CustomResourceOptions);
@overload
def CarrierGateway(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   tags_all: Optional[Mapping[str, str]] = None,
                   vpc_id: Optional[str] = None)
@overload
def CarrierGateway(resource_name: str,
                   args: CarrierGatewayArgs,
                   opts: Optional[ResourceOptions] = None)
func NewCarrierGateway(ctx *Context, name string, args CarrierGatewayArgs, opts ...ResourceOption) (*CarrierGateway, error)
public CarrierGateway(string name, CarrierGatewayArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args CarrierGatewayArgs
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 CarrierGatewayArgs
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 CarrierGatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CarrierGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

CarrierGateway Resource Properties

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

Inputs

The CarrierGateway resource accepts the following input properties:

VpcId string
The ID of the VPC to associate with the carrier gateway.
Tags Dictionary<string, string>
TagsAll Dictionary<string, string>
VpcId string
The ID of the VPC to associate with the carrier gateway.
Tags map[string]string
TagsAll map[string]string
vpcId string
The ID of the VPC to associate with the carrier gateway.
tags {[key: string]: string}
tagsAll {[key: string]: string}
vpc_id str
The ID of the VPC to associate with the carrier gateway.
tags Mapping[str, str]
tags_all Mapping[str, str]

Outputs

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

Arn string
The ARN of the carrier gateway.
Id string
The provider-assigned unique ID for this managed resource.
OwnerId string
The AWS account ID of the owner of the carrier gateway.
Arn string
The ARN of the carrier gateway.
Id string
The provider-assigned unique ID for this managed resource.
OwnerId string
The AWS account ID of the owner of the carrier gateway.
arn string
The ARN of the carrier gateway.
id string
The provider-assigned unique ID for this managed resource.
ownerId string
The AWS account ID of the owner of the carrier gateway.
arn str
The ARN of the carrier gateway.
id str
The provider-assigned unique ID for this managed resource.
owner_id str
The AWS account ID of the owner of the carrier gateway.

Look up an Existing CarrierGateway Resource

Get an existing CarrierGateway 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?: CarrierGatewayState, opts?: CustomResourceOptions): CarrierGateway
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        owner_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc_id: Optional[str] = None) -> CarrierGateway
func GetCarrierGateway(ctx *Context, name string, id IDInput, state *CarrierGatewayState, opts ...ResourceOption) (*CarrierGateway, error)
public static CarrierGateway Get(string name, Input<string> id, CarrierGatewayState? 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:

Arn string
The ARN of the carrier gateway.
OwnerId string
The AWS account ID of the owner of the carrier gateway.
Tags Dictionary<string, string>
TagsAll Dictionary<string, string>
VpcId string
The ID of the VPC to associate with the carrier gateway.
Arn string
The ARN of the carrier gateway.
OwnerId string
The AWS account ID of the owner of the carrier gateway.
Tags map[string]string
TagsAll map[string]string
VpcId string
The ID of the VPC to associate with the carrier gateway.
arn string
The ARN of the carrier gateway.
ownerId string
The AWS account ID of the owner of the carrier gateway.
tags {[key: string]: string}
tagsAll {[key: string]: string}
vpcId string
The ID of the VPC to associate with the carrier gateway.
arn str
The ARN of the carrier gateway.
owner_id str
The AWS account ID of the owner of the carrier gateway.
tags Mapping[str, str]
tags_all Mapping[str, str]
vpc_id str
The ID of the VPC to associate with the carrier gateway.

Import

aws_ec2_carrier_gateway can be imported using the carrier gateway’s ID, e.g.

 $ pulumi import aws:ec2/carrierGateway:CarrierGateway example cgw-12345

Package Details

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