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

This is the new 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

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 CloudFormation template, use the following syntax:

JSON

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

Properties

CredentialProviderConfigurations

The credential provider configurations.

Required: No

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

MetadataConfiguration

The metadata configuration for HTTP header and query parameter propagation to and from this gateway target.

Required: No

Type: MetadataConfiguration

Update requires: No interruption

Name

The name of the gateway target.

Required: Yes

Type: String

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

Update requires: No interruption

TargetConfiguration

The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.

Required: Yes

Type: TargetConfiguration

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the gateway identifier and target ID. For example:

my-gateway-a1b2c3d4e5|a1B2c3D4e5

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedAt

The date and time at which the target was created.

GatewayArn

The Amazon Resource Name (ARN) of the gateway target.

LastSynchronizedAt

The timestamp when the target was last synchronized.

Status

The status of the gateway target.

StatusReasons

The status reasons for the target status.

TargetId

The target ID.

UpdatedAt

The date and time at which the target was updated.