We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
Resource Type definition for Carrier Gateway which describes the Carrier Gateway resource
Create CarrierGateway Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CarrierGateway(name: string, args: CarrierGatewayArgs, opts?: CustomResourceOptions);@overload
def CarrierGateway(resource_name: str,
args: CarrierGatewayArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CarrierGateway(resource_name: str,
opts: Optional[ResourceOptions] = None,
vpc_id: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewCarrierGateway(ctx *Context, name string, args CarrierGatewayArgs, opts ...ResourceOption) (*CarrierGateway, error)public CarrierGateway(string name, CarrierGatewayArgs args, CustomResourceOptions? opts = null)
public CarrierGateway(String name, CarrierGatewayArgs args)
public CarrierGateway(String name, CarrierGatewayArgs args, CustomResourceOptions options)
type: aws-native:ec2:CarrierGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_ec2_carrier_gateway" "name" {
# resource properties
}Parameters
- 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.
- name String
- The unique name of the resource.
- args CarrierGatewayArgs
- The arguments to resource properties.
- options 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 Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The CarrierGateway resource accepts the following input properties:
- Vpc
Id string - The ID of the VPC.
-
List<Pulumi.
Aws Native. Inputs. Tag> - The tags for the carrier gateway.
- vpc_
id string - The ID of the VPC.
- list(object)
- The tags for the carrier gateway.
- vpc_
id str - The ID of the VPC.
-
Sequence[Tag
Args] - The tags for the carrier gateway.
- vpc
Id String - The ID of the VPC.
- List<Property Map>
- The tags for the carrier gateway.
Outputs
All input properties are implicitly available as output properties. Additionally, the CarrierGateway resource produces the following output properties:
- Carrier
Gateway stringId - The ID of the carrier gateway.
- Id string
- The provider-assigned unique ID for this managed resource.
- Owner
Id string - The ID of the owner.
- State string
- The state of the carrier gateway.
- Carrier
Gateway stringId - The ID of the carrier gateway.
- Id string
- The provider-assigned unique ID for this managed resource.
- Owner
Id string - The ID of the owner.
- State string
- The state of the carrier gateway.
- carrier_
gateway_ stringid - The ID of the carrier gateway.
- id string
- The provider-assigned unique ID for this managed resource.
- owner_
id string - The ID of the owner.
- state string
- The state of the carrier gateway.
- carrier
Gateway StringId - The ID of the carrier gateway.
- id String
- The provider-assigned unique ID for this managed resource.
- owner
Id String - The ID of the owner.
- state String
- The state of the carrier gateway.
- carrier
Gateway stringId - The ID of the carrier gateway.
- id string
- The provider-assigned unique ID for this managed resource.
- owner
Id string - The ID of the owner.
- state string
- The state of the carrier gateway.
- carrier_
gateway_ strid - The ID of the carrier gateway.
- id str
- The provider-assigned unique ID for this managed resource.
- owner_
id str - The ID of the owner.
- state str
- The state of the carrier gateway.
- carrier
Gateway StringId - The ID of the carrier gateway.
- id String
- The provider-assigned unique ID for this managed resource.
- owner
Id String - The ID of the owner.
- state String
- The state of the carrier gateway.
Look up 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>, opts?: CustomResourceOptions): CarrierGateway@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> CarrierGatewayfunc GetCarrierGateway(ctx *Context, name string, id IDInput, state *CarrierGatewayState, opts ...ResourceOption) (*CarrierGateway, error)public static CarrierGateway Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static CarrierGateway get(String name, Output<String> id, CustomResourceOptions options)resources: existingCarrierGateway: type: aws-native:ec2:CarrierGateway get: id: ${id}import {
to = aws-native_ec2_carrier_gateway.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state CarrierGatewayState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
Tag, TagArgs
A set of tags to apply to the resource.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi