We recommend new projects start with resources from the AWS provider.
aws-native.bedrockagentcore.GatewayTarget
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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:
- Created
At string - Gateway
Arn string - Id string
- The provider-assigned unique ID for this managed resource.
- Status
Pulumi.
Aws Native. Bedrock Agent Core. Gateway Target Target Status - Status
Reasons List<string> - Target
Id string - Updated
At string
- Created
At string - Gateway
Arn string - Id string
- The provider-assigned unique ID for this managed resource.
- Status
Gateway
Target Target Status - Status
Reasons []string - Target
Id string - Updated
At string
- created
At String - gateway
Arn String - id String
- The provider-assigned unique ID for this managed resource.
- status
Gateway
Target Target Status - status
Reasons List<String> - target
Id String - updated
At String
- created
At string - gateway
Arn string - id string
- The provider-assigned unique ID for this managed resource.
- status
Gateway
Target Target Status - status
Reasons string[] - target
Id string - updated
At string
- created_
at str - gateway_
arn str - id str
- The provider-assigned unique ID for this managed resource.
- status
Gateway
Target Target Status - status_
reasons Sequence[str] - target_
id str - updated_
at str
- created
At String - gateway
Arn String - id String
- The provider-assigned unique ID for this managed resource.
- status "CREATING" | "UPDATING" | "UPDATE_UNSUCCESSFUL" | "DELETING" | "READY" | "FAILED"
- status
Reasons List<String> - target
Id String - updated
At String
Supporting Types
GatewayTargetApiKeyCredentialLocation, GatewayTargetApiKeyCredentialLocationArgs
- Header
- HEADER
- Query
Parameter - QUERY_PARAMETER
- Gateway
Target Api Key Credential Location Header - HEADER
- Gateway
Target Api Key Credential Location Query Parameter - QUERY_PARAMETER
- Header
- HEADER
- Query
Parameter - QUERY_PARAMETER
- Header
- HEADER
- Query
Parameter - QUERY_PARAMETER
- HEADER
- HEADER
- QUERY_PARAMETER
- QUERY_PARAMETER
- "HEADER"
- HEADER
- "QUERY_PARAMETER"
- QUERY_PARAMETER
GatewayTargetApiKeyCredentialProvider, GatewayTargetApiKeyCredentialProviderArgs
GatewayTargetApiSchemaConfiguration0Properties, GatewayTargetApiSchemaConfiguration0PropertiesArgs
GatewayTargetApiSchemaConfiguration1Properties, GatewayTargetApiSchemaConfiguration1PropertiesArgs
- Inline
Payload string
- Inline
Payload string
- inline
Payload String
- inline
Payload string
- inline_
payload str
- inline
Payload String
GatewayTargetCredentialProvider0Properties, GatewayTargetCredentialProvider0PropertiesArgs
GatewayTargetCredentialProvider1Properties, GatewayTargetCredentialProvider1PropertiesArgs
GatewayTargetCredentialProviderConfiguration, GatewayTargetCredentialProviderConfigurationArgs
GatewayTargetCredentialProviderType, GatewayTargetCredentialProviderTypeArgs
- Gateway
Iam Role - GATEWAY_IAM_ROLE
- Oauth
- OAUTH
- Api
Key - API_KEY
- Gateway
Target Credential Provider Type Gateway Iam Role - GATEWAY_IAM_ROLE
- Gateway
Target Credential Provider Type Oauth - OAUTH
- Gateway
Target Credential Provider Type Api Key - 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
- 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
- lambda
Arn String - tool
Schema Property Map | Property Map
GatewayTargetMcpTargetConfiguration0Properties, GatewayTargetMcpTargetConfiguration0PropertiesArgs
GatewayTargetMcpTargetConfiguration1Properties, GatewayTargetMcpTargetConfiguration1PropertiesArgs
GatewayTargetMcpTargetConfiguration2Properties, GatewayTargetMcpTargetConfiguration2PropertiesArgs
GatewayTargetOAuthCredentialProvider, GatewayTargetOAuthCredentialProviderArgs
- Provider
Arn string - Scopes List<string>
- Custom
Parameters Dictionary<string, string>
- Provider
Arn string - Scopes []string
- Custom
Parameters map[string]string
- provider
Arn String - scopes List<String>
- custom
Parameters Map<String,String>
- provider
Arn string - scopes string[]
- custom
Parameters {[key: string]: string}
- provider_
arn str - scopes Sequence[str]
- custom_
parameters Mapping[str, str]
- provider
Arn String - scopes List<String>
- custom
Parameters Map<String>
GatewayTargetS3Configuration, GatewayTargetS3ConfigurationArgs
- Bucket
Owner stringAccount Id - Uri string
- Bucket
Owner stringAccount Id - Uri string
- bucket
Owner StringAccount Id - uri String
- bucket
Owner stringAccount Id - uri string
- bucket_
owner_ straccount_ id - uri str
- bucket
Owner StringAccount Id - uri String
GatewayTargetSchemaDefinition, GatewayTargetSchemaDefinitionArgs
- Type
Pulumi.
Aws Native. Bedrock Agent Core. Gateway Target Schema Type - Description string
- Items
Pulumi.
Aws Native. Bedrock Agent Core. Inputs. Gateway Target Schema Definition - Properties
Dictionary<string, Pulumi.
Aws Native. Bedrock Agent Core. Inputs. Gateway Target Schema Definition> - Required List<string>
- Type
Gateway
Target Schema Type - Description string
- Items
Gateway
Target Schema Definition - Properties
map[string]Gateway
Target Schema Definition - Required []string
- type
Gateway
Target Schema Type - description String
- items
Gateway
Target Schema Definition - properties
Map<String,Gateway
Target Schema Definition> - required List<String>
- type
Gateway
Target Schema Type - description string
- items
Gateway
Target Schema Definition - properties
{[key: string]: Gateway
Target Schema Definition} - required string[]
- type
Gateway
Target Schema Type - description str
- items
Gateway
Target Schema Definition - properties
Mapping[str, Gateway
Target Schema Definition] - required Sequence[str]
- type "string" | "number" | "object" | "array" | "boolean" | "integer"
- description String
- items Property Map
- properties Map<Property Map>
- required List<String>
GatewayTargetSchemaType, GatewayTargetSchemaTypeArgs
- String
- string
- Number
- number
- Object
- object
- Array
- array
- Boolean
- boolean
- Integer
- integer
- Gateway
Target Schema Type String - string
- Gateway
Target Schema Type Number - number
- Gateway
Target Schema Type Object - object
- Gateway
Target Schema Type Array - array
- Gateway
Target Schema Type Boolean - boolean
- Gateway
Target Schema Type 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
- "string"
- string
- "number"
- number
- "object"
- object
- "array"
- array
- "boolean"
- boolean
- "integer"
- integer
GatewayTargetTargetConfigurationProperties, GatewayTargetTargetConfigurationPropertiesArgs
GatewayTargetTargetStatus, GatewayTargetTargetStatusArgs
- Creating
- CREATING
- Updating
- UPDATING
- Update
Unsuccessful - UPDATE_UNSUCCESSFUL
- Deleting
- DELETING
- Ready
- READY
- Failed
- FAILED
- Gateway
Target Target Status Creating - CREATING
- Gateway
Target Target Status Updating - UPDATING
- Gateway
Target Target Status Update Unsuccessful - UPDATE_UNSUCCESSFUL
- Gateway
Target Target Status Deleting - DELETING
- Gateway
Target Target Status Ready - READY
- Gateway
Target Target Status 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
- 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
- description String
- input
Schema Property Map - name String
- output
Schema Property Map
GatewayTargetToolSchema0Properties, GatewayTargetToolSchema0PropertiesArgs
GatewayTargetToolSchema1Properties, GatewayTargetToolSchema1PropertiesArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.