CarrierGateway class

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

Example Usage

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

const example = new aws.ec2.CarrierGateway("example", {
    vpcId: exampleAwsVpc.id,
    tags: {
        Name: "example-carrier-gateway",
    },
});
import pulumi
import pulumi_aws as aws

example = aws.ec2.CarrierGateway("example",
    vpc_id=example_aws_vpc["id"],
    tags={
        "Name": "example-carrier-gateway",
    })
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Ec2.CarrierGateway("example", new()
    {
        VpcId = exampleAwsVpc.Id,
        Tags =
        {
            { "Name", "example-carrier-gateway" },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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(exampleAwsVpc.Id),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example-carrier-gateway"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ec2_carriergateway" "example" {
  vpc_id = exampleAwsVpc.id
  tags = {
    "Name" = "example-carrier-gateway"
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.CarrierGateway;
import com.pulumi.aws.ec2.CarrierGatewayArgs;
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 CarrierGateway("example", CarrierGatewayArgs.builder()
            .vpcId(exampleAwsVpc.id())
            .tags(Map.of("Name", "example-carrier-gateway"))
            .build());

    }
}
resources:
  example:
    type: aws:ec2:CarrierGateway
    properties:
      vpcId: ${exampleAwsVpc.id}
      tags:
        Name: example-carrier-gateway

Import

Using pulumi import, import aws.ec2.CarrierGateway using the carrier gateway's ID. For example:

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

Constructors

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

Properties

arn ↔ Output<String>
The ARN of the carrier gateway.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
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
ownerId ↔ Output<String>
The AWS account ID of the owner of the carrier gateway.
latefinal
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
tags ↔ Output<Map<String, String>?>
A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
vpcId ↔ Output<String>
The ID of the VPC to associate with the carrier gateway.
latefinal

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, {CarrierGatewayState? state, CustomResourceOptions? options}) → CarrierGateway
Gets an existing CarrierGateway resource's state with the given name and id.