1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. bedrockagentcore
  5. GatewayTarget

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

AWS Cloud Control v1.51.0 published on Monday, Feb 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.bedrockagentcore.GatewayTarget

aws-native logo

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

AWS Cloud Control v1.51.0 published on Monday, Feb 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::BedrockAgentCore::GatewayTarget

    Create GatewayTarget Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GatewayTarget(name: string, args: GatewayTargetArgs, opts?: CustomResourceOptions);
    @overload
def GatewayTarget(resource_name: str,
                  args: GatewayTargetArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def GatewayTarget(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  target_configuration: Optional[GatewayTargetTargetConfigurationPropertiesArgs] = None,
                  credential_provider_configurations: Optional[Sequence[GatewayTargetCredentialProviderConfigurationArgs]] = None,
                  description: Optional[str] = None,
                  gateway_identifier: Optional[str] = None,
                  metadata_configuration: Optional[GatewayTargetMetadataConfigurationArgs] = None,
                  name: Optional[str] = None)
    func NewGatewayTarget(ctx *Context, name string, args GatewayTargetArgs, opts ...ResourceOption) (*GatewayTarget, error)
    public GatewayTarget(string name, GatewayTargetArgs args, CustomResourceOptions? opts = null)
    public GatewayTarget(String name, GatewayTargetArgs args)
public GatewayTarget(String name, GatewayTargetArgs args, CustomResourceOptions options)

    type: aws-native:bedrockagentcore:GatewayTarget
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GatewayTargetArgs
    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 GatewayTargetArgs
    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 GatewayTargetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayTargetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayTargetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    GatewayTarget 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 GatewayTarget resource accepts the following input properties:

    TargetConfiguration GatewayTargetTargetConfigurationPropertiesArgs
    The target configuration for the Smithy model target.
    CredentialProviderConfigurations []GatewayTargetCredentialProviderConfigurationArgs
    The OAuth credential provider configuration.
    Description string
    The description for the gateway target.
    GatewayIdentifier string
    The gateway ID for the gateway target.
    MetadataConfiguration GatewayTargetMetadataConfigurationArgs
    Name string
    The name for the gateway target.
    targetConfiguration GatewayTargetTargetConfigurationProperties
    The target configuration for the Smithy model target.
    credentialProviderConfigurations List<GatewayTargetCredentialProviderConfiguration>
    The OAuth credential provider configuration.
    description String
    The description for the gateway target.
    gatewayIdentifier String
    The gateway ID for the gateway target.
    metadataConfiguration GatewayTargetMetadataConfiguration
    name String
    The name for the gateway target.
    targetConfiguration GatewayTargetTargetConfigurationProperties
    The target configuration for the Smithy model target.
    credentialProviderConfigurations GatewayTargetCredentialProviderConfiguration[]
    The OAuth credential provider configuration.
    description string
    The description for the gateway target.
    gatewayIdentifier string
    The gateway ID for the gateway target.
    metadataConfiguration GatewayTargetMetadataConfiguration
    name string
    The name for the gateway target.
    target_configuration GatewayTargetTargetConfigurationPropertiesArgs
    The target configuration for the Smithy model target.
    credential_provider_configurations Sequence[GatewayTargetCredentialProviderConfigurationArgs]
    The OAuth credential provider configuration.
    description str
    The description for the gateway target.
    gateway_identifier str
    The gateway ID for the gateway target.
    metadata_configuration GatewayTargetMetadataConfigurationArgs
    name str
    The name for the gateway target.
    targetConfiguration Property Map
    The target configuration for the Smithy model target.
    credentialProviderConfigurations List<Property Map>
    The OAuth credential provider configuration.
    description String
    The description for the gateway target.
    gatewayIdentifier String
    The gateway ID for the gateway target.
    metadataConfiguration Property Map
    name String
    The name for the gateway target.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GatewayTarget resource produces the following output properties:

    CreatedAt string
    The date and time at which the gateway target was created.
    GatewayArn string
    Id string
    The provider-assigned unique ID for this managed resource.
    LastSynchronizedAt string
    Status Pulumi.AwsNative.BedrockAgentCore.GatewayTargetTargetStatus
    The status for the gateway target.
    StatusReasons List<string>
    The status reasons for the gateway target.
    TargetId string
    The target ID for the gateway target.
    UpdatedAt string
    The time at which the resource was updated.
    CreatedAt string
    The date and time at which the gateway target was created.
    GatewayArn string
    Id string
    The provider-assigned unique ID for this managed resource.
    LastSynchronizedAt string
    Status GatewayTargetTargetStatus
    The status for the gateway target.
    StatusReasons []string
    The status reasons for the gateway target.
    TargetId string
    The target ID for the gateway target.
    UpdatedAt string
    The time at which the resource was updated.
    createdAt String
    The date and time at which the gateway target was created.
    gatewayArn String
    id String
    The provider-assigned unique ID for this managed resource.
    lastSynchronizedAt String
    status GatewayTargetTargetStatus
    The status for the gateway target.
    statusReasons List<String>
    The status reasons for the gateway target.
    targetId String
    The target ID for the gateway target.
    updatedAt String
    The time at which the resource was updated.
    createdAt string
    The date and time at which the gateway target was created.
    gatewayArn string
    id string
    The provider-assigned unique ID for this managed resource.
    lastSynchronizedAt string
    status GatewayTargetTargetStatus
    The status for the gateway target.
    statusReasons string[]
    The status reasons for the gateway target.
    targetId string
    The target ID for the gateway target.
    updatedAt string
    The time at which the resource was updated.
    created_at str
    The date and time at which the gateway target was created.
    gateway_arn str
    id str
    The provider-assigned unique ID for this managed resource.
    last_synchronized_at str
    status GatewayTargetTargetStatus
    The status for the gateway target.
    status_reasons Sequence[str]
    The status reasons for the gateway target.
    target_id str
    The target ID for the gateway target.
    updated_at str
    The time at which the resource was updated.
    createdAt String
    The date and time at which the gateway target was created.
    gatewayArn String
    id String
    The provider-assigned unique ID for this managed resource.
    lastSynchronizedAt String
    status "CREATING" | "UPDATING" | "UPDATE_UNSUCCESSFUL" | "DELETING" | "READY" | "FAILED" | "SYNCHRONIZING" | "SYNCHRONIZE_UNSUCCESSFUL"
    The status for the gateway target.
    statusReasons List<String>
    The status reasons for the gateway target.
    targetId String
    The target ID for the gateway target.
    updatedAt String
    The time at which the resource was updated.

    Supporting Types

    GatewayTargetApiGatewayTargetConfiguration, GatewayTargetApiGatewayTargetConfigurationArgs

    GatewayTargetApiGatewayToolConfiguration, GatewayTargetApiGatewayToolConfigurationArgs

    GatewayTargetApiGatewayToolFilter, GatewayTargetApiGatewayToolFilterArgs

    GatewayTargetApiGatewayToolOverride, GatewayTargetApiGatewayToolOverrideArgs

    GatewayTargetApiKeyCredentialLocation, GatewayTargetApiKeyCredentialLocationArgs

    Header
    HEADER
    QueryParameter
    QUERY_PARAMETER
    GatewayTargetApiKeyCredentialLocationHeader
    HEADER
    GatewayTargetApiKeyCredentialLocationQueryParameter
    QUERY_PARAMETER
    Header
    HEADER
    QueryParameter
    QUERY_PARAMETER
    Header
    HEADER
    QueryParameter
    QUERY_PARAMETER
    HEADER
    HEADER
    QUERY_PARAMETER
    QUERY_PARAMETER
    "HEADER"
    HEADER
    "QUERY_PARAMETER"
    QUERY_PARAMETER

    GatewayTargetApiKeyCredentialProvider, GatewayTargetApiKeyCredentialProviderArgs

    GatewayTargetApiSchemaConfiguration0Properties, GatewayTargetApiSchemaConfiguration0PropertiesArgs

    GatewayTargetApiSchemaConfiguration1Properties, GatewayTargetApiSchemaConfiguration1PropertiesArgs

    GatewayTargetCredentialProvider0Properties, GatewayTargetCredentialProvider0PropertiesArgs

    GatewayTargetCredentialProvider1Properties, GatewayTargetCredentialProvider1PropertiesArgs

    GatewayTargetCredentialProviderConfiguration, GatewayTargetCredentialProviderConfigurationArgs

    credentialProviderType "GATEWAY_IAM_ROLE" | "OAUTH" | "API_KEY"
    The credential provider type for the gateway target.
    credentialProvider Property Map | Property Map
    The credential provider for the gateway target.

    GatewayTargetCredentialProviderType, GatewayTargetCredentialProviderTypeArgs

    GatewayIamRole
    GATEWAY_IAM_ROLE
    Oauth
    OAUTH
    ApiKey
    API_KEY
    GatewayTargetCredentialProviderTypeGatewayIamRole
    GATEWAY_IAM_ROLE
    GatewayTargetCredentialProviderTypeOauth
    OAUTH
    GatewayTargetCredentialProviderTypeApiKey
    API_KEY
    GatewayIamRole
    GATEWAY_IAM_ROLE
    Oauth
    OAUTH
    ApiKey
    API_KEY
    GatewayIamRole
    GATEWAY_IAM_ROLE
    Oauth
    OAUTH
    ApiKey
    API_KEY
    GATEWAY_IAM_ROLE
    GATEWAY_IAM_ROLE
    OAUTH
    OAUTH
    API_KEY
    API_KEY
    "GATEWAY_IAM_ROLE"
    GATEWAY_IAM_ROLE
    "OAUTH"
    OAUTH
    "API_KEY"
    API_KEY

    GatewayTargetMcpLambdaTargetConfiguration, GatewayTargetMcpLambdaTargetConfigurationArgs

    GatewayTargetMcpServerTargetConfiguration, GatewayTargetMcpServerTargetConfigurationArgs

    Endpoint string
    Endpoint string
    endpoint String
    endpoint string
    endpoint String

    GatewayTargetMcpTargetConfiguration0Properties, GatewayTargetMcpTargetConfiguration0PropertiesArgs

    GatewayTargetMcpTargetConfiguration1Properties, GatewayTargetMcpTargetConfiguration1PropertiesArgs

    GatewayTargetMcpTargetConfiguration2Properties, GatewayTargetMcpTargetConfiguration2PropertiesArgs

    GatewayTargetMcpTargetConfiguration3Properties, GatewayTargetMcpTargetConfiguration3PropertiesArgs

    GatewayTargetMcpTargetConfiguration4Properties, GatewayTargetMcpTargetConfiguration4PropertiesArgs

    GatewayTargetMetadataConfiguration, GatewayTargetMetadataConfigurationArgs

    GatewayTargetOAuthCredentialProvider, GatewayTargetOAuthCredentialProviderArgs

    ProviderArn string
    Scopes List<string>
    CustomParameters Dictionary<string, string>
    DefaultReturnUrl string
    Return URL for OAuth callback.
    GrantType Pulumi.AwsNative.BedrockAgentCore.GatewayTargetOAuthGrantType
    ProviderArn string
    Scopes []string
    CustomParameters map[string]string
    DefaultReturnUrl string
    Return URL for OAuth callback.
    GrantType GatewayTargetOAuthGrantType
    providerArn String
    scopes List<String>
    customParameters Map<String,String>
    defaultReturnUrl String
    Return URL for OAuth callback.
    grantType GatewayTargetOAuthGrantType
    providerArn string
    scopes string[]
    customParameters {[key: string]: string}
    defaultReturnUrl string
    Return URL for OAuth callback.
    grantType GatewayTargetOAuthGrantType
    provider_arn str
    scopes Sequence[str]
    custom_parameters Mapping[str, str]
    default_return_url str
    Return URL for OAuth callback.
    grant_type GatewayTargetOAuthGrantType
    providerArn String
    scopes List<String>
    customParameters Map<String>
    defaultReturnUrl String
    Return URL for OAuth callback.
    grantType "AUTHORIZATION_CODE" | "CLIENT_CREDENTIALS"

    GatewayTargetOAuthGrantType, GatewayTargetOAuthGrantTypeArgs

    AuthorizationCode
    AUTHORIZATION_CODE
    ClientCredentials
    CLIENT_CREDENTIALS
    GatewayTargetOAuthGrantTypeAuthorizationCode
    AUTHORIZATION_CODE
    GatewayTargetOAuthGrantTypeClientCredentials
    CLIENT_CREDENTIALS
    AuthorizationCode
    AUTHORIZATION_CODE
    ClientCredentials
    CLIENT_CREDENTIALS
    AuthorizationCode
    AUTHORIZATION_CODE
    ClientCredentials
    CLIENT_CREDENTIALS
    AUTHORIZATION_CODE
    AUTHORIZATION_CODE
    CLIENT_CREDENTIALS
    CLIENT_CREDENTIALS
    "AUTHORIZATION_CODE"
    AUTHORIZATION_CODE
    "CLIENT_CREDENTIALS"
    CLIENT_CREDENTIALS

    GatewayTargetRestApiMethod, GatewayTargetRestApiMethodArgs

    Get
    GET
    Delete
    DELETE
    Head
    HEAD
    Options
    OPTIONS
    Patch
    PATCH
    Put
    PUT
    Post
    POST
    GatewayTargetRestApiMethodGet
    GET
    GatewayTargetRestApiMethodDelete
    DELETE
    GatewayTargetRestApiMethodHead
    HEAD
    GatewayTargetRestApiMethodOptions
    OPTIONS
    GatewayTargetRestApiMethodPatch
    PATCH
    GatewayTargetRestApiMethodPut
    PUT
    GatewayTargetRestApiMethodPost
    POST
    Get
    GET
    Delete
    DELETE
    Head
    HEAD
    Options
    OPTIONS
    Patch
    PATCH
    Put
    PUT
    Post
    POST
    Get
    GET
    Delete
    DELETE
    Head
    HEAD
    Options
    OPTIONS
    Patch
    PATCH
    Put
    PUT
    Post
    POST
    GET
    GET
    DELETE
    DELETE
    HEAD
    HEAD
    OPTIONS
    OPTIONS
    PATCH
    PATCH
    PUT
    PUT
    POST
    POST
    "GET"
    GET
    "DELETE"
    DELETE
    "HEAD"
    HEAD
    "OPTIONS"
    OPTIONS
    "PATCH"
    PATCH
    "PUT"
    PUT
    "POST"
    POST

    GatewayTargetS3Configuration, GatewayTargetS3ConfigurationArgs

    GatewayTargetSchemaDefinition, GatewayTargetSchemaDefinitionArgs

    Type Pulumi.AwsNative.BedrockAgentCore.GatewayTargetSchemaType
    Description string
    Items Pulumi.AwsNative.BedrockAgentCore.Inputs.GatewayTargetSchemaDefinition
    Properties Dictionary<string, Pulumi.AwsNative.BedrockAgentCore.Inputs.GatewayTargetSchemaDefinition>
    Required List<string>
    type GatewayTargetSchemaType
    description String
    items GatewayTargetSchemaDefinition
    properties Map<String,GatewayTargetSchemaDefinition>
    required List<String>
    type GatewayTargetSchemaType
    description string
    items GatewayTargetSchemaDefinition
    properties {[key: string]: GatewayTargetSchemaDefinition}
    required string[]
    type GatewayTargetSchemaType
    description str
    items GatewayTargetSchemaDefinition
    properties Mapping[str, GatewayTargetSchemaDefinition]
    required Sequence[str]

    GatewayTargetSchemaType, GatewayTargetSchemaTypeArgs

    String
    string
    Number
    number
    Object
    object
    Array
    array
    Boolean
    boolean
    Integer
    integer
    GatewayTargetSchemaTypeString
    string
    GatewayTargetSchemaTypeNumber
    number
    GatewayTargetSchemaTypeObject
    object
    GatewayTargetSchemaTypeArray
    array
    GatewayTargetSchemaTypeBoolean
    boolean
    GatewayTargetSchemaTypeInteger
    integer
    String
    string
    Number
    number
    Object
    object
    Array
    array
    Boolean
    boolean
    Integer
    integer
    String
    string
    Number
    number
    Object
    object
    Array
    array
    Boolean
    boolean
    Integer
    integer
    STRING
    string
    NUMBER
    number
    OBJECT
    object
    ARRAY
    array
    BOOLEAN
    boolean
    INTEGER
    integer
    "string"
    string
    "number"
    number
    "object"
    object
    "array"
    array
    "boolean"
    boolean
    "integer"
    integer

    GatewayTargetTargetConfigurationProperties, GatewayTargetTargetConfigurationPropertiesArgs

    GatewayTargetTargetStatus, GatewayTargetTargetStatusArgs

    Creating
    CREATING
    Updating
    UPDATING
    UpdateUnsuccessful
    UPDATE_UNSUCCESSFUL
    Deleting
    DELETING
    Ready
    READY
    Failed
    FAILED
    Synchronizing
    SYNCHRONIZING
    SynchronizeUnsuccessful
    SYNCHRONIZE_UNSUCCESSFUL
    GatewayTargetTargetStatusCreating
    CREATING
    GatewayTargetTargetStatusUpdating
    UPDATING
    GatewayTargetTargetStatusUpdateUnsuccessful
    UPDATE_UNSUCCESSFUL
    GatewayTargetTargetStatusDeleting
    DELETING
    GatewayTargetTargetStatusReady
    READY
    GatewayTargetTargetStatusFailed
    FAILED
    GatewayTargetTargetStatusSynchronizing
    SYNCHRONIZING
    GatewayTargetTargetStatusSynchronizeUnsuccessful
    SYNCHRONIZE_UNSUCCESSFUL
    Creating
    CREATING
    Updating
    UPDATING
    UpdateUnsuccessful
    UPDATE_UNSUCCESSFUL
    Deleting
    DELETING
    Ready
    READY
    Failed
    FAILED
    Synchronizing
    SYNCHRONIZING
    SynchronizeUnsuccessful
    SYNCHRONIZE_UNSUCCESSFUL
    Creating
    CREATING
    Updating
    UPDATING
    UpdateUnsuccessful
    UPDATE_UNSUCCESSFUL
    Deleting
    DELETING
    Ready
    READY
    Failed
    FAILED
    Synchronizing
    SYNCHRONIZING
    SynchronizeUnsuccessful
    SYNCHRONIZE_UNSUCCESSFUL
    CREATING
    CREATING
    UPDATING
    UPDATING
    UPDATE_UNSUCCESSFUL
    UPDATE_UNSUCCESSFUL
    DELETING
    DELETING
    READY
    READY
    FAILED
    FAILED
    SYNCHRONIZING
    SYNCHRONIZING
    SYNCHRONIZE_UNSUCCESSFUL
    SYNCHRONIZE_UNSUCCESSFUL
    "CREATING"
    CREATING
    "UPDATING"
    UPDATING
    "UPDATE_UNSUCCESSFUL"
    UPDATE_UNSUCCESSFUL
    "DELETING"
    DELETING
    "READY"
    READY
    "FAILED"
    FAILED
    "SYNCHRONIZING"
    SYNCHRONIZING
    "SYNCHRONIZE_UNSUCCESSFUL"
    SYNCHRONIZE_UNSUCCESSFUL

    GatewayTargetToolDefinition, GatewayTargetToolDefinitionArgs

    GatewayTargetToolSchema0Properties, GatewayTargetToolSchema0PropertiesArgs

    GatewayTargetToolSchema1Properties, GatewayTargetToolSchema1PropertiesArgs

    Package Details

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

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

    AWS Cloud Control v1.51.0 published on Monday, Feb 2, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate