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.36.0 published on Friday, Oct 3, 2025 by Pulumi

aws-native.bedrockagentcore.GatewayTarget

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.36.0 published on Friday, Oct 3, 2025 by Pulumi

    Definition of AWS::BedrockAgentCore::GatewayTarget Resource Type

    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,
                      credential_provider_configurations: Optional[Sequence[GatewayTargetCredentialProviderConfigurationArgs]] = None,
                      target_configuration: Optional[GatewayTargetTargetConfigurationPropertiesArgs] = None,
                      description: Optional[str] = None,
                      gateway_identifier: Optional[str] = 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:

    Outputs

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

    CreatedAt string
    GatewayArn string
    Id string
    The provider-assigned unique ID for this managed resource.
    Status Pulumi.AwsNative.BedrockAgentCore.GatewayTargetTargetStatus
    StatusReasons List<string>
    TargetId string
    UpdatedAt string
    CreatedAt string
    GatewayArn string
    Id string
    The provider-assigned unique ID for this managed resource.
    Status GatewayTargetTargetStatus
    StatusReasons []string
    TargetId string
    UpdatedAt string
    createdAt String
    gatewayArn String
    id String
    The provider-assigned unique ID for this managed resource.
    status GatewayTargetTargetStatus
    statusReasons List<String>
    targetId String
    updatedAt String
    createdAt string
    gatewayArn string
    id string
    The provider-assigned unique ID for this managed resource.
    status GatewayTargetTargetStatus
    statusReasons string[]
    targetId string
    updatedAt string
    created_at str
    gateway_arn str
    id str
    The provider-assigned unique ID for this managed resource.
    status GatewayTargetTargetStatus
    status_reasons Sequence[str]
    target_id str
    updated_at str
    createdAt String
    gatewayArn String
    id String
    The provider-assigned unique ID for this managed resource.
    status "CREATING" | "UPDATING" | "UPDATE_UNSUCCESSFUL" | "DELETING" | "READY" | "FAILED"
    statusReasons List<String>
    targetId String
    updatedAt String

    Supporting Types

    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

    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

    GatewayTargetMcpTargetConfiguration0Properties, GatewayTargetMcpTargetConfiguration0PropertiesArgs

    GatewayTargetMcpTargetConfiguration1Properties, GatewayTargetMcpTargetConfiguration1PropertiesArgs

    GatewayTargetMcpTargetConfiguration2Properties, GatewayTargetMcpTargetConfiguration2PropertiesArgs

    GatewayTargetOAuthCredentialProvider, GatewayTargetOAuthCredentialProviderArgs

    ProviderArn string
    Scopes List<string>
    CustomParameters Dictionary<string, string>
    ProviderArn string
    Scopes []string
    CustomParameters map[string]string
    providerArn String
    scopes List<String>
    customParameters Map<String,String>
    providerArn string
    scopes string[]
    customParameters {[key: string]: string}
    provider_arn str
    scopes Sequence[str]
    custom_parameters Mapping[str, str]
    providerArn String
    scopes List<String>
    customParameters Map<String>

    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
    GatewayTargetTargetStatusCreating
    CREATING
    GatewayTargetTargetStatusUpdating
    UPDATING
    GatewayTargetTargetStatusUpdateUnsuccessful
    UPDATE_UNSUCCESSFUL
    GatewayTargetTargetStatusDeleting
    DELETING
    GatewayTargetTargetStatusReady
    READY
    GatewayTargetTargetStatusFailed
    FAILED
    Creating
    CREATING
    Updating
    UPDATING
    UpdateUnsuccessful
    UPDATE_UNSUCCESSFUL
    Deleting
    DELETING
    Ready
    READY
    Failed
    FAILED
    Creating
    CREATING
    Updating
    UPDATING
    UpdateUnsuccessful
    UPDATE_UNSUCCESSFUL
    Deleting
    DELETING
    Ready
    READY
    Failed
    FAILED
    CREATING
    CREATING
    UPDATING
    UPDATING
    UPDATE_UNSUCCESSFUL
    UPDATE_UNSUCCESSFUL
    DELETING
    DELETING
    READY
    READY
    FAILED
    FAILED
    "CREATING"
    CREATING
    "UPDATING"
    UPDATING
    "UPDATE_UNSUCCESSFUL"
    UPDATE_UNSUCCESSFUL
    "DELETING"
    DELETING
    "READY"
    READY
    "FAILED"
    FAILED

    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.36.0 published on Friday, Oct 3, 2025 by Pulumi
      AI Agentic Workflows: Register now