1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. ecs
  6. getGateway

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi

    Resource schema for AWS ECS Gateway

    Using getGateway

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGateway(args: GetGatewayArgs, opts?: InvokeOptions): Promise<GetGatewayResult>
    function getGatewayOutput(args: GetGatewayOutputArgs, opts?: InvokeOutputOptions): Output<GetGatewayResult>
    def get_gateway(arn: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetGatewayResult
    def get_gateway_output(arn: pulumi.Input[Optional[str]] = None,
                    opts: Optional[InvokeOutputOptions] = None) -> Output[GetGatewayResult]
    func LookupGateway(ctx *Context, args *LookupGatewayArgs, opts ...InvokeOption) (*LookupGatewayResult, error)
    func LookupGatewayOutput(ctx *Context, args *LookupGatewayOutputArgs, opts ...InvokeOption) LookupGatewayResultOutput

    > Note: This function is named LookupGateway in the Go SDK.

    public static class GetGateway 
    {
        public static Task<GetGatewayResult> InvokeAsync(GetGatewayArgs args, InvokeOptions? opts = null)
        public static Output<GetGatewayResult> Invoke(GetGatewayInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetGatewayResult> Invoke(GetGatewayInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)
    public static Output<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)
    public static Output<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: aws-native:ecs:getGateway
      arguments:
        # arguments dictionary
    data "aws-native_ecs_get_gateway" "name" {
        # arguments
    }

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the gateway.
    Arn string
    The Amazon Resource Name (ARN) of the gateway.
    arn string
    The Amazon Resource Name (ARN) of the gateway.
    arn String
    The Amazon Resource Name (ARN) of the gateway.
    arn string
    The Amazon Resource Name (ARN) of the gateway.
    arn str
    The Amazon Resource Name (ARN) of the gateway.
    arn String
    The Amazon Resource Name (ARN) of the gateway.

    getGateway Result

    The following output properties are available:

    AccessType Pulumi.AwsNative.Ecs.GatewayAccessType
    The access type of the gateway.
    Arn string
    The Amazon Resource Name (ARN) of the gateway.
    Configuration Pulumi.AwsNative.Ecs.Outputs.GatewayConfiguration
    The configuration for the gateway.
    CreatedAt string
    The timestamp when the gateway was created.
    DeletionProtection bool
    Whether deletion protection is enabled for the gateway.
    InfrastructureRoleArn string
    The ARN of the IAM role that ECS uses to manage infrastructure for the gateway.
    PropagateTags Pulumi.AwsNative.Ecs.GatewayPropagateGatewayTags
    Specifies whether to propagate the tags from the gateway to other resources.
    Status Pulumi.AwsNative.Ecs.GatewayStatus
    The status of the gateway.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The metadata that you apply to the gateway to help you categorize and organize them.
    UpdatedAt string
    The timestamp when the gateway was last updated.
    AccessType GatewayAccessType
    The access type of the gateway.
    Arn string
    The Amazon Resource Name (ARN) of the gateway.
    Configuration GatewayConfiguration
    The configuration for the gateway.
    CreatedAt string
    The timestamp when the gateway was created.
    DeletionProtection bool
    Whether deletion protection is enabled for the gateway.
    InfrastructureRoleArn string
    The ARN of the IAM role that ECS uses to manage infrastructure for the gateway.
    PropagateTags GatewayPropagateGatewayTags
    Specifies whether to propagate the tags from the gateway to other resources.
    Status GatewayStatus
    The status of the gateway.
    Tags Tag
    The metadata that you apply to the gateway to help you categorize and organize them.
    UpdatedAt 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.
    configuration object
    The configuration for the gateway.
    created_at string
    The timestamp when the gateway was created.
    deletion_protection bool
    Whether deletion protection is enabled for the gateway.
    infrastructure_role_arn string
    The ARN of the IAM role that ECS uses to manage infrastructure for the gateway.
    propagate_tags "NONE" | "GATEWAY"
    Specifies whether to propagate the tags from the gateway to other resources.
    status "ACTIVE" | "UPDATE_IN_PROGRESS" | "UPDATE_COMPLETE" | "UPDATE_FAILED" | "DELETED"
    The status of the gateway.
    tags list(object)
    The metadata that you apply to the gateway to help you categorize and organize them.
    updated_at string
    The timestamp when the gateway was last updated.
    accessType GatewayAccessType
    The access type of the gateway.
    arn String
    The Amazon Resource Name (ARN) of the gateway.
    configuration GatewayConfiguration
    The configuration for the gateway.
    createdAt String
    The timestamp when the gateway was created.
    deletionProtection Boolean
    Whether deletion protection is enabled for the gateway.
    infrastructureRoleArn String
    The ARN of the IAM role that ECS uses to manage infrastructure for the gateway.
    propagateTags GatewayPropagateGatewayTags
    Specifies whether to propagate the tags from the gateway to other resources.
    status GatewayStatus
    The status of the gateway.
    tags List<Tag>
    The metadata that you apply to the gateway to help you categorize and organize them.
    updatedAt String
    The timestamp when the gateway was last updated.
    accessType GatewayAccessType
    The access type of the gateway.
    arn string
    The Amazon Resource Name (ARN) of the gateway.
    configuration GatewayConfiguration
    The configuration for the gateway.
    createdAt string
    The timestamp when the gateway was created.
    deletionProtection boolean
    Whether deletion protection is enabled for the gateway.
    infrastructureRoleArn string
    The ARN of the IAM role that ECS uses to manage infrastructure for the gateway.
    propagateTags GatewayPropagateGatewayTags
    Specifies whether to propagate the tags from the gateway to other resources.
    status GatewayStatus
    The status of the gateway.
    tags Tag[]
    The metadata that you apply to the gateway to help you categorize and organize them.
    updatedAt string
    The timestamp when the gateway was last updated.
    access_type GatewayAccessType
    The access type of the gateway.
    arn str
    The Amazon Resource Name (ARN) of the gateway.
    configuration GatewayConfiguration
    The configuration for the gateway.
    created_at str
    The timestamp when the gateway was created.
    deletion_protection bool
    Whether deletion protection is enabled for the gateway.
    infrastructure_role_arn str
    The ARN of the IAM role that ECS uses to manage infrastructure for the gateway.
    propagate_tags GatewayPropagateGatewayTags
    Specifies whether to propagate the tags from the gateway to other resources.
    status GatewayStatus
    The status of the gateway.
    tags Sequence[root_Tag]
    The metadata that you apply to the gateway to help you categorize and organize them.
    updated_at str
    The timestamp when the gateway was last updated.
    accessType "PUBLIC" | "PRIVATE"
    The access type of the gateway.
    arn String
    The Amazon Resource Name (ARN) of the gateway.
    configuration Property Map
    The configuration for the gateway.
    createdAt String
    The timestamp when the gateway was created.
    deletionProtection Boolean
    Whether deletion protection is enabled for the gateway.
    infrastructureRoleArn String
    The ARN of the IAM role that ECS uses to manage infrastructure for the gateway.
    propagateTags "NONE" | "GATEWAY"
    Specifies whether to propagate the tags from the gateway to other resources.
    status "ACTIVE" | "UPDATE_IN_PROGRESS" | "UPDATE_COMPLETE" | "UPDATE_FAILED" | "DELETED"
    The status of the gateway.
    tags List<Property Map>
    The metadata that you apply to the gateway to help you categorize and organize them.
    updatedAt String
    The timestamp when the gateway was last updated.

    Supporting Types

    GatewayAccessType

    NameValue
    PublicPUBLIC
    PrivatePRIVATE
    NameValue
    GatewayAccessTypePublicPUBLIC
    GatewayAccessTypePrivatePRIVATE
    Value
    PUBLIC
    PRIVATE
    NameValue
    PublicPUBLIC
    PrivatePRIVATE
    NameValue
    PublicPUBLIC
    PrivatePRIVATE
    NameValue
    PUBLICPUBLIC
    PRIVATEPRIVATE
    Value
    PUBLIC
    PRIVATE

    GatewayAlbDesyncMitigationMode

    NameValue
    Monitormonitor
    Defensivedefensive
    Stricteststrictest
    NameValue
    GatewayAlbDesyncMitigationModeMonitormonitor
    GatewayAlbDesyncMitigationModeDefensivedefensive
    GatewayAlbDesyncMitigationModeStricteststrictest
    Value
    monitor
    defensive
    strictest
    NameValue
    Monitormonitor
    Defensivedefensive
    Stricteststrictest
    NameValue
    Monitormonitor
    Defensivedefensive
    Stricteststrictest
    NameValue
    MONITORmonitor
    DEFENSIVEdefensive
    STRICTESTstrictest
    Value
    monitor
    defensive
    strictest

    GatewayAlbProtocol

    NameValue
    HttpHTTP
    HttpsHTTPS
    NameValue
    GatewayAlbProtocolHttpHTTP
    GatewayAlbProtocolHttpsHTTPS
    Value
    HTTP
    HTTPS
    NameValue
    HttpHTTP
    HttpsHTTPS
    NameValue
    HttpHTTP
    HttpsHTTPS
    NameValue
    HTTPHTTP
    HTTPSHTTPS
    Value
    HTTP
    HTTPS

    GatewayAlbTestTrafficRules

    GatewayConfiguration

    GatewayElbAccessLogConfiguration

    GatewayElbAccessLogDestination

    GatewayElbAccessLogS3Destination

    Bucket string
    The S3 bucket for access logs.
    Prefix string
    The S3 prefix for access logs.
    Bucket string
    The S3 bucket for access logs.
    Prefix string
    The S3 prefix for access logs.
    bucket string
    The S3 bucket for access logs.
    prefix string
    The S3 prefix for access logs.
    bucket String
    The S3 bucket for access logs.
    prefix String
    The S3 prefix for access logs.
    bucket string
    The S3 bucket for access logs.
    prefix string
    The S3 prefix for access logs.
    bucket str
    The S3 bucket for access logs.
    prefix str
    The S3 prefix for access logs.
    bucket String
    The S3 bucket for access logs.
    prefix String
    The S3 prefix for access logs.

    GatewayElbIpAddressType

    NameValue
    Ipv4ipv4
    Dualstackdualstack
    DualstackWithoutPublicIpv4dualstack-without-public-ipv4
    NameValue
    GatewayElbIpAddressTypeIpv4ipv4
    GatewayElbIpAddressTypeDualstackdualstack
    GatewayElbIpAddressTypeDualstackWithoutPublicIpv4dualstack-without-public-ipv4
    Value
    ipv4
    dualstack
    dualstack-without-public-ipv4
    NameValue
    Ipv4ipv4
    Dualstackdualstack
    DualstackWithoutPublicIpv4dualstack-without-public-ipv4
    NameValue
    Ipv4ipv4
    Dualstackdualstack
    DualstackWithoutPublicIpv4dualstack-without-public-ipv4
    NameValue
    IPV4ipv4
    DUALSTACKdualstack
    DUALSTACK_WITHOUT_PUBLIC_IPV4dualstack-without-public-ipv4
    Value
    ipv4
    dualstack
    dualstack-without-public-ipv4

    GatewayElbNetworkConfiguration

    InboundSecurityGroup string
    The inbound security group for the ALB.
    IpAddressType Pulumi.AwsNative.Ecs.GatewayElbIpAddressType
    Subnets List<string>
    The subnets for the ALB.
    InboundSecurityGroup string
    The inbound security group for the ALB.
    IpAddressType GatewayElbIpAddressType
    Subnets []string
    The subnets for the ALB.
    inbound_security_group string
    The inbound security group for the ALB.
    ip_address_type "ipv4" | "dualstack" | "dualstack-without-public-ipv4"
    subnets list(string)
    The subnets for the ALB.
    inboundSecurityGroup String
    The inbound security group for the ALB.
    ipAddressType GatewayElbIpAddressType
    subnets List<String>
    The subnets for the ALB.
    inboundSecurityGroup string
    The inbound security group for the ALB.
    ipAddressType GatewayElbIpAddressType
    subnets string[]
    The subnets for the ALB.
    inbound_security_group str
    The inbound security group for the ALB.
    ip_address_type GatewayElbIpAddressType
    subnets Sequence[str]
    The subnets for the ALB.
    inboundSecurityGroup String
    The inbound security group for the ALB.
    ipAddressType "ipv4" | "dualstack" | "dualstack-without-public-ipv4"
    subnets List<String>
    The subnets for the ALB.

    GatewayElbScheme

    NameValue
    InternetFacinginternet-facing
    Internalinternal
    NameValue
    GatewayElbSchemeInternetFacinginternet-facing
    GatewayElbSchemeInternalinternal
    Value
    internet-facing
    internal
    NameValue
    InternetFacinginternet-facing
    Internalinternal
    NameValue
    InternetFacinginternet-facing
    Internalinternal
    NameValue
    INTERNET_FACINGinternet-facing
    INTERNALinternal
    Value
    internet-facing
    internal

    GatewayHostSharedAlbConfiguration

    AccessLogs GatewayElbAccessLogConfiguration
    CurrentAlbCount int
    The current number of ALBs provisioned for the gateway.
    HttpDesync GatewayAlbDesyncMitigationMode
    MaxAlbCount int
    The maximum number of ALBs to provision for the gateway.
    NetworkConfiguration GatewayElbNetworkConfiguration
    Port int
    The port on which the ALB listens.
    Protocol GatewayAlbProtocol
    Scheme GatewayElbScheme
    TestTrafficRules GatewayAlbTestTrafficRules
    WebAclArn string
    The ARN of the WAFv2 web ACL to associate with the ALB.
    access_logs object
    current_alb_count number
    The current number of ALBs provisioned for the gateway.
    http_desync "monitor" | "defensive" | "strictest"
    max_alb_count number
    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_rules object
    web_acl_arn string
    The ARN of the WAFv2 web ACL to associate with the ALB.
    accessLogs GatewayElbAccessLogConfiguration
    currentAlbCount Integer
    The current number of ALBs provisioned for the gateway.
    httpDesync GatewayAlbDesyncMitigationMode
    maxAlbCount Integer
    The maximum number of ALBs to provision for the gateway.
    networkConfiguration GatewayElbNetworkConfiguration
    port Integer
    The port on which the ALB listens.
    protocol GatewayAlbProtocol
    scheme GatewayElbScheme
    testTrafficRules GatewayAlbTestTrafficRules
    webAclArn String
    The ARN of the WAFv2 web ACL to associate with the ALB.
    accessLogs GatewayElbAccessLogConfiguration
    currentAlbCount number
    The current number of ALBs provisioned for the gateway.
    httpDesync GatewayAlbDesyncMitigationMode
    maxAlbCount number
    The maximum number of ALBs to provision for the gateway.
    networkConfiguration GatewayElbNetworkConfiguration
    port number
    The port on which the ALB listens.
    protocol GatewayAlbProtocol
    scheme GatewayElbScheme
    testTrafficRules GatewayAlbTestTrafficRules
    webAclArn string
    The ARN of the WAFv2 web ACL to associate with the ALB.
    access_logs GatewayElbAccessLogConfiguration
    current_alb_count int
    The current number of ALBs provisioned for the gateway.
    http_desync GatewayAlbDesyncMitigationMode
    max_alb_count int
    The maximum number of ALBs to provision for the gateway.
    network_configuration GatewayElbNetworkConfiguration
    port int
    The port on which the ALB listens.
    protocol GatewayAlbProtocol
    scheme GatewayElbScheme
    test_traffic_rules GatewayAlbTestTrafficRules
    web_acl_arn str
    The ARN of the WAFv2 web ACL to associate with the ALB.
    accessLogs Property Map
    currentAlbCount Number
    The current number of ALBs provisioned for the gateway.
    httpDesync "monitor" | "defensive" | "strictest"
    maxAlbCount Number
    The maximum number of ALBs to provision for the gateway.
    networkConfiguration Property Map
    port Number
    The port on which the ALB listens.
    protocol "HTTP" | "HTTPS"
    scheme "internet-facing" | "internal"
    testTrafficRules Property Map
    webAclArn String
    The ARN of the WAFv2 web ACL to associate with the ALB.

    GatewayPropagateGatewayTags

    NameValue
    NoneNONE
    GatewayGATEWAY
    NameValue
    GatewayPropagateGatewayTagsNoneNONE
    GatewayPropagateGatewayTagsGatewayGATEWAY
    Value
    NONE
    GATEWAY
    NameValue
    NoneNONE
    GatewayGATEWAY
    NameValue
    NoneNONE
    GatewayGATEWAY
    NameValue
    NONENONE
    GATEWAYGATEWAY
    Value
    NONE
    GATEWAY

    GatewayStatus

    NameValue
    ActiveACTIVE
    UpdateInProgressUPDATE_IN_PROGRESS
    UpdateCompleteUPDATE_COMPLETE
    UpdateFailedUPDATE_FAILED
    DeletedDELETED
    NameValue
    GatewayStatusActiveACTIVE
    GatewayStatusUpdateInProgressUPDATE_IN_PROGRESS
    GatewayStatusUpdateCompleteUPDATE_COMPLETE
    GatewayStatusUpdateFailedUPDATE_FAILED
    GatewayStatusDeletedDELETED
    Value
    ACTIVE
    UPDATE_IN_PROGRESS
    UPDATE_COMPLETE
    UPDATE_FAILED
    DELETED
    NameValue
    ActiveACTIVE
    UpdateInProgressUPDATE_IN_PROGRESS
    UpdateCompleteUPDATE_COMPLETE
    UpdateFailedUPDATE_FAILED
    DeletedDELETED
    NameValue
    ActiveACTIVE
    UpdateInProgressUPDATE_IN_PROGRESS
    UpdateCompleteUPDATE_COMPLETE
    UpdateFailedUPDATE_FAILED
    DeletedDELETED
    NameValue
    ACTIVEACTIVE
    UPDATE_IN_PROGRESSUPDATE_IN_PROGRESS
    UPDATE_COMPLETEUPDATE_COMPLETE
    UPDATE_FAILEDUPDATE_FAILED
    DELETEDDELETED
    Value
    ACTIVE
    UPDATE_IN_PROGRESS
    UPDATE_COMPLETE
    UPDATE_FAILED
    DELETED

    GatewayTestTrafficHeader

    Name string
    The name of the header.
    Values List<string>
    The values for the header.
    Name string
    The name of the header.
    Values []string
    The values for the header.
    name string
    The name of the header.
    values list(string)
    The values for the header.
    name String
    The name of the header.
    values List<String>
    The values for the header.
    name string
    The name of the header.
    values string[]
    The values for the header.
    name str
    The name of the header.
    values Sequence[str]
    The values for the header.
    name String
    The name of the header.
    values List<String>
    The values for the header.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial