AWS::BedrockAgentCore::GatewayTarget - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::BedrockAgentCore::GatewayTarget

Note

Amazon Bedrock AgentCore is in preview release and is subject to change.

After creating a gateway, you can add targets, which define the tools that your gateway will host.

For more information about adding gateway targets, see Add targets to an existing gateway.

See the Properties section below for descriptions of both the required and optional properties.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::BedrockAgentCore::GatewayTarget",
  "Properties" : {
      "CredentialProviderConfigurations" : [ CredentialProviderConfiguration, ... ],
      "Description" : String,
      "GatewayIdentifier" : String,
      "Name" : String,
      "TargetConfiguration" : TargetConfiguration
    }
}

YAML

Type: AWS::BedrockAgentCore::GatewayTarget
Properties:
  CredentialProviderConfigurations: 
    - CredentialProviderConfiguration
  Description: String
  GatewayIdentifier: String
  Name: String
  TargetConfiguration: 
    TargetConfiguration

Properties

CredentialProviderConfigurations

The OAuth credential provider configuration.

Required: Yes

Type: Array of CredentialProviderConfiguration

Minimum: 1

Maximum: 1

Update requires: No interruption

Description

The description for the gateway target.

Required: No

Type: String

Minimum: 1

Maximum: 200

Update requires: No interruption

GatewayIdentifier

The gateway ID for the gateway target.

Required: No

Type: String

Pattern: ^([0-9a-z][-]?){1,100}-[0-9a-z]{10}$

Update requires: Replacement

Name

The name for the gateway target.

Required: Yes

Type: String

Pattern: ^([0-9a-zA-Z][-]?){1,100}$

Update requires: No interruption

TargetConfiguration

The target configuration for the Smithy model target.

Required: Yes

Type: TargetConfiguration

Update requires: No interruption

Return values

Ref

Fn::GetAtt

CreatedAt

The date and time at which the gateway target was created.

GatewayArn

Property description not available.

Status

The status for the gateway target.

StatusReasons

The status reasons for the gateway target.

TargetId

The target ID for the gateway target.

UpdatedAt

The time at which the resource was updated.