1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. bedrockagentcore
  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

    Definition of AWS::BedrockAgentCore::Gateway Resource Type

    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(gateway_identifier: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetGatewayResult
    def get_gateway_output(gateway_identifier: 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:bedrockagentcore:getGateway
      arguments:
        # arguments dictionary
    data "aws-native_bedrockagentcore_get_gateway" "name" {
        # arguments
    }

    The following arguments are supported:

    getGateway Result

    The following output properties are available:

    AuthorizerConfiguration Pulumi.AwsNative.BedrockAgentCore.Outputs.GatewayAuthorizerConfigurationProperties
    AuthorizerType Pulumi.AwsNative.BedrockAgentCore.GatewayAuthorizerType
    The authorizer type for the gateway.
    CreatedAt string
    The date and time at which the gateway was created.
    Description string
    The description for the gateway.
    ExceptionLevel Pulumi.AwsNative.BedrockAgentCore.GatewayExceptionLevel
    The exception level for the gateway.
    GatewayArn string
    The ARN for the gateway.
    GatewayIdentifier string
    GatewayUrl string
    The gateway URL for the gateway.
    InterceptorConfigurations List<Pulumi.AwsNative.BedrockAgentCore.Outputs.GatewayInterceptorConfiguration>
    KmsKeyArn string
    The KMS key ARN for the gateway.
    Name string
    The name for the gateway.
    PolicyEngineConfiguration Pulumi.AwsNative.BedrockAgentCore.Outputs.GatewayPolicyEngineConfiguration
    ProtocolConfiguration Pulumi.AwsNative.BedrockAgentCore.Outputs.GatewayProtocolConfigurationProperties
    The protocol configuration for the gateway target.
    ProtocolType object

    The protocol type for the gateway target.

    Search the CloudFormation User Guide for AWS::BedrockAgentCore::Gateway for more information about the expected schema for this property.

    RoleArn string
    Status Pulumi.AwsNative.BedrockAgentCore.GatewayStatus
    The status for the gateway.
    StatusReasons List<string>
    The status reasons for the gateway.
    Tags Dictionary<string, string>
    The tags for the gateway.
    UpdatedAt string
    WafConfiguration Pulumi.AwsNative.BedrockAgentCore.Outputs.GatewayWafConfiguration
    WebAclArn string
    WorkloadIdentityDetails Pulumi.AwsNative.BedrockAgentCore.Outputs.GatewayWorkloadIdentityDetails
    AuthorizerConfiguration GatewayAuthorizerConfigurationProperties
    AuthorizerType GatewayAuthorizerType
    The authorizer type for the gateway.
    CreatedAt string
    The date and time at which the gateway was created.
    Description string
    The description for the gateway.
    ExceptionLevel GatewayExceptionLevel
    The exception level for the gateway.
    GatewayArn string
    The ARN for the gateway.
    GatewayIdentifier string
    GatewayUrl string
    The gateway URL for the gateway.
    InterceptorConfigurations []GatewayInterceptorConfiguration
    KmsKeyArn string
    The KMS key ARN for the gateway.
    Name string
    The name for the gateway.
    PolicyEngineConfiguration GatewayPolicyEngineConfiguration
    ProtocolConfiguration GatewayProtocolConfigurationProperties
    The protocol configuration for the gateway target.
    ProtocolType interface{}

    The protocol type for the gateway target.

    Search the CloudFormation User Guide for AWS::BedrockAgentCore::Gateway for more information about the expected schema for this property.

    RoleArn string
    Status GatewayStatus
    The status for the gateway.
    StatusReasons []string
    The status reasons for the gateway.
    Tags map[string]string
    The tags for the gateway.
    UpdatedAt string
    WafConfiguration GatewayWafConfiguration
    WebAclArn string
    WorkloadIdentityDetails GatewayWorkloadIdentityDetails
    authorizer_configuration object
    authorizer_type "CUSTOM_JWT" | "AWS_IAM" | "NONE" | "AUTHENTICATE_ONLY"
    The authorizer type for the gateway.
    created_at string
    The date and time at which the gateway was created.
    description string
    The description for the gateway.
    exception_level "DEBUG"
    The exception level for the gateway.
    gateway_arn string
    The ARN for the gateway.
    gateway_identifier string
    gateway_url string
    The gateway URL for the gateway.
    interceptor_configurations list(object)
    kms_key_arn string
    The KMS key ARN for the gateway.
    name string
    The name for the gateway.
    policy_engine_configuration object
    protocol_configuration object
    The protocol configuration for the gateway target.
    protocol_type any

    The protocol type for the gateway target.

    Search the CloudFormation User Guide for AWS::BedrockAgentCore::Gateway for more information about the expected schema for this property.

    role_arn string
    status "CREATING" | "UPDATING" | "UPDATE_UNSUCCESSFUL" | "DELETING" | "READY" | "FAILED"
    The status for the gateway.
    status_reasons list(string)
    The status reasons for the gateway.
    tags map(string)
    The tags for the gateway.
    updated_at string
    waf_configuration object
    web_acl_arn string
    workload_identity_details object
    authorizerConfiguration GatewayAuthorizerConfigurationProperties
    authorizerType GatewayAuthorizerType
    The authorizer type for the gateway.
    createdAt String
    The date and time at which the gateway was created.
    description String
    The description for the gateway.
    exceptionLevel GatewayExceptionLevel
    The exception level for the gateway.
    gatewayArn String
    The ARN for the gateway.
    gatewayIdentifier String
    gatewayUrl String
    The gateway URL for the gateway.
    interceptorConfigurations List<GatewayInterceptorConfiguration>
    kmsKeyArn String
    The KMS key ARN for the gateway.
    name String
    The name for the gateway.
    policyEngineConfiguration GatewayPolicyEngineConfiguration
    protocolConfiguration GatewayProtocolConfigurationProperties
    The protocol configuration for the gateway target.
    protocolType Object

    The protocol type for the gateway target.

    Search the CloudFormation User Guide for AWS::BedrockAgentCore::Gateway for more information about the expected schema for this property.

    roleArn String
    status GatewayStatus
    The status for the gateway.
    statusReasons List<String>
    The status reasons for the gateway.
    tags Map<String,String>
    The tags for the gateway.
    updatedAt String
    wafConfiguration GatewayWafConfiguration
    webAclArn String
    workloadIdentityDetails GatewayWorkloadIdentityDetails
    authorizerConfiguration GatewayAuthorizerConfigurationProperties
    authorizerType GatewayAuthorizerType
    The authorizer type for the gateway.
    createdAt string
    The date and time at which the gateway was created.
    description string
    The description for the gateway.
    exceptionLevel GatewayExceptionLevel
    The exception level for the gateway.
    gatewayArn string
    The ARN for the gateway.
    gatewayIdentifier string
    gatewayUrl string
    The gateway URL for the gateway.
    interceptorConfigurations GatewayInterceptorConfiguration[]
    kmsKeyArn string
    The KMS key ARN for the gateway.
    name string
    The name for the gateway.
    policyEngineConfiguration GatewayPolicyEngineConfiguration
    protocolConfiguration GatewayProtocolConfigurationProperties
    The protocol configuration for the gateway target.
    protocolType any

    The protocol type for the gateway target.

    Search the CloudFormation User Guide for AWS::BedrockAgentCore::Gateway for more information about the expected schema for this property.

    roleArn string
    status GatewayStatus
    The status for the gateway.
    statusReasons string[]
    The status reasons for the gateway.
    tags {[key: string]: string}
    The tags for the gateway.
    updatedAt string
    wafConfiguration GatewayWafConfiguration
    webAclArn string
    workloadIdentityDetails GatewayWorkloadIdentityDetails
    authorizer_configuration GatewayAuthorizerConfigurationProperties
    authorizer_type GatewayAuthorizerType
    The authorizer type for the gateway.
    created_at str
    The date and time at which the gateway was created.
    description str
    The description for the gateway.
    exception_level GatewayExceptionLevel
    The exception level for the gateway.
    gateway_arn str
    The ARN for the gateway.
    gateway_identifier str
    gateway_url str
    The gateway URL for the gateway.
    interceptor_configurations Sequence[GatewayInterceptorConfiguration]
    kms_key_arn str
    The KMS key ARN for the gateway.
    name str
    The name for the gateway.
    policy_engine_configuration GatewayPolicyEngineConfiguration
    protocol_configuration GatewayProtocolConfigurationProperties
    The protocol configuration for the gateway target.
    protocol_type Any

    The protocol type for the gateway target.

    Search the CloudFormation User Guide for AWS::BedrockAgentCore::Gateway for more information about the expected schema for this property.

    role_arn str
    status GatewayStatus
    The status for the gateway.
    status_reasons Sequence[str]
    The status reasons for the gateway.
    tags Mapping[str, str]
    The tags for the gateway.
    updated_at str
    waf_configuration GatewayWafConfiguration
    web_acl_arn str
    workload_identity_details GatewayWorkloadIdentityDetails
    authorizerConfiguration Property Map
    authorizerType "CUSTOM_JWT" | "AWS_IAM" | "NONE" | "AUTHENTICATE_ONLY"
    The authorizer type for the gateway.
    createdAt String
    The date and time at which the gateway was created.
    description String
    The description for the gateway.
    exceptionLevel "DEBUG"
    The exception level for the gateway.
    gatewayArn String
    The ARN for the gateway.
    gatewayIdentifier String
    gatewayUrl String
    The gateway URL for the gateway.
    interceptorConfigurations List<Property Map>
    kmsKeyArn String
    The KMS key ARN for the gateway.
    name String
    The name for the gateway.
    policyEngineConfiguration Property Map
    protocolConfiguration Property Map
    The protocol configuration for the gateway target.
    protocolType Any

    The protocol type for the gateway target.

    Search the CloudFormation User Guide for AWS::BedrockAgentCore::Gateway for more information about the expected schema for this property.

    roleArn String
    status "CREATING" | "UPDATING" | "UPDATE_UNSUCCESSFUL" | "DELETING" | "READY" | "FAILED"
    The status for the gateway.
    statusReasons List<String>
    The status reasons for the gateway.
    tags Map<String>
    The tags for the gateway.
    updatedAt String
    wafConfiguration Property Map
    webAclArn String
    workloadIdentityDetails Property Map

    Supporting Types

    GatewayAuthorizerConfigurationProperties

    GatewayAuthorizerType

    NameValue
    CustomJwtCUSTOM_JWT
    AwsIamAWS_IAM
    NoneNONE
    AuthenticateOnlyAUTHENTICATE_ONLY
    NameValue
    GatewayAuthorizerTypeCustomJwtCUSTOM_JWT
    GatewayAuthorizerTypeAwsIamAWS_IAM
    GatewayAuthorizerTypeNoneNONE
    GatewayAuthorizerTypeAuthenticateOnlyAUTHENTICATE_ONLY
    Value
    CUSTOM_JWT
    AWS_IAM
    NONE
    AUTHENTICATE_ONLY
    NameValue
    CustomJwtCUSTOM_JWT
    AwsIamAWS_IAM
    NoneNONE
    AuthenticateOnlyAUTHENTICATE_ONLY
    NameValue
    CustomJwtCUSTOM_JWT
    AwsIamAWS_IAM
    NoneNONE
    AuthenticateOnlyAUTHENTICATE_ONLY
    NameValue
    CUSTOM_JWTCUSTOM_JWT
    AWS_IAMAWS_IAM
    NONENONE
    AUTHENTICATE_ONLYAUTHENTICATE_ONLY
    Value
    CUSTOM_JWT
    AWS_IAM
    NONE
    AUTHENTICATE_ONLY

    GatewayAuthorizingClaimMatchValueType

    GatewayClaimMatchOperatorType

    NameValue
    EqualsValueEQUALS
    ContainsCONTAINS
    ContainsAnyCONTAINS_ANY
    NameValue
    GatewayClaimMatchOperatorTypeEqualsEQUALS
    GatewayClaimMatchOperatorTypeContainsCONTAINS
    GatewayClaimMatchOperatorTypeContainsAnyCONTAINS_ANY
    Value
    EQUALS
    CONTAINS
    CONTAINS_ANY
    NameValue
    EqualsEQUALS
    ContainsCONTAINS
    ContainsAnyCONTAINS_ANY
    NameValue
    EqualsEQUALS
    ContainsCONTAINS
    ContainsAnyCONTAINS_ANY
    NameValue
    EQUALSEQUALS
    CONTAINSCONTAINS
    CONTAINS_ANYCONTAINS_ANY
    Value
    EQUALS
    CONTAINS
    CONTAINS_ANY

    GatewayClaimMatchValueType0Properties

    GatewayClaimMatchValueType1Properties

    GatewayCustomClaimValidationType

    GatewayCustomJwtAuthorizerConfiguration

    GatewayEndpointIpAddressType

    NameValue
    Ipv4IPV4
    Ipv6IPV6
    NameValue
    GatewayEndpointIpAddressTypeIpv4IPV4
    GatewayEndpointIpAddressTypeIpv6IPV6
    Value
    IPV4
    IPV6
    NameValue
    Ipv4IPV4
    Ipv6IPV6
    NameValue
    Ipv4IPV4
    Ipv6IPV6
    NameValue
    IPV4IPV4
    IPV6IPV6
    Value
    IPV4
    IPV6

    GatewayExceptionLevel

    NameValue
    DebugDEBUG
    NameValue
    GatewayExceptionLevelDebugDEBUG
    Value
    DEBUG
    NameValue
    DebugDEBUG
    NameValue
    DebugDEBUG
    NameValue
    DEBUGDEBUG
    Value
    DEBUG

    GatewayInboundTokenClaimValueType

    NameValue
    StringSTRING
    StringArraySTRING_ARRAY
    NameValue
    GatewayInboundTokenClaimValueTypeStringSTRING
    GatewayInboundTokenClaimValueTypeStringArraySTRING_ARRAY
    Value
    STRING
    STRING_ARRAY
    NameValue
    StringSTRING
    StringArraySTRING_ARRAY
    NameValue
    StringSTRING
    StringArraySTRING_ARRAY
    NameValue
    STRINGSTRING
    STRING_ARRAYSTRING_ARRAY
    Value
    STRING
    STRING_ARRAY

    GatewayInterceptionPoint

    NameValue
    RequestREQUEST
    ResponseRESPONSE
    NameValue
    GatewayInterceptionPointRequestREQUEST
    GatewayInterceptionPointResponseRESPONSE
    Value
    REQUEST
    RESPONSE
    NameValue
    RequestREQUEST
    ResponseRESPONSE
    NameValue
    RequestREQUEST
    ResponseRESPONSE
    NameValue
    REQUESTREQUEST
    RESPONSERESPONSE
    Value
    REQUEST
    RESPONSE

    GatewayInterceptorConfiguration

    GatewayInterceptorInputConfiguration

    GatewayInterceptorPayloadExclusion

    NameValue
    ResponseBodyRESPONSE_BODY
    NameValue
    GatewayInterceptorPayloadExclusionResponseBodyRESPONSE_BODY
    Value
    RESPONSE_BODY
    NameValue
    ResponseBodyRESPONSE_BODY
    NameValue
    ResponseBodyRESPONSE_BODY
    NameValue
    RESPONSE_BODYRESPONSE_BODY
    Value
    RESPONSE_BODY

    GatewayInterceptorPayloadExclusionSelectorProperties

    GatewayInterceptorPayloadFilter

    GatewayLambdaInterceptorConfiguration

    Arn string
    Arn string
    arn string
    arn String
    arn string
    arn str
    arn String

    GatewayManagedVpcResource

    GatewayMcpGatewayConfiguration

    GatewayPolicyEngineConfiguration

    GatewayPolicyEngineMode

    NameValue
    LogOnlyLOG_ONLY
    EnforceENFORCE
    NameValue
    GatewayPolicyEngineModeLogOnlyLOG_ONLY
    GatewayPolicyEngineModeEnforceENFORCE
    Value
    LOG_ONLY
    ENFORCE
    NameValue
    LogOnlyLOG_ONLY
    EnforceENFORCE
    NameValue
    LogOnlyLOG_ONLY
    EnforceENFORCE
    NameValue
    LOG_ONLYLOG_ONLY
    ENFORCEENFORCE
    Value
    LOG_ONLY
    ENFORCE

    GatewayPrivateEndpoint0Properties

    GatewayPrivateEndpoint1Properties

    GatewayProtocolConfigurationProperties

    GatewaySearchType

    NameValue
    SemanticSEMANTIC
    NameValue
    GatewaySearchTypeSemanticSEMANTIC
    Value
    SEMANTIC
    NameValue
    SemanticSEMANTIC
    NameValue
    SemanticSEMANTIC
    NameValue
    SEMANTICSEMANTIC
    Value
    SEMANTIC

    GatewaySelfManagedLatticeResourceProperties

    GatewaySessionConfiguration

    GatewayStatus

    NameValue
    CreatingCREATING
    UpdatingUPDATING
    UpdateUnsuccessfulUPDATE_UNSUCCESSFUL
    DeletingDELETING
    ReadyREADY
    FailedFAILED
    NameValue
    GatewayStatusCreatingCREATING
    GatewayStatusUpdatingUPDATING
    GatewayStatusUpdateUnsuccessfulUPDATE_UNSUCCESSFUL
    GatewayStatusDeletingDELETING
    GatewayStatusReadyREADY
    GatewayStatusFailedFAILED
    Value
    CREATING
    UPDATING
    UPDATE_UNSUCCESSFUL
    DELETING
    READY
    FAILED
    NameValue
    CreatingCREATING
    UpdatingUPDATING
    UpdateUnsuccessfulUPDATE_UNSUCCESSFUL
    DeletingDELETING
    ReadyREADY
    FailedFAILED
    NameValue
    CreatingCREATING
    UpdatingUPDATING
    UpdateUnsuccessfulUPDATE_UNSUCCESSFUL
    DeletingDELETING
    ReadyREADY
    FailedFAILED
    NameValue
    CREATINGCREATING
    UPDATINGUPDATING
    UPDATE_UNSUCCESSFULUPDATE_UNSUCCESSFUL
    DELETINGDELETING
    READYREADY
    FAILEDFAILED
    Value
    CREATING
    UPDATING
    UPDATE_UNSUCCESSFUL
    DELETING
    READY
    FAILED

    GatewayStreamingConfiguration

    GatewayWafConfiguration

    GatewayWafFailureMode

    NameValue
    FailCloseFAIL_CLOSE
    FailOpenFAIL_OPEN
    NameValue
    GatewayWafFailureModeFailCloseFAIL_CLOSE
    GatewayWafFailureModeFailOpenFAIL_OPEN
    Value
    FAIL_CLOSE
    FAIL_OPEN
    NameValue
    FailCloseFAIL_CLOSE
    FailOpenFAIL_OPEN
    NameValue
    FailCloseFAIL_CLOSE
    FailOpenFAIL_OPEN
    NameValue
    FAIL_CLOSEFAIL_CLOSE
    FAIL_OPENFAIL_OPEN
    Value
    FAIL_CLOSE
    FAIL_OPEN

    GatewayWorkloadIdentityDetails

    InterceptorConfigurationProperties

    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