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 schema for AWS ECS Gateway
Create Gateway Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);@overload
def Gateway(resource_name: str,
args: GatewayArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Gateway(resource_name: str,
opts: Optional[ResourceOptions] = None,
configuration: Optional[GatewayConfigurationArgs] = None,
infrastructure_role_arn: Optional[str] = None,
deletion_protection: Optional[bool] = None,
gateway_name: Optional[str] = None,
propagate_tags: Optional[GatewayPropagateGatewayTags] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
public Gateway(String name, GatewayArgs args)
public Gateway(String name, GatewayArgs args, CustomResourceOptions options)
type: aws-native:ecs:Gateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_ecs_gateway" "name" {
# resource properties
}Parameters
- 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.
- args GatewayArgs
- 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 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.
- name String
- The unique name of the resource.
- args GatewayArgs
- The arguments to resource properties.
- options 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 Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Gateway resource accepts the following input properties:
- Configuration
Pulumi.
Aws Native. Ecs. Inputs. Gateway Configuration - The configuration for the gateway.
- Infrastructure
Role stringArn - The ARN of the IAM role that ECS uses to manage infrastructure for the gateway.
- Deletion
Protection bool - Whether deletion protection is enabled for the gateway.
- Gateway
Name string - The name of the gateway. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.
-
Pulumi.
Aws Native. Ecs. Gateway Propagate Gateway Tags - Specifies whether to propagate the tags from the gateway to other resources.
-
List<Pulumi.
Aws Native. Inputs. Tag> - The metadata that you apply to the gateway to help you categorize and organize them.
- Configuration
Gateway
Configuration Args - The configuration for the gateway.
- Infrastructure
Role stringArn - The ARN of the IAM role that ECS uses to manage infrastructure for the gateway.
- Deletion
Protection bool - Whether deletion protection is enabled for the gateway.
- Gateway
Name string - The name of the gateway. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.
-
Gateway
Propagate Gateway Tags - Specifies whether to propagate the tags from the gateway to other resources.
-
Tag
Args - The metadata that you apply to the gateway to help you categorize and organize them.
- configuration object
- The configuration for the gateway.
- infrastructure_
role_ stringarn - The ARN of the IAM role that ECS uses to manage infrastructure for the gateway.
- deletion_
protection bool - Whether deletion protection is enabled for the gateway.
- gateway_
name string - The name of the gateway. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.
- "NONE" | "GATEWAY"
- Specifies whether to propagate the tags from the gateway to other resources.
- list(object)
- The metadata that you apply to the gateway to help you categorize and organize them.
- configuration
Gateway
Configuration - The configuration for the gateway.
- infrastructure
Role StringArn - The ARN of the IAM role that ECS uses to manage infrastructure for the gateway.
- deletion
Protection Boolean - Whether deletion protection is enabled for the gateway.
- gateway
Name String - The name of the gateway. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.
-
Gateway
Propagate Gateway Tags - Specifies whether to propagate the tags from the gateway to other resources.
- List<Tag>
- The metadata that you apply to the gateway to help you categorize and organize them.
- configuration
Gateway
Configuration - The configuration for the gateway.
- infrastructure
Role stringArn - The ARN of the IAM role that ECS uses to manage infrastructure for the gateway.
- deletion
Protection boolean - Whether deletion protection is enabled for the gateway.
- gateway
Name string - The name of the gateway. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.
-
Gateway
Propagate Gateway Tags - Specifies whether to propagate the tags from the gateway to other resources.
- Tag[]
- The metadata that you apply to the gateway to help you categorize and organize them.
- configuration
Gateway
Configuration Args - The configuration for the gateway.
- infrastructure_
role_ strarn - The ARN of the IAM role that ECS uses to manage infrastructure for the gateway.
- deletion_
protection bool - Whether deletion protection is enabled for the gateway.
- gateway_
name str - The name of the gateway. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.
-
Gateway
Propagate Gateway Tags - Specifies whether to propagate the tags from the gateway to other resources.
-
Sequence[Tag
Args] - The metadata that you apply to the gateway to help you categorize and organize them.
- configuration Property Map
- The configuration for the gateway.
- infrastructure
Role StringArn - The ARN of the IAM role that ECS uses to manage infrastructure for the gateway.
- deletion
Protection Boolean - Whether deletion protection is enabled for the gateway.
- gateway
Name String - The name of the gateway. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.
- "NONE" | "GATEWAY"
- Specifies whether to propagate the tags from the gateway to other resources.
- List<Property Map>
- The metadata that you apply to the gateway to help you categorize and organize them.
Outputs
All input properties are implicitly available as output properties. Additionally, the Gateway resource produces the following output properties:
- Access
Type Pulumi.Aws Native. Ecs. Gateway Access Type - The access type of the gateway.
- Arn string
- The Amazon Resource Name (ARN) of the gateway.
- Created
At string - The timestamp when the gateway was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Pulumi.
Aws Native. Ecs. Gateway Status - The status of the gateway.
- Updated
At string - The timestamp when the gateway was last updated.
- Access
Type GatewayAccess Type - The access type of the gateway.
- Arn string
- The Amazon Resource Name (ARN) of the gateway.
- Created
At string - The timestamp when the gateway was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Gateway
Status - The status of the gateway.
- Updated
At string - The timestamp when the gateway was last updated.
- access_
type "PUBLIC" | "PRIVATE" - The access type of the gateway.
- arn string
- The Amazon Resource Name (ARN) of the gateway.
- created_
at string - The timestamp when the gateway was created.
- id string
- The provider-assigned unique ID for this managed resource.
- status "ACTIVE" | "UPDATE_IN_PROGRESS" | "UPDATE_COMPLETE" | "UPDATE_FAILED" | "DELETED"
- The status of the gateway.
- updated_
at string - The timestamp when the gateway was last updated.
- access
Type GatewayAccess Type - The access type of the gateway.
- arn String
- The Amazon Resource Name (ARN) of the gateway.
- created
At String - The timestamp when the gateway was created.
- id String
- The provider-assigned unique ID for this managed resource.
- status
Gateway
Status - The status of the gateway.
- updated
At String - The timestamp when the gateway was last updated.
- access
Type GatewayAccess Type - The access type of the gateway.
- arn string
- The Amazon Resource Name (ARN) of the gateway.
- created
At string - The timestamp when the gateway was created.
- id string
- The provider-assigned unique ID for this managed resource.
- status
Gateway
Status - The status of the gateway.
- updated
At string - The timestamp when the gateway was last updated.
- access_
type GatewayAccess Type - The access type of the gateway.
- arn str
- The Amazon Resource Name (ARN) of the gateway.
- created_
at str - The timestamp when the gateway was created.
- id str
- The provider-assigned unique ID for this managed resource.
- status
Gateway
Status - The status of the gateway.
- updated_
at str - The timestamp when the gateway was last updated.
- access
Type "PUBLIC" | "PRIVATE" - The access type of the gateway.
- arn String
- The Amazon Resource Name (ARN) of the gateway.
- created
At String - The timestamp when the gateway was created.
- id String
- The provider-assigned unique ID for this managed resource.
- status "ACTIVE" | "UPDATE_IN_PROGRESS" | "UPDATE_COMPLETE" | "UPDATE_FAILED" | "DELETED"
- The status of the gateway.
- updated
At String - The timestamp when the gateway was last updated.
Look up 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>, opts?: CustomResourceOptions): Gateway@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> Gatewayfunc GetGateway(ctx *Context, name string, id IDInput, state *GatewayState, opts ...ResourceOption) (*Gateway, error)public static Gateway Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static Gateway get(String name, Output<String> id, CustomResourceOptions options)resources: existingGateway: type: aws-native:ecs:Gateway get: id: ${id}import {
to = aws-native_ecs_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 GatewayState
- 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
GatewayAccessType
The access type for the gateway.
| Name | Value |
|---|---|
| Public | PUBLIC |
| Private | PRIVATE |
| Name | Value |
|---|---|
| Gateway | PUBLIC |
| Gateway | PRIVATE |
| Value |
|---|
PUBLIC |
PRIVATE |
| Name | Value |
|---|---|
| Public | PUBLIC |
| Private | PRIVATE |
| Name | Value |
|---|---|
| Public | PUBLIC |
| Private | PRIVATE |
| Name | Value |
|---|---|
| PUBLIC | PUBLIC |
| PRIVATE | PRIVATE |
| Value |
|---|
PUBLIC |
PRIVATE |
GatewayAlbDesyncMitigationMode
The HTTP desync mitigation mode for the ALB.
| Name | Value |
|---|---|
| Monitor | monitor |
| Defensive | defensive |
| Strictest | strictest |
| Name | Value |
|---|---|
| Gateway | monitor |
| Gateway | defensive |
| Gateway | strictest |
| Value |
|---|
monitor |
defensive |
strictest |
| Name | Value |
|---|---|
| Monitor | monitor |
| Defensive | defensive |
| Strictest | strictest |
| Name | Value |
|---|---|
| Monitor | monitor |
| Defensive | defensive |
| Strictest | strictest |
| Name | Value |
|---|---|
| MONITOR | monitor |
| DEFENSIVE | defensive |
| STRICTEST | strictest |
| Value |
|---|
monitor |
defensive |
strictest |
GatewayAlbProtocol
The protocol for the ALB listener.
| Name | Value |
|---|---|
| Http | HTTP |
| Https | HTTPS |
| Name | Value |
|---|---|
| Gateway | HTTP |
| Gateway | HTTPS |
| Value |
|---|
HTTP |
HTTPS |
| Name | Value |
|---|---|
| Http | HTTP |
| Https | HTTPS |
| Name | Value |
|---|---|
| Http | HTTP |
| Https | HTTPS |
| Name | Value |
|---|---|
| HTTP | HTTP |
| HTTPS | HTTPS |
| Value |
|---|
HTTP |
HTTPS |
GatewayAlbTestTrafficRules, GatewayAlbTestTrafficRulesArgs
The test traffic rules for the gateway ALB.
GatewayConfiguration, GatewayConfigurationArgs
The configuration for the gateway. Currently only supports hostSharedAlb.
GatewayElbAccessLogConfiguration, GatewayElbAccessLogConfigurationArgs
The access log configuration for the gateway ALB. Access logging is enabled by the presence of a destination.
GatewayElbAccessLogDestination, GatewayElbAccessLogDestinationArgs
The destination for gateway ALB access logs. Exactly one destination type must be specified.
GatewayElbAccessLogS3Destination, GatewayElbAccessLogS3DestinationArgs
The S3 destination for gateway ALB access logs.
GatewayElbIpAddressType
The IP address type for the ALB.
| Name | Value |
|---|---|
| Ipv4 | ipv4 |
| Dualstack | dualstack |
| Dualstack | dualstack-without-public-ipv4 |
| Name | Value |
|---|---|
| Gateway | ipv4 |
| Gateway | dualstack |
| Gateway | dualstack-without-public-ipv4 |
| Value |
|---|
ipv4 |
dualstack |
dualstack-without-public-ipv4 |
| Name | Value |
|---|---|
| Ipv4 | ipv4 |
| Dualstack | dualstack |
| Dualstack | dualstack-without-public-ipv4 |
| Name | Value |
|---|---|
| Ipv4 | ipv4 |
| Dualstack | dualstack |
| Dualstack | dualstack-without-public-ipv4 |
| Name | Value |
|---|---|
| IPV4 | ipv4 |
| DUALSTACK | dualstack |
| DUALSTACK_WITHOUT_PUBLIC_IPV4 | dualstack-without-public-ipv4 |
| Value |
|---|
ipv4 |
dualstack |
dualstack-without-public-ipv4 |
GatewayElbNetworkConfiguration, GatewayElbNetworkConfigurationArgs
The network configuration for the gateway ALB.
- Inbound
Security stringGroup - The inbound security group for the ALB.
- Ip
Address Pulumi.Type Aws Native. Ecs. Gateway Elb Ip Address Type - Subnets List<string>
- The subnets for the ALB.
- Inbound
Security stringGroup - The inbound security group for the ALB.
- Ip
Address GatewayType Elb Ip Address Type - Subnets []string
- The subnets for the ALB.
- inbound_
security_ stringgroup - The inbound security group for the ALB.
- ip_
address_ "ipv4" | "dualstack" | "dualstack-without-public-ipv4"type - subnets list(string)
- The subnets for the ALB.
- inbound
Security StringGroup - The inbound security group for the ALB.
- ip
Address GatewayType Elb Ip Address Type - subnets List<String>
- The subnets for the ALB.
- inbound
Security stringGroup - The inbound security group for the ALB.
- ip
Address GatewayType Elb Ip Address Type - subnets string[]
- The subnets for the ALB.
- inbound_
security_ strgroup - The inbound security group for the ALB.
- ip_
address_ Gatewaytype Elb Ip Address Type - subnets Sequence[str]
- The subnets for the ALB.
- inbound
Security StringGroup - The inbound security group for the ALB.
- ip
Address "ipv4" | "dualstack" | "dualstack-without-public-ipv4"Type - subnets List<String>
- The subnets for the ALB.
GatewayElbScheme
The scheme for the ALB.
| Name | Value |
|---|---|
| Internet | internet-facing |
| Internal | internal |
| Name | Value |
|---|---|
| Gateway | internet-facing |
| Gateway | internal |
| Value |
|---|
internet-facing |
internal |
| Name | Value |
|---|---|
| Internet | internet-facing |
| Internal | internal |
| Name | Value |
|---|---|
| Internet | internet-facing |
| Internal | internal |
| Name | Value |
|---|---|
| INTERNET_FACING | internet-facing |
| INTERNAL | internal |
| Value |
|---|
internet-facing |
internal |
GatewayHostSharedAlbConfiguration, GatewayHostSharedAlbConfigurationArgs
The host shared ALB configuration for the gateway.
- Access
Logs Pulumi.Aws Native. Ecs. Inputs. Gateway Elb Access Log Configuration - Current
Alb intCount - The current number of ALBs provisioned for the gateway.
- Http
Desync Pulumi.Aws Native. Ecs. Gateway Alb Desync Mitigation Mode - Max
Alb intCount - The maximum number of ALBs to provision for the gateway.
- Network
Configuration Pulumi.Aws Native. Ecs. Inputs. Gateway Elb Network Configuration - Port int
- The port on which the ALB listens.
- Protocol
Pulumi.
Aws Native. Ecs. Gateway Alb Protocol - Scheme
Pulumi.
Aws Native. Ecs. Gateway Elb Scheme - Test
Traffic Pulumi.Rules Aws Native. Ecs. Inputs. Gateway Alb Test Traffic Rules - Web
Acl stringArn - The ARN of the WAFv2 web ACL to associate with the ALB.
- Access
Logs GatewayElb Access Log Configuration - Current
Alb intCount - The current number of ALBs provisioned for the gateway.
- Http
Desync GatewayAlb Desync Mitigation Mode - Max
Alb intCount - The maximum number of ALBs to provision for the gateway.
- Network
Configuration GatewayElb Network Configuration - Port int
- The port on which the ALB listens.
- Protocol
Gateway
Alb Protocol - Scheme
Gateway
Elb Scheme - Test
Traffic GatewayRules Alb Test Traffic Rules - Web
Acl stringArn - The ARN of the WAFv2 web ACL to associate with the ALB.
- access_
logs object - current_
alb_ numbercount - The current number of ALBs provisioned for the gateway.
- http_
desync "monitor" | "defensive" | "strictest" - max_
alb_ numbercount - The maximum number of ALBs to provision for the gateway.
- network_
configuration object - port number
- The port on which the ALB listens.
- protocol "HTTP" | "HTTPS"
- scheme "internet-facing" | "internal"
- test_
traffic_ objectrules - web_
acl_ stringarn - The ARN of the WAFv2 web ACL to associate with the ALB.
- access
Logs GatewayElb Access Log Configuration - current
Alb IntegerCount - The current number of ALBs provisioned for the gateway.
- http
Desync GatewayAlb Desync Mitigation Mode - max
Alb IntegerCount - The maximum number of ALBs to provision for the gateway.
- network
Configuration GatewayElb Network Configuration - port Integer
- The port on which the ALB listens.
- protocol
Gateway
Alb Protocol - scheme
Gateway
Elb Scheme - test
Traffic GatewayRules Alb Test Traffic Rules - web
Acl StringArn - The ARN of the WAFv2 web ACL to associate with the ALB.
- access
Logs GatewayElb Access Log Configuration - current
Alb numberCount - The current number of ALBs provisioned for the gateway.
- http
Desync GatewayAlb Desync Mitigation Mode - max
Alb numberCount - The maximum number of ALBs to provision for the gateway.
- network
Configuration GatewayElb Network Configuration - port number
- The port on which the ALB listens.
- protocol
Gateway
Alb Protocol - scheme
Gateway
Elb Scheme - test
Traffic GatewayRules Alb Test Traffic Rules - web
Acl stringArn - The ARN of the WAFv2 web ACL to associate with the ALB.
- access_
logs GatewayElb Access Log Configuration - current_
alb_ intcount - The current number of ALBs provisioned for the gateway.
- http_
desync GatewayAlb Desync Mitigation Mode - max_
alb_ intcount - The maximum number of ALBs to provision for the gateway.
- network_
configuration GatewayElb Network Configuration - port int
- The port on which the ALB listens.
- protocol
Gateway
Alb Protocol - scheme
Gateway
Elb Scheme - test_
traffic_ Gatewayrules Alb Test Traffic Rules - web_
acl_ strarn - The ARN of the WAFv2 web ACL to associate with the ALB.
- access
Logs Property Map - current
Alb NumberCount - The current number of ALBs provisioned for the gateway.
- http
Desync "monitor" | "defensive" | "strictest" - max
Alb NumberCount - The maximum number of ALBs to provision for the gateway.
- network
Configuration Property Map - port Number
- The port on which the ALB listens.
- protocol "HTTP" | "HTTPS"
- scheme "internet-facing" | "internal"
- test
Traffic Property MapRules - web
Acl StringArn - The ARN of the WAFv2 web ACL to associate with the ALB.
GatewayPropagateGatewayTags
Specifies whether to propagate the tags from the gateway to other resources.
| Name | Value |
|---|---|
| None | NONE |
| Gateway | GATEWAY |
| Name | Value |
|---|---|
| Gateway | NONE |
| Gateway | GATEWAY |
| Value |
|---|
NONE |
GATEWAY |
| Name | Value |
|---|---|
| None | NONE |
| Gateway | GATEWAY |
| Name | Value |
|---|---|
| None | NONE |
| Gateway | GATEWAY |
| Name | Value |
|---|---|
| NONE | NONE |
| GATEWAY | GATEWAY |
| Value |
|---|
NONE |
GATEWAY |
GatewayStatus
The status of the gateway.
| Name | Value |
|---|---|
| Active | ACTIVE |
| Update | UPDATE_IN_PROGRESS |
| Update | UPDATE_COMPLETE |
| Update | UPDATE_FAILED |
| Deleted | DELETED |
| Name | Value |
|---|---|
| Gateway | ACTIVE |
| Gateway | UPDATE_IN_PROGRESS |
| Gateway | UPDATE_COMPLETE |
| Gateway | UPDATE_FAILED |
| Gateway | DELETED |
| Value |
|---|
ACTIVE |
UPDATE_IN_PROGRESS |
UPDATE_COMPLETE |
UPDATE_FAILED |
DELETED |
| Name | Value |
|---|---|
| Active | ACTIVE |
| Update | UPDATE_IN_PROGRESS |
| Update | UPDATE_COMPLETE |
| Update | UPDATE_FAILED |
| Deleted | DELETED |
| Name | Value |
|---|---|
| Active | ACTIVE |
| Update | UPDATE_IN_PROGRESS |
| Update | UPDATE_COMPLETE |
| Update | UPDATE_FAILED |
| Deleted | DELETED |
| Name | Value |
|---|---|
| ACTIVE | ACTIVE |
| UPDATE_IN_PROGRESS | UPDATE_IN_PROGRESS |
| UPDATE_COMPLETE | UPDATE_COMPLETE |
| UPDATE_FAILED | UPDATE_FAILED |
| DELETED | DELETED |
| Value |
|---|
ACTIVE |
UPDATE_IN_PROGRESS |
UPDATE_COMPLETE |
UPDATE_FAILED |
DELETED |
GatewayTestTrafficHeader, GatewayTestTrafficHeaderArgs
The header configuration for test traffic routing.
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