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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# Bedrock AgentCore
<a name="AWS_BedrockAgentCore"></a>

**Resource types**
+ [AWS::BedrockAgentCore::ApiKeyCredentialProvider](aws-resource-bedrockagentcore-apikeycredentialprovider.md)
+ [AWS::BedrockAgentCore::BrowserCustom](aws-resource-bedrockagentcore-browsercustom.md)
+ [AWS::BedrockAgentCore::BrowserProfile](aws-resource-bedrockagentcore-browserprofile.md)
+ [AWS::BedrockAgentCore::CodeInterpreterCustom](aws-resource-bedrockagentcore-codeinterpretercustom.md)
+ [AWS::BedrockAgentCore::Evaluator](aws-resource-bedrockagentcore-evaluator.md)
+ [AWS::BedrockAgentCore::Gateway](aws-resource-bedrockagentcore-gateway.md)
+ [AWS::BedrockAgentCore::GatewayTarget](aws-resource-bedrockagentcore-gatewaytarget.md)
+ [AWS::BedrockAgentCore::Memory](aws-resource-bedrockagentcore-memory.md)
+ [AWS::BedrockAgentCore::OAuth2CredentialProvider](aws-resource-bedrockagentcore-oauth2credentialprovider.md)
+ [AWS::BedrockAgentCore::OnlineEvaluationConfig](aws-resource-bedrockagentcore-onlineevaluationconfig.md)
+ [AWS::BedrockAgentCore::Policy](aws-resource-bedrockagentcore-policy.md)
+ [AWS::BedrockAgentCore::PolicyEngine](aws-resource-bedrockagentcore-policyengine.md)
+ [AWS::BedrockAgentCore::Runtime](aws-resource-bedrockagentcore-runtime.md)
+ [AWS::BedrockAgentCore::RuntimeEndpoint](aws-resource-bedrockagentcore-runtimeendpoint.md)
+ [AWS::BedrockAgentCore::WorkloadIdentity](aws-resource-bedrockagentcore-workloadidentity.md)

# AWS::BedrockAgentCore::ApiKeyCredentialProvider
<a name="aws-resource-bedrockagentcore-apikeycredentialprovider"></a>

Creates a new API key credential provider.

## Syntax
<a name="aws-resource-bedrockagentcore-apikeycredentialprovider-syntax"></a>

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

### JSON
<a name="aws-resource-bedrockagentcore-apikeycredentialprovider-syntax.json"></a>

```
{
  "Type" : "AWS::BedrockAgentCore::ApiKeyCredentialProvider",
  "Properties" : {
      "[ApiKey](#cfn-bedrockagentcore-apikeycredentialprovider-apikey)" : String,
      "[Name](#cfn-bedrockagentcore-apikeycredentialprovider-name)" : String,
      "[Tags](#cfn-bedrockagentcore-apikeycredentialprovider-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-bedrockagentcore-apikeycredentialprovider-syntax.yaml"></a>

```
Type: AWS::BedrockAgentCore::ApiKeyCredentialProvider
Properties:
  [ApiKey](#cfn-bedrockagentcore-apikeycredentialprovider-apikey): String
  [Name](#cfn-bedrockagentcore-apikeycredentialprovider-name): String
  [Tags](#cfn-bedrockagentcore-apikeycredentialprovider-tags): 
    - Tag
```

## Properties
<a name="aws-resource-bedrockagentcore-apikeycredentialprovider-properties"></a>

`ApiKey`  <a name="cfn-bedrockagentcore-apikeycredentialprovider-apikey"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `65536`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-bedrockagentcore-apikeycredentialprovider-name"></a>
The name of the API key credential provider.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9\-_]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-bedrockagentcore-apikeycredentialprovider-tags"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-bedrockagentcore-apikeycredentialprovider-tag.md)  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-bedrockagentcore-apikeycredentialprovider-return-values"></a>

### Ref
<a name="aws-resource-bedrockagentcore-apikeycredentialprovider-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-bedrockagentcore-apikeycredentialprovider-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-bedrockagentcore-apikeycredentialprovider-return-values-fn--getatt-fn--getatt"></a>

`CreatedTime`  <a name="CreatedTime-fn::getatt"></a>
The timestamp when the API key credential provider was created.

`CredentialProviderArn`  <a name="CredentialProviderArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the API key credential provider.

`LastUpdatedTime`  <a name="LastUpdatedTime-fn::getatt"></a>
The timestamp when the API key credential provider was last updated.

# AWS::BedrockAgentCore::ApiKeyCredentialProvider ApiKeySecretArn
<a name="aws-properties-bedrockagentcore-apikeycredentialprovider-apikeysecretarn"></a>

<a name="aws-properties-bedrockagentcore-apikeycredentialprovider-apikeysecretarn-description"></a>The `ApiKeySecretArn` property type specifies Property description not available. for an [AWS::BedrockAgentCore::ApiKeyCredentialProvider](aws-resource-bedrockagentcore-apikeycredentialprovider.md).

## Syntax
<a name="aws-properties-bedrockagentcore-apikeycredentialprovider-apikeysecretarn-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-apikeycredentialprovider-apikeysecretarn-syntax.json"></a>

```
{
  "[SecretArn](#cfn-bedrockagentcore-apikeycredentialprovider-apikeysecretarn-secretarn)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-apikeycredentialprovider-apikeysecretarn-syntax.yaml"></a>

```
  [SecretArn](#cfn-bedrockagentcore-apikeycredentialprovider-apikeysecretarn-secretarn): String
```

## Properties
<a name="aws-properties-bedrockagentcore-apikeycredentialprovider-apikeysecretarn-properties"></a>

`SecretArn`  <a name="cfn-bedrockagentcore-apikeycredentialprovider-apikeysecretarn-secretarn"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:(aws|aws-us-gov):secretsmanager:[A-Za-z0-9-]{1,64}:[0-9]{12}:secret:[a-zA-Z0-9-_/+=.@!]+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::ApiKeyCredentialProvider Tag
<a name="aws-properties-bedrockagentcore-apikeycredentialprovider-tag"></a>

<a name="aws-properties-bedrockagentcore-apikeycredentialprovider-tag-description"></a>The `Tag` property type specifies Property description not available. for an [AWS::BedrockAgentCore::ApiKeyCredentialProvider](aws-resource-bedrockagentcore-apikeycredentialprovider.md).

## Syntax
<a name="aws-properties-bedrockagentcore-apikeycredentialprovider-tag-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-apikeycredentialprovider-tag-syntax.json"></a>

```
{
  "[Key](#cfn-bedrockagentcore-apikeycredentialprovider-tag-key)" : String,
  "[Value](#cfn-bedrockagentcore-apikeycredentialprovider-tag-value)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-apikeycredentialprovider-tag-syntax.yaml"></a>

```
  [Key](#cfn-bedrockagentcore-apikeycredentialprovider-tag-key): String
  [Value](#cfn-bedrockagentcore-apikeycredentialprovider-tag-value): String
```

## Properties
<a name="aws-properties-bedrockagentcore-apikeycredentialprovider-tag-properties"></a>

`Key`  <a name="cfn-bedrockagentcore-apikeycredentialprovider-tag-key"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-bedrockagentcore-apikeycredentialprovider-tag-value"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::BrowserCustom
<a name="aws-resource-bedrockagentcore-browsercustom"></a>

AgentCore Browser tool provides a fast, secure, cloud-based browser runtime to enable AI agents to interact with websites at scale.

For more information about using the custom browser, see [Interact with web applications using Amazon Bedrock AgentCore Browser](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/browser-tool.html).

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

## Syntax
<a name="aws-resource-bedrockagentcore-browsercustom-syntax"></a>

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

### JSON
<a name="aws-resource-bedrockagentcore-browsercustom-syntax.json"></a>

```
{
  "Type" : "AWS::BedrockAgentCore::BrowserCustom",
  "Properties" : {
      "[BrowserSigning](#cfn-bedrockagentcore-browsercustom-browsersigning)" : BrowserSigning,
      "[Description](#cfn-bedrockagentcore-browsercustom-description)" : String,
      "[ExecutionRoleArn](#cfn-bedrockagentcore-browsercustom-executionrolearn)" : String,
      "[Name](#cfn-bedrockagentcore-browsercustom-name)" : String,
      "[NetworkConfiguration](#cfn-bedrockagentcore-browsercustom-networkconfiguration)" : BrowserNetworkConfiguration,
      "[RecordingConfig](#cfn-bedrockagentcore-browsercustom-recordingconfig)" : RecordingConfig,
      "[Tags](#cfn-bedrockagentcore-browsercustom-tags)" : {Key: Value, ...}
    }
}
```

### YAML
<a name="aws-resource-bedrockagentcore-browsercustom-syntax.yaml"></a>

```
Type: AWS::BedrockAgentCore::BrowserCustom
Properties:
  [BrowserSigning](#cfn-bedrockagentcore-browsercustom-browsersigning): 
    BrowserSigning
  [Description](#cfn-bedrockagentcore-browsercustom-description): String
  [ExecutionRoleArn](#cfn-bedrockagentcore-browsercustom-executionrolearn): String
  [Name](#cfn-bedrockagentcore-browsercustom-name): String
  [NetworkConfiguration](#cfn-bedrockagentcore-browsercustom-networkconfiguration): 
    BrowserNetworkConfiguration
  [RecordingConfig](#cfn-bedrockagentcore-browsercustom-recordingconfig): 
    RecordingConfig
  [Tags](#cfn-bedrockagentcore-browsercustom-tags): 
    Key: Value
```

## Properties
<a name="aws-resource-bedrockagentcore-browsercustom-properties"></a>

`BrowserSigning`  <a name="cfn-bedrockagentcore-browsercustom-browsersigning"></a>
The browser signing configuration that enables cryptographic agent identification using HTTP message signatures for web bot authentication.  
*Required*: No  
*Type*: [BrowserSigning](aws-properties-bedrockagentcore-browsercustom-browsersigning.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Description`  <a name="cfn-bedrockagentcore-browsercustom-description"></a>
The description of the browser.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ExecutionRoleArn`  <a name="cfn-bedrockagentcore-browsercustom-executionrolearn"></a>
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the browser to access AWS services.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:(aws(?:-cn|-us-gov|-iso(?:-[bef])?)?):iam::[0-9]{12}:role/.+$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-bedrockagentcore-browsercustom-name"></a>
The name of the browser. The name must be unique within your account.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`NetworkConfiguration`  <a name="cfn-bedrockagentcore-browsercustom-networkconfiguration"></a>
The network configuration for the browser. This configuration specifies the network mode for the browser.  
*Required*: Yes  
*Type*: [BrowserNetworkConfiguration](aws-properties-bedrockagentcore-browsercustom-browsernetworkconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RecordingConfig`  <a name="cfn-bedrockagentcore-browsercustom-recordingconfig"></a>
The recording configuration for the browser. When enabled, browser sessions are recorded and stored in the specified Amazon S3 location.  
*Required*: No  
*Type*: [RecordingConfig](aws-properties-bedrockagentcore-browsercustom-recordingconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-bedrockagentcore-browsercustom-tags"></a>
A map of tag keys and values to assign to the browser. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-bedrockagentcore-browsercustom-return-values"></a>

### Ref
<a name="aws-resource-bedrockagentcore-browsercustom-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the custom browser. For example:

 `arn:aws:bedrock-agentcore:us-east-1:123456789012:browser-custom/MyBrowser-a1b2c3d4e5` 

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-bedrockagentcore-browsercustom-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-bedrockagentcore-browsercustom-return-values-fn--getatt-fn--getatt"></a>

`BrowserArn`  <a name="BrowserArn-fn::getatt"></a>
The ARN for the custom browser.

`BrowserId`  <a name="BrowserId-fn::getatt"></a>
The ID for the custom browser.

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
The time at which the custom browser was created.

`FailureReason`  <a name="FailureReason-fn::getatt"></a>
The reason for failure if the browser is in a failed state.

`LastUpdatedAt`  <a name="LastUpdatedAt-fn::getatt"></a>
The time at which the custom browser was last updated.

`Status`  <a name="Status-fn::getatt"></a>
The status of the custom browser.

# AWS::BedrockAgentCore::BrowserCustom BrowserNetworkConfiguration
<a name="aws-properties-bedrockagentcore-browsercustom-browsernetworkconfiguration"></a>

The network configuration for a browser. This structure defines how the browser connects to the network.

## Syntax
<a name="aws-properties-bedrockagentcore-browsercustom-browsernetworkconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-browsercustom-browsernetworkconfiguration-syntax.json"></a>

```
{
  "[NetworkMode](#cfn-bedrockagentcore-browsercustom-browsernetworkconfiguration-networkmode)" : String,
  "[VpcConfig](#cfn-bedrockagentcore-browsercustom-browsernetworkconfiguration-vpcconfig)" : VpcConfig
}
```

### YAML
<a name="aws-properties-bedrockagentcore-browsercustom-browsernetworkconfiguration-syntax.yaml"></a>

```
  [NetworkMode](#cfn-bedrockagentcore-browsercustom-browsernetworkconfiguration-networkmode): String
  [VpcConfig](#cfn-bedrockagentcore-browsercustom-browsernetworkconfiguration-vpcconfig): 
    VpcConfig
```

## Properties
<a name="aws-properties-bedrockagentcore-browsercustom-browsernetworkconfiguration-properties"></a>

`NetworkMode`  <a name="cfn-bedrockagentcore-browsercustom-browsernetworkconfiguration-networkmode"></a>
The network mode for the browser. This field specifies how the browser connects to the network.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `PUBLIC | VPC`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`VpcConfig`  <a name="cfn-bedrockagentcore-browsercustom-browsernetworkconfiguration-vpcconfig"></a>
The network mode configuration for the AgentCore Runtime.  
*Required*: No  
*Type*: [VpcConfig](aws-properties-bedrockagentcore-browsercustom-vpcconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::BedrockAgentCore::BrowserCustom BrowserSigning
<a name="aws-properties-bedrockagentcore-browsercustom-browsersigning"></a>

Configuration for enabling browser signing capabilities that allow agents to cryptographically identify themselves to websites using HTTP message signatures.

## Syntax
<a name="aws-properties-bedrockagentcore-browsercustom-browsersigning-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-browsercustom-browsersigning-syntax.json"></a>

```
{
  "[Enabled](#cfn-bedrockagentcore-browsercustom-browsersigning-enabled)" : Boolean
}
```

### YAML
<a name="aws-properties-bedrockagentcore-browsercustom-browsersigning-syntax.yaml"></a>

```
  [Enabled](#cfn-bedrockagentcore-browsercustom-browsersigning-enabled): Boolean
```

## Properties
<a name="aws-properties-bedrockagentcore-browsercustom-browsersigning-properties"></a>

`Enabled`  <a name="cfn-bedrockagentcore-browsercustom-browsersigning-enabled"></a>
Specifies whether browser signing is enabled. When enabled, the browser will cryptographically sign HTTP requests to identify itself as an AI agent to bot control vendors.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::BedrockAgentCore::BrowserCustom RecordingConfig
<a name="aws-properties-bedrockagentcore-browsercustom-recordingconfig"></a>

The recording configuration for a browser. This structure defines how browser sessions are recorded.

## Syntax
<a name="aws-properties-bedrockagentcore-browsercustom-recordingconfig-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-browsercustom-recordingconfig-syntax.json"></a>

```
{
  "[Enabled](#cfn-bedrockagentcore-browsercustom-recordingconfig-enabled)" : Boolean,
  "[S3Location](#cfn-bedrockagentcore-browsercustom-recordingconfig-s3location)" : S3Location
}
```

### YAML
<a name="aws-properties-bedrockagentcore-browsercustom-recordingconfig-syntax.yaml"></a>

```
  [Enabled](#cfn-bedrockagentcore-browsercustom-recordingconfig-enabled): Boolean
  [S3Location](#cfn-bedrockagentcore-browsercustom-recordingconfig-s3location): 
    S3Location
```

## Properties
<a name="aws-properties-bedrockagentcore-browsercustom-recordingconfig-properties"></a>

`Enabled`  <a name="cfn-bedrockagentcore-browsercustom-recordingconfig-enabled"></a>
Indicates whether recording is enabled for the browser. When set to true, browser sessions are recorded.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`S3Location`  <a name="cfn-bedrockagentcore-browsercustom-recordingconfig-s3location"></a>
The Amazon S3 location where browser recordings are stored. This location contains the recorded browser sessions.  
*Required*: No  
*Type*: [S3Location](aws-properties-bedrockagentcore-browsercustom-s3location.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::BedrockAgentCore::BrowserCustom S3Location
<a name="aws-properties-bedrockagentcore-browsercustom-s3location"></a>

The Amazon S3 location for storing data. This structure defines where in Amazon S3 data is stored.

## Syntax
<a name="aws-properties-bedrockagentcore-browsercustom-s3location-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-browsercustom-s3location-syntax.json"></a>

```
{
  "[Bucket](#cfn-bedrockagentcore-browsercustom-s3location-bucket)" : String,
  "[Prefix](#cfn-bedrockagentcore-browsercustom-s3location-prefix)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-browsercustom-s3location-syntax.yaml"></a>

```
  [Bucket](#cfn-bedrockagentcore-browsercustom-s3location-bucket): String
  [Prefix](#cfn-bedrockagentcore-browsercustom-s3location-prefix): String
```

## Properties
<a name="aws-properties-bedrockagentcore-browsercustom-s3location-properties"></a>

`Bucket`  <a name="cfn-bedrockagentcore-browsercustom-s3location-bucket"></a>
The name of the Amazon S3 bucket. This bucket contains the stored data.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Prefix`  <a name="cfn-bedrockagentcore-browsercustom-s3location-prefix"></a>
The prefix for objects in the Amazon S3 bucket. This prefix is added to the object keys to organize the data.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::BedrockAgentCore::BrowserCustom VpcConfig
<a name="aws-properties-bedrockagentcore-browsercustom-vpcconfig"></a>

VpcConfig for the Agent.

## Syntax
<a name="aws-properties-bedrockagentcore-browsercustom-vpcconfig-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-browsercustom-vpcconfig-syntax.json"></a>

```
{
  "[SecurityGroups](#cfn-bedrockagentcore-browsercustom-vpcconfig-securitygroups)" : [ String, ... ],
  "[Subnets](#cfn-bedrockagentcore-browsercustom-vpcconfig-subnets)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-bedrockagentcore-browsercustom-vpcconfig-syntax.yaml"></a>

```
  [SecurityGroups](#cfn-bedrockagentcore-browsercustom-vpcconfig-securitygroups): 
    - String
  [Subnets](#cfn-bedrockagentcore-browsercustom-vpcconfig-subnets): 
    - String
```

## Properties
<a name="aws-properties-bedrockagentcore-browsercustom-vpcconfig-properties"></a>

`SecurityGroups`  <a name="cfn-bedrockagentcore-browsercustom-vpcconfig-securitygroups"></a>
The security groups associated with the VPC configuration.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `16`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Subnets`  <a name="cfn-bedrockagentcore-browsercustom-vpcconfig-subnets"></a>
The subnets associated with the VPC configuration.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `16`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::BedrockAgentCore::BrowserProfile
<a name="aws-resource-bedrockagentcore-browserprofile"></a>

Specifies a browser profile for Amazon Bedrock AgentCore. A browser profile stores persistent browser session data, including cookies, local storage, session storage, and browsing history, enabling AI agents to maintain authenticated sessions and reuse browser state across multiple browser sessions.

For more information, see [Manage browser profiles in Amazon Bedrock AgentCore](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/browser-profiles.html).

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

## Syntax
<a name="aws-resource-bedrockagentcore-browserprofile-syntax"></a>

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

### JSON
<a name="aws-resource-bedrockagentcore-browserprofile-syntax.json"></a>

```
{
  "Type" : "AWS::BedrockAgentCore::BrowserProfile",
  "Properties" : {
      "[Description](#cfn-bedrockagentcore-browserprofile-description)" : String,
      "[Name](#cfn-bedrockagentcore-browserprofile-name)" : String,
      "[Tags](#cfn-bedrockagentcore-browserprofile-tags)" : {Key: Value, ...}
    }
}
```

### YAML
<a name="aws-resource-bedrockagentcore-browserprofile-syntax.yaml"></a>

```
Type: AWS::BedrockAgentCore::BrowserProfile
Properties:
  [Description](#cfn-bedrockagentcore-browserprofile-description): String
  [Name](#cfn-bedrockagentcore-browserprofile-name): String
  [Tags](#cfn-bedrockagentcore-browserprofile-tags): 
    Key: Value
```

## Properties
<a name="aws-resource-bedrockagentcore-browserprofile-properties"></a>

`Description`  <a name="cfn-bedrockagentcore-browserprofile-description"></a>
The description of the browser profile.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-bedrockagentcore-browserprofile-name"></a>
The name of the browser profile.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,47}$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-bedrockagentcore-browserprofile-tags"></a>
The tags for the browser profile.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-bedrockagentcore-browserprofile-return-values"></a>

### Ref
<a name="aws-resource-bedrockagentcore-browserprofile-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the browser profile. For example:

 `arn:aws:bedrock-agentcore:us-east-1:123456789012:browser-profile/MyBrowserProfile-a1b2c3d4e5` 

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-bedrockagentcore-browserprofile-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-bedrockagentcore-browserprofile-return-values-fn--getatt-fn--getatt"></a>

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
The timestamp when the browser profile was created.

`LastSavedAt`  <a name="LastSavedAt-fn::getatt"></a>
The timestamp when browser session data was last saved to this profile.

`LastSavedBrowserId`  <a name="LastSavedBrowserId-fn::getatt"></a>
The identifier of the browser from which data was last saved to this profile.

`LastSavedBrowserSessionId`  <a name="LastSavedBrowserSessionId-fn::getatt"></a>
The identifier of the browser session from which data was last saved to this profile.

`LastUpdatedAt`  <a name="LastUpdatedAt-fn::getatt"></a>
The timestamp when the browser profile was last updated.

`ProfileArn`  <a name="ProfileArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the browser profile.

`ProfileId`  <a name="ProfileId-fn::getatt"></a>
The unique identifier of the browser profile.

`Status`  <a name="Status-fn::getatt"></a>
The current status of the browser profile.

# AWS::BedrockAgentCore::CodeInterpreterCustom
<a name="aws-resource-bedrockagentcore-codeinterpretercustom"></a>

The AgentCore Code Interpreter tool enables agents to securely execute code in isolated sandbox environments. It offers advanced configuration support and seamless integration with popular frameworks.

For more information about using the custom code interpreter, see [Execute code and analyze data using Amazon Bedrock AgentCore Code Interpreter](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/code-interpreter-tool.html).

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

## Syntax
<a name="aws-resource-bedrockagentcore-codeinterpretercustom-syntax"></a>

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

### JSON
<a name="aws-resource-bedrockagentcore-codeinterpretercustom-syntax.json"></a>

```
{
  "Type" : "AWS::BedrockAgentCore::CodeInterpreterCustom",
  "Properties" : {
      "[Description](#cfn-bedrockagentcore-codeinterpretercustom-description)" : String,
      "[ExecutionRoleArn](#cfn-bedrockagentcore-codeinterpretercustom-executionrolearn)" : String,
      "[Name](#cfn-bedrockagentcore-codeinterpretercustom-name)" : String,
      "[NetworkConfiguration](#cfn-bedrockagentcore-codeinterpretercustom-networkconfiguration)" : CodeInterpreterNetworkConfiguration,
      "[Tags](#cfn-bedrockagentcore-codeinterpretercustom-tags)" : {Key: Value, ...}
    }
}
```

### YAML
<a name="aws-resource-bedrockagentcore-codeinterpretercustom-syntax.yaml"></a>

```
Type: AWS::BedrockAgentCore::CodeInterpreterCustom
Properties:
  [Description](#cfn-bedrockagentcore-codeinterpretercustom-description): String
  [ExecutionRoleArn](#cfn-bedrockagentcore-codeinterpretercustom-executionrolearn): String
  [Name](#cfn-bedrockagentcore-codeinterpretercustom-name): String
  [NetworkConfiguration](#cfn-bedrockagentcore-codeinterpretercustom-networkconfiguration): 
    CodeInterpreterNetworkConfiguration
  [Tags](#cfn-bedrockagentcore-codeinterpretercustom-tags): 
    Key: Value
```

## Properties
<a name="aws-resource-bedrockagentcore-codeinterpretercustom-properties"></a>

`Description`  <a name="cfn-bedrockagentcore-codeinterpretercustom-description"></a>
The description of the code interpreter.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ExecutionRoleArn`  <a name="cfn-bedrockagentcore-codeinterpretercustom-executionrolearn"></a>
The IAM role ARN that provides permissions for the code interpreter.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:(aws(?:-cn|-us-gov|-iso(?:-[bef])?)?):iam::[0-9]{12}:role/.+$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-bedrockagentcore-codeinterpretercustom-name"></a>
The name of the code interpreter.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`NetworkConfiguration`  <a name="cfn-bedrockagentcore-codeinterpretercustom-networkconfiguration"></a>
The network configuration for a code interpreter. This structure defines how the code interpreter connects to the network.  
*Required*: Yes  
*Type*: [CodeInterpreterNetworkConfiguration](aws-properties-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-bedrockagentcore-codeinterpretercustom-tags"></a>
A map of tag keys and values to assign to the browser. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-bedrockagentcore-codeinterpretercustom-return-values"></a>

### Ref
<a name="aws-resource-bedrockagentcore-codeinterpretercustom-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the custom code interpreter. For example:

 `arn:aws:bedrock-agentcore:us-east-1:123456789012:code-interpreter-custom/MyCodeInterpreter-a1b2c3d4e5` 

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-bedrockagentcore-codeinterpretercustom-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-bedrockagentcore-codeinterpretercustom-return-values-fn--getatt-fn--getatt"></a>

`CodeInterpreterArn`  <a name="CodeInterpreterArn-fn::getatt"></a>
The code interpreter Amazon Resource Name (ARN).

`CodeInterpreterId`  <a name="CodeInterpreterId-fn::getatt"></a>
The unique identifier of the created code interpreter.

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
The timestamp when the code interpreter was created.

`FailureReason`  <a name="FailureReason-fn::getatt"></a>
The reason for failure if the code interpreter is in a failed state.

`LastUpdatedAt`  <a name="LastUpdatedAt-fn::getatt"></a>
The time at which the code interpreter was last updated.

`Status`  <a name="Status-fn::getatt"></a>
The status of the custom code interpreter.

# AWS::BedrockAgentCore::CodeInterpreterCustom CodeInterpreterNetworkConfiguration
<a name="aws-properties-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration"></a>

The network configuration for a code interpreter. This structure defines how the code interpreter connects to the network.

## Syntax
<a name="aws-properties-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration-syntax.json"></a>

```
{
  "[NetworkMode](#cfn-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration-networkmode)" : String,
  "[VpcConfig](#cfn-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration-vpcconfig)" : VpcConfig
}
```

### YAML
<a name="aws-properties-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration-syntax.yaml"></a>

```
  [NetworkMode](#cfn-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration-networkmode): String
  [VpcConfig](#cfn-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration-vpcconfig): 
    VpcConfig
```

## Properties
<a name="aws-properties-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration-properties"></a>

`NetworkMode`  <a name="cfn-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration-networkmode"></a>
The network mode for the code interpreter. This field specifies how the code interpreter connects to the network.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `PUBLIC | SANDBOX | VPC`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`VpcConfig`  <a name="cfn-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration-vpcconfig"></a>
The network mode configuration for the AgentCore Runtime.  
*Required*: No  
*Type*: [VpcConfig](aws-properties-bedrockagentcore-codeinterpretercustom-vpcconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::BedrockAgentCore::CodeInterpreterCustom VpcConfig
<a name="aws-properties-bedrockagentcore-codeinterpretercustom-vpcconfig"></a>

VpcConfig for the Agent.

## Syntax
<a name="aws-properties-bedrockagentcore-codeinterpretercustom-vpcconfig-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-codeinterpretercustom-vpcconfig-syntax.json"></a>

```
{
  "[SecurityGroups](#cfn-bedrockagentcore-codeinterpretercustom-vpcconfig-securitygroups)" : [ String, ... ],
  "[Subnets](#cfn-bedrockagentcore-codeinterpretercustom-vpcconfig-subnets)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-bedrockagentcore-codeinterpretercustom-vpcconfig-syntax.yaml"></a>

```
  [SecurityGroups](#cfn-bedrockagentcore-codeinterpretercustom-vpcconfig-securitygroups): 
    - String
  [Subnets](#cfn-bedrockagentcore-codeinterpretercustom-vpcconfig-subnets): 
    - String
```

## Properties
<a name="aws-properties-bedrockagentcore-codeinterpretercustom-vpcconfig-properties"></a>

`SecurityGroups`  <a name="cfn-bedrockagentcore-codeinterpretercustom-vpcconfig-securitygroups"></a>
The security groups associated with the VPC configuration.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `16`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Subnets`  <a name="cfn-bedrockagentcore-codeinterpretercustom-vpcconfig-subnets"></a>
The subnets associated with the VPC configuration.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `16`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::BedrockAgentCore::Evaluator
<a name="aws-resource-bedrockagentcore-evaluator"></a>

Specifies an evaluator for Amazon Bedrock AgentCore. An evaluator assesses agent quality using LLM-as-a-Judge configurations to measure and improve agent performance.

For more information, see [Evaluate agent quality with Amazon Bedrock AgentCore](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/evaluators.html).

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

## Syntax
<a name="aws-resource-bedrockagentcore-evaluator-syntax"></a>

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

### JSON
<a name="aws-resource-bedrockagentcore-evaluator-syntax.json"></a>

```
{
  "Type" : "AWS::BedrockAgentCore::Evaluator",
  "Properties" : {
      "[Description](#cfn-bedrockagentcore-evaluator-description)" : String,
      "[EvaluatorConfig](#cfn-bedrockagentcore-evaluator-evaluatorconfig)" : EvaluatorConfig,
      "[EvaluatorName](#cfn-bedrockagentcore-evaluator-evaluatorname)" : String,
      "[Level](#cfn-bedrockagentcore-evaluator-level)" : String,
      "[Tags](#cfn-bedrockagentcore-evaluator-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-bedrockagentcore-evaluator-syntax.yaml"></a>

```
Type: AWS::BedrockAgentCore::Evaluator
Properties:
  [Description](#cfn-bedrockagentcore-evaluator-description): String
  [EvaluatorConfig](#cfn-bedrockagentcore-evaluator-evaluatorconfig): 
    EvaluatorConfig
  [EvaluatorName](#cfn-bedrockagentcore-evaluator-evaluatorname): String
  [Level](#cfn-bedrockagentcore-evaluator-level): String
  [Tags](#cfn-bedrockagentcore-evaluator-tags): 
    - Tag
```

## Properties
<a name="aws-resource-bedrockagentcore-evaluator-properties"></a>

`Description`  <a name="cfn-bedrockagentcore-evaluator-description"></a>
 The description of the evaluator.   
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EvaluatorConfig`  <a name="cfn-bedrockagentcore-evaluator-evaluatorconfig"></a>
 The configuration of the evaluator, including LLM-as-a-Judge settings for custom evaluators.   
*Required*: Yes  
*Type*: [EvaluatorConfig](aws-properties-bedrockagentcore-evaluator-evaluatorconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EvaluatorName`  <a name="cfn-bedrockagentcore-evaluator-evaluatorname"></a>
 The name of the evaluator.   
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,47}$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Level`  <a name="cfn-bedrockagentcore-evaluator-level"></a>
 The evaluation level (`TOOL_CALL`, `TRACE`, or `SESSION`) that determines the scope of evaluation.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `TOOL_CALL | TRACE | SESSION`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-bedrockagentcore-evaluator-tags"></a>
The tags for the evaluator.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-bedrockagentcore-evaluator-tag.md)  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-bedrockagentcore-evaluator-return-values"></a>

### Ref
<a name="aws-resource-bedrockagentcore-evaluator-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the evaluator. For example:

 `arn:aws:bedrock-agentcore:us-east-1:123456789012:evaluator/EXAMPLE12345` 

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-bedrockagentcore-evaluator-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-bedrockagentcore-evaluator-return-values-fn--getatt-fn--getatt"></a>

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
The timestamp when the evaluator was created.

`EvaluatorArn`  <a name="EvaluatorArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the evaluator.

`EvaluatorId`  <a name="EvaluatorId-fn::getatt"></a>
The unique identifier of the evaluator.

`Status`  <a name="Status-fn::getatt"></a>
The current status of the evaluator.

`UpdatedAt`  <a name="UpdatedAt-fn::getatt"></a>
The timestamp when the evaluator was last updated.

# AWS::BedrockAgentCore::Evaluator BedrockEvaluatorModelConfig
<a name="aws-properties-bedrockagentcore-evaluator-bedrockevaluatormodelconfig"></a>

 The Amazon Bedrock model configuration for evaluation. 

## Syntax
<a name="aws-properties-bedrockagentcore-evaluator-bedrockevaluatormodelconfig-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-evaluator-bedrockevaluatormodelconfig-syntax.json"></a>

```
{
  "[AdditionalModelRequestFields](#cfn-bedrockagentcore-evaluator-bedrockevaluatormodelconfig-additionalmodelrequestfields)" : Json,
  "[InferenceConfig](#cfn-bedrockagentcore-evaluator-bedrockevaluatormodelconfig-inferenceconfig)" : InferenceConfiguration,
  "[ModelId](#cfn-bedrockagentcore-evaluator-bedrockevaluatormodelconfig-modelid)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-evaluator-bedrockevaluatormodelconfig-syntax.yaml"></a>

```
  [AdditionalModelRequestFields](#cfn-bedrockagentcore-evaluator-bedrockevaluatormodelconfig-additionalmodelrequestfields): Json
  [InferenceConfig](#cfn-bedrockagentcore-evaluator-bedrockevaluatormodelconfig-inferenceconfig): 
    InferenceConfiguration
  [ModelId](#cfn-bedrockagentcore-evaluator-bedrockevaluatormodelconfig-modelid): String
```

## Properties
<a name="aws-properties-bedrockagentcore-evaluator-bedrockevaluatormodelconfig-properties"></a>

`AdditionalModelRequestFields`  <a name="cfn-bedrockagentcore-evaluator-bedrockevaluatormodelconfig-additionalmodelrequestfields"></a>
 Additional model-specific request fields to customize model behavior beyond the standard inference configuration.   
*Required*: No  
*Type*: Json  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InferenceConfig`  <a name="cfn-bedrockagentcore-evaluator-bedrockevaluatormodelconfig-inferenceconfig"></a>
 The inference configuration parameters that control model behavior during evaluation, including temperature, token limits, and sampling settings.   
*Required*: No  
*Type*: [InferenceConfiguration](aws-properties-bedrockagentcore-evaluator-inferenceconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelId`  <a name="cfn-bedrockagentcore-evaluator-bedrockevaluatormodelconfig-modelid"></a>
 The identifier of the Amazon Bedrock model to use for evaluation. Must be a supported foundation model available in your region.   
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Evaluator CategoricalScaleDefinition
<a name="aws-properties-bedrockagentcore-evaluator-categoricalscaledefinition"></a>

 The definition of a categorical rating scale option that provides a named category with its description for evaluation scoring. 

## Syntax
<a name="aws-properties-bedrockagentcore-evaluator-categoricalscaledefinition-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-evaluator-categoricalscaledefinition-syntax.json"></a>

```
{
  "[Definition](#cfn-bedrockagentcore-evaluator-categoricalscaledefinition-definition)" : String,
  "[Label](#cfn-bedrockagentcore-evaluator-categoricalscaledefinition-label)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-evaluator-categoricalscaledefinition-syntax.yaml"></a>

```
  [Definition](#cfn-bedrockagentcore-evaluator-categoricalscaledefinition-definition): String
  [Label](#cfn-bedrockagentcore-evaluator-categoricalscaledefinition-label): String
```

## Properties
<a name="aws-properties-bedrockagentcore-evaluator-categoricalscaledefinition-properties"></a>

`Definition`  <a name="cfn-bedrockagentcore-evaluator-categoricalscaledefinition-definition"></a>
 The description that explains what this categorical rating represents and when it should be used.   
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Label`  <a name="cfn-bedrockagentcore-evaluator-categoricalscaledefinition-label"></a>
 The label or name of this categorical rating option.   
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Evaluator CodeBasedEvaluatorConfig
<a name="aws-properties-bedrockagentcore-evaluator-codebasedevaluatorconfig"></a>

<a name="aws-properties-bedrockagentcore-evaluator-codebasedevaluatorconfig-description"></a>The `CodeBasedEvaluatorConfig` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Evaluator](aws-resource-bedrockagentcore-evaluator.md).

## Syntax
<a name="aws-properties-bedrockagentcore-evaluator-codebasedevaluatorconfig-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-evaluator-codebasedevaluatorconfig-syntax.json"></a>

```
{
  "[LambdaConfig](#cfn-bedrockagentcore-evaluator-codebasedevaluatorconfig-lambdaconfig)" : LambdaEvaluatorConfig
}
```

### YAML
<a name="aws-properties-bedrockagentcore-evaluator-codebasedevaluatorconfig-syntax.yaml"></a>

```
  [LambdaConfig](#cfn-bedrockagentcore-evaluator-codebasedevaluatorconfig-lambdaconfig): 
    LambdaEvaluatorConfig
```

## Properties
<a name="aws-properties-bedrockagentcore-evaluator-codebasedevaluatorconfig-properties"></a>

`LambdaConfig`  <a name="cfn-bedrockagentcore-evaluator-codebasedevaluatorconfig-lambdaconfig"></a>
Property description not available.  
*Required*: Yes  
*Type*: [LambdaEvaluatorConfig](aws-properties-bedrockagentcore-evaluator-lambdaevaluatorconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Evaluator EvaluatorConfig
<a name="aws-properties-bedrockagentcore-evaluator-evaluatorconfig"></a>

 The configuration of the evaluator, including LLM-as-a-Judge settings for custom evaluators. 

## Syntax
<a name="aws-properties-bedrockagentcore-evaluator-evaluatorconfig-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-evaluator-evaluatorconfig-syntax.json"></a>

```
{
  "[CodeBased](#cfn-bedrockagentcore-evaluator-evaluatorconfig-codebased)" : CodeBasedEvaluatorConfig,
  "[LlmAsAJudge](#cfn-bedrockagentcore-evaluator-evaluatorconfig-llmasajudge)" : LlmAsAJudgeEvaluatorConfig
}
```

### YAML
<a name="aws-properties-bedrockagentcore-evaluator-evaluatorconfig-syntax.yaml"></a>

```
  [CodeBased](#cfn-bedrockagentcore-evaluator-evaluatorconfig-codebased): 
    CodeBasedEvaluatorConfig
  [LlmAsAJudge](#cfn-bedrockagentcore-evaluator-evaluatorconfig-llmasajudge): 
    LlmAsAJudgeEvaluatorConfig
```

## Properties
<a name="aws-properties-bedrockagentcore-evaluator-evaluatorconfig-properties"></a>

`CodeBased`  <a name="cfn-bedrockagentcore-evaluator-evaluatorconfig-codebased"></a>
Property description not available.  
*Required*: No  
*Type*: [CodeBasedEvaluatorConfig](aws-properties-bedrockagentcore-evaluator-codebasedevaluatorconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LlmAsAJudge`  <a name="cfn-bedrockagentcore-evaluator-evaluatorconfig-llmasajudge"></a>
 The LLM-as-a-Judge configuration that uses a language model to evaluate agent performance based on custom instructions and rating scales.   
*Required*: No  
*Type*: [LlmAsAJudgeEvaluatorConfig](aws-properties-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Evaluator EvaluatorModelConfig
<a name="aws-properties-bedrockagentcore-evaluator-evaluatormodelconfig"></a>

 The model configuration that specifies which foundation model to use and how to configure it for evaluation. 

## Syntax
<a name="aws-properties-bedrockagentcore-evaluator-evaluatormodelconfig-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-evaluator-evaluatormodelconfig-syntax.json"></a>

```
{
  "[BedrockEvaluatorModelConfig](#cfn-bedrockagentcore-evaluator-evaluatormodelconfig-bedrockevaluatormodelconfig)" : BedrockEvaluatorModelConfig
}
```

### YAML
<a name="aws-properties-bedrockagentcore-evaluator-evaluatormodelconfig-syntax.yaml"></a>

```
  [BedrockEvaluatorModelConfig](#cfn-bedrockagentcore-evaluator-evaluatormodelconfig-bedrockevaluatormodelconfig): 
    BedrockEvaluatorModelConfig
```

## Properties
<a name="aws-properties-bedrockagentcore-evaluator-evaluatormodelconfig-properties"></a>

`BedrockEvaluatorModelConfig`  <a name="cfn-bedrockagentcore-evaluator-evaluatormodelconfig-bedrockevaluatormodelconfig"></a>
 The Amazon Bedrock model configuration for evaluation.   
*Required*: Yes  
*Type*: [BedrockEvaluatorModelConfig](aws-properties-bedrockagentcore-evaluator-bedrockevaluatormodelconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Evaluator InferenceConfiguration
<a name="aws-properties-bedrockagentcore-evaluator-inferenceconfiguration"></a>

 The inference configuration parameters that control model behavior during evaluation, including temperature, token limits, and sampling settings. 

## Syntax
<a name="aws-properties-bedrockagentcore-evaluator-inferenceconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-evaluator-inferenceconfiguration-syntax.json"></a>

```
{
  "[MaxTokens](#cfn-bedrockagentcore-evaluator-inferenceconfiguration-maxtokens)" : Integer,
  "[Temperature](#cfn-bedrockagentcore-evaluator-inferenceconfiguration-temperature)" : Number,
  "[TopP](#cfn-bedrockagentcore-evaluator-inferenceconfiguration-topp)" : Number
}
```

### YAML
<a name="aws-properties-bedrockagentcore-evaluator-inferenceconfiguration-syntax.yaml"></a>

```
  [MaxTokens](#cfn-bedrockagentcore-evaluator-inferenceconfiguration-maxtokens): Integer
  [Temperature](#cfn-bedrockagentcore-evaluator-inferenceconfiguration-temperature): Number
  [TopP](#cfn-bedrockagentcore-evaluator-inferenceconfiguration-topp): Number
```

## Properties
<a name="aws-properties-bedrockagentcore-evaluator-inferenceconfiguration-properties"></a>

`MaxTokens`  <a name="cfn-bedrockagentcore-evaluator-inferenceconfiguration-maxtokens"></a>
 The maximum number of tokens to generate in the model response during evaluation.   
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Temperature`  <a name="cfn-bedrockagentcore-evaluator-inferenceconfiguration-temperature"></a>
 The temperature value that controls randomness in the model's responses. Lower values produce more deterministic outputs.   
*Required*: No  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TopP`  <a name="cfn-bedrockagentcore-evaluator-inferenceconfiguration-topp"></a>
 The top-p sampling parameter that controls the diversity of the model's responses by limiting the cumulative probability of token choices.   
*Required*: No  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Evaluator LambdaEvaluatorConfig
<a name="aws-properties-bedrockagentcore-evaluator-lambdaevaluatorconfig"></a>

<a name="aws-properties-bedrockagentcore-evaluator-lambdaevaluatorconfig-description"></a>The `LambdaEvaluatorConfig` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Evaluator](aws-resource-bedrockagentcore-evaluator.md).

## Syntax
<a name="aws-properties-bedrockagentcore-evaluator-lambdaevaluatorconfig-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-evaluator-lambdaevaluatorconfig-syntax.json"></a>

```
{
  "[LambdaArn](#cfn-bedrockagentcore-evaluator-lambdaevaluatorconfig-lambdaarn)" : String,
  "[LambdaTimeoutInSeconds](#cfn-bedrockagentcore-evaluator-lambdaevaluatorconfig-lambdatimeoutinseconds)" : Integer
}
```

### YAML
<a name="aws-properties-bedrockagentcore-evaluator-lambdaevaluatorconfig-syntax.yaml"></a>

```
  [LambdaArn](#cfn-bedrockagentcore-evaluator-lambdaevaluatorconfig-lambdaarn): String
  [LambdaTimeoutInSeconds](#cfn-bedrockagentcore-evaluator-lambdaevaluatorconfig-lambdatimeoutinseconds): Integer
```

## Properties
<a name="aws-properties-bedrockagentcore-evaluator-lambdaevaluatorconfig-properties"></a>

`LambdaArn`  <a name="cfn-bedrockagentcore-evaluator-lambdaevaluatorconfig-lambdaarn"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:(aws[a-zA-Z-]*)?:lambda:([a-z]{2}(-gov)?-[a-z]+-\d{1}):(\d{12}):function:([a-zA-Z0-9-_.]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LambdaTimeoutInSeconds`  <a name="cfn-bedrockagentcore-evaluator-lambdaevaluatorconfig-lambdatimeoutinseconds"></a>
Property description not available.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `300`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Evaluator LlmAsAJudgeEvaluatorConfig
<a name="aws-properties-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig"></a>

 The LLM-as-a-Judge configuration that uses a language model to evaluate agent performance based on custom instructions and rating scales. 

## Syntax
<a name="aws-properties-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig-syntax.json"></a>

```
{
  "[Instructions](#cfn-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig-instructions)" : String,
  "[ModelConfig](#cfn-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig-modelconfig)" : EvaluatorModelConfig,
  "[RatingScale](#cfn-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig-ratingscale)" : RatingScale
}
```

### YAML
<a name="aws-properties-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig-syntax.yaml"></a>

```
  [Instructions](#cfn-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig-instructions): String
  [ModelConfig](#cfn-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig-modelconfig): 
    EvaluatorModelConfig
  [RatingScale](#cfn-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig-ratingscale): 
    RatingScale
```

## Properties
<a name="aws-properties-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig-properties"></a>

`Instructions`  <a name="cfn-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig-instructions"></a>
 The evaluation instructions that guide the language model in assessing agent performance, including criteria and evaluation guidelines.   
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelConfig`  <a name="cfn-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig-modelconfig"></a>
 The model configuration that specifies which foundation model to use and how to configure it for evaluation.   
*Required*: Yes  
*Type*: [EvaluatorModelConfig](aws-properties-bedrockagentcore-evaluator-evaluatormodelconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RatingScale`  <a name="cfn-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig-ratingscale"></a>
 The rating scale that defines how the evaluator should score agent performance, either numerical or categorical.   
*Required*: Yes  
*Type*: [RatingScale](aws-properties-bedrockagentcore-evaluator-ratingscale.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Evaluator NumericalScaleDefinition
<a name="aws-properties-bedrockagentcore-evaluator-numericalscaledefinition"></a>

 The definition of a numerical rating scale option that provides a numeric value with its description for evaluation scoring. 

## Syntax
<a name="aws-properties-bedrockagentcore-evaluator-numericalscaledefinition-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-evaluator-numericalscaledefinition-syntax.json"></a>

```
{
  "[Definition](#cfn-bedrockagentcore-evaluator-numericalscaledefinition-definition)" : String,
  "[Label](#cfn-bedrockagentcore-evaluator-numericalscaledefinition-label)" : String,
  "[Value](#cfn-bedrockagentcore-evaluator-numericalscaledefinition-value)" : Number
}
```

### YAML
<a name="aws-properties-bedrockagentcore-evaluator-numericalscaledefinition-syntax.yaml"></a>

```
  [Definition](#cfn-bedrockagentcore-evaluator-numericalscaledefinition-definition): String
  [Label](#cfn-bedrockagentcore-evaluator-numericalscaledefinition-label): String
  [Value](#cfn-bedrockagentcore-evaluator-numericalscaledefinition-value): Number
```

## Properties
<a name="aws-properties-bedrockagentcore-evaluator-numericalscaledefinition-properties"></a>

`Definition`  <a name="cfn-bedrockagentcore-evaluator-numericalscaledefinition-definition"></a>
 The description that explains what this numerical rating represents and when it should be used.   
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Label`  <a name="cfn-bedrockagentcore-evaluator-numericalscaledefinition-label"></a>
 The label or name that describes this numerical rating option.   
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-bedrockagentcore-evaluator-numericalscaledefinition-value"></a>
 The numerical value for this rating scale option.   
*Required*: Yes  
*Type*: Number  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Evaluator RatingScale
<a name="aws-properties-bedrockagentcore-evaluator-ratingscale"></a>

 The rating scale that defines how the evaluator should score agent performance, either numerical or categorical. 

## Syntax
<a name="aws-properties-bedrockagentcore-evaluator-ratingscale-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-evaluator-ratingscale-syntax.json"></a>

```
{
  "[Categorical](#cfn-bedrockagentcore-evaluator-ratingscale-categorical)" : [ CategoricalScaleDefinition, ... ],
  "[Numerical](#cfn-bedrockagentcore-evaluator-ratingscale-numerical)" : [ NumericalScaleDefinition, ... ]
}
```

### YAML
<a name="aws-properties-bedrockagentcore-evaluator-ratingscale-syntax.yaml"></a>

```
  [Categorical](#cfn-bedrockagentcore-evaluator-ratingscale-categorical): 
    - CategoricalScaleDefinition
  [Numerical](#cfn-bedrockagentcore-evaluator-ratingscale-numerical): 
    - NumericalScaleDefinition
```

## Properties
<a name="aws-properties-bedrockagentcore-evaluator-ratingscale-properties"></a>

`Categorical`  <a name="cfn-bedrockagentcore-evaluator-ratingscale-categorical"></a>
 The categorical rating scale with named categories and definitions for qualitative evaluation.   
*Required*: No  
*Type*: Array of [CategoricalScaleDefinition](aws-properties-bedrockagentcore-evaluator-categoricalscaledefinition.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Numerical`  <a name="cfn-bedrockagentcore-evaluator-ratingscale-numerical"></a>
 The numerical rating scale with defined score values and descriptions for quantitative evaluation.   
*Required*: No  
*Type*: Array of [NumericalScaleDefinition](aws-properties-bedrockagentcore-evaluator-numericalscaledefinition.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Evaluator Tag
<a name="aws-properties-bedrockagentcore-evaluator-tag"></a>

 A key-value pair for tagging the evaluator. 

## Syntax
<a name="aws-properties-bedrockagentcore-evaluator-tag-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-evaluator-tag-syntax.json"></a>

```
{
  "[Key](#cfn-bedrockagentcore-evaluator-tag-key)" : String,
  "[Value](#cfn-bedrockagentcore-evaluator-tag-value)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-evaluator-tag-syntax.yaml"></a>

```
  [Key](#cfn-bedrockagentcore-evaluator-tag-key): String
  [Value](#cfn-bedrockagentcore-evaluator-tag-value): String
```

## Properties
<a name="aws-properties-bedrockagentcore-evaluator-tag-properties"></a>

`Key`  <a name="cfn-bedrockagentcore-evaluator-tag-key"></a>
The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with `aws:`. digits, whitespace, `_`, `.`, `:`, `/`, `=`, `+`, `@`, `-`, and `"`.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-bedrockagentcore-evaluator-tag-value"></a>
The value for the tag. You can specify a value that's 1 to 256 characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Gateway
<a name="aws-resource-bedrockagentcore-gateway"></a>

Amazon Bedrock AgentCore Gateway provides a unified connectivity layer between agents and the tools and resources they need to interact with.

For more information about creating a gateway, see [Set up an Amazon Bedrock AgentCore gateway](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/gateway-building.html).

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

## Syntax
<a name="aws-resource-bedrockagentcore-gateway-syntax"></a>

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

### JSON
<a name="aws-resource-bedrockagentcore-gateway-syntax.json"></a>

```
{
  "Type" : "AWS::BedrockAgentCore::Gateway",
  "Properties" : {
      "[AuthorizerConfiguration](#cfn-bedrockagentcore-gateway-authorizerconfiguration)" : AuthorizerConfiguration,
      "[AuthorizerType](#cfn-bedrockagentcore-gateway-authorizertype)" : String,
      "[Description](#cfn-bedrockagentcore-gateway-description)" : String,
      "[ExceptionLevel](#cfn-bedrockagentcore-gateway-exceptionlevel)" : String,
      "[InterceptorConfigurations](#cfn-bedrockagentcore-gateway-interceptorconfigurations)" : [ GatewayInterceptorConfiguration, ... ],
      "[KmsKeyArn](#cfn-bedrockagentcore-gateway-kmskeyarn)" : String,
      "[Name](#cfn-bedrockagentcore-gateway-name)" : String,
      "[PolicyEngineConfiguration](#cfn-bedrockagentcore-gateway-policyengineconfiguration)" : GatewayPolicyEngineConfiguration,
      "[ProtocolConfiguration](#cfn-bedrockagentcore-gateway-protocolconfiguration)" : GatewayProtocolConfiguration,
      "[ProtocolType](#cfn-bedrockagentcore-gateway-protocoltype)" : String,
      "[RoleArn](#cfn-bedrockagentcore-gateway-rolearn)" : String,
      "[Tags](#cfn-bedrockagentcore-gateway-tags)" : {Key: Value, ...}
    }
}
```

### YAML
<a name="aws-resource-bedrockagentcore-gateway-syntax.yaml"></a>

```
Type: AWS::BedrockAgentCore::Gateway
Properties:
  [AuthorizerConfiguration](#cfn-bedrockagentcore-gateway-authorizerconfiguration): 
    AuthorizerConfiguration
  [AuthorizerType](#cfn-bedrockagentcore-gateway-authorizertype): String
  [Description](#cfn-bedrockagentcore-gateway-description): String
  [ExceptionLevel](#cfn-bedrockagentcore-gateway-exceptionlevel): String
  [InterceptorConfigurations](#cfn-bedrockagentcore-gateway-interceptorconfigurations): 
    - GatewayInterceptorConfiguration
  [KmsKeyArn](#cfn-bedrockagentcore-gateway-kmskeyarn): String
  [Name](#cfn-bedrockagentcore-gateway-name): String
  [PolicyEngineConfiguration](#cfn-bedrockagentcore-gateway-policyengineconfiguration): 
    GatewayPolicyEngineConfiguration
  [ProtocolConfiguration](#cfn-bedrockagentcore-gateway-protocolconfiguration): 
    GatewayProtocolConfiguration
  [ProtocolType](#cfn-bedrockagentcore-gateway-protocoltype): String
  [RoleArn](#cfn-bedrockagentcore-gateway-rolearn): String
  [Tags](#cfn-bedrockagentcore-gateway-tags): 
    Key: Value
```

## Properties
<a name="aws-resource-bedrockagentcore-gateway-properties"></a>

`AuthorizerConfiguration`  <a name="cfn-bedrockagentcore-gateway-authorizerconfiguration"></a>
Represents inbound authorization configuration options used to authenticate incoming requests.   
*Required*: No  
*Type*: [AuthorizerConfiguration](aws-properties-bedrockagentcore-gateway-authorizerconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AuthorizerType`  <a name="cfn-bedrockagentcore-gateway-authorizertype"></a>
The type of authorizer used by the gateway.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `CUSTOM_JWT | AWS_IAM | NONE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-bedrockagentcore-gateway-description"></a>
The description of the gateway.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExceptionLevel`  <a name="cfn-bedrockagentcore-gateway-exceptionlevel"></a>
The exception level for the gateway.  
*Required*: No  
*Type*: String  
*Allowed values*: `DEBUG`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InterceptorConfigurations`  <a name="cfn-bedrockagentcore-gateway-interceptorconfigurations"></a>
A list of configuration settings for a gateway interceptor. Gateway interceptors allow custom code to be invoked during gateway invocations.  
*Required*: No  
*Type*: Array of [GatewayInterceptorConfiguration](aws-properties-bedrockagentcore-gateway-gatewayinterceptorconfiguration.md)  
*Minimum*: `1`  
*Maximum*: `2`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KmsKeyArn`  <a name="cfn-bedrockagentcore-gateway-kmskeyarn"></a>
The KMS key ARN for the gateway.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:[a-z0-9-]{1,20}:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-bedrockagentcore-gateway-name"></a>
The name of the gateway.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([0-9a-zA-Z][-]?){1,100}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PolicyEngineConfiguration`  <a name="cfn-bedrockagentcore-gateway-policyengineconfiguration"></a>
Property description not available.  
*Required*: No  
*Type*: [GatewayPolicyEngineConfiguration](aws-properties-bedrockagentcore-gateway-gatewaypolicyengineconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProtocolConfiguration`  <a name="cfn-bedrockagentcore-gateway-protocolconfiguration"></a>
The protocol configuration for the gateway target.  
*Required*: No  
*Type*: [GatewayProtocolConfiguration](aws-properties-bedrockagentcore-gateway-gatewayprotocolconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProtocolType`  <a name="cfn-bedrockagentcore-gateway-protocoltype"></a>
The protocol type used by the gateway.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `MCP`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleArn`  <a name="cfn-bedrockagentcore-gateway-rolearn"></a>
The ARN of the IAM role that provides permissions for the gateway to access AWS services.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:[a-z0-9-]{1,20}:iam::([0-9]{12})?:role/.+$`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-bedrockagentcore-gateway-tags"></a>
The tags for the gateway.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-bedrockagentcore-gateway-return-values"></a>

### Ref
<a name="aws-resource-bedrockagentcore-gateway-return-values-ref"></a>

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

 `my-gateway-a1b2c3d4e5` 

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-bedrockagentcore-gateway-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-bedrockagentcore-gateway-return-values-fn--getatt-fn--getatt"></a>

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
The date and time at which the target was created.

`GatewayArn`  <a name="GatewayArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the gateway target.

`GatewayIdentifier`  <a name="GatewayIdentifier-fn::getatt"></a>
The unique identifier of the gateway.

`GatewayUrl`  <a name="GatewayUrl-fn::getatt"></a>
The URL endpoint for the gateway.

`Status`  <a name="Status-fn::getatt"></a>
The status for the gateway.

`StatusReasons`  <a name="StatusReasons-fn::getatt"></a>
The status reasons for the target status.

`UpdatedAt`  <a name="UpdatedAt-fn::getatt"></a>
The date and time at which the target was updated.

# AWS::BedrockAgentCore::Gateway AuthorizerConfiguration
<a name="aws-properties-bedrockagentcore-gateway-authorizerconfiguration"></a>

Represents inbound authorization configuration options used to authenticate incoming requests. 

## Syntax
<a name="aws-properties-bedrockagentcore-gateway-authorizerconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gateway-authorizerconfiguration-syntax.json"></a>

```
{
  "[CustomJWTAuthorizer](#cfn-bedrockagentcore-gateway-authorizerconfiguration-customjwtauthorizer)" : CustomJWTAuthorizerConfiguration
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gateway-authorizerconfiguration-syntax.yaml"></a>

```
  [CustomJWTAuthorizer](#cfn-bedrockagentcore-gateway-authorizerconfiguration-customjwtauthorizer): 
    CustomJWTAuthorizerConfiguration
```

## Properties
<a name="aws-properties-bedrockagentcore-gateway-authorizerconfiguration-properties"></a>

`CustomJWTAuthorizer`  <a name="cfn-bedrockagentcore-gateway-authorizerconfiguration-customjwtauthorizer"></a>
The inbound JWT-based authorization, specifying how incoming requests should be authenticated.  
*Required*: Yes  
*Type*: [CustomJWTAuthorizerConfiguration](aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Gateway AuthorizingClaimMatchValueType
<a name="aws-properties-bedrockagentcore-gateway-authorizingclaimmatchvaluetype"></a>

Defines the value or values to match for and the relationship of the match.

## Syntax
<a name="aws-properties-bedrockagentcore-gateway-authorizingclaimmatchvaluetype-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gateway-authorizingclaimmatchvaluetype-syntax.json"></a>

```
{
  "[ClaimMatchOperator](#cfn-bedrockagentcore-gateway-authorizingclaimmatchvaluetype-claimmatchoperator)" : String,
  "[ClaimMatchValue](#cfn-bedrockagentcore-gateway-authorizingclaimmatchvaluetype-claimmatchvalue)" : ClaimMatchValueType
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gateway-authorizingclaimmatchvaluetype-syntax.yaml"></a>

```
  [ClaimMatchOperator](#cfn-bedrockagentcore-gateway-authorizingclaimmatchvaluetype-claimmatchoperator): String
  [ClaimMatchValue](#cfn-bedrockagentcore-gateway-authorizingclaimmatchvaluetype-claimmatchvalue): 
    ClaimMatchValueType
```

## Properties
<a name="aws-properties-bedrockagentcore-gateway-authorizingclaimmatchvaluetype-properties"></a>

`ClaimMatchOperator`  <a name="cfn-bedrockagentcore-gateway-authorizingclaimmatchvaluetype-claimmatchoperator"></a>
Defines the relationship between the claim field value and the value or values you're matching for.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `EQUALS | CONTAINS | CONTAINS_ANY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClaimMatchValue`  <a name="cfn-bedrockagentcore-gateway-authorizingclaimmatchvaluetype-claimmatchvalue"></a>
The value or values to match for.  
*Required*: Yes  
*Type*: [ClaimMatchValueType](aws-properties-bedrockagentcore-gateway-claimmatchvaluetype.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Gateway ClaimMatchValueType
<a name="aws-properties-bedrockagentcore-gateway-claimmatchvaluetype"></a>

The value or values to match for.
+ Include a `matchValueString` with the `EQUALS` operator to specify a string that matches the claim field value.
+ Include a `matchValueArray` to specify an array of string values. You can use the following operators:
  + Use `CONTAINS` to yield a match if the claim field value is in the array.
  + Use `CONTAINS_ANY` to yield a match if the claim field value contains any of the strings in the array.

## Syntax
<a name="aws-properties-bedrockagentcore-gateway-claimmatchvaluetype-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gateway-claimmatchvaluetype-syntax.json"></a>

```
{
  "[MatchValueString](#cfn-bedrockagentcore-gateway-claimmatchvaluetype-matchvaluestring)" : String,
  "[MatchValueStringList](#cfn-bedrockagentcore-gateway-claimmatchvaluetype-matchvaluestringlist)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gateway-claimmatchvaluetype-syntax.yaml"></a>

```
  [MatchValueString](#cfn-bedrockagentcore-gateway-claimmatchvaluetype-matchvaluestring): 
    String
  [MatchValueStringList](#cfn-bedrockagentcore-gateway-claimmatchvaluetype-matchvaluestringlist): 
    - String
```

## Properties
<a name="aws-properties-bedrockagentcore-gateway-claimmatchvaluetype-properties"></a>

`MatchValueString`  <a name="cfn-bedrockagentcore-gateway-claimmatchvaluetype-matchvaluestring"></a>
The string value to match for.  
*Required*: No  
*Type*: String  
*Pattern*: `[A-Za-z0-9_.-]+`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MatchValueStringList`  <a name="cfn-bedrockagentcore-gateway-claimmatchvaluetype-matchvaluestringlist"></a>
An array of strings to check for a match.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Gateway CustomClaimValidationType
<a name="aws-properties-bedrockagentcore-gateway-customclaimvalidationtype"></a>

Defines the name of a custom claim field and rules for finding matches to authenticate its value.

## Syntax
<a name="aws-properties-bedrockagentcore-gateway-customclaimvalidationtype-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gateway-customclaimvalidationtype-syntax.json"></a>

```
{
  "[AuthorizingClaimMatchValue](#cfn-bedrockagentcore-gateway-customclaimvalidationtype-authorizingclaimmatchvalue)" : AuthorizingClaimMatchValueType,
  "[InboundTokenClaimName](#cfn-bedrockagentcore-gateway-customclaimvalidationtype-inboundtokenclaimname)" : String,
  "[InboundTokenClaimValueType](#cfn-bedrockagentcore-gateway-customclaimvalidationtype-inboundtokenclaimvaluetype)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gateway-customclaimvalidationtype-syntax.yaml"></a>

```
  [AuthorizingClaimMatchValue](#cfn-bedrockagentcore-gateway-customclaimvalidationtype-authorizingclaimmatchvalue): 
    AuthorizingClaimMatchValueType
  [InboundTokenClaimName](#cfn-bedrockagentcore-gateway-customclaimvalidationtype-inboundtokenclaimname): String
  [InboundTokenClaimValueType](#cfn-bedrockagentcore-gateway-customclaimvalidationtype-inboundtokenclaimvaluetype): String
```

## Properties
<a name="aws-properties-bedrockagentcore-gateway-customclaimvalidationtype-properties"></a>

`AuthorizingClaimMatchValue`  <a name="cfn-bedrockagentcore-gateway-customclaimvalidationtype-authorizingclaimmatchvalue"></a>
Defines the value or values to match for and the relationship of the match.  
*Required*: Yes  
*Type*: [AuthorizingClaimMatchValueType](aws-properties-bedrockagentcore-gateway-authorizingclaimmatchvaluetype.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InboundTokenClaimName`  <a name="cfn-bedrockagentcore-gateway-customclaimvalidationtype-inboundtokenclaimname"></a>
The name of the custom claim field to check.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[A-Za-z0-9_.-:]+`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InboundTokenClaimValueType`  <a name="cfn-bedrockagentcore-gateway-customclaimvalidationtype-inboundtokenclaimvaluetype"></a>
The data type of the claim value to check for.  
+ Use `STRING` if you want to find an exact match to a string you define.
+ Use `STRING_ARRAY` if you want to fnd a match to at least one value in an array you define.
*Required*: Yes  
*Type*: String  
*Allowed values*: `STRING | STRING_ARRAY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Gateway CustomJWTAuthorizerConfiguration
<a name="aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration"></a>

Configuration for inbound JWT-based authorization, specifying how incoming requests should be authenticated.

## Syntax
<a name="aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration-syntax.json"></a>

```
{
  "[AllowedAudience](#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-allowedaudience)" : [ String, ... ],
  "[AllowedClients](#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-allowedclients)" : [ String, ... ],
  "[AllowedScopes](#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-allowedscopes)" : [ String, ... ],
  "[CustomClaims](#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-customclaims)" : [ CustomClaimValidationType, ... ],
  "[DiscoveryUrl](#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-discoveryurl)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration-syntax.yaml"></a>

```
  [AllowedAudience](#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-allowedaudience): 
    - String
  [AllowedClients](#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-allowedclients): 
    - String
  [AllowedScopes](#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-allowedscopes): 
    - String
  [CustomClaims](#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-customclaims): 
    - CustomClaimValidationType
  [DiscoveryUrl](#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-discoveryurl): String
```

## Properties
<a name="aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration-properties"></a>

`AllowedAudience`  <a name="cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-allowedaudience"></a>
Represents individual audience values that are validated in the incoming JWT token validation process.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AllowedClients`  <a name="cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-allowedclients"></a>
Represents individual client IDs that are validated in the incoming JWT token validation process.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AllowedScopes`  <a name="cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-allowedscopes"></a>
An array of scopes that are allowed to access the token.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CustomClaims`  <a name="cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-customclaims"></a>
An array of objects that define a custom claim validation name, value, and operation   
*Required*: No  
*Type*: Array of [CustomClaimValidationType](aws-properties-bedrockagentcore-gateway-customclaimvalidationtype.md)  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DiscoveryUrl`  <a name="cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-discoveryurl"></a>
This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^.+/\.well-known/openid-configuration$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Gateway GatewayInterceptorConfiguration
<a name="aws-properties-bedrockagentcore-gateway-gatewayinterceptorconfiguration"></a>

The configuration for an interceptor on a gateway. This structure defines settings for an interceptor that will be invoked during the invocation of the gateway.

## Syntax
<a name="aws-properties-bedrockagentcore-gateway-gatewayinterceptorconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gateway-gatewayinterceptorconfiguration-syntax.json"></a>

```
{
  "[InputConfiguration](#cfn-bedrockagentcore-gateway-gatewayinterceptorconfiguration-inputconfiguration)" : InterceptorInputConfiguration,
  "[InterceptionPoints](#cfn-bedrockagentcore-gateway-gatewayinterceptorconfiguration-interceptionpoints)" : [ String, ... ],
  "[Interceptor](#cfn-bedrockagentcore-gateway-gatewayinterceptorconfiguration-interceptor)" : InterceptorConfiguration
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gateway-gatewayinterceptorconfiguration-syntax.yaml"></a>

```
  [InputConfiguration](#cfn-bedrockagentcore-gateway-gatewayinterceptorconfiguration-inputconfiguration): 
    InterceptorInputConfiguration
  [InterceptionPoints](#cfn-bedrockagentcore-gateway-gatewayinterceptorconfiguration-interceptionpoints): 
    - String
  [Interceptor](#cfn-bedrockagentcore-gateway-gatewayinterceptorconfiguration-interceptor): 
    InterceptorConfiguration
```

## Properties
<a name="aws-properties-bedrockagentcore-gateway-gatewayinterceptorconfiguration-properties"></a>

`InputConfiguration`  <a name="cfn-bedrockagentcore-gateway-gatewayinterceptorconfiguration-inputconfiguration"></a>
The configuration for the input of the interceptor. This field specifies how the input to the interceptor is constructed  
*Required*: No  
*Type*: [InterceptorInputConfiguration](aws-properties-bedrockagentcore-gateway-interceptorinputconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InterceptionPoints`  <a name="cfn-bedrockagentcore-gateway-gatewayinterceptorconfiguration-interceptionpoints"></a>
The supported points of interception. This field specifies which points during the gateway invocation to invoke the interceptor  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `2`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Interceptor`  <a name="cfn-bedrockagentcore-gateway-gatewayinterceptorconfiguration-interceptor"></a>
The infrastructure settings of an interceptor configuration. This structure defines how the interceptor can be invoked.  
*Required*: Yes  
*Type*: [InterceptorConfiguration](aws-properties-bedrockagentcore-gateway-interceptorconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Gateway GatewayPolicyEngineConfiguration
<a name="aws-properties-bedrockagentcore-gateway-gatewaypolicyengineconfiguration"></a>

The configuration for a policy engine associated with a gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.

## Syntax
<a name="aws-properties-bedrockagentcore-gateway-gatewaypolicyengineconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gateway-gatewaypolicyengineconfiguration-syntax.json"></a>

```
{
  "[Arn](#cfn-bedrockagentcore-gateway-gatewaypolicyengineconfiguration-arn)" : String,
  "[Mode](#cfn-bedrockagentcore-gateway-gatewaypolicyengineconfiguration-mode)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gateway-gatewaypolicyengineconfiguration-syntax.yaml"></a>

```
  [Arn](#cfn-bedrockagentcore-gateway-gatewaypolicyengineconfiguration-arn): String
  [Mode](#cfn-bedrockagentcore-gateway-gatewaypolicyengineconfiguration-mode): String
```

## Properties
<a name="aws-properties-bedrockagentcore-gateway-gatewaypolicyengineconfiguration-properties"></a>

`Arn`  <a name="cfn-bedrockagentcore-gateway-gatewaypolicyengineconfiguration-arn"></a>
The ARN of the policy engine. The policy engine contains Cedar policies that define fine-grained authorization rules specifying who can perform what actions on which resources as agents interact through the gateway.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:[a-z0-9-]{1,20}:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:policy-engine/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9_]{10}$`  
*Minimum*: `1`  
*Maximum*: `170`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Mode`  <a name="cfn-bedrockagentcore-gateway-gatewaypolicyengineconfiguration-mode"></a>
The enforcement mode for the policy engine. Valid values include:  
+ `LOG_ONLY` - The policy engine evaluates each action against your policies and adds traces on whether tool calls would be allowed or denied, but does not enforce the decision. Use this mode to test and validate policies before enabling enforcement.
+ `ENFORCE` - The policy engine evaluates actions against your policies and enforces decisions by allowing or denying agent operations. Test and validate policies in `LOG_ONLY` mode before enabling enforcement to avoid unintended denials or adversely affecting production traffic.
*Required*: Yes  
*Type*: String  
*Allowed values*: `LOG_ONLY | ENFORCE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Gateway GatewayProtocolConfiguration
<a name="aws-properties-bedrockagentcore-gateway-gatewayprotocolconfiguration"></a>

The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.

## Syntax
<a name="aws-properties-bedrockagentcore-gateway-gatewayprotocolconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gateway-gatewayprotocolconfiguration-syntax.json"></a>

```
{
  "[Mcp](#cfn-bedrockagentcore-gateway-gatewayprotocolconfiguration-mcp)" : MCPGatewayConfiguration
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gateway-gatewayprotocolconfiguration-syntax.yaml"></a>

```
  [Mcp](#cfn-bedrockagentcore-gateway-gatewayprotocolconfiguration-mcp): 
    MCPGatewayConfiguration
```

## Properties
<a name="aws-properties-bedrockagentcore-gateway-gatewayprotocolconfiguration-properties"></a>

`Mcp`  <a name="cfn-bedrockagentcore-gateway-gatewayprotocolconfiguration-mcp"></a>
The configuration for the Model Context Protocol (MCP). This protocol enables communication between Amazon Bedrock Agent and external tools.  
*Required*: Yes  
*Type*: [MCPGatewayConfiguration](aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Gateway InterceptorConfiguration
<a name="aws-properties-bedrockagentcore-gateway-interceptorconfiguration"></a>

The interceptor configuration.

## Syntax
<a name="aws-properties-bedrockagentcore-gateway-interceptorconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gateway-interceptorconfiguration-syntax.json"></a>

```
{
  "[Lambda](#cfn-bedrockagentcore-gateway-interceptorconfiguration-lambda)" : LambdaInterceptorConfiguration
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gateway-interceptorconfiguration-syntax.yaml"></a>

```
  [Lambda](#cfn-bedrockagentcore-gateway-interceptorconfiguration-lambda): 
    LambdaInterceptorConfiguration
```

## Properties
<a name="aws-properties-bedrockagentcore-gateway-interceptorconfiguration-properties"></a>

`Lambda`  <a name="cfn-bedrockagentcore-gateway-interceptorconfiguration-lambda"></a>
The details of the lambda function used for the interceptor.  
*Required*: Yes  
*Type*: [LambdaInterceptorConfiguration](aws-properties-bedrockagentcore-gateway-lambdainterceptorconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Gateway InterceptorInputConfiguration
<a name="aws-properties-bedrockagentcore-gateway-interceptorinputconfiguration"></a>

The input configuration of the interceptor.

## Syntax
<a name="aws-properties-bedrockagentcore-gateway-interceptorinputconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gateway-interceptorinputconfiguration-syntax.json"></a>

```
{
  "[PassRequestHeaders](#cfn-bedrockagentcore-gateway-interceptorinputconfiguration-passrequestheaders)" : Boolean
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gateway-interceptorinputconfiguration-syntax.yaml"></a>

```
  [PassRequestHeaders](#cfn-bedrockagentcore-gateway-interceptorinputconfiguration-passrequestheaders): Boolean
```

## Properties
<a name="aws-properties-bedrockagentcore-gateway-interceptorinputconfiguration-properties"></a>

`PassRequestHeaders`  <a name="cfn-bedrockagentcore-gateway-interceptorinputconfiguration-passrequestheaders"></a>
Indicates whether to pass request headers as input into the interceptor. When set to true, request headers will be passed.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Gateway LambdaInterceptorConfiguration
<a name="aws-properties-bedrockagentcore-gateway-lambdainterceptorconfiguration"></a>

The lambda configuration for the interceptor

## Syntax
<a name="aws-properties-bedrockagentcore-gateway-lambdainterceptorconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gateway-lambdainterceptorconfiguration-syntax.json"></a>

```
{
  "[Arn](#cfn-bedrockagentcore-gateway-lambdainterceptorconfiguration-arn)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gateway-lambdainterceptorconfiguration-syntax.yaml"></a>

```
  [Arn](#cfn-bedrockagentcore-gateway-lambdainterceptorconfiguration-arn): String
```

## Properties
<a name="aws-properties-bedrockagentcore-gateway-lambdainterceptorconfiguration-properties"></a>

`Arn`  <a name="cfn-bedrockagentcore-gateway-lambdainterceptorconfiguration-arn"></a>
The arn of the lambda function to be invoked for the interceptor.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:[a-z0-9-]{1,20}:lambda:([a-z]{2}(-gov)?-[a-z]+-\d{1}):(\d{12}):function:([a-zA-Z0-9-_.]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?$`  
*Minimum*: `1`  
*Maximum*: `170`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Gateway MCPGatewayConfiguration
<a name="aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration"></a>

The configuration for a Model Context Protocol (MCP) gateway. This structure defines how the gateway implements the MCP protocol.

## Syntax
<a name="aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration-syntax.json"></a>

```
{
  "[Instructions](#cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-instructions)" : String,
  "[SearchType](#cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-searchtype)" : String,
  "[SupportedVersions](#cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-supportedversions)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration-syntax.yaml"></a>

```
  [Instructions](#cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-instructions): String
  [SearchType](#cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-searchtype): String
  [SupportedVersions](#cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-supportedversions): 
    - String
```

## Properties
<a name="aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration-properties"></a>

`Instructions`  <a name="cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-instructions"></a>
The instructions for using the Model Context Protocol gateway. These instructions provide guidance on how to interact with the gateway.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SearchType`  <a name="cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-searchtype"></a>
The search type for the Model Context Protocol gateway. This field specifies how the gateway handles search operations.  
*Required*: No  
*Type*: String  
*Allowed values*: `SEMANTIC`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SupportedVersions`  <a name="cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-supportedversions"></a>
The supported versions of the Model Context Protocol. This field specifies which versions of the protocol the gateway can use.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Gateway WorkloadIdentityDetails
<a name="aws-properties-bedrockagentcore-gateway-workloadidentitydetails"></a>

The workload identity details for the gateway.

## Syntax
<a name="aws-properties-bedrockagentcore-gateway-workloadidentitydetails-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gateway-workloadidentitydetails-syntax.json"></a>

```
{
  "[WorkloadIdentityArn](#cfn-bedrockagentcore-gateway-workloadidentitydetails-workloadidentityarn)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gateway-workloadidentitydetails-syntax.yaml"></a>

```
  [WorkloadIdentityArn](#cfn-bedrockagentcore-gateway-workloadidentitydetails-workloadidentityarn): String
```

## Properties
<a name="aws-properties-bedrockagentcore-gateway-workloadidentitydetails-properties"></a>

`WorkloadIdentityArn`  <a name="cfn-bedrockagentcore-gateway-workloadidentitydetails-workloadidentityarn"></a>
The Amazon Resource Name (ARN) of the workload identity.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::GatewayTarget
<a name="aws-resource-bedrockagentcore-gatewaytarget"></a>

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](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/gateway-building-adding-targets.html).

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

## Syntax
<a name="aws-resource-bedrockagentcore-gatewaytarget-syntax"></a>

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

### JSON
<a name="aws-resource-bedrockagentcore-gatewaytarget-syntax.json"></a>

```
{
  "Type" : "AWS::BedrockAgentCore::GatewayTarget",
  "Properties" : {
      "[CredentialProviderConfigurations](#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfigurations)" : [ CredentialProviderConfiguration, ... ],
      "[Description](#cfn-bedrockagentcore-gatewaytarget-description)" : String,
      "[GatewayIdentifier](#cfn-bedrockagentcore-gatewaytarget-gatewayidentifier)" : String,
      "[MetadataConfiguration](#cfn-bedrockagentcore-gatewaytarget-metadataconfiguration)" : MetadataConfiguration,
      "[Name](#cfn-bedrockagentcore-gatewaytarget-name)" : String,
      "[TargetConfiguration](#cfn-bedrockagentcore-gatewaytarget-targetconfiguration)" : TargetConfiguration
    }
}
```

### YAML
<a name="aws-resource-bedrockagentcore-gatewaytarget-syntax.yaml"></a>

```
Type: AWS::BedrockAgentCore::GatewayTarget
Properties:
  [CredentialProviderConfigurations](#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfigurations): 
    - CredentialProviderConfiguration
  [Description](#cfn-bedrockagentcore-gatewaytarget-description): String
  [GatewayIdentifier](#cfn-bedrockagentcore-gatewaytarget-gatewayidentifier): String
  [MetadataConfiguration](#cfn-bedrockagentcore-gatewaytarget-metadataconfiguration): 
    MetadataConfiguration
  [Name](#cfn-bedrockagentcore-gatewaytarget-name): String
  [TargetConfiguration](#cfn-bedrockagentcore-gatewaytarget-targetconfiguration): 
    TargetConfiguration
```

## Properties
<a name="aws-resource-bedrockagentcore-gatewaytarget-properties"></a>

`CredentialProviderConfigurations`  <a name="cfn-bedrockagentcore-gatewaytarget-credentialproviderconfigurations"></a>
The credential provider configurations.  
*Required*: No  
*Type*: Array of [CredentialProviderConfiguration](aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration.md)  
*Minimum*: `1`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-bedrockagentcore-gatewaytarget-description"></a>
The description for the gateway target.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GatewayIdentifier`  <a name="cfn-bedrockagentcore-gatewaytarget-gatewayidentifier"></a>
The gateway ID for the gateway target.  
*Required*: No  
*Type*: String  
*Pattern*: `^([0-9a-z][-]?){1,100}-[0-9a-z]{10}$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MetadataConfiguration`  <a name="cfn-bedrockagentcore-gatewaytarget-metadataconfiguration"></a>
The metadata configuration for HTTP header and query parameter propagation to and from this gateway target.  
*Required*: No  
*Type*: [MetadataConfiguration](aws-properties-bedrockagentcore-gatewaytarget-metadataconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-bedrockagentcore-gatewaytarget-name"></a>
The name of the gateway target.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([0-9a-zA-Z][-]?){1,100}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetConfiguration`  <a name="cfn-bedrockagentcore-gatewaytarget-targetconfiguration"></a>
The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.  
*Required*: Yes  
*Type*: [TargetConfiguration](aws-properties-bedrockagentcore-gatewaytarget-targetconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-bedrockagentcore-gatewaytarget-return-values"></a>

### Ref
<a name="aws-resource-bedrockagentcore-gatewaytarget-return-values-ref"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-bedrockagentcore-gatewaytarget-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-bedrockagentcore-gatewaytarget-return-values-fn--getatt-fn--getatt"></a>

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
The date and time at which the target was created.

`GatewayArn`  <a name="GatewayArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the gateway target.

`LastSynchronizedAt`  <a name="LastSynchronizedAt-fn::getatt"></a>
The timestamp when the target was last synchronized.

`Status`  <a name="Status-fn::getatt"></a>
The status of the gateway target.

`StatusReasons`  <a name="StatusReasons-fn::getatt"></a>
The status reasons for the target status.

`TargetId`  <a name="TargetId-fn::getatt"></a>
The target ID.

`UpdatedAt`  <a name="UpdatedAt-fn::getatt"></a>
The date and time at which the target was updated.

# AWS::BedrockAgentCore::GatewayTarget ApiGatewayTargetConfiguration
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration"></a>

The configuration for an Amazon API Gateway target.

## Syntax
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration-syntax.json"></a>

```
{
  "[ApiGatewayToolConfiguration](#cfn-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration-apigatewaytoolconfiguration)" : ApiGatewayToolConfiguration,
  "[RestApiId](#cfn-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration-restapiid)" : String,
  "[Stage](#cfn-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration-stage)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration-syntax.yaml"></a>

```
  [ApiGatewayToolConfiguration](#cfn-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration-apigatewaytoolconfiguration): 
    ApiGatewayToolConfiguration
  [RestApiId](#cfn-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration-restapiid): String
  [Stage](#cfn-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration-stage): String
```

## Properties
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration-properties"></a>

`ApiGatewayToolConfiguration`  <a name="cfn-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration-apigatewaytoolconfiguration"></a>
The configuration for defining REST API tool filters and overrides for the gateway target.  
*Required*: Yes  
*Type*: [ApiGatewayToolConfiguration](aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RestApiId`  <a name="cfn-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration-restapiid"></a>
The ID of the API Gateway REST API.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Stage`  <a name="cfn-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration-stage"></a>
The ID of the stage of the REST API to add as a target.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::GatewayTarget ApiGatewayToolConfiguration
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration"></a>

The configuration for defining REST API tool filters and overrides for the gateway target.

## Syntax
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration-syntax.json"></a>

```
{
  "[ToolFilters](#cfn-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration-toolfilters)" : [ ApiGatewayToolFilter, ... ],
  "[ToolOverrides](#cfn-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration-tooloverrides)" : [ ApiGatewayToolOverride, ... ]
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration-syntax.yaml"></a>

```
  [ToolFilters](#cfn-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration-toolfilters): 
    - ApiGatewayToolFilter
  [ToolOverrides](#cfn-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration-tooloverrides): 
    - ApiGatewayToolOverride
```

## Properties
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration-properties"></a>

`ToolFilters`  <a name="cfn-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration-toolfilters"></a>
A list of path and method patterns to expose as tools using metadata from the REST API's OpenAPI specification.  
*Required*: Yes  
*Type*: Array of [ApiGatewayToolFilter](aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolfilter.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ToolOverrides`  <a name="cfn-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration-tooloverrides"></a>
A list of explicit tool definitions with optional custom names and descriptions.  
*Required*: No  
*Type*: Array of [ApiGatewayToolOverride](aws-properties-bedrockagentcore-gatewaytarget-apigatewaytooloverride.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::GatewayTarget ApiGatewayToolFilter
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolfilter"></a>

Specifies which operations from an API Gateway REST API are exposed as tools. Tool names and descriptions are derived from the operationId and description fields in the API's exported OpenAPI specification.

## Syntax
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolfilter-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolfilter-syntax.json"></a>

```
{
  "[FilterPath](#cfn-bedrockagentcore-gatewaytarget-apigatewaytoolfilter-filterpath)" : String,
  "[Methods](#cfn-bedrockagentcore-gatewaytarget-apigatewaytoolfilter-methods)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolfilter-syntax.yaml"></a>

```
  [FilterPath](#cfn-bedrockagentcore-gatewaytarget-apigatewaytoolfilter-filterpath): String
  [Methods](#cfn-bedrockagentcore-gatewaytarget-apigatewaytoolfilter-methods): 
    - String
```

## Properties
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolfilter-properties"></a>

`FilterPath`  <a name="cfn-bedrockagentcore-gatewaytarget-apigatewaytoolfilter-filterpath"></a>
Resource path to match in the REST API. Supports exact paths (for example, `/pets`) or wildcard paths (for example, `/pets/*` to match all paths under `/pets`). Must match existing paths in the REST API.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Methods`  <a name="cfn-bedrockagentcore-gatewaytarget-apigatewaytoolfilter-methods"></a>
The methods to filter for.  
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::GatewayTarget ApiGatewayToolOverride
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytooloverride"></a>

Settings to override configurations for a tool.

## Syntax
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytooloverride-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytooloverride-syntax.json"></a>

```
{
  "[Description](#cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-description)" : String,
  "[Method](#cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-method)" : String,
  "[Name](#cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-name)" : String,
  "[Path](#cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-path)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytooloverride-syntax.yaml"></a>

```
  [Description](#cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-description): String
  [Method](#cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-method): String
  [Name](#cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-name): String
  [Path](#cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-path): String
```

## Properties
<a name="aws-properties-bedrockagentcore-gatewaytarget-apigatewaytooloverride-properties"></a>

`Description`  <a name="cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-description"></a>
The description of the tool. Provides information about the purpose and usage of the tool. If not provided, uses the description from the API's OpenAPI specification.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Method`  <a name="cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-method"></a>
The HTTP method to expose for the specified path.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `GET | DELETE | HEAD | OPTIONS | PATCH | PUT | POST`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-name"></a>
The name of tool. Identifies the tool in the Model Context Protocol.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Path`  <a name="cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-path"></a>
Resource path in the REST API (e.g., `/pets`). Must explicitly match an existing path in the REST API.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::GatewayTarget ApiKeyCredentialProvider
<a name="aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider"></a>

An API key credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using an API key.

## Syntax
<a name="aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider-syntax.json"></a>

```
{
  "[CredentialLocation](#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentiallocation)" : String,
  "[CredentialParameterName](#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialparametername)" : String,
  "[CredentialPrefix](#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialprefix)" : String,
  "[ProviderArn](#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-providerarn)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider-syntax.yaml"></a>

```
  [CredentialLocation](#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentiallocation): String
  [CredentialParameterName](#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialparametername): String
  [CredentialPrefix](#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialprefix): String
  [ProviderArn](#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-providerarn): String
```

## Properties
<a name="aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider-properties"></a>

`CredentialLocation`  <a name="cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentiallocation"></a>
The location of the API key credential. This field specifies where in the request the API key should be placed.  
*Required*: No  
*Type*: String  
*Allowed values*: `HEADER | QUERY_PARAMETER`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CredentialParameterName`  <a name="cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialparametername"></a>
The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CredentialPrefix`  <a name="cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialprefix"></a>
The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProviderArn`  <a name="cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-providerarn"></a>
The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in AWS.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:([^:]*):([^:]*):([^:]*):([0-9]{12})?:(.+)$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::GatewayTarget ApiSchemaConfiguration
<a name="aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration"></a>

Configuration for API schema.

## Syntax
<a name="aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration-syntax.json"></a>

```
{
  "[InlinePayload](#cfn-bedrockagentcore-gatewaytarget-apischemaconfiguration-inlinepayload)" : String,
  "[S3](#cfn-bedrockagentcore-gatewaytarget-apischemaconfiguration-s3)" : S3Configuration
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration-syntax.yaml"></a>

```
  [InlinePayload](#cfn-bedrockagentcore-gatewaytarget-apischemaconfiguration-inlinepayload): String
  [S3](#cfn-bedrockagentcore-gatewaytarget-apischemaconfiguration-s3): 
    S3Configuration
```

## Properties
<a name="aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration-properties"></a>

`InlinePayload`  <a name="cfn-bedrockagentcore-gatewaytarget-apischemaconfiguration-inlinepayload"></a>
The inline payload containing the API schema definition.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3`  <a name="cfn-bedrockagentcore-gatewaytarget-apischemaconfiguration-s3"></a>
The S3 configuration for a gateway. This structure defines how the gateway accesses files in S3.  
*Required*: No  
*Type*: [S3Configuration](aws-properties-bedrockagentcore-gatewaytarget-s3configuration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::GatewayTarget CredentialProvider
<a name="aws-properties-bedrockagentcore-gatewaytarget-credentialprovider"></a>

A credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint.

## Syntax
<a name="aws-properties-bedrockagentcore-gatewaytarget-credentialprovider-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gatewaytarget-credentialprovider-syntax.json"></a>

```
{
  "[ApiKeyCredentialProvider](#cfn-bedrockagentcore-gatewaytarget-credentialprovider-apikeycredentialprovider)" : ApiKeyCredentialProvider,
  "[IamCredentialProvider](#cfn-bedrockagentcore-gatewaytarget-credentialprovider-iamcredentialprovider)" : IamCredentialProvider,
  "[OauthCredentialProvider](#cfn-bedrockagentcore-gatewaytarget-credentialprovider-oauthcredentialprovider)" : OAuthCredentialProvider
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gatewaytarget-credentialprovider-syntax.yaml"></a>

```
  [ApiKeyCredentialProvider](#cfn-bedrockagentcore-gatewaytarget-credentialprovider-apikeycredentialprovider): 
    ApiKeyCredentialProvider
  [IamCredentialProvider](#cfn-bedrockagentcore-gatewaytarget-credentialprovider-iamcredentialprovider): 
    IamCredentialProvider
  [OauthCredentialProvider](#cfn-bedrockagentcore-gatewaytarget-credentialprovider-oauthcredentialprovider): 
    OAuthCredentialProvider
```

## Properties
<a name="aws-properties-bedrockagentcore-gatewaytarget-credentialprovider-properties"></a>

`ApiKeyCredentialProvider`  <a name="cfn-bedrockagentcore-gatewaytarget-credentialprovider-apikeycredentialprovider"></a>
The API key credential provider. This provider uses an API key to authenticate with the target endpoint.  
*Required*: No  
*Type*: [ApiKeyCredentialProvider](aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IamCredentialProvider`  <a name="cfn-bedrockagentcore-gatewaytarget-credentialprovider-iamcredentialprovider"></a>
The IAM credential provider. This provider uses IAM authentication with SigV4 signing to access the target endpoint.  
*Required*: No  
*Type*: [IamCredentialProvider](aws-properties-bedrockagentcore-gatewaytarget-iamcredentialprovider.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OauthCredentialProvider`  <a name="cfn-bedrockagentcore-gatewaytarget-credentialprovider-oauthcredentialprovider"></a>
The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.  
*Required*: No  
*Type*: [OAuthCredentialProvider](aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::GatewayTarget CredentialProviderConfiguration
<a name="aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration"></a>

The configuration for a credential provider. This structure defines how the gateway authenticates with the target endpoint.

## Syntax
<a name="aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-syntax.json"></a>

```
{
  "[CredentialProvider](#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-credentialprovider)" : CredentialProvider,
  "[CredentialProviderType](#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-credentialprovidertype)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-syntax.yaml"></a>

```
  [CredentialProvider](#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-credentialprovider): 
    CredentialProvider
  [CredentialProviderType](#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-credentialprovidertype): String
```

## Properties
<a name="aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-properties"></a>

`CredentialProvider`  <a name="cfn-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-credentialprovider"></a>
The credential provider. This field contains the specific configuration for the credential provider type.  
*Required*: No  
*Type*: [CredentialProvider](aws-properties-bedrockagentcore-gatewaytarget-credentialprovider.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CredentialProviderType`  <a name="cfn-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-credentialprovidertype"></a>
The type of credential provider. This field specifies which authentication method the gateway uses.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `GATEWAY_IAM_ROLE | OAUTH | API_KEY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::GatewayTarget IamCredentialProvider
<a name="aws-properties-bedrockagentcore-gatewaytarget-iamcredentialprovider"></a>

An IAM credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using IAM credentials and SigV4 signing.

## Syntax
<a name="aws-properties-bedrockagentcore-gatewaytarget-iamcredentialprovider-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gatewaytarget-iamcredentialprovider-syntax.json"></a>

```
{
  "[Region](#cfn-bedrockagentcore-gatewaytarget-iamcredentialprovider-region)" : String,
  "[Service](#cfn-bedrockagentcore-gatewaytarget-iamcredentialprovider-service)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gatewaytarget-iamcredentialprovider-syntax.yaml"></a>

```
  [Region](#cfn-bedrockagentcore-gatewaytarget-iamcredentialprovider-region): String
  [Service](#cfn-bedrockagentcore-gatewaytarget-iamcredentialprovider-service): String
```

## Properties
<a name="aws-properties-bedrockagentcore-gatewaytarget-iamcredentialprovider-properties"></a>

`Region`  <a name="cfn-bedrockagentcore-gatewaytarget-iamcredentialprovider-region"></a>
The AWS Region used for SigV4 signing. If not specified, defaults to the gateway's Region.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9-]+$`  
*Minimum*: `1`  
*Maximum*: `32`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Service`  <a name="cfn-bedrockagentcore-gatewaytarget-iamcredentialprovider-service"></a>
The target AWS service name used for SigV4 signing. This value identifies the service that the gateway authenticates with when making requests to the target endpoint.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9._-]+$`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::GatewayTarget McpLambdaTargetConfiguration
<a name="aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration"></a>

The Lambda configuration for a Model Context Protocol target. This structure defines how the gateway uses a Lambda function to communicate with the target.

## Syntax
<a name="aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration-syntax.json"></a>

```
{
  "[LambdaArn](#cfn-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration-lambdaarn)" : String,
  "[ToolSchema](#cfn-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration-toolschema)" : ToolSchema
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration-syntax.yaml"></a>

```
  [LambdaArn](#cfn-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration-lambdaarn): String
  [ToolSchema](#cfn-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration-toolschema): 
    ToolSchema
```

## Properties
<a name="aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration-properties"></a>

`LambdaArn`  <a name="cfn-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration-lambdaarn"></a>
The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to communicate with the target.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:(aws[a-zA-Z-]*)?:lambda:([a-z]{2}(-gov)?-[a-z]+-\d{1}):(\d{12}):function:([a-zA-Z0-9-_.]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?$`  
*Minimum*: `1`  
*Maximum*: `170`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ToolSchema`  <a name="cfn-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration-toolschema"></a>
The tool schema for the Lambda function. This schema defines the structure of the tools that the Lambda function provides.  
*Required*: Yes  
*Type*: [ToolSchema](aws-properties-bedrockagentcore-gatewaytarget-toolschema.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::GatewayTarget McpServerTargetConfiguration
<a name="aws-properties-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration"></a>

The configuration for an MCP server target.

## Syntax
<a name="aws-properties-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration-syntax.json"></a>

```
{
  "[Endpoint](#cfn-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration-endpoint)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration-syntax.yaml"></a>

```
  [Endpoint](#cfn-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration-endpoint): String
```

## Properties
<a name="aws-properties-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration-properties"></a>

`Endpoint`  <a name="cfn-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration-endpoint"></a>
The endpoint URL for the MCP server.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^https://.*`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::GatewayTarget McpTargetConfiguration
<a name="aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration"></a>

The Model Context Protocol (MCP) configuration for a target. This structure defines how the gateway uses MCP to communicate with the target.

## Syntax
<a name="aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration-syntax.json"></a>

```
{
  "[ApiGateway](#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-apigateway)" : ApiGatewayTargetConfiguration,
  "[Lambda](#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-lambda)" : McpLambdaTargetConfiguration,
  "[McpServer](#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-mcpserver)" : McpServerTargetConfiguration,
  "[OpenApiSchema](#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-openapischema)" : ApiSchemaConfiguration,
  "[SmithyModel](#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-smithymodel)" : ApiSchemaConfiguration
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration-syntax.yaml"></a>

```
  [ApiGateway](#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-apigateway): 
    ApiGatewayTargetConfiguration
  [Lambda](#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-lambda): 
    McpLambdaTargetConfiguration
  [McpServer](#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-mcpserver): 
    McpServerTargetConfiguration
  [OpenApiSchema](#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-openapischema): 
    ApiSchemaConfiguration
  [SmithyModel](#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-smithymodel): 
    ApiSchemaConfiguration
```

## Properties
<a name="aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration-properties"></a>

`ApiGateway`  <a name="cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-apigateway"></a>
The configuration for an Amazon API Gateway target.  
*Required*: No  
*Type*: [ApiGatewayTargetConfiguration](aws-properties-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Lambda`  <a name="cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-lambda"></a>
The Lambda configuration for the Model Context Protocol target. This configuration defines how the gateway uses a Lambda function to communicate with the target.  
*Required*: No  
*Type*: [McpLambdaTargetConfiguration](aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`McpServer`  <a name="cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-mcpserver"></a>
The configuration for an MCP server target.  
*Required*: No  
*Type*: [McpServerTargetConfiguration](aws-properties-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OpenApiSchema`  <a name="cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-openapischema"></a>
The OpenAPI schema for the Model Context Protocol target. This schema defines the API structure of the target.  
*Required*: No  
*Type*: [ApiSchemaConfiguration](aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SmithyModel`  <a name="cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-smithymodel"></a>
The Smithy model for the Model Context Protocol target. This model defines the API structure of the target using the Smithy specification.  
*Required*: No  
*Type*: [ApiSchemaConfiguration](aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::GatewayTarget MetadataConfiguration
<a name="aws-properties-bedrockagentcore-gatewaytarget-metadataconfiguration"></a>

Configuration for HTTP header and query parameter propagation between the gateway and target servers.

## Syntax
<a name="aws-properties-bedrockagentcore-gatewaytarget-metadataconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gatewaytarget-metadataconfiguration-syntax.json"></a>

```
{
  "[AllowedQueryParameters](#cfn-bedrockagentcore-gatewaytarget-metadataconfiguration-allowedqueryparameters)" : [ String, ... ],
  "[AllowedRequestHeaders](#cfn-bedrockagentcore-gatewaytarget-metadataconfiguration-allowedrequestheaders)" : [ String, ... ],
  "[AllowedResponseHeaders](#cfn-bedrockagentcore-gatewaytarget-metadataconfiguration-allowedresponseheaders)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gatewaytarget-metadataconfiguration-syntax.yaml"></a>

```
  [AllowedQueryParameters](#cfn-bedrockagentcore-gatewaytarget-metadataconfiguration-allowedqueryparameters): 
    - String
  [AllowedRequestHeaders](#cfn-bedrockagentcore-gatewaytarget-metadataconfiguration-allowedrequestheaders): 
    - String
  [AllowedResponseHeaders](#cfn-bedrockagentcore-gatewaytarget-metadataconfiguration-allowedresponseheaders): 
    - String
```

## Properties
<a name="aws-properties-bedrockagentcore-gatewaytarget-metadataconfiguration-properties"></a>

`AllowedQueryParameters`  <a name="cfn-bedrockagentcore-gatewaytarget-metadataconfiguration-allowedqueryparameters"></a>
A list of URL query parameters that are allowed to be propagated from incoming gateway URL to the target.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AllowedRequestHeaders`  <a name="cfn-bedrockagentcore-gatewaytarget-metadataconfiguration-allowedrequestheaders"></a>
A list of HTTP headers that are allowed to be propagated from incoming client requests to the target.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AllowedResponseHeaders`  <a name="cfn-bedrockagentcore-gatewaytarget-metadataconfiguration-allowedresponseheaders"></a>
A list of HTTP headers that are allowed to be propagated from the target response back to the client.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::GatewayTarget OAuthCredentialProvider
<a name="aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider"></a>

An OAuth credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using OAuth.

## Syntax
<a name="aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider-syntax.json"></a>

```
{
  "[CustomParameters](#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-customparameters)" : {Key: Value, ...},
  "[DefaultReturnUrl](#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-defaultreturnurl)" : String,
  "[GrantType](#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-granttype)" : String,
  "[ProviderArn](#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-providerarn)" : String,
  "[Scopes](#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-scopes)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider-syntax.yaml"></a>

```
  [CustomParameters](#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-customparameters): 
    Key: Value
  [DefaultReturnUrl](#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-defaultreturnurl): String
  [GrantType](#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-granttype): String
  [ProviderArn](#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-providerarn): String
  [Scopes](#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-scopes): 
    - String
```

## Properties
<a name="aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider-properties"></a>

`CustomParameters`  <a name="cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-customparameters"></a>
The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `.+`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DefaultReturnUrl`  <a name="cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-defaultreturnurl"></a>
The URL where the end user's browser is redirected after obtaining the authorization code. Generally points to the customer's application.  
*Required*: No  
*Type*: String  
*Pattern*: `\w+:(\/?\/?)[^\s]+`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GrantType`  <a name="cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-granttype"></a>
Specifies the kind of credentials to use for authorization:  
+ `CLIENT_CREDENTIALS` - Authorization with a client ID and secret.
+ `AUTHORIZATION_CODE` - Authorization with a token that is specific to an individual end user.
*Required*: No  
*Type*: String  
*Allowed values*: `AUTHORIZATION_CODE | CLIENT_CREDENTIALS`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProviderArn`  <a name="cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-providerarn"></a>
The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in AWS.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:([^:]*):([^:]*):([^:]*):([0-9]{12})?:(.+)$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Scopes`  <a name="cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-scopes"></a>
The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `64 | 100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::GatewayTarget S3Configuration
<a name="aws-properties-bedrockagentcore-gatewaytarget-s3configuration"></a>

The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.

## Syntax
<a name="aws-properties-bedrockagentcore-gatewaytarget-s3configuration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gatewaytarget-s3configuration-syntax.json"></a>

```
{
  "[BucketOwnerAccountId](#cfn-bedrockagentcore-gatewaytarget-s3configuration-bucketowneraccountid)" : String,
  "[Uri](#cfn-bedrockagentcore-gatewaytarget-s3configuration-uri)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gatewaytarget-s3configuration-syntax.yaml"></a>

```
  [BucketOwnerAccountId](#cfn-bedrockagentcore-gatewaytarget-s3configuration-bucketowneraccountid): String
  [Uri](#cfn-bedrockagentcore-gatewaytarget-s3configuration-uri): String
```

## Properties
<a name="aws-properties-bedrockagentcore-gatewaytarget-s3configuration-properties"></a>

`BucketOwnerAccountId`  <a name="cfn-bedrockagentcore-gatewaytarget-s3configuration-bucketowneraccountid"></a>
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.  
*Required*: No  
*Type*: String  
*Pattern*: `^[0-9]{12}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Uri`  <a name="cfn-bedrockagentcore-gatewaytarget-s3configuration-uri"></a>
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.  
*Required*: No  
*Type*: String  
*Pattern*: `^s3://.{1,2043}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::GatewayTarget SchemaDefinition
<a name="aws-properties-bedrockagentcore-gatewaytarget-schemadefinition"></a>

A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.

## Syntax
<a name="aws-properties-bedrockagentcore-gatewaytarget-schemadefinition-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gatewaytarget-schemadefinition-syntax.json"></a>

```
{
  "[Description](#cfn-bedrockagentcore-gatewaytarget-schemadefinition-description)" : String,
  "[Items](#cfn-bedrockagentcore-gatewaytarget-schemadefinition-items)" : SchemaDefinition,
  "[Properties](#cfn-bedrockagentcore-gatewaytarget-schemadefinition-properties)" : {Key: Value, ...},
  "[Required](#cfn-bedrockagentcore-gatewaytarget-schemadefinition-required)" : [ String, ... ],
  "[Type](#cfn-bedrockagentcore-gatewaytarget-schemadefinition-type)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gatewaytarget-schemadefinition-syntax.yaml"></a>

```
  [Description](#cfn-bedrockagentcore-gatewaytarget-schemadefinition-description): String
  [Items](#cfn-bedrockagentcore-gatewaytarget-schemadefinition-items): 
    SchemaDefinition
  [Properties](#cfn-bedrockagentcore-gatewaytarget-schemadefinition-properties): 
    Key: Value
  [Required](#cfn-bedrockagentcore-gatewaytarget-schemadefinition-required): 
    - String
  [Type](#cfn-bedrockagentcore-gatewaytarget-schemadefinition-type): String
```

## Properties
<a name="aws-properties-bedrockagentcore-gatewaytarget-schemadefinition-properties"></a>

`Description`  <a name="cfn-bedrockagentcore-gatewaytarget-schemadefinition-description"></a>
The description of the schema definition. This description provides information about the purpose and usage of the schema.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Items`  <a name="cfn-bedrockagentcore-gatewaytarget-schemadefinition-items"></a>
The items in the schema definition. This field is used for array types to define the structure of the array elements.  
*Required*: No  
*Type*: [SchemaDefinition](#aws-properties-bedrockagentcore-gatewaytarget-schemadefinition)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Properties`  <a name="cfn-bedrockagentcore-gatewaytarget-schemadefinition-properties"></a>
The properties of the schema definition. These properties define the fields in the schema.  
*Required*: No  
*Type*: Object of [SchemaDefinition](#aws-properties-bedrockagentcore-gatewaytarget-schemadefinition)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Required`  <a name="cfn-bedrockagentcore-gatewaytarget-schemadefinition-required"></a>
The required fields in the schema definition. These fields must be provided when using the schema.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-bedrockagentcore-gatewaytarget-schemadefinition-type"></a>
The type of the schema definition. This field specifies the data type of the schema.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `string | number | object | array | boolean | integer`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::GatewayTarget TargetConfiguration
<a name="aws-properties-bedrockagentcore-gatewaytarget-targetconfiguration"></a>

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

## Syntax
<a name="aws-properties-bedrockagentcore-gatewaytarget-targetconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gatewaytarget-targetconfiguration-syntax.json"></a>

```
{
  "[Mcp](#cfn-bedrockagentcore-gatewaytarget-targetconfiguration-mcp)" : McpTargetConfiguration
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gatewaytarget-targetconfiguration-syntax.yaml"></a>

```
  [Mcp](#cfn-bedrockagentcore-gatewaytarget-targetconfiguration-mcp): 
    McpTargetConfiguration
```

## Properties
<a name="aws-properties-bedrockagentcore-gatewaytarget-targetconfiguration-properties"></a>

`Mcp`  <a name="cfn-bedrockagentcore-gatewaytarget-targetconfiguration-mcp"></a>
The Model Context Protocol (MCP) configuration for the target. This configuration defines how the gateway uses MCP to communicate with the target.  
*Required*: Yes  
*Type*: [McpTargetConfiguration](aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::GatewayTarget ToolDefinition
<a name="aws-properties-bedrockagentcore-gatewaytarget-tooldefinition"></a>

A tool definition for a gateway target. This structure defines a tool that the target exposes through the Model Context Protocol.

## Syntax
<a name="aws-properties-bedrockagentcore-gatewaytarget-tooldefinition-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gatewaytarget-tooldefinition-syntax.json"></a>

```
{
  "[Description](#cfn-bedrockagentcore-gatewaytarget-tooldefinition-description)" : String,
  "[InputSchema](#cfn-bedrockagentcore-gatewaytarget-tooldefinition-inputschema)" : SchemaDefinition,
  "[Name](#cfn-bedrockagentcore-gatewaytarget-tooldefinition-name)" : String,
  "[OutputSchema](#cfn-bedrockagentcore-gatewaytarget-tooldefinition-outputschema)" : SchemaDefinition
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gatewaytarget-tooldefinition-syntax.yaml"></a>

```
  [Description](#cfn-bedrockagentcore-gatewaytarget-tooldefinition-description): String
  [InputSchema](#cfn-bedrockagentcore-gatewaytarget-tooldefinition-inputschema): 
    SchemaDefinition
  [Name](#cfn-bedrockagentcore-gatewaytarget-tooldefinition-name): String
  [OutputSchema](#cfn-bedrockagentcore-gatewaytarget-tooldefinition-outputschema): 
    SchemaDefinition
```

## Properties
<a name="aws-properties-bedrockagentcore-gatewaytarget-tooldefinition-properties"></a>

`Description`  <a name="cfn-bedrockagentcore-gatewaytarget-tooldefinition-description"></a>
The description of the tool. This description provides information about the purpose and usage of the tool.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InputSchema`  <a name="cfn-bedrockagentcore-gatewaytarget-tooldefinition-inputschema"></a>
The input schema for the tool. This schema defines the structure of the input that the tool accepts.  
*Required*: Yes  
*Type*: [SchemaDefinition](aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-bedrockagentcore-gatewaytarget-tooldefinition-name"></a>
The name of the tool. This name identifies the tool in the Model Context Protocol.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OutputSchema`  <a name="cfn-bedrockagentcore-gatewaytarget-tooldefinition-outputschema"></a>
The output schema for the tool. This schema defines the structure of the output that the tool produces.  
*Required*: No  
*Type*: [SchemaDefinition](aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::GatewayTarget ToolSchema
<a name="aws-properties-bedrockagentcore-gatewaytarget-toolschema"></a>

A tool schema for a gateway target. This structure defines the schema for a tool that the target exposes through the Model Context Protocol.

## Syntax
<a name="aws-properties-bedrockagentcore-gatewaytarget-toolschema-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-gatewaytarget-toolschema-syntax.json"></a>

```
{
  "[InlinePayload](#cfn-bedrockagentcore-gatewaytarget-toolschema-inlinepayload)" : [ ToolDefinition, ... ],
  "[S3](#cfn-bedrockagentcore-gatewaytarget-toolschema-s3)" : S3Configuration
}
```

### YAML
<a name="aws-properties-bedrockagentcore-gatewaytarget-toolschema-syntax.yaml"></a>

```
  [InlinePayload](#cfn-bedrockagentcore-gatewaytarget-toolschema-inlinepayload): 
    - ToolDefinition
  [S3](#cfn-bedrockagentcore-gatewaytarget-toolschema-s3): 
    S3Configuration
```

## Properties
<a name="aws-properties-bedrockagentcore-gatewaytarget-toolschema-properties"></a>

`InlinePayload`  <a name="cfn-bedrockagentcore-gatewaytarget-toolschema-inlinepayload"></a>
The inline payload of the tool schema. This payload contains the schema definition directly in the request.  
*Required*: No  
*Type*: Array of [ToolDefinition](aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3`  <a name="cfn-bedrockagentcore-gatewaytarget-toolschema-s3"></a>
The Amazon S3 location of the tool schema. This location contains the schema definition file.  
*Required*: No  
*Type*: [S3Configuration](aws-properties-bedrockagentcore-gatewaytarget-s3configuration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory
<a name="aws-resource-bedrockagentcore-memory"></a>

Memory allows AI agents to maintain both immediate and long-term knowledge, enabling context-aware and personalized interactions.

For more information about using Memory in Amazon Bedrock AgentCore, see [Host agent or tools with Amazon Bedrock AgentCore Memory](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/memory-getting-started.html).

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

## Syntax
<a name="aws-resource-bedrockagentcore-memory-syntax"></a>

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

### JSON
<a name="aws-resource-bedrockagentcore-memory-syntax.json"></a>

```
{
  "Type" : "AWS::BedrockAgentCore::Memory",
  "Properties" : {
      "[Description](#cfn-bedrockagentcore-memory-description)" : String,
      "[EncryptionKeyArn](#cfn-bedrockagentcore-memory-encryptionkeyarn)" : String,
      "[EventExpiryDuration](#cfn-bedrockagentcore-memory-eventexpiryduration)" : Integer,
      "[MemoryExecutionRoleArn](#cfn-bedrockagentcore-memory-memoryexecutionrolearn)" : String,
      "[MemoryStrategies](#cfn-bedrockagentcore-memory-memorystrategies)" : [ MemoryStrategy, ... ],
      "[Name](#cfn-bedrockagentcore-memory-name)" : String,
      "[StreamDeliveryResources](#cfn-bedrockagentcore-memory-streamdeliveryresources)" : StreamDeliveryResources,
      "[Tags](#cfn-bedrockagentcore-memory-tags)" : {Key: Value, ...}
    }
}
```

### YAML
<a name="aws-resource-bedrockagentcore-memory-syntax.yaml"></a>

```
Type: AWS::BedrockAgentCore::Memory
Properties:
  [Description](#cfn-bedrockagentcore-memory-description): String
  [EncryptionKeyArn](#cfn-bedrockagentcore-memory-encryptionkeyarn): String
  [EventExpiryDuration](#cfn-bedrockagentcore-memory-eventexpiryduration): Integer
  [MemoryExecutionRoleArn](#cfn-bedrockagentcore-memory-memoryexecutionrolearn): String
  [MemoryStrategies](#cfn-bedrockagentcore-memory-memorystrategies): 
    - MemoryStrategy
  [Name](#cfn-bedrockagentcore-memory-name): String
  [StreamDeliveryResources](#cfn-bedrockagentcore-memory-streamdeliveryresources): 
    StreamDeliveryResources
  [Tags](#cfn-bedrockagentcore-memory-tags): 
    Key: Value
```

## Properties
<a name="aws-resource-bedrockagentcore-memory-properties"></a>

`Description`  <a name="cfn-bedrockagentcore-memory-description"></a>
The description of the memory.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EncryptionKeyArn`  <a name="cfn-bedrockagentcore-memory-encryptionkeyarn"></a>
The ARN of the KMS key used to encrypt the memory.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:(aws(?:-cn|-us-gov|-iso(?:-[bef])?)?):[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`EventExpiryDuration`  <a name="cfn-bedrockagentcore-memory-eventexpiryduration"></a>
The number of days after which memory events will expire.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `3`  
*Maximum*: `365`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MemoryExecutionRoleArn`  <a name="cfn-bedrockagentcore-memory-memoryexecutionrolearn"></a>
The ARN of the IAM role that provides permissions for the memory.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:(aws(?:-cn|-us-gov|-iso(?:-[bef])?)?):[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MemoryStrategies`  <a name="cfn-bedrockagentcore-memory-memorystrategies"></a>
The list of memory strategies associated with this memory.  
*Required*: No  
*Type*: Array of [MemoryStrategy](aws-properties-bedrockagentcore-memory-memorystrategy.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-bedrockagentcore-memory-name"></a>
The name of the memory.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,47}$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`StreamDeliveryResources`  <a name="cfn-bedrockagentcore-memory-streamdeliveryresources"></a>
Configuration for streaming memory record data to external resources.  
*Required*: No  
*Type*: [StreamDeliveryResources](aws-properties-bedrockagentcore-memory-streamdeliveryresources.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-bedrockagentcore-memory-tags"></a>
A map of tag keys and values to assign to an AgentCore Memory. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `^[a-zA-Z0-9\s._:/=+@-]{1,128}$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-bedrockagentcore-memory-return-values"></a>

### Ref
<a name="aws-resource-bedrockagentcore-memory-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the memory. For example:

 `arn:aws:bedrock-agentcore:us-east-1:123456789012:memory/MyMemory-a1b2c3d4e5` 

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-bedrockagentcore-memory-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-bedrockagentcore-memory-return-values-fn--getatt-fn--getatt"></a>

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
The timestamp when the memory was created.

`FailureReason`  <a name="FailureReason-fn::getatt"></a>
The reason for failure if the memory is in a failed state.

`MemoryArn`  <a name="MemoryArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the memory.

`MemoryId`  <a name="MemoryId-fn::getatt"></a>
The unique identifier of the memory.

`Status`  <a name="Status-fn::getatt"></a>
The current status of the memory.

`UpdatedAt`  <a name="UpdatedAt-fn::getatt"></a>
The timestamp when the memory was last updated.

# AWS::BedrockAgentCore::Memory ContentConfiguration
<a name="aws-properties-bedrockagentcore-memory-contentconfiguration"></a>

Defines what content to stream and at what level of detail.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-contentconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-contentconfiguration-syntax.json"></a>

```
{
  "[Level](#cfn-bedrockagentcore-memory-contentconfiguration-level)" : String,
  "[Type](#cfn-bedrockagentcore-memory-contentconfiguration-type)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-contentconfiguration-syntax.yaml"></a>

```
  [Level](#cfn-bedrockagentcore-memory-contentconfiguration-level): String
  [Type](#cfn-bedrockagentcore-memory-contentconfiguration-type): String
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-contentconfiguration-properties"></a>

`Level`  <a name="cfn-bedrockagentcore-memory-contentconfiguration-level"></a>
Level of detail for streamed content.  
*Required*: No  
*Type*: String  
*Allowed values*: `METADATA_ONLY | FULL_CONTENT`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-bedrockagentcore-memory-contentconfiguration-type"></a>
Type of content to stream.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `MEMORY_RECORDS`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory CustomConfigurationInput
<a name="aws-properties-bedrockagentcore-memory-customconfigurationinput"></a>

The memory configuration input.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-customconfigurationinput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-customconfigurationinput-syntax.json"></a>

```
{
  "[EpisodicOverride](#cfn-bedrockagentcore-memory-customconfigurationinput-episodicoverride)" : EpisodicOverride,
  "[SelfManagedConfiguration](#cfn-bedrockagentcore-memory-customconfigurationinput-selfmanagedconfiguration)" : SelfManagedConfiguration,
  "[SemanticOverride](#cfn-bedrockagentcore-memory-customconfigurationinput-semanticoverride)" : SemanticOverride,
  "[SummaryOverride](#cfn-bedrockagentcore-memory-customconfigurationinput-summaryoverride)" : SummaryOverride,
  "[UserPreferenceOverride](#cfn-bedrockagentcore-memory-customconfigurationinput-userpreferenceoverride)" : UserPreferenceOverride
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-customconfigurationinput-syntax.yaml"></a>

```
  [EpisodicOverride](#cfn-bedrockagentcore-memory-customconfigurationinput-episodicoverride): 
    EpisodicOverride
  [SelfManagedConfiguration](#cfn-bedrockagentcore-memory-customconfigurationinput-selfmanagedconfiguration): 
    SelfManagedConfiguration
  [SemanticOverride](#cfn-bedrockagentcore-memory-customconfigurationinput-semanticoverride): 
    SemanticOverride
  [SummaryOverride](#cfn-bedrockagentcore-memory-customconfigurationinput-summaryoverride): 
    SummaryOverride
  [UserPreferenceOverride](#cfn-bedrockagentcore-memory-customconfigurationinput-userpreferenceoverride): 
    UserPreferenceOverride
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-customconfigurationinput-properties"></a>

`EpisodicOverride`  <a name="cfn-bedrockagentcore-memory-customconfigurationinput-episodicoverride"></a>
The episodic memory strategy override configuration for a custom memory strategy.  
*Required*: No  
*Type*: [EpisodicOverride](aws-properties-bedrockagentcore-memory-episodicoverride.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SelfManagedConfiguration`  <a name="cfn-bedrockagentcore-memory-customconfigurationinput-selfmanagedconfiguration"></a>
The custom configuration input.  
*Required*: No  
*Type*: [SelfManagedConfiguration](aws-properties-bedrockagentcore-memory-selfmanagedconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SemanticOverride`  <a name="cfn-bedrockagentcore-memory-customconfigurationinput-semanticoverride"></a>
The memory override configuration.  
*Required*: No  
*Type*: [SemanticOverride](aws-properties-bedrockagentcore-memory-semanticoverride.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SummaryOverride`  <a name="cfn-bedrockagentcore-memory-customconfigurationinput-summaryoverride"></a>
The memory configuration override.  
*Required*: No  
*Type*: [SummaryOverride](aws-properties-bedrockagentcore-memory-summaryoverride.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UserPreferenceOverride`  <a name="cfn-bedrockagentcore-memory-customconfigurationinput-userpreferenceoverride"></a>
The memory user preference override.  
*Required*: No  
*Type*: [UserPreferenceOverride](aws-properties-bedrockagentcore-memory-userpreferenceoverride.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory CustomMemoryStrategy
<a name="aws-properties-bedrockagentcore-memory-custommemorystrategy"></a>

The memory strategy.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-custommemorystrategy-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-custommemorystrategy-syntax.json"></a>

```
{
  "[Configuration](#cfn-bedrockagentcore-memory-custommemorystrategy-configuration)" : CustomConfigurationInput,
  "[CreatedAt](#cfn-bedrockagentcore-memory-custommemorystrategy-createdat)" : String,
  "[Description](#cfn-bedrockagentcore-memory-custommemorystrategy-description)" : String,
  "[Name](#cfn-bedrockagentcore-memory-custommemorystrategy-name)" : String,
  "[Namespaces](#cfn-bedrockagentcore-memory-custommemorystrategy-namespaces)" : [ String, ... ],
  "[NamespaceTemplates](#cfn-bedrockagentcore-memory-custommemorystrategy-namespacetemplates)" : [ String, ... ],
  "[Status](#cfn-bedrockagentcore-memory-custommemorystrategy-status)" : String,
  "[StrategyId](#cfn-bedrockagentcore-memory-custommemorystrategy-strategyid)" : String,
  "[Type](#cfn-bedrockagentcore-memory-custommemorystrategy-type)" : String,
  "[UpdatedAt](#cfn-bedrockagentcore-memory-custommemorystrategy-updatedat)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-custommemorystrategy-syntax.yaml"></a>

```
  [Configuration](#cfn-bedrockagentcore-memory-custommemorystrategy-configuration): 
    CustomConfigurationInput
  [CreatedAt](#cfn-bedrockagentcore-memory-custommemorystrategy-createdat): String
  [Description](#cfn-bedrockagentcore-memory-custommemorystrategy-description): String
  [Name](#cfn-bedrockagentcore-memory-custommemorystrategy-name): String
  [Namespaces](#cfn-bedrockagentcore-memory-custommemorystrategy-namespaces): 
    - String
  [NamespaceTemplates](#cfn-bedrockagentcore-memory-custommemorystrategy-namespacetemplates): 
    - String
  [Status](#cfn-bedrockagentcore-memory-custommemorystrategy-status): String
  [StrategyId](#cfn-bedrockagentcore-memory-custommemorystrategy-strategyid): String
  [Type](#cfn-bedrockagentcore-memory-custommemorystrategy-type): String
  [UpdatedAt](#cfn-bedrockagentcore-memory-custommemorystrategy-updatedat): String
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-custommemorystrategy-properties"></a>

`Configuration`  <a name="cfn-bedrockagentcore-memory-custommemorystrategy-configuration"></a>
The memory strategy configuration.  
*Required*: No  
*Type*: [CustomConfigurationInput](aws-properties-bedrockagentcore-memory-customconfigurationinput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CreatedAt`  <a name="cfn-bedrockagentcore-memory-custommemorystrategy-createdat"></a>
The memory strategy creation date and time.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-bedrockagentcore-memory-custommemorystrategy-description"></a>
The memory strategy description.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-bedrockagentcore-memory-custommemorystrategy-name"></a>
The memory strategy name.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,47}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Namespaces`  <a name="cfn-bedrockagentcore-memory-custommemorystrategy-namespaces"></a>
The memory strategy namespaces.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NamespaceTemplates`  <a name="cfn-bedrockagentcore-memory-custommemorystrategy-namespacetemplates"></a>
Property description not available.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-bedrockagentcore-memory-custommemorystrategy-status"></a>
The memory strategy status.  
*Required*: No  
*Type*: String  
*Allowed values*: `CREATING | ACTIVE | DELETING | FAILED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StrategyId`  <a name="cfn-bedrockagentcore-memory-custommemorystrategy-strategyid"></a>
The memory strategy ID.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$`  
*Minimum*: `12`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-bedrockagentcore-memory-custommemorystrategy-type"></a>
The memory strategy type.  
*Required*: No  
*Type*: String  
*Allowed values*: `SEMANTIC | SUMMARIZATION | USER_PREFERENCE | CUSTOM | EPISODIC`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UpdatedAt`  <a name="cfn-bedrockagentcore-memory-custommemorystrategy-updatedat"></a>
The memory strategy update date and time.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory EpisodicMemoryStrategy
<a name="aws-properties-bedrockagentcore-memory-episodicmemorystrategy"></a>

The configuration for an episodic memory strategy. Episodic memory stores and retrieves specific interaction episodes between agents and users.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-episodicmemorystrategy-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-episodicmemorystrategy-syntax.json"></a>

```
{
  "[CreatedAt](#cfn-bedrockagentcore-memory-episodicmemorystrategy-createdat)" : String,
  "[Description](#cfn-bedrockagentcore-memory-episodicmemorystrategy-description)" : String,
  "[Name](#cfn-bedrockagentcore-memory-episodicmemorystrategy-name)" : String,
  "[Namespaces](#cfn-bedrockagentcore-memory-episodicmemorystrategy-namespaces)" : [ String, ... ],
  "[NamespaceTemplates](#cfn-bedrockagentcore-memory-episodicmemorystrategy-namespacetemplates)" : [ String, ... ],
  "[ReflectionConfiguration](#cfn-bedrockagentcore-memory-episodicmemorystrategy-reflectionconfiguration)" : EpisodicReflectionConfigurationInput,
  "[Status](#cfn-bedrockagentcore-memory-episodicmemorystrategy-status)" : String,
  "[StrategyId](#cfn-bedrockagentcore-memory-episodicmemorystrategy-strategyid)" : String,
  "[Type](#cfn-bedrockagentcore-memory-episodicmemorystrategy-type)" : String,
  "[UpdatedAt](#cfn-bedrockagentcore-memory-episodicmemorystrategy-updatedat)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-episodicmemorystrategy-syntax.yaml"></a>

```
  [CreatedAt](#cfn-bedrockagentcore-memory-episodicmemorystrategy-createdat): String
  [Description](#cfn-bedrockagentcore-memory-episodicmemorystrategy-description): String
  [Name](#cfn-bedrockagentcore-memory-episodicmemorystrategy-name): String
  [Namespaces](#cfn-bedrockagentcore-memory-episodicmemorystrategy-namespaces): 
    - String
  [NamespaceTemplates](#cfn-bedrockagentcore-memory-episodicmemorystrategy-namespacetemplates): 
    - String
  [ReflectionConfiguration](#cfn-bedrockagentcore-memory-episodicmemorystrategy-reflectionconfiguration): 
    EpisodicReflectionConfigurationInput
  [Status](#cfn-bedrockagentcore-memory-episodicmemorystrategy-status): String
  [StrategyId](#cfn-bedrockagentcore-memory-episodicmemorystrategy-strategyid): String
  [Type](#cfn-bedrockagentcore-memory-episodicmemorystrategy-type): String
  [UpdatedAt](#cfn-bedrockagentcore-memory-episodicmemorystrategy-updatedat): String
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-episodicmemorystrategy-properties"></a>

`CreatedAt`  <a name="cfn-bedrockagentcore-memory-episodicmemorystrategy-createdat"></a>
The timestamp when the episodic memory strategy was created.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-bedrockagentcore-memory-episodicmemorystrategy-description"></a>
The description of the episodic memory strategy.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-bedrockagentcore-memory-episodicmemorystrategy-name"></a>
The name of the episodic memory strategy.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,47}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Namespaces`  <a name="cfn-bedrockagentcore-memory-episodicmemorystrategy-namespaces"></a>
The namespaces for which to create episodes.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NamespaceTemplates`  <a name="cfn-bedrockagentcore-memory-episodicmemorystrategy-namespacetemplates"></a>
Property description not available.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReflectionConfiguration`  <a name="cfn-bedrockagentcore-memory-episodicmemorystrategy-reflectionconfiguration"></a>
The configuration for the reflections created with the episodic memory strategy.  
*Required*: No  
*Type*: [EpisodicReflectionConfigurationInput](aws-properties-bedrockagentcore-memory-episodicreflectionconfigurationinput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-bedrockagentcore-memory-episodicmemorystrategy-status"></a>
The current status of the episodic memory strategy.  
*Required*: No  
*Type*: String  
*Allowed values*: `CREATING | ACTIVE | DELETING | FAILED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StrategyId`  <a name="cfn-bedrockagentcore-memory-episodicmemorystrategy-strategyid"></a>
The unique identifier of the memory strategy.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$`  
*Minimum*: `12`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-bedrockagentcore-memory-episodicmemorystrategy-type"></a>
The type of the memory strategy.  
*Required*: No  
*Type*: String  
*Allowed values*: `SEMANTIC | SUMMARIZATION | USER_PREFERENCE | CUSTOM | EPISODIC`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UpdatedAt`  <a name="cfn-bedrockagentcore-memory-episodicmemorystrategy-updatedat"></a>
The timestamp when the episodic memory strategy was last updated.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory EpisodicOverride
<a name="aws-properties-bedrockagentcore-memory-episodicoverride"></a>

The configuration to override the episodic memory strategy.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-episodicoverride-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-episodicoverride-syntax.json"></a>

```
{
  "[Consolidation](#cfn-bedrockagentcore-memory-episodicoverride-consolidation)" : EpisodicOverrideConsolidationConfigurationInput,
  "[Extraction](#cfn-bedrockagentcore-memory-episodicoverride-extraction)" : EpisodicOverrideExtractionConfigurationInput,
  "[Reflection](#cfn-bedrockagentcore-memory-episodicoverride-reflection)" : EpisodicOverrideReflectionConfigurationInput
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-episodicoverride-syntax.yaml"></a>

```
  [Consolidation](#cfn-bedrockagentcore-memory-episodicoverride-consolidation): 
    EpisodicOverrideConsolidationConfigurationInput
  [Extraction](#cfn-bedrockagentcore-memory-episodicoverride-extraction): 
    EpisodicOverrideExtractionConfigurationInput
  [Reflection](#cfn-bedrockagentcore-memory-episodicoverride-reflection): 
    EpisodicOverrideReflectionConfigurationInput
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-episodicoverride-properties"></a>

`Consolidation`  <a name="cfn-bedrockagentcore-memory-episodicoverride-consolidation"></a>
Contains configurations for overriding the consolidation step of the episodic memory strategy.  
*Required*: No  
*Type*: [EpisodicOverrideConsolidationConfigurationInput](aws-properties-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Extraction`  <a name="cfn-bedrockagentcore-memory-episodicoverride-extraction"></a>
Contains configurations for overriding the extraction step of the episodic memory strategy.  
*Required*: No  
*Type*: [EpisodicOverrideExtractionConfigurationInput](aws-properties-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Reflection`  <a name="cfn-bedrockagentcore-memory-episodicoverride-reflection"></a>
Contains configurations for overriding the reflection step of the episodic memory strategy.  
*Required*: No  
*Type*: [EpisodicOverrideReflectionConfigurationInput](aws-properties-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory EpisodicOverrideConsolidationConfigurationInput
<a name="aws-properties-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput"></a>

Configurations for overriding the consolidation step of the episodic memory strategy.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput-syntax.json"></a>

```
{
  "[AppendToPrompt](#cfn-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput-appendtoprompt)" : String,
  "[ModelId](#cfn-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput-modelid)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput-syntax.yaml"></a>

```
  [AppendToPrompt](#cfn-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput-appendtoprompt): String
  [ModelId](#cfn-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput-modelid): String
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput-properties"></a>

`AppendToPrompt`  <a name="cfn-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput-appendtoprompt"></a>
The text to append to the prompt for the consolidation step of the episodic memory strategy.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `30000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelId`  <a name="cfn-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput-modelid"></a>
The model ID to use for the consolidation step of the episodic memory strategy.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory EpisodicOverrideExtractionConfigurationInput
<a name="aws-properties-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput"></a>

Configurations for overriding the extraction step of the episodic memory strategy.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput-syntax.json"></a>

```
{
  "[AppendToPrompt](#cfn-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput-appendtoprompt)" : String,
  "[ModelId](#cfn-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput-modelid)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput-syntax.yaml"></a>

```
  [AppendToPrompt](#cfn-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput-appendtoprompt): String
  [ModelId](#cfn-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput-modelid): String
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput-properties"></a>

`AppendToPrompt`  <a name="cfn-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput-appendtoprompt"></a>
The text to append to the prompt for the extraction step of the episodic memory strategy.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `30000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelId`  <a name="cfn-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput-modelid"></a>
The model ID to use for the extraction step of the episodic memory strategy.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory EpisodicOverrideReflectionConfigurationInput
<a name="aws-properties-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput"></a>

Configurations for overriding the reflection step of the episodic memory strategy.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-syntax.json"></a>

```
{
  "[AppendToPrompt](#cfn-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-appendtoprompt)" : String,
  "[ModelId](#cfn-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-modelid)" : String,
  "[Namespaces](#cfn-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-namespaces)" : [ String, ... ],
  "[NamespaceTemplates](#cfn-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-namespacetemplates)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-syntax.yaml"></a>

```
  [AppendToPrompt](#cfn-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-appendtoprompt): String
  [ModelId](#cfn-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-modelid): String
  [Namespaces](#cfn-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-namespaces): 
    - String
  [NamespaceTemplates](#cfn-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-namespacetemplates): 
    - String
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-properties"></a>

`AppendToPrompt`  <a name="cfn-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-appendtoprompt"></a>
The text to append to the prompt for reflection step of the episodic memory strategy.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `30000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelId`  <a name="cfn-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-modelid"></a>
The model ID to use for the reflection step of the episodic memory strategy.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Namespaces`  <a name="cfn-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-namespaces"></a>
The namespaces to use for episodic reflection. Can be less nested than the episodic namespaces.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NamespaceTemplates`  <a name="cfn-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-namespacetemplates"></a>
The namespaceTemplates to use for episodic reflection. Can be less nested than the episodic namespaces.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory EpisodicReflectionConfigurationInput
<a name="aws-properties-bedrockagentcore-memory-episodicreflectionconfigurationinput"></a>

An episodic reflection configuration input.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-episodicreflectionconfigurationinput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-episodicreflectionconfigurationinput-syntax.json"></a>

```
{
  "[Namespaces](#cfn-bedrockagentcore-memory-episodicreflectionconfigurationinput-namespaces)" : [ String, ... ],
  "[NamespaceTemplates](#cfn-bedrockagentcore-memory-episodicreflectionconfigurationinput-namespacetemplates)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-episodicreflectionconfigurationinput-syntax.yaml"></a>

```
  [Namespaces](#cfn-bedrockagentcore-memory-episodicreflectionconfigurationinput-namespaces): 
    - String
  [NamespaceTemplates](#cfn-bedrockagentcore-memory-episodicreflectionconfigurationinput-namespacetemplates): 
    - String
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-episodicreflectionconfigurationinput-properties"></a>

`Namespaces`  <a name="cfn-bedrockagentcore-memory-episodicreflectionconfigurationinput-namespaces"></a>
The namespaces over which to create reflections. Can be less nested than episode namespaces.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NamespaceTemplates`  <a name="cfn-bedrockagentcore-memory-episodicreflectionconfigurationinput-namespacetemplates"></a>
The namespaceTemplates over which to create reflections. Can be less nested than episode namespaces.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory InvocationConfigurationInput
<a name="aws-properties-bedrockagentcore-memory-invocationconfigurationinput"></a>

The memory invocation configuration input.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-invocationconfigurationinput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-invocationconfigurationinput-syntax.json"></a>

```
{
  "[PayloadDeliveryBucketName](#cfn-bedrockagentcore-memory-invocationconfigurationinput-payloaddeliverybucketname)" : String,
  "[TopicArn](#cfn-bedrockagentcore-memory-invocationconfigurationinput-topicarn)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-invocationconfigurationinput-syntax.yaml"></a>

```
  [PayloadDeliveryBucketName](#cfn-bedrockagentcore-memory-invocationconfigurationinput-payloaddeliverybucketname): String
  [TopicArn](#cfn-bedrockagentcore-memory-invocationconfigurationinput-topicarn): String
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-invocationconfigurationinput-properties"></a>

`PayloadDeliveryBucketName`  <a name="cfn-bedrockagentcore-memory-invocationconfigurationinput-payloaddeliverybucketname"></a>
The message invocation configuration information for the bucket name.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TopicArn`  <a name="cfn-bedrockagentcore-memory-invocationconfigurationinput-topicarn"></a>
The memory trigger condition topic Amazon Resource Name (ARN).  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:(aws(?:-cn|-us-gov|-iso(?:-[bef])?)?):[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory KinesisResource
<a name="aws-properties-bedrockagentcore-memory-kinesisresource"></a>

Configuration for Kinesis Data Stream delivery.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-kinesisresource-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-kinesisresource-syntax.json"></a>

```
{
  "[ContentConfigurations](#cfn-bedrockagentcore-memory-kinesisresource-contentconfigurations)" : [ ContentConfiguration, ... ],
  "[DataStreamArn](#cfn-bedrockagentcore-memory-kinesisresource-datastreamarn)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-kinesisresource-syntax.yaml"></a>

```
  [ContentConfigurations](#cfn-bedrockagentcore-memory-kinesisresource-contentconfigurations): 
    - ContentConfiguration
  [DataStreamArn](#cfn-bedrockagentcore-memory-kinesisresource-datastreamarn): String
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-kinesisresource-properties"></a>

`ContentConfigurations`  <a name="cfn-bedrockagentcore-memory-kinesisresource-contentconfigurations"></a>
Content configurations for stream delivery.  
*Required*: Yes  
*Type*: Array of [ContentConfiguration](aws-properties-bedrockagentcore-memory-contentconfiguration.md)  
*Minimum*: `1`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DataStreamArn`  <a name="cfn-bedrockagentcore-memory-kinesisresource-datastreamarn"></a>
ARN of the Kinesis Data Stream.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:(aws(?:-cn|-us-gov|-iso(?:-[bef])?)?):[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory MemoryStrategy
<a name="aws-properties-bedrockagentcore-memory-memorystrategy"></a>

The memory strategy.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-memorystrategy-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-memorystrategy-syntax.json"></a>

```
{
  "[CustomMemoryStrategy](#cfn-bedrockagentcore-memory-memorystrategy-custommemorystrategy)" : CustomMemoryStrategy,
  "[EpisodicMemoryStrategy](#cfn-bedrockagentcore-memory-memorystrategy-episodicmemorystrategy)" : EpisodicMemoryStrategy,
  "[SemanticMemoryStrategy](#cfn-bedrockagentcore-memory-memorystrategy-semanticmemorystrategy)" : SemanticMemoryStrategy,
  "[SummaryMemoryStrategy](#cfn-bedrockagentcore-memory-memorystrategy-summarymemorystrategy)" : SummaryMemoryStrategy,
  "[UserPreferenceMemoryStrategy](#cfn-bedrockagentcore-memory-memorystrategy-userpreferencememorystrategy)" : UserPreferenceMemoryStrategy
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-memorystrategy-syntax.yaml"></a>

```
  [CustomMemoryStrategy](#cfn-bedrockagentcore-memory-memorystrategy-custommemorystrategy): 
    CustomMemoryStrategy
  [EpisodicMemoryStrategy](#cfn-bedrockagentcore-memory-memorystrategy-episodicmemorystrategy): 
    EpisodicMemoryStrategy
  [SemanticMemoryStrategy](#cfn-bedrockagentcore-memory-memorystrategy-semanticmemorystrategy): 
    SemanticMemoryStrategy
  [SummaryMemoryStrategy](#cfn-bedrockagentcore-memory-memorystrategy-summarymemorystrategy): 
    SummaryMemoryStrategy
  [UserPreferenceMemoryStrategy](#cfn-bedrockagentcore-memory-memorystrategy-userpreferencememorystrategy): 
    UserPreferenceMemoryStrategy
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-memorystrategy-properties"></a>

`CustomMemoryStrategy`  <a name="cfn-bedrockagentcore-memory-memorystrategy-custommemorystrategy"></a>
The memory strategy.  
*Required*: No  
*Type*: [CustomMemoryStrategy](aws-properties-bedrockagentcore-memory-custommemorystrategy.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EpisodicMemoryStrategy`  <a name="cfn-bedrockagentcore-memory-memorystrategy-episodicmemorystrategy"></a>
The episodic memory strategy configuration.  
*Required*: No  
*Type*: [EpisodicMemoryStrategy](aws-properties-bedrockagentcore-memory-episodicmemorystrategy.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SemanticMemoryStrategy`  <a name="cfn-bedrockagentcore-memory-memorystrategy-semanticmemorystrategy"></a>
The memory strategy.  
*Required*: No  
*Type*: [SemanticMemoryStrategy](aws-properties-bedrockagentcore-memory-semanticmemorystrategy.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SummaryMemoryStrategy`  <a name="cfn-bedrockagentcore-memory-memorystrategy-summarymemorystrategy"></a>
The memory strategy summary.  
*Required*: No  
*Type*: [SummaryMemoryStrategy](aws-properties-bedrockagentcore-memory-summarymemorystrategy.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UserPreferenceMemoryStrategy`  <a name="cfn-bedrockagentcore-memory-memorystrategy-userpreferencememorystrategy"></a>
The memory strategy.  
*Required*: No  
*Type*: [UserPreferenceMemoryStrategy](aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory MessageBasedTriggerInput
<a name="aws-properties-bedrockagentcore-memory-messagebasedtriggerinput"></a>

The message based trigger input.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-messagebasedtriggerinput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-messagebasedtriggerinput-syntax.json"></a>

```
{
  "[MessageCount](#cfn-bedrockagentcore-memory-messagebasedtriggerinput-messagecount)" : Integer
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-messagebasedtriggerinput-syntax.yaml"></a>

```
  [MessageCount](#cfn-bedrockagentcore-memory-messagebasedtriggerinput-messagecount): Integer
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-messagebasedtriggerinput-properties"></a>

`MessageCount`  <a name="cfn-bedrockagentcore-memory-messagebasedtriggerinput-messagecount"></a>
The memory trigger condition input for the message based trigger message count.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory SelfManagedConfiguration
<a name="aws-properties-bedrockagentcore-memory-selfmanagedconfiguration"></a>

The self managed configuration.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-selfmanagedconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-selfmanagedconfiguration-syntax.json"></a>

```
{
  "[HistoricalContextWindowSize](#cfn-bedrockagentcore-memory-selfmanagedconfiguration-historicalcontextwindowsize)" : Integer,
  "[InvocationConfiguration](#cfn-bedrockagentcore-memory-selfmanagedconfiguration-invocationconfiguration)" : InvocationConfigurationInput,
  "[TriggerConditions](#cfn-bedrockagentcore-memory-selfmanagedconfiguration-triggerconditions)" : [ TriggerConditionInput, ... ]
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-selfmanagedconfiguration-syntax.yaml"></a>

```
  [HistoricalContextWindowSize](#cfn-bedrockagentcore-memory-selfmanagedconfiguration-historicalcontextwindowsize): Integer
  [InvocationConfiguration](#cfn-bedrockagentcore-memory-selfmanagedconfiguration-invocationconfiguration): 
    InvocationConfigurationInput
  [TriggerConditions](#cfn-bedrockagentcore-memory-selfmanagedconfiguration-triggerconditions): 
    - TriggerConditionInput
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-selfmanagedconfiguration-properties"></a>

`HistoricalContextWindowSize`  <a name="cfn-bedrockagentcore-memory-selfmanagedconfiguration-historicalcontextwindowsize"></a>
The memory configuration for self managed.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InvocationConfiguration`  <a name="cfn-bedrockagentcore-memory-selfmanagedconfiguration-invocationconfiguration"></a>
The self managed configuration.  
*Required*: No  
*Type*: [InvocationConfigurationInput](aws-properties-bedrockagentcore-memory-invocationconfigurationinput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TriggerConditions`  <a name="cfn-bedrockagentcore-memory-selfmanagedconfiguration-triggerconditions"></a>
A list of conditions that trigger memory processing.  
*Required*: No  
*Type*: Array of [TriggerConditionInput](aws-properties-bedrockagentcore-memory-triggerconditioninput.md)  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory SemanticMemoryStrategy
<a name="aws-properties-bedrockagentcore-memory-semanticmemorystrategy"></a>

The memory strategy.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-semanticmemorystrategy-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-semanticmemorystrategy-syntax.json"></a>

```
{
  "[CreatedAt](#cfn-bedrockagentcore-memory-semanticmemorystrategy-createdat)" : String,
  "[Description](#cfn-bedrockagentcore-memory-semanticmemorystrategy-description)" : String,
  "[Name](#cfn-bedrockagentcore-memory-semanticmemorystrategy-name)" : String,
  "[Namespaces](#cfn-bedrockagentcore-memory-semanticmemorystrategy-namespaces)" : [ String, ... ],
  "[NamespaceTemplates](#cfn-bedrockagentcore-memory-semanticmemorystrategy-namespacetemplates)" : [ String, ... ],
  "[Status](#cfn-bedrockagentcore-memory-semanticmemorystrategy-status)" : String,
  "[StrategyId](#cfn-bedrockagentcore-memory-semanticmemorystrategy-strategyid)" : String,
  "[Type](#cfn-bedrockagentcore-memory-semanticmemorystrategy-type)" : String,
  "[UpdatedAt](#cfn-bedrockagentcore-memory-semanticmemorystrategy-updatedat)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-semanticmemorystrategy-syntax.yaml"></a>

```
  [CreatedAt](#cfn-bedrockagentcore-memory-semanticmemorystrategy-createdat): String
  [Description](#cfn-bedrockagentcore-memory-semanticmemorystrategy-description): String
  [Name](#cfn-bedrockagentcore-memory-semanticmemorystrategy-name): String
  [Namespaces](#cfn-bedrockagentcore-memory-semanticmemorystrategy-namespaces): 
    - String
  [NamespaceTemplates](#cfn-bedrockagentcore-memory-semanticmemorystrategy-namespacetemplates): 
    - String
  [Status](#cfn-bedrockagentcore-memory-semanticmemorystrategy-status): String
  [StrategyId](#cfn-bedrockagentcore-memory-semanticmemorystrategy-strategyid): String
  [Type](#cfn-bedrockagentcore-memory-semanticmemorystrategy-type): String
  [UpdatedAt](#cfn-bedrockagentcore-memory-semanticmemorystrategy-updatedat): String
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-semanticmemorystrategy-properties"></a>

`CreatedAt`  <a name="cfn-bedrockagentcore-memory-semanticmemorystrategy-createdat"></a>
The memory strategy creation date and time.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-bedrockagentcore-memory-semanticmemorystrategy-description"></a>
The memory strategy description.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-bedrockagentcore-memory-semanticmemorystrategy-name"></a>
The memory strategy name.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,47}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Namespaces`  <a name="cfn-bedrockagentcore-memory-semanticmemorystrategy-namespaces"></a>
The memory strategy namespaces.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NamespaceTemplates`  <a name="cfn-bedrockagentcore-memory-semanticmemorystrategy-namespacetemplates"></a>
Property description not available.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-bedrockagentcore-memory-semanticmemorystrategy-status"></a>
The memory strategy status.  
*Required*: No  
*Type*: String  
*Allowed values*: `CREATING | ACTIVE | DELETING | FAILED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StrategyId`  <a name="cfn-bedrockagentcore-memory-semanticmemorystrategy-strategyid"></a>
The memory strategy ID.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$`  
*Minimum*: `12`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-bedrockagentcore-memory-semanticmemorystrategy-type"></a>
The memory strategy type.  
*Required*: No  
*Type*: String  
*Allowed values*: `SEMANTIC | SUMMARIZATION | USER_PREFERENCE | CUSTOM | EPISODIC`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UpdatedAt`  <a name="cfn-bedrockagentcore-memory-semanticmemorystrategy-updatedat"></a>
The timestamp when the semantic memory strategy was last updated.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory SemanticOverride
<a name="aws-properties-bedrockagentcore-memory-semanticoverride"></a>

The memory override.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-semanticoverride-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-semanticoverride-syntax.json"></a>

```
{
  "[Consolidation](#cfn-bedrockagentcore-memory-semanticoverride-consolidation)" : SemanticOverrideConsolidationConfigurationInput,
  "[Extraction](#cfn-bedrockagentcore-memory-semanticoverride-extraction)" : SemanticOverrideExtractionConfigurationInput
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-semanticoverride-syntax.yaml"></a>

```
  [Consolidation](#cfn-bedrockagentcore-memory-semanticoverride-consolidation): 
    SemanticOverrideConsolidationConfigurationInput
  [Extraction](#cfn-bedrockagentcore-memory-semanticoverride-extraction): 
    SemanticOverrideExtractionConfigurationInput
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-semanticoverride-properties"></a>

`Consolidation`  <a name="cfn-bedrockagentcore-memory-semanticoverride-consolidation"></a>
The memory override consolidation.  
*Required*: No  
*Type*: [SemanticOverrideConsolidationConfigurationInput](aws-properties-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Extraction`  <a name="cfn-bedrockagentcore-memory-semanticoverride-extraction"></a>
The memory override extraction.  
*Required*: No  
*Type*: [SemanticOverrideExtractionConfigurationInput](aws-properties-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory SemanticOverrideConsolidationConfigurationInput
<a name="aws-properties-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput"></a>

The memory override configuration.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput-syntax.json"></a>

```
{
  "[AppendToPrompt](#cfn-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput-appendtoprompt)" : String,
  "[ModelId](#cfn-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput-modelid)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput-syntax.yaml"></a>

```
  [AppendToPrompt](#cfn-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput-appendtoprompt): String
  [ModelId](#cfn-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput-modelid): String
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput-properties"></a>

`AppendToPrompt`  <a name="cfn-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput-appendtoprompt"></a>
The override configuration.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `30000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelId`  <a name="cfn-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput-modelid"></a>
The memory override model ID.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory SemanticOverrideExtractionConfigurationInput
<a name="aws-properties-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput"></a>

The memory override configuration.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput-syntax.json"></a>

```
{
  "[AppendToPrompt](#cfn-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput-appendtoprompt)" : String,
  "[ModelId](#cfn-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput-modelid)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput-syntax.yaml"></a>

```
  [AppendToPrompt](#cfn-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput-appendtoprompt): String
  [ModelId](#cfn-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput-modelid): String
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput-properties"></a>

`AppendToPrompt`  <a name="cfn-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput-appendtoprompt"></a>
The extraction configuration.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `30000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelId`  <a name="cfn-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput-modelid"></a>
The memory override configuration model ID.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory StreamDeliveryResource
<a name="aws-properties-bedrockagentcore-memory-streamdeliveryresource"></a>

Supported stream delivery resource types.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-streamdeliveryresource-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-streamdeliveryresource-syntax.json"></a>

```
{
  "[Kinesis](#cfn-bedrockagentcore-memory-streamdeliveryresource-kinesis)" : KinesisResource
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-streamdeliveryresource-syntax.yaml"></a>

```
  [Kinesis](#cfn-bedrockagentcore-memory-streamdeliveryresource-kinesis): 
    KinesisResource
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-streamdeliveryresource-properties"></a>

`Kinesis`  <a name="cfn-bedrockagentcore-memory-streamdeliveryresource-kinesis"></a>
Kinesis Data Stream configuration.  
*Required*: No  
*Type*: [KinesisResource](aws-properties-bedrockagentcore-memory-kinesisresource.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory StreamDeliveryResources
<a name="aws-properties-bedrockagentcore-memory-streamdeliveryresources"></a>

Configuration for streaming memory record data to external resources.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-streamdeliveryresources-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-streamdeliveryresources-syntax.json"></a>

```
{
  "[Resources](#cfn-bedrockagentcore-memory-streamdeliveryresources-resources)" : [ StreamDeliveryResource, ... ]
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-streamdeliveryresources-syntax.yaml"></a>

```
  [Resources](#cfn-bedrockagentcore-memory-streamdeliveryresources-resources): 
    - StreamDeliveryResource
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-streamdeliveryresources-properties"></a>

`Resources`  <a name="cfn-bedrockagentcore-memory-streamdeliveryresources-resources"></a>
List of stream delivery resource configurations.  
*Required*: Yes  
*Type*: Array of [StreamDeliveryResource](aws-properties-bedrockagentcore-memory-streamdeliveryresource.md)  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory SummaryMemoryStrategy
<a name="aws-properties-bedrockagentcore-memory-summarymemorystrategy"></a>

The memory strategy.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-summarymemorystrategy-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-summarymemorystrategy-syntax.json"></a>

```
{
  "[CreatedAt](#cfn-bedrockagentcore-memory-summarymemorystrategy-createdat)" : String,
  "[Description](#cfn-bedrockagentcore-memory-summarymemorystrategy-description)" : String,
  "[Name](#cfn-bedrockagentcore-memory-summarymemorystrategy-name)" : String,
  "[Namespaces](#cfn-bedrockagentcore-memory-summarymemorystrategy-namespaces)" : [ String, ... ],
  "[NamespaceTemplates](#cfn-bedrockagentcore-memory-summarymemorystrategy-namespacetemplates)" : [ String, ... ],
  "[Status](#cfn-bedrockagentcore-memory-summarymemorystrategy-status)" : String,
  "[StrategyId](#cfn-bedrockagentcore-memory-summarymemorystrategy-strategyid)" : String,
  "[Type](#cfn-bedrockagentcore-memory-summarymemorystrategy-type)" : String,
  "[UpdatedAt](#cfn-bedrockagentcore-memory-summarymemorystrategy-updatedat)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-summarymemorystrategy-syntax.yaml"></a>

```
  [CreatedAt](#cfn-bedrockagentcore-memory-summarymemorystrategy-createdat): String
  [Description](#cfn-bedrockagentcore-memory-summarymemorystrategy-description): String
  [Name](#cfn-bedrockagentcore-memory-summarymemorystrategy-name): String
  [Namespaces](#cfn-bedrockagentcore-memory-summarymemorystrategy-namespaces): 
    - String
  [NamespaceTemplates](#cfn-bedrockagentcore-memory-summarymemorystrategy-namespacetemplates): 
    - String
  [Status](#cfn-bedrockagentcore-memory-summarymemorystrategy-status): String
  [StrategyId](#cfn-bedrockagentcore-memory-summarymemorystrategy-strategyid): String
  [Type](#cfn-bedrockagentcore-memory-summarymemorystrategy-type): String
  [UpdatedAt](#cfn-bedrockagentcore-memory-summarymemorystrategy-updatedat): String
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-summarymemorystrategy-properties"></a>

`CreatedAt`  <a name="cfn-bedrockagentcore-memory-summarymemorystrategy-createdat"></a>
The timestamp when the summary memory strategy was created.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-bedrockagentcore-memory-summarymemorystrategy-description"></a>
The memory strategy description.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-bedrockagentcore-memory-summarymemorystrategy-name"></a>
The memory strategy name.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,47}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Namespaces`  <a name="cfn-bedrockagentcore-memory-summarymemorystrategy-namespaces"></a>
The summary memory strategy.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NamespaceTemplates`  <a name="cfn-bedrockagentcore-memory-summarymemorystrategy-namespacetemplates"></a>
Property description not available.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-bedrockagentcore-memory-summarymemorystrategy-status"></a>
The memory strategy status.  
*Required*: No  
*Type*: String  
*Allowed values*: `CREATING | ACTIVE | DELETING | FAILED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StrategyId`  <a name="cfn-bedrockagentcore-memory-summarymemorystrategy-strategyid"></a>
The memory strategy ID.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$`  
*Minimum*: `12`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-bedrockagentcore-memory-summarymemorystrategy-type"></a>
The memory strategy type.  
*Required*: No  
*Type*: String  
*Allowed values*: `SEMANTIC | SUMMARIZATION | USER_PREFERENCE | CUSTOM | EPISODIC`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UpdatedAt`  <a name="cfn-bedrockagentcore-memory-summarymemorystrategy-updatedat"></a>
The memory strategy update date and time.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory SummaryOverride
<a name="aws-properties-bedrockagentcore-memory-summaryoverride"></a>

The memory summary override.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-summaryoverride-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-summaryoverride-syntax.json"></a>

```
{
  "[Consolidation](#cfn-bedrockagentcore-memory-summaryoverride-consolidation)" : SummaryOverrideConsolidationConfigurationInput
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-summaryoverride-syntax.yaml"></a>

```
  [Consolidation](#cfn-bedrockagentcore-memory-summaryoverride-consolidation): 
    SummaryOverrideConsolidationConfigurationInput
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-summaryoverride-properties"></a>

`Consolidation`  <a name="cfn-bedrockagentcore-memory-summaryoverride-consolidation"></a>
The memory override consolidation.  
*Required*: No  
*Type*: [SummaryOverrideConsolidationConfigurationInput](aws-properties-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory SummaryOverrideConsolidationConfigurationInput
<a name="aws-properties-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput"></a>

The consolidation configuration.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput-syntax.json"></a>

```
{
  "[AppendToPrompt](#cfn-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput-appendtoprompt)" : String,
  "[ModelId](#cfn-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput-modelid)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput-syntax.yaml"></a>

```
  [AppendToPrompt](#cfn-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput-appendtoprompt): String
  [ModelId](#cfn-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput-modelid): String
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput-properties"></a>

`AppendToPrompt`  <a name="cfn-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput-appendtoprompt"></a>
The memory override configuration.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `30000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelId`  <a name="cfn-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput-modelid"></a>
The memory override configuration model ID.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory TimeBasedTriggerInput
<a name="aws-properties-bedrockagentcore-memory-timebasedtriggerinput"></a>

The memory trigger condition input for the time based trigger.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-timebasedtriggerinput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-timebasedtriggerinput-syntax.json"></a>

```
{
  "[IdleSessionTimeout](#cfn-bedrockagentcore-memory-timebasedtriggerinput-idlesessiontimeout)" : Integer
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-timebasedtriggerinput-syntax.yaml"></a>

```
  [IdleSessionTimeout](#cfn-bedrockagentcore-memory-timebasedtriggerinput-idlesessiontimeout): Integer
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-timebasedtriggerinput-properties"></a>

`IdleSessionTimeout`  <a name="cfn-bedrockagentcore-memory-timebasedtriggerinput-idlesessiontimeout"></a>
The memory trigger condition input for the session timeout.  
*Required*: No  
*Type*: Integer  
*Minimum*: `10`  
*Maximum*: `3000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory TokenBasedTriggerInput
<a name="aws-properties-bedrockagentcore-memory-tokenbasedtriggerinput"></a>

The token based trigger input.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-tokenbasedtriggerinput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-tokenbasedtriggerinput-syntax.json"></a>

```
{
  "[TokenCount](#cfn-bedrockagentcore-memory-tokenbasedtriggerinput-tokencount)" : Integer
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-tokenbasedtriggerinput-syntax.yaml"></a>

```
  [TokenCount](#cfn-bedrockagentcore-memory-tokenbasedtriggerinput-tokencount): Integer
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-tokenbasedtriggerinput-properties"></a>

`TokenCount`  <a name="cfn-bedrockagentcore-memory-tokenbasedtriggerinput-tokencount"></a>
The token based trigger token count.  
*Required*: No  
*Type*: Integer  
*Minimum*: `100`  
*Maximum*: `500000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory TriggerConditionInput
<a name="aws-properties-bedrockagentcore-memory-triggerconditioninput"></a>

The memory trigger condition input.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-triggerconditioninput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-triggerconditioninput-syntax.json"></a>

```
{
  "[MessageBasedTrigger](#cfn-bedrockagentcore-memory-triggerconditioninput-messagebasedtrigger)" : MessageBasedTriggerInput,
  "[TimeBasedTrigger](#cfn-bedrockagentcore-memory-triggerconditioninput-timebasedtrigger)" : TimeBasedTriggerInput,
  "[TokenBasedTrigger](#cfn-bedrockagentcore-memory-triggerconditioninput-tokenbasedtrigger)" : TokenBasedTriggerInput
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-triggerconditioninput-syntax.yaml"></a>

```
  [MessageBasedTrigger](#cfn-bedrockagentcore-memory-triggerconditioninput-messagebasedtrigger): 
    MessageBasedTriggerInput
  [TimeBasedTrigger](#cfn-bedrockagentcore-memory-triggerconditioninput-timebasedtrigger): 
    TimeBasedTriggerInput
  [TokenBasedTrigger](#cfn-bedrockagentcore-memory-triggerconditioninput-tokenbasedtrigger): 
    TokenBasedTriggerInput
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-triggerconditioninput-properties"></a>

`MessageBasedTrigger`  <a name="cfn-bedrockagentcore-memory-triggerconditioninput-messagebasedtrigger"></a>
The memory trigger condition input for the message based trigger.  
*Required*: No  
*Type*: [MessageBasedTriggerInput](aws-properties-bedrockagentcore-memory-messagebasedtriggerinput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeBasedTrigger`  <a name="cfn-bedrockagentcore-memory-triggerconditioninput-timebasedtrigger"></a>
The memory trigger condition input.  
*Required*: No  
*Type*: [TimeBasedTriggerInput](aws-properties-bedrockagentcore-memory-timebasedtriggerinput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TokenBasedTrigger`  <a name="cfn-bedrockagentcore-memory-triggerconditioninput-tokenbasedtrigger"></a>
The trigger condition information for a token based trigger.  
*Required*: No  
*Type*: [TokenBasedTriggerInput](aws-properties-bedrockagentcore-memory-tokenbasedtriggerinput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory UserPreferenceMemoryStrategy
<a name="aws-properties-bedrockagentcore-memory-userpreferencememorystrategy"></a>

The memory strategy.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-userpreferencememorystrategy-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-userpreferencememorystrategy-syntax.json"></a>

```
{
  "[CreatedAt](#cfn-bedrockagentcore-memory-userpreferencememorystrategy-createdat)" : String,
  "[Description](#cfn-bedrockagentcore-memory-userpreferencememorystrategy-description)" : String,
  "[Name](#cfn-bedrockagentcore-memory-userpreferencememorystrategy-name)" : String,
  "[Namespaces](#cfn-bedrockagentcore-memory-userpreferencememorystrategy-namespaces)" : [ String, ... ],
  "[NamespaceTemplates](#cfn-bedrockagentcore-memory-userpreferencememorystrategy-namespacetemplates)" : [ String, ... ],
  "[Status](#cfn-bedrockagentcore-memory-userpreferencememorystrategy-status)" : String,
  "[StrategyId](#cfn-bedrockagentcore-memory-userpreferencememorystrategy-strategyid)" : String,
  "[Type](#cfn-bedrockagentcore-memory-userpreferencememorystrategy-type)" : String,
  "[UpdatedAt](#cfn-bedrockagentcore-memory-userpreferencememorystrategy-updatedat)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-userpreferencememorystrategy-syntax.yaml"></a>

```
  [CreatedAt](#cfn-bedrockagentcore-memory-userpreferencememorystrategy-createdat): String
  [Description](#cfn-bedrockagentcore-memory-userpreferencememorystrategy-description): String
  [Name](#cfn-bedrockagentcore-memory-userpreferencememorystrategy-name): String
  [Namespaces](#cfn-bedrockagentcore-memory-userpreferencememorystrategy-namespaces): 
    - String
  [NamespaceTemplates](#cfn-bedrockagentcore-memory-userpreferencememorystrategy-namespacetemplates): 
    - String
  [Status](#cfn-bedrockagentcore-memory-userpreferencememorystrategy-status): String
  [StrategyId](#cfn-bedrockagentcore-memory-userpreferencememorystrategy-strategyid): String
  [Type](#cfn-bedrockagentcore-memory-userpreferencememorystrategy-type): String
  [UpdatedAt](#cfn-bedrockagentcore-memory-userpreferencememorystrategy-updatedat): String
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-userpreferencememorystrategy-properties"></a>

`CreatedAt`  <a name="cfn-bedrockagentcore-memory-userpreferencememorystrategy-createdat"></a>
The memory strategy creation date and time.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-bedrockagentcore-memory-userpreferencememorystrategy-description"></a>
The memory strategy description.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-bedrockagentcore-memory-userpreferencememorystrategy-name"></a>
The memory strategy name.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,47}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Namespaces`  <a name="cfn-bedrockagentcore-memory-userpreferencememorystrategy-namespaces"></a>
The memory namespaces.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NamespaceTemplates`  <a name="cfn-bedrockagentcore-memory-userpreferencememorystrategy-namespacetemplates"></a>
Property description not available.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-bedrockagentcore-memory-userpreferencememorystrategy-status"></a>
The memory strategy status.  
*Required*: No  
*Type*: String  
*Allowed values*: `CREATING | ACTIVE | DELETING | FAILED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StrategyId`  <a name="cfn-bedrockagentcore-memory-userpreferencememorystrategy-strategyid"></a>
The memory strategy ID.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$`  
*Minimum*: `12`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-bedrockagentcore-memory-userpreferencememorystrategy-type"></a>
The memory strategy type.  
*Required*: No  
*Type*: String  
*Allowed values*: `SEMANTIC | SUMMARIZATION | USER_PREFERENCE | CUSTOM | EPISODIC`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UpdatedAt`  <a name="cfn-bedrockagentcore-memory-userpreferencememorystrategy-updatedat"></a>
The memory strategy update date and time.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory UserPreferenceOverride
<a name="aws-properties-bedrockagentcore-memory-userpreferenceoverride"></a>

The memory user preference override.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-userpreferenceoverride-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-userpreferenceoverride-syntax.json"></a>

```
{
  "[Consolidation](#cfn-bedrockagentcore-memory-userpreferenceoverride-consolidation)" : UserPreferenceOverrideConsolidationConfigurationInput,
  "[Extraction](#cfn-bedrockagentcore-memory-userpreferenceoverride-extraction)" : UserPreferenceOverrideExtractionConfigurationInput
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-userpreferenceoverride-syntax.yaml"></a>

```
  [Consolidation](#cfn-bedrockagentcore-memory-userpreferenceoverride-consolidation): 
    UserPreferenceOverrideConsolidationConfigurationInput
  [Extraction](#cfn-bedrockagentcore-memory-userpreferenceoverride-extraction): 
    UserPreferenceOverrideExtractionConfigurationInput
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-userpreferenceoverride-properties"></a>

`Consolidation`  <a name="cfn-bedrockagentcore-memory-userpreferenceoverride-consolidation"></a>
The memory override consolidation information.  
*Required*: No  
*Type*: [UserPreferenceOverrideConsolidationConfigurationInput](aws-properties-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Extraction`  <a name="cfn-bedrockagentcore-memory-userpreferenceoverride-extraction"></a>
The memory user preferences for extraction.  
*Required*: No  
*Type*: [UserPreferenceOverrideExtractionConfigurationInput](aws-properties-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory UserPreferenceOverrideConsolidationConfigurationInput
<a name="aws-properties-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput"></a>

The configuration input.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput-syntax.json"></a>

```
{
  "[AppendToPrompt](#cfn-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput-appendtoprompt)" : String,
  "[ModelId](#cfn-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput-modelid)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput-syntax.yaml"></a>

```
  [AppendToPrompt](#cfn-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput-appendtoprompt): String
  [ModelId](#cfn-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput-modelid): String
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput-properties"></a>

`AppendToPrompt`  <a name="cfn-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput-appendtoprompt"></a>
The memory configuration.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `30000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelId`  <a name="cfn-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput-modelid"></a>
The memory override configuration model ID.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Memory UserPreferenceOverrideExtractionConfigurationInput
<a name="aws-properties-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput"></a>

The memory override configuration.

## Syntax
<a name="aws-properties-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput-syntax.json"></a>

```
{
  "[AppendToPrompt](#cfn-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput-appendtoprompt)" : String,
  "[ModelId](#cfn-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput-modelid)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput-syntax.yaml"></a>

```
  [AppendToPrompt](#cfn-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput-appendtoprompt): String
  [ModelId](#cfn-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput-modelid): String
```

## Properties
<a name="aws-properties-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput-properties"></a>

`AppendToPrompt`  <a name="cfn-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput-appendtoprompt"></a>
The extraction configuration.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `30000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelId`  <a name="cfn-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput-modelid"></a>
The memory override for the model ID.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OAuth2CredentialProvider
<a name="aws-resource-bedrockagentcore-oauth2credentialprovider"></a>

<a name="aws-resource-bedrockagentcore-oauth2credentialprovider-description"></a>The `AWS::BedrockAgentCore::OAuth2CredentialProvider` resource Property description not available. for BedrockAgentCore.

## Syntax
<a name="aws-resource-bedrockagentcore-oauth2credentialprovider-syntax"></a>

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

### JSON
<a name="aws-resource-bedrockagentcore-oauth2credentialprovider-syntax.json"></a>

```
{
  "Type" : "AWS::BedrockAgentCore::OAuth2CredentialProvider",
  "Properties" : {
      "[CredentialProviderVendor](#cfn-bedrockagentcore-oauth2credentialprovider-credentialprovidervendor)" : String,
      "[Name](#cfn-bedrockagentcore-oauth2credentialprovider-name)" : String,
      "[Oauth2ProviderConfigInput](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput)" : Oauth2ProviderConfigInput,
      "[Tags](#cfn-bedrockagentcore-oauth2credentialprovider-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-bedrockagentcore-oauth2credentialprovider-syntax.yaml"></a>

```
Type: AWS::BedrockAgentCore::OAuth2CredentialProvider
Properties:
  [CredentialProviderVendor](#cfn-bedrockagentcore-oauth2credentialprovider-credentialprovidervendor): String
  [Name](#cfn-bedrockagentcore-oauth2credentialprovider-name): String
  [Oauth2ProviderConfigInput](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput): 
    Oauth2ProviderConfigInput
  [Tags](#cfn-bedrockagentcore-oauth2credentialprovider-tags): 
    - Tag
```

## Properties
<a name="aws-resource-bedrockagentcore-oauth2credentialprovider-properties"></a>

`CredentialProviderVendor`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-credentialprovidervendor"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `GoogleOauth2 | GithubOauth2 | SlackOauth2 | SalesforceOauth2 | MicrosoftOauth2 | CustomOauth2 | AtlassianOauth2 | LinkedinOauth2 | XOauth2 | OktaOauth2 | OneLoginOauth2 | PingOneOauth2 | FacebookOauth2 | YandexOauth2 | RedditOauth2 | ZoomOauth2 | TwitchOauth2 | SpotifyOauth2 | DropboxOauth2 | NotionOauth2 | HubspotOauth2 | CyberArkOauth2 | FusionAuthOauth2 | Auth0Oauth2 | CognitoOauth2`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-name"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9\-_]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Oauth2ProviderConfigInput`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput"></a>
Contains the input configuration for an OAuth2 provider.  
*Required*: No  
*Type*: [Oauth2ProviderConfigInput](aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-tags"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-bedrockagentcore-oauth2credentialprovider-tag.md)  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-bedrockagentcore-oauth2credentialprovider-return-values"></a>

### Ref
<a name="aws-resource-bedrockagentcore-oauth2credentialprovider-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-bedrockagentcore-oauth2credentialprovider-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-bedrockagentcore-oauth2credentialprovider-return-values-fn--getatt-fn--getatt"></a>

`CallbackUrl`  <a name="CallbackUrl-fn::getatt"></a>
Property description not available.

`CreatedTime`  <a name="CreatedTime-fn::getatt"></a>
Property description not available.

`CredentialProviderArn`  <a name="CredentialProviderArn-fn::getatt"></a>
Property description not available.

`LastUpdatedTime`  <a name="LastUpdatedTime-fn::getatt"></a>
Property description not available.

# AWS::BedrockAgentCore::OAuth2CredentialProvider AtlassianOauth2ProviderConfigInput
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput"></a>

Configuration settings for connecting to Atlassian services using OAuth2 authentication. This includes the client credentials required to authenticate with Atlassian's OAuth2 authorization server.

## Syntax
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput-syntax.json"></a>

```
{
  "[ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput-clientid)" : String,
  "[ClientSecret](#cfn-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput-clientsecret)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput-syntax.yaml"></a>

```
  [ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput-clientid): String
  [ClientSecret](#cfn-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput-clientsecret): String
```

## Properties
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput-properties"></a>

`ClientId`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput-clientid"></a>
The client ID for the Atlassian OAuth2 provider. This identifier is assigned by Atlassian when you register your application.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClientSecret`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput-clientsecret"></a>
The client secret for the Atlassian OAuth2 provider. This secret is assigned by Atlassian and used along with the client ID to authenticate your application.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OAuth2CredentialProvider ClientSecretArn
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-clientsecretarn"></a>

<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-clientsecretarn-description"></a>The `ClientSecretArn` property type specifies Property description not available. for an [AWS::BedrockAgentCore::OAuth2CredentialProvider](aws-resource-bedrockagentcore-oauth2credentialprovider.md).

## Syntax
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-clientsecretarn-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-clientsecretarn-syntax.json"></a>

```
{
  "[SecretArn](#cfn-bedrockagentcore-oauth2credentialprovider-clientsecretarn-secretarn)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-clientsecretarn-syntax.yaml"></a>

```
  [SecretArn](#cfn-bedrockagentcore-oauth2credentialprovider-clientsecretarn-secretarn): String
```

## Properties
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-clientsecretarn-properties"></a>

`SecretArn`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-clientsecretarn-secretarn"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:(aws|aws-us-gov):secretsmanager:[A-Za-z0-9-]{1,64}:[0-9]{12}:secret:[a-zA-Z0-9-_/+=.@!]+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OAuth2CredentialProvider CustomOauth2ProviderConfigInput
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput"></a>

Input configuration for a custom OAuth2 provider.

## Syntax
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-syntax.json"></a>

```
{
  "[ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientid)" : String,
  "[ClientSecret](#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientsecret)" : String,
  "[OauthDiscovery](#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-oauthdiscovery)" : Oauth2Discovery
}
```

### YAML
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-syntax.yaml"></a>

```
  [ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientid): String
  [ClientSecret](#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientsecret): String
  [OauthDiscovery](#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-oauthdiscovery): 
    Oauth2Discovery
```

## Properties
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-properties"></a>

`ClientId`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientid"></a>
The client ID for the custom OAuth2 provider.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClientSecret`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientsecret"></a>
The client secret for the custom OAuth2 provider.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OauthDiscovery`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-oauthdiscovery"></a>
The OAuth2 discovery information for the custom provider.  
*Required*: Yes  
*Type*: [Oauth2Discovery](aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2discovery.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OAuth2CredentialProvider GithubOauth2ProviderConfigInput
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput"></a>

Input configuration for a GitHub OAuth2 provider.

## Syntax
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput-syntax.json"></a>

```
{
  "[ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput-clientid)" : String,
  "[ClientSecret](#cfn-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput-clientsecret)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput-syntax.yaml"></a>

```
  [ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput-clientid): String
  [ClientSecret](#cfn-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput-clientsecret): String
```

## Properties
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput-properties"></a>

`ClientId`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput-clientid"></a>
The client ID for the GitHub OAuth2 provider.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClientSecret`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput-clientsecret"></a>
The client secret for the GitHub OAuth2 provider.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OAuth2CredentialProvider GoogleOauth2ProviderConfigInput
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput"></a>

Input configuration for a Google OAuth2 provider.

## Syntax
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput-syntax.json"></a>

```
{
  "[ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput-clientid)" : String,
  "[ClientSecret](#cfn-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput-clientsecret)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput-syntax.yaml"></a>

```
  [ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput-clientid): String
  [ClientSecret](#cfn-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput-clientsecret): String
```

## Properties
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput-properties"></a>

`ClientId`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput-clientid"></a>
The client ID for the Google OAuth2 provider.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClientSecret`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput-clientsecret"></a>
The client secret for the Google OAuth2 provider.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OAuth2CredentialProvider IncludedOauth2ProviderConfigInput
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput"></a>

Configuration settings for connecting to a supported OAuth2 provider. This includes client credentials and OAuth2 discovery information for providers that have built-in support.

## Syntax
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-syntax.json"></a>

```
{
  "[AuthorizationEndpoint](#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-authorizationendpoint)" : String,
  "[ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-clientid)" : String,
  "[ClientSecret](#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-clientsecret)" : String,
  "[Issuer](#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-issuer)" : String,
  "[TokenEndpoint](#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-tokenendpoint)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-syntax.yaml"></a>

```
  [AuthorizationEndpoint](#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-authorizationendpoint): String
  [ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-clientid): String
  [ClientSecret](#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-clientsecret): String
  [Issuer](#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-issuer): String
  [TokenEndpoint](#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-tokenendpoint): String
```

## Properties
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-properties"></a>

`AuthorizationEndpoint`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-authorizationendpoint"></a>
OAuth2 authorization endpoint for your isolated OAuth2 application tenant. This is where users are redirected to authenticate and authorize access to their resources.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClientId`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-clientid"></a>
The client ID for the supported OAuth2 provider. This identifier is assigned by the OAuth2 provider when you register your application.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClientSecret`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-clientsecret"></a>
The client secret for the supported OAuth2 provider. This secret is assigned by the OAuth2 provider and used along with the client ID to authenticate your application.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Issuer`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-issuer"></a>
Token issuer of your isolated OAuth2 application tenant. This URL identifies the authorization server that issues tokens for this provider.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TokenEndpoint`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-tokenendpoint"></a>
OAuth2 token endpoint for your isolated OAuth2 application tenant. This is where authorization codes are exchanged for access tokens.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OAuth2CredentialProvider LinkedinOauth2ProviderConfigInput
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput"></a>

Configuration settings for connecting to LinkedIn services using OAuth2 authentication. This includes the client credentials required to authenticate with LinkedIn's OAuth2 authorization server.

## Syntax
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput-syntax.json"></a>

```
{
  "[ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput-clientid)" : String,
  "[ClientSecret](#cfn-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput-clientsecret)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput-syntax.yaml"></a>

```
  [ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput-clientid): String
  [ClientSecret](#cfn-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput-clientsecret): String
```

## Properties
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput-properties"></a>

`ClientId`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput-clientid"></a>
The client ID for the LinkedIn OAuth2 provider. This identifier is assigned by LinkedIn when you register your application.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClientSecret`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput-clientsecret"></a>
The client secret for the LinkedIn OAuth2 provider. This secret is assigned by LinkedIn and used along with the client ID to authenticate your application.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OAuth2CredentialProvider MicrosoftOauth2ProviderConfigInput
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput"></a>

Input configuration for a Microsoft OAuth2 provider.

## Syntax
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput-syntax.json"></a>

```
{
  "[ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput-clientid)" : String,
  "[ClientSecret](#cfn-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput-clientsecret)" : String,
  "[TenantId](#cfn-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput-tenantid)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput-syntax.yaml"></a>

```
  [ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput-clientid): String
  [ClientSecret](#cfn-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput-clientsecret): String
  [TenantId](#cfn-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput-tenantid): String
```

## Properties
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput-properties"></a>

`ClientId`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput-clientid"></a>
The client ID for the Microsoft OAuth2 provider.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClientSecret`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput-clientsecret"></a>
The client secret for the Microsoft OAuth2 provider.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TenantId`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput-tenantid"></a>
The Microsoft Entra ID (formerly Azure AD) tenant ID for your organization. This identifies the specific tenant within Microsoft's identity platform where your application is registered.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OAuth2CredentialProvider Oauth2AuthorizationServerMetadata
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata"></a>

Contains the authorization server metadata for an OAuth2 provider.

## Syntax
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-syntax.json"></a>

```
{
  "[AuthorizationEndpoint](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-authorizationendpoint)" : String,
  "[Issuer](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-issuer)" : String,
  "[ResponseTypes](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-responsetypes)" : [ String, ... ],
  "[TokenEndpoint](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-tokenendpoint)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-syntax.yaml"></a>

```
  [AuthorizationEndpoint](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-authorizationendpoint): String
  [Issuer](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-issuer): String
  [ResponseTypes](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-responsetypes): 
    - String
  [TokenEndpoint](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-tokenendpoint): String
```

## Properties
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-properties"></a>

`AuthorizationEndpoint`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-authorizationendpoint"></a>
The authorization endpoint URL for the OAuth2 authorization server.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Issuer`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-issuer"></a>
The issuer URL for the OAuth2 authorization server.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResponseTypes`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-responsetypes"></a>
The supported response types for the OAuth2 authorization server.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TokenEndpoint`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-tokenendpoint"></a>
The token endpoint URL for the OAuth2 authorization server.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OAuth2CredentialProvider Oauth2Discovery
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2discovery"></a>

Contains the discovery information for an OAuth2 provider.

## Syntax
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2discovery-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2discovery-syntax.json"></a>

```
{
  "[AuthorizationServerMetadata](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2discovery-authorizationservermetadata)" : Oauth2AuthorizationServerMetadata,
  "[DiscoveryUrl](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2discovery-discoveryurl)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2discovery-syntax.yaml"></a>

```
  [AuthorizationServerMetadata](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2discovery-authorizationservermetadata): 
    Oauth2AuthorizationServerMetadata
  [DiscoveryUrl](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2discovery-discoveryurl): String
```

## Properties
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2discovery-properties"></a>

`AuthorizationServerMetadata`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-oauth2discovery-authorizationservermetadata"></a>
The authorization server metadata for the OAuth2 provider.  
*Required*: No  
*Type*: [Oauth2AuthorizationServerMetadata](aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DiscoveryUrl`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-oauth2discovery-discoveryurl"></a>
The discovery URL for the OAuth2 provider.  
*Required*: No  
*Type*: String  
*Pattern*: `^.+/\.well-known/openid-configuration$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OAuth2CredentialProvider Oauth2ProviderConfigInput
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput"></a>

Contains the input configuration for an OAuth2 provider.

## Syntax
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-syntax.json"></a>

```
{
  "[AtlassianOauth2ProviderConfig](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-atlassianoauth2providerconfig)" : AtlassianOauth2ProviderConfigInput,
  "[CustomOauth2ProviderConfig](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-customoauth2providerconfig)" : CustomOauth2ProviderConfigInput,
  "[GithubOauth2ProviderConfig](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-githuboauth2providerconfig)" : GithubOauth2ProviderConfigInput,
  "[GoogleOauth2ProviderConfig](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-googleoauth2providerconfig)" : GoogleOauth2ProviderConfigInput,
  "[IncludedOauth2ProviderConfig](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-includedoauth2providerconfig)" : IncludedOauth2ProviderConfigInput,
  "[LinkedinOauth2ProviderConfig](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-linkedinoauth2providerconfig)" : LinkedinOauth2ProviderConfigInput,
  "[MicrosoftOauth2ProviderConfig](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-microsoftoauth2providerconfig)" : MicrosoftOauth2ProviderConfigInput,
  "[SalesforceOauth2ProviderConfig](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-salesforceoauth2providerconfig)" : SalesforceOauth2ProviderConfigInput,
  "[SlackOauth2ProviderConfig](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-slackoauth2providerconfig)" : SlackOauth2ProviderConfigInput
}
```

### YAML
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-syntax.yaml"></a>

```
  [AtlassianOauth2ProviderConfig](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-atlassianoauth2providerconfig): 
    AtlassianOauth2ProviderConfigInput
  [CustomOauth2ProviderConfig](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-customoauth2providerconfig): 
    CustomOauth2ProviderConfigInput
  [GithubOauth2ProviderConfig](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-githuboauth2providerconfig): 
    GithubOauth2ProviderConfigInput
  [GoogleOauth2ProviderConfig](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-googleoauth2providerconfig): 
    GoogleOauth2ProviderConfigInput
  [IncludedOauth2ProviderConfig](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-includedoauth2providerconfig): 
    IncludedOauth2ProviderConfigInput
  [LinkedinOauth2ProviderConfig](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-linkedinoauth2providerconfig): 
    LinkedinOauth2ProviderConfigInput
  [MicrosoftOauth2ProviderConfig](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-microsoftoauth2providerconfig): 
    MicrosoftOauth2ProviderConfigInput
  [SalesforceOauth2ProviderConfig](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-salesforceoauth2providerconfig): 
    SalesforceOauth2ProviderConfigInput
  [SlackOauth2ProviderConfig](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-slackoauth2providerconfig): 
    SlackOauth2ProviderConfigInput
```

## Properties
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-properties"></a>

`AtlassianOauth2ProviderConfig`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-atlassianoauth2providerconfig"></a>
Configuration settings for Atlassian OAuth2 provider integration.  
*Required*: No  
*Type*: [AtlassianOauth2ProviderConfigInput](aws-properties-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CustomOauth2ProviderConfig`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-customoauth2providerconfig"></a>
The configuration for a custom OAuth2 provider.  
*Required*: No  
*Type*: [CustomOauth2ProviderConfigInput](aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GithubOauth2ProviderConfig`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-githuboauth2providerconfig"></a>
The configuration for a GitHub OAuth2 provider.  
*Required*: No  
*Type*: [GithubOauth2ProviderConfigInput](aws-properties-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GoogleOauth2ProviderConfig`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-googleoauth2providerconfig"></a>
The configuration for a Google OAuth2 provider.  
*Required*: No  
*Type*: [GoogleOauth2ProviderConfigInput](aws-properties-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IncludedOauth2ProviderConfig`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-includedoauth2providerconfig"></a>
The configuration for a non-custom OAuth2 provider. This includes settings for supported OAuth2 providers that have built-in integration support.  
*Required*: No  
*Type*: [IncludedOauth2ProviderConfigInput](aws-properties-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LinkedinOauth2ProviderConfig`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-linkedinoauth2providerconfig"></a>
Configuration settings for LinkedIn OAuth2 provider integration.  
*Required*: No  
*Type*: [LinkedinOauth2ProviderConfigInput](aws-properties-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MicrosoftOauth2ProviderConfig`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-microsoftoauth2providerconfig"></a>
The configuration for a Microsoft OAuth2 provider.  
*Required*: No  
*Type*: [MicrosoftOauth2ProviderConfigInput](aws-properties-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SalesforceOauth2ProviderConfig`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-salesforceoauth2providerconfig"></a>
The configuration for a Salesforce OAuth2 provider.  
*Required*: No  
*Type*: [SalesforceOauth2ProviderConfigInput](aws-properties-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SlackOauth2ProviderConfig`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-slackoauth2providerconfig"></a>
The configuration for a Slack OAuth2 provider.  
*Required*: No  
*Type*: [SlackOauth2ProviderConfigInput](aws-properties-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OAuth2CredentialProvider Oauth2ProviderConfigOutput
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput"></a>

Contains the output configuration for an OAuth2 provider.

## Syntax
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput-syntax.json"></a>

```
{
  "[ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput-clientid)" : String,
  "[OauthDiscovery](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput-oauthdiscovery)" : Oauth2Discovery
}
```

### YAML
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput-syntax.yaml"></a>

```
  [ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput-clientid): String
  [OauthDiscovery](#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput-oauthdiscovery): 
    Oauth2Discovery
```

## Properties
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput-properties"></a>

`ClientId`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput-clientid"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OauthDiscovery`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput-oauthdiscovery"></a>
Property description not available.  
*Required*: No  
*Type*: [Oauth2Discovery](aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2discovery.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OAuth2CredentialProvider SalesforceOauth2ProviderConfigInput
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput"></a>

Input configuration for a Salesforce OAuth2 provider.

## Syntax
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput-syntax.json"></a>

```
{
  "[ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput-clientid)" : String,
  "[ClientSecret](#cfn-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput-clientsecret)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput-syntax.yaml"></a>

```
  [ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput-clientid): String
  [ClientSecret](#cfn-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput-clientsecret): String
```

## Properties
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput-properties"></a>

`ClientId`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput-clientid"></a>
The client ID for the Salesforce OAuth2 provider.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClientSecret`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput-clientsecret"></a>
The client secret for the Salesforce OAuth2 provider.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OAuth2CredentialProvider SlackOauth2ProviderConfigInput
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput"></a>

Input configuration for a Slack OAuth2 provider.

## Syntax
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput-syntax.json"></a>

```
{
  "[ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput-clientid)" : String,
  "[ClientSecret](#cfn-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput-clientsecret)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput-syntax.yaml"></a>

```
  [ClientId](#cfn-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput-clientid): String
  [ClientSecret](#cfn-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput-clientsecret): String
```

## Properties
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput-properties"></a>

`ClientId`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput-clientid"></a>
The client ID for the Slack OAuth2 provider.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClientSecret`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput-clientsecret"></a>
The client secret for the Slack OAuth2 provider.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OAuth2CredentialProvider Tag
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-tag"></a>

<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-tag-description"></a>The `Tag` property type specifies Property description not available. for an [AWS::BedrockAgentCore::OAuth2CredentialProvider](aws-resource-bedrockagentcore-oauth2credentialprovider.md).

## Syntax
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-tag-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-tag-syntax.json"></a>

```
{
  "[Key](#cfn-bedrockagentcore-oauth2credentialprovider-tag-key)" : String,
  "[Value](#cfn-bedrockagentcore-oauth2credentialprovider-tag-value)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-tag-syntax.yaml"></a>

```
  [Key](#cfn-bedrockagentcore-oauth2credentialprovider-tag-key): String
  [Value](#cfn-bedrockagentcore-oauth2credentialprovider-tag-value): String
```

## Properties
<a name="aws-properties-bedrockagentcore-oauth2credentialprovider-tag-properties"></a>

`Key`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-tag-key"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-bedrockagentcore-oauth2credentialprovider-tag-value"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OnlineEvaluationConfig
<a name="aws-resource-bedrockagentcore-onlineevaluationconfig"></a>

Specifies an online evaluation configuration for Amazon Bedrock AgentCore. An online evaluation configuration enables continuous monitoring and assessment of agent performance in production.

For more information, see [Monitor agent performance with Amazon Bedrock AgentCore online evaluation](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/online-evaluation.html).

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

## Syntax
<a name="aws-resource-bedrockagentcore-onlineevaluationconfig-syntax"></a>

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

### JSON
<a name="aws-resource-bedrockagentcore-onlineevaluationconfig-syntax.json"></a>

```
{
  "Type" : "AWS::BedrockAgentCore::OnlineEvaluationConfig",
  "Properties" : {
      "[DataSourceConfig](#cfn-bedrockagentcore-onlineevaluationconfig-datasourceconfig)" : DataSourceConfig,
      "[Description](#cfn-bedrockagentcore-onlineevaluationconfig-description)" : String,
      "[EvaluationExecutionRoleArn](#cfn-bedrockagentcore-onlineevaluationconfig-evaluationexecutionrolearn)" : String,
      "[Evaluators](#cfn-bedrockagentcore-onlineevaluationconfig-evaluators)" : [ EvaluatorReference, ... ],
      "[ExecutionStatus](#cfn-bedrockagentcore-onlineevaluationconfig-executionstatus)" : String,
      "[OnlineEvaluationConfigName](#cfn-bedrockagentcore-onlineevaluationconfig-onlineevaluationconfigname)" : String,
      "[Rule](#cfn-bedrockagentcore-onlineevaluationconfig-rule)" : Rule,
      "[Tags](#cfn-bedrockagentcore-onlineevaluationconfig-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-bedrockagentcore-onlineevaluationconfig-syntax.yaml"></a>

```
Type: AWS::BedrockAgentCore::OnlineEvaluationConfig
Properties:
  [DataSourceConfig](#cfn-bedrockagentcore-onlineevaluationconfig-datasourceconfig): 
    DataSourceConfig
  [Description](#cfn-bedrockagentcore-onlineevaluationconfig-description): String
  [EvaluationExecutionRoleArn](#cfn-bedrockagentcore-onlineevaluationconfig-evaluationexecutionrolearn): String
  [Evaluators](#cfn-bedrockagentcore-onlineevaluationconfig-evaluators): 
    - EvaluatorReference
  [ExecutionStatus](#cfn-bedrockagentcore-onlineevaluationconfig-executionstatus): String
  [OnlineEvaluationConfigName](#cfn-bedrockagentcore-onlineevaluationconfig-onlineevaluationconfigname): String
  [Rule](#cfn-bedrockagentcore-onlineevaluationconfig-rule): 
    Rule
  [Tags](#cfn-bedrockagentcore-onlineevaluationconfig-tags): 
    - Tag
```

## Properties
<a name="aws-resource-bedrockagentcore-onlineevaluationconfig-properties"></a>

`DataSourceConfig`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-datasourceconfig"></a>
 The data source configuration specifying CloudWatch log groups and service names to monitor.   
*Required*: Yes  
*Type*: [DataSourceConfig](aws-properties-bedrockagentcore-onlineevaluationconfig-datasourceconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-description"></a>
 The description of the online evaluation configuration.   
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EvaluationExecutionRoleArn`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-evaluationexecutionrolearn"></a>
 The Amazon Resource Name (ARN) of the IAM role used for evaluation execution.   
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Evaluators`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-evaluators"></a>
 The list of evaluators applied during online evaluation.   
*Required*: Yes  
*Type*: Array of [EvaluatorReference](aws-properties-bedrockagentcore-onlineevaluationconfig-evaluatorreference.md)  
*Minimum*: `1`  
*Maximum*: `10`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExecutionStatus`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-executionstatus"></a>
 The execution status indicating whether the online evaluation is currently running.   
*Required*: No  
*Type*: String  
*Allowed values*: `ENABLED | DISABLED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OnlineEvaluationConfigName`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-onlineevaluationconfigname"></a>
 The name of the online evaluation configuration.   
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,47}$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Rule`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-rule"></a>
 The evaluation rule containing sampling configuration, filters, and session settings.   
*Required*: Yes  
*Type*: [Rule](aws-properties-bedrockagentcore-onlineevaluationconfig-rule.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-tags"></a>
The tags for the online evaluation configuration.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-bedrockagentcore-onlineevaluationconfig-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-bedrockagentcore-onlineevaluationconfig-return-values"></a>

### Ref
<a name="aws-resource-bedrockagentcore-onlineevaluationconfig-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique identifier of the online evaluation configuration.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-bedrockagentcore-onlineevaluationconfig-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-bedrockagentcore-onlineevaluationconfig-return-values-fn--getatt-fn--getatt"></a>

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
The timestamp when the online evaluation configuration was created.

`OnlineEvaluationConfigArn`  <a name="OnlineEvaluationConfigArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the online evaluation configuration.

`OnlineEvaluationConfigId`  <a name="OnlineEvaluationConfigId-fn::getatt"></a>
The unique identifier of the online evaluation configuration.

`Status`  <a name="Status-fn::getatt"></a>
The current status of the online evaluation configuration.

`UpdatedAt`  <a name="UpdatedAt-fn::getatt"></a>
The timestamp when the online evaluation configuration was last updated.

# AWS::BedrockAgentCore::OnlineEvaluationConfig CloudWatchLogsInputConfig
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig"></a>

 The CloudWatch logs configuration for reading agent traces from log groups. 

## Syntax
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig-syntax.json"></a>

```
{
  "[LogGroupNames](#cfn-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig-loggroupnames)" : [ String, ... ],
  "[ServiceNames](#cfn-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig-servicenames)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig-syntax.yaml"></a>

```
  [LogGroupNames](#cfn-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig-loggroupnames): 
    - String
  [ServiceNames](#cfn-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig-servicenames): 
    - String
```

## Properties
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig-properties"></a>

`LogGroupNames`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig-loggroupnames"></a>
 The list of CloudWatch log group names to monitor for agent traces.   
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1 | 1`  
*Maximum*: `512 | 5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServiceNames`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig-servicenames"></a>
 The list of service names to filter traces within the specified log groups. Used to identify relevant agent sessions.   
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1 | 1`  
*Maximum*: `256 | 1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OnlineEvaluationConfig CloudWatchOutputConfig
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchoutputconfig"></a>

 The CloudWatch configuration for writing evaluation results to CloudWatch logs with embedded metric format. 

## Syntax
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchoutputconfig-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchoutputconfig-syntax.json"></a>

```
{
  "[LogGroupName](#cfn-bedrockagentcore-onlineevaluationconfig-cloudwatchoutputconfig-loggroupname)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchoutputconfig-syntax.yaml"></a>

```
  [LogGroupName](#cfn-bedrockagentcore-onlineevaluationconfig-cloudwatchoutputconfig-loggroupname): String
```

## Properties
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchoutputconfig-properties"></a>

`LogGroupName`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-cloudwatchoutputconfig-loggroupname"></a>
 The name of the CloudWatch log group where evaluation results will be written. The log group will be created if it doesn't exist.   
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OnlineEvaluationConfig DataSourceConfig
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-datasourceconfig"></a>

 The data source configuration specifying CloudWatch log groups and service names to monitor. 

## Syntax
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-datasourceconfig-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-datasourceconfig-syntax.json"></a>

```
{
  "[CloudWatchLogs](#cfn-bedrockagentcore-onlineevaluationconfig-datasourceconfig-cloudwatchlogs)" : CloudWatchLogsInputConfig
}
```

### YAML
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-datasourceconfig-syntax.yaml"></a>

```
  [CloudWatchLogs](#cfn-bedrockagentcore-onlineevaluationconfig-datasourceconfig-cloudwatchlogs): 
    CloudWatchLogsInputConfig
```

## Properties
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-datasourceconfig-properties"></a>

`CloudWatchLogs`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-datasourceconfig-cloudwatchlogs"></a>
 The CloudWatch logs configuration for reading agent traces from log groups.   
*Required*: Yes  
*Type*: [CloudWatchLogsInputConfig](aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OnlineEvaluationConfig EvaluatorReference
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-evaluatorreference"></a>

 A reference to an evaluator used in the online evaluation configuration. 

## Syntax
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-evaluatorreference-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-evaluatorreference-syntax.json"></a>

```
{
  "[EvaluatorId](#cfn-bedrockagentcore-onlineevaluationconfig-evaluatorreference-evaluatorid)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-evaluatorreference-syntax.yaml"></a>

```
  [EvaluatorId](#cfn-bedrockagentcore-onlineevaluationconfig-evaluatorreference-evaluatorid): String
```

## Properties
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-evaluatorreference-properties"></a>

`EvaluatorId`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-evaluatorreference-evaluatorid"></a>
 The unique identifier of the evaluator. Can reference builtin evaluators (e.g., `Builtin.Helpfulness`) or custom evaluators.   
*Required*: Yes  
*Type*: String  
*Pattern*: `^(Builtin\.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10})$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OnlineEvaluationConfig Filter
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-filter"></a>

 A filter that applies conditions to agent traces during online evaluation to determine which traces should be evaluated. 

## Syntax
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-filter-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-filter-syntax.json"></a>

```
{
  "[Key](#cfn-bedrockagentcore-onlineevaluationconfig-filter-key)" : String,
  "[Operator](#cfn-bedrockagentcore-onlineevaluationconfig-filter-operator)" : String,
  "[Value](#cfn-bedrockagentcore-onlineevaluationconfig-filter-value)" : FilterValue
}
```

### YAML
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-filter-syntax.yaml"></a>

```
  [Key](#cfn-bedrockagentcore-onlineevaluationconfig-filter-key): String
  [Operator](#cfn-bedrockagentcore-onlineevaluationconfig-filter-operator): String
  [Value](#cfn-bedrockagentcore-onlineevaluationconfig-filter-value): 
    FilterValue
```

## Properties
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-filter-properties"></a>

`Key`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-filter-key"></a>
 The key or field name to filter on within the agent trace data.   
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9._-]+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Operator`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-filter-operator"></a>
 The comparison operator to use for filtering. Valid values include `Equals`, `NotEquals`, `GreaterThan`, `LessThan`, `GreaterThanOrEqual`, `LessThanOrEqual`, `Contains`, and `NotContains`.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `Equals | NotEquals | GreaterThan | LessThan | GreaterThanOrEqual | LessThanOrEqual | Contains | NotContains`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-filter-value"></a>
 The value to compare against using the specified operator.   
*Required*: Yes  
*Type*: [FilterValue](aws-properties-bedrockagentcore-onlineevaluationconfig-filtervalue.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OnlineEvaluationConfig FilterValue
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-filtervalue"></a>

 The value to compare against using the specified operator. Can be a string, double, or boolean value. 

## Syntax
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-filtervalue-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-filtervalue-syntax.json"></a>

```
{
  "[BooleanValue](#cfn-bedrockagentcore-onlineevaluationconfig-filtervalue-booleanvalue)" : Boolean,
  "[DoubleValue](#cfn-bedrockagentcore-onlineevaluationconfig-filtervalue-doublevalue)" : Number,
  "[StringValue](#cfn-bedrockagentcore-onlineevaluationconfig-filtervalue-stringvalue)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-filtervalue-syntax.yaml"></a>

```
  [BooleanValue](#cfn-bedrockagentcore-onlineevaluationconfig-filtervalue-booleanvalue): 
    Boolean
  [DoubleValue](#cfn-bedrockagentcore-onlineevaluationconfig-filtervalue-doublevalue): Number
  [StringValue](#cfn-bedrockagentcore-onlineevaluationconfig-filtervalue-stringvalue): 
    String
```

## Properties
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-filtervalue-properties"></a>

`BooleanValue`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-filtervalue-booleanvalue"></a>
 The boolean value for true/false filtering conditions.   
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DoubleValue`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-filtervalue-doublevalue"></a>
 The numeric value for numerical filtering and comparisons.   
*Required*: No  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StringValue`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-filtervalue-stringvalue"></a>
 The string value for text-based filtering.   
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OnlineEvaluationConfig OutputConfig
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-outputconfig"></a>

 The output configuration specifying where evaluation results are written. 

## Syntax
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-outputconfig-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-outputconfig-syntax.json"></a>

```
{
  "[CloudWatchConfig](#cfn-bedrockagentcore-onlineevaluationconfig-outputconfig-cloudwatchconfig)" : CloudWatchOutputConfig
}
```

### YAML
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-outputconfig-syntax.yaml"></a>

```
  [CloudWatchConfig](#cfn-bedrockagentcore-onlineevaluationconfig-outputconfig-cloudwatchconfig): 
    CloudWatchOutputConfig
```

## Properties
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-outputconfig-properties"></a>

`CloudWatchConfig`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-outputconfig-cloudwatchconfig"></a>
 The CloudWatch configuration for writing evaluation results to CloudWatch logs with embedded metric format.   
*Required*: No  
*Type*: [CloudWatchOutputConfig](aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchoutputconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OnlineEvaluationConfig Rule
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-rule"></a>

 The evaluation rule containing sampling configuration, filters, and session settings. 

## Syntax
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-rule-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-rule-syntax.json"></a>

```
{
  "[Filters](#cfn-bedrockagentcore-onlineevaluationconfig-rule-filters)" : [ Filter, ... ],
  "[SamplingConfig](#cfn-bedrockagentcore-onlineevaluationconfig-rule-samplingconfig)" : SamplingConfig,
  "[SessionConfig](#cfn-bedrockagentcore-onlineevaluationconfig-rule-sessionconfig)" : SessionConfig
}
```

### YAML
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-rule-syntax.yaml"></a>

```
  [Filters](#cfn-bedrockagentcore-onlineevaluationconfig-rule-filters): 
    - Filter
  [SamplingConfig](#cfn-bedrockagentcore-onlineevaluationconfig-rule-samplingconfig): 
    SamplingConfig
  [SessionConfig](#cfn-bedrockagentcore-onlineevaluationconfig-rule-sessionconfig): 
    SessionConfig
```

## Properties
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-rule-properties"></a>

`Filters`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-rule-filters"></a>
 The list of filters that determine which agent traces should be included in the evaluation based on trace properties.   
*Required*: No  
*Type*: Array of [Filter](aws-properties-bedrockagentcore-onlineevaluationconfig-filter.md)  
*Minimum*: `0`  
*Maximum*: `5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SamplingConfig`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-rule-samplingconfig"></a>
 The sampling configuration that determines what percentage of agent traces to evaluate.   
*Required*: Yes  
*Type*: [SamplingConfig](aws-properties-bedrockagentcore-onlineevaluationconfig-samplingconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SessionConfig`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-rule-sessionconfig"></a>
 The session configuration that defines timeout settings for detecting when agent sessions are complete and ready for evaluation.   
*Required*: No  
*Type*: [SessionConfig](aws-properties-bedrockagentcore-onlineevaluationconfig-sessionconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OnlineEvaluationConfig SamplingConfig
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-samplingconfig"></a>

 The sampling configuration that determines what percentage of agent traces to evaluate. 

## Syntax
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-samplingconfig-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-samplingconfig-syntax.json"></a>

```
{
  "[SamplingPercentage](#cfn-bedrockagentcore-onlineevaluationconfig-samplingconfig-samplingpercentage)" : Number
}
```

### YAML
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-samplingconfig-syntax.yaml"></a>

```
  [SamplingPercentage](#cfn-bedrockagentcore-onlineevaluationconfig-samplingconfig-samplingpercentage): Number
```

## Properties
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-samplingconfig-properties"></a>

`SamplingPercentage`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-samplingconfig-samplingpercentage"></a>
 The percentage of agent traces to sample for evaluation, ranging from 0.01% to 100%.   
*Required*: Yes  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OnlineEvaluationConfig SessionConfig
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-sessionconfig"></a>

 The session configuration that defines timeout settings for detecting when agent sessions are complete and ready for evaluation. 

## Syntax
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-sessionconfig-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-sessionconfig-syntax.json"></a>

```
{
  "[SessionTimeoutMinutes](#cfn-bedrockagentcore-onlineevaluationconfig-sessionconfig-sessiontimeoutminutes)" : Integer
}
```

### YAML
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-sessionconfig-syntax.yaml"></a>

```
  [SessionTimeoutMinutes](#cfn-bedrockagentcore-onlineevaluationconfig-sessionconfig-sessiontimeoutminutes): Integer
```

## Properties
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-sessionconfig-properties"></a>

`SessionTimeoutMinutes`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-sessionconfig-sessiontimeoutminutes"></a>
 The number of minutes of inactivity after which an agent session is considered complete and ready for evaluation.   
*Required*: Yes  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `1440`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::OnlineEvaluationConfig Tag
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-tag"></a>

 A key-value pair for tagging the online evaluation configuration. 

## Syntax
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-tag-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-tag-syntax.json"></a>

```
{
  "[Key](#cfn-bedrockagentcore-onlineevaluationconfig-tag-key)" : String,
  "[Value](#cfn-bedrockagentcore-onlineevaluationconfig-tag-value)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-tag-syntax.yaml"></a>

```
  [Key](#cfn-bedrockagentcore-onlineevaluationconfig-tag-key): String
  [Value](#cfn-bedrockagentcore-onlineevaluationconfig-tag-value): String
```

## Properties
<a name="aws-properties-bedrockagentcore-onlineevaluationconfig-tag-properties"></a>

`Key`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-tag-key"></a>
The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with `aws:`. digits, whitespace, `_`, `.`, `:`, `/`, `=`, `+`, `@`, `-`, and `"`.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-bedrockagentcore-onlineevaluationconfig-tag-value"></a>
The value for the tag. You can specify a value that's 1 to 256 characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Policy
<a name="aws-resource-bedrockagentcore-policy"></a>

Specifies a Cedar authorization policy within an Amazon Bedrock AgentCore policy engine. A policy defines the authorization logic that controls what actions your AI agents can perform.

For more information, see [Control agent actions with Amazon Bedrock AgentCore policy engines](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/policy-engine.html).

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

## Syntax
<a name="aws-resource-bedrockagentcore-policy-syntax"></a>

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

### JSON
<a name="aws-resource-bedrockagentcore-policy-syntax.json"></a>

```
{
  "Type" : "AWS::BedrockAgentCore::Policy",
  "Properties" : {
      "[Definition](#cfn-bedrockagentcore-policy-definition)" : PolicyDefinition,
      "[Description](#cfn-bedrockagentcore-policy-description)" : String,
      "[Name](#cfn-bedrockagentcore-policy-name)" : String,
      "[PolicyEngineId](#cfn-bedrockagentcore-policy-policyengineid)" : String,
      "[ValidationMode](#cfn-bedrockagentcore-policy-validationmode)" : String
    }
}
```

### YAML
<a name="aws-resource-bedrockagentcore-policy-syntax.yaml"></a>

```
Type: AWS::BedrockAgentCore::Policy
Properties:
  [Definition](#cfn-bedrockagentcore-policy-definition): 
    PolicyDefinition
  [Description](#cfn-bedrockagentcore-policy-description): String
  [Name](#cfn-bedrockagentcore-policy-name): String
  [PolicyEngineId](#cfn-bedrockagentcore-policy-policyengineid): String
  [ValidationMode](#cfn-bedrockagentcore-policy-validationmode): String
```

## Properties
<a name="aws-resource-bedrockagentcore-policy-properties"></a>

`Definition`  <a name="cfn-bedrockagentcore-policy-definition"></a>
The Cedar policy statement that defines the access control rules. This contains the actual policy logic used for agent behavior control and access decisions.  
*Required*: Yes  
*Type*: [PolicyDefinition](aws-properties-bedrockagentcore-policy-policydefinition.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-bedrockagentcore-policy-description"></a>
A human-readable description of the policy's purpose and functionality. Limited to 4,096 characters, this helps administrators understand and manage the policy.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `4096`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-bedrockagentcore-policy-name"></a>
The customer-assigned immutable name for the policy. This human-readable identifier must be unique within the account and cannot exceed 48 characters.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[A-Za-z][A-Za-z0-9_]*$`  
*Minimum*: `1`  
*Maximum*: `48`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PolicyEngineId`  <a name="cfn-bedrockagentcore-policy-policyengineid"></a>
The identifier of the policy engine that manages this policy. This establishes the policy engine context for policy evaluation and management.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[A-Za-z][A-Za-z0-9_]*-[a-z0-9_]{10}$`  
*Minimum*: `12`  
*Maximum*: `59`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ValidationMode`  <a name="cfn-bedrockagentcore-policy-validationmode"></a>
The validation mode for the policy. Determines how Cedar analyzer validation results are handled.  
*Required*: No  
*Type*: String  
*Allowed values*: `FAIL_ON_ANY_FINDINGS | IGNORE_ALL_FINDINGS`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-bedrockagentcore-policy-return-values"></a>

### Ref
<a name="aws-resource-bedrockagentcore-policy-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the policy. For example:

 `arn:aws:bedrock-agentcore:us-east-1:123456789012:policy-engine/MyPolicyEngine-a1b2c3d4e5/policy/MyPolicy-f6g7h8i9j0` 

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-bedrockagentcore-policy-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-bedrockagentcore-policy-return-values-fn--getatt-fn--getatt"></a>

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
The timestamp when the policy was created.

`PolicyArn`  <a name="PolicyArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the policy.

`PolicyId`  <a name="PolicyId-fn::getatt"></a>
The unique identifier of the policy.

`Status`  <a name="Status-fn::getatt"></a>
The current status of the policy.

`StatusReasons`  <a name="StatusReasons-fn::getatt"></a>
Additional information about the current status of the policy.

`UpdatedAt`  <a name="UpdatedAt-fn::getatt"></a>
The timestamp when the policy was last updated.

# AWS::BedrockAgentCore::Policy CedarPolicy
<a name="aws-properties-bedrockagentcore-policy-cedarpolicy"></a>

A Cedar policy statement within the AgentCore Policy system.

## Syntax
<a name="aws-properties-bedrockagentcore-policy-cedarpolicy-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-policy-cedarpolicy-syntax.json"></a>

```
{
  "[Statement](#cfn-bedrockagentcore-policy-cedarpolicy-statement)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-policy-cedarpolicy-syntax.yaml"></a>

```
  [Statement](#cfn-bedrockagentcore-policy-cedarpolicy-statement): String
```

## Properties
<a name="aws-properties-bedrockagentcore-policy-cedarpolicy-properties"></a>

`Statement`  <a name="cfn-bedrockagentcore-policy-cedarpolicy-statement"></a>
The Cedar policy statement that defines the authorization logic.  
*Required*: Yes  
*Type*: String  
*Minimum*: `35`  
*Maximum*: `153600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Policy PolicyDefinition
<a name="aws-properties-bedrockagentcore-policy-policydefinition"></a>

The definition structure for policies. Encapsulates different policy formats.

## Syntax
<a name="aws-properties-bedrockagentcore-policy-policydefinition-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-policy-policydefinition-syntax.json"></a>

```
{
  "[Cedar](#cfn-bedrockagentcore-policy-policydefinition-cedar)" : CedarPolicy
}
```

### YAML
<a name="aws-properties-bedrockagentcore-policy-policydefinition-syntax.yaml"></a>

```
  [Cedar](#cfn-bedrockagentcore-policy-policydefinition-cedar): 
    CedarPolicy
```

## Properties
<a name="aws-properties-bedrockagentcore-policy-policydefinition-properties"></a>

`Cedar`  <a name="cfn-bedrockagentcore-policy-policydefinition-cedar"></a>
The Cedar policy definition.  
*Required*: Yes  
*Type*: [CedarPolicy](aws-properties-bedrockagentcore-policy-cedarpolicy.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::PolicyEngine
<a name="aws-resource-bedrockagentcore-policyengine"></a>

Specifies a policy engine for Amazon Bedrock AgentCore. A policy engine provides Cedar-based authorization to control what actions your AI agents can perform.

For more information, see [Control agent actions with Amazon Bedrock AgentCore policy engines](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/policy-engine.html).

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

## Syntax
<a name="aws-resource-bedrockagentcore-policyengine-syntax"></a>

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

### JSON
<a name="aws-resource-bedrockagentcore-policyengine-syntax.json"></a>

```
{
  "Type" : "AWS::BedrockAgentCore::PolicyEngine",
  "Properties" : {
      "[Description](#cfn-bedrockagentcore-policyengine-description)" : String,
      "[EncryptionKeyArn](#cfn-bedrockagentcore-policyengine-encryptionkeyarn)" : String,
      "[Name](#cfn-bedrockagentcore-policyengine-name)" : String,
      "[Tags](#cfn-bedrockagentcore-policyengine-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-bedrockagentcore-policyengine-syntax.yaml"></a>

```
Type: AWS::BedrockAgentCore::PolicyEngine
Properties:
  [Description](#cfn-bedrockagentcore-policyengine-description): String
  [EncryptionKeyArn](#cfn-bedrockagentcore-policyengine-encryptionkeyarn): String
  [Name](#cfn-bedrockagentcore-policyengine-name): String
  [Tags](#cfn-bedrockagentcore-policyengine-tags): 
    - Tag
```

## Properties
<a name="aws-resource-bedrockagentcore-policyengine-properties"></a>

`Description`  <a name="cfn-bedrockagentcore-policyengine-description"></a>
A human-readable description of the policy engine's purpose and scope. Limited to 4,096 characters, this helps administrators understand the policy engine's role in the overall governance strategy.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `4096`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EncryptionKeyArn`  <a name="cfn-bedrockagentcore-policyengine-encryptionkeyarn"></a>
The ARN of the KMS key used to encrypt the policy engine data.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-bedrockagentcore-policyengine-name"></a>
The customer-assigned immutable name for the policy engine. This human-readable identifier must be unique within the account and cannot exceed 48 characters.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[A-Za-z][A-Za-z0-9_]*$`  
*Minimum*: `1`  
*Maximum*: `48`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-bedrockagentcore-policyengine-tags"></a>
The tags for the policy engine.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-bedrockagentcore-policyengine-tag.md)  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-bedrockagentcore-policyengine-return-values"></a>

### Ref
<a name="aws-resource-bedrockagentcore-policyengine-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the policy engine. For example:

 `arn:aws:bedrock-agentcore:us-east-1:123456789012:policy-engine/MyPolicyEngine-a1b2c3d4e5` 

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-bedrockagentcore-policyengine-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-bedrockagentcore-policyengine-return-values-fn--getatt-fn--getatt"></a>

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
The timestamp when the policy engine was created.

`PolicyEngineArn`  <a name="PolicyEngineArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the policy engine.

`PolicyEngineId`  <a name="PolicyEngineId-fn::getatt"></a>
The unique identifier of the policy engine.

`Status`  <a name="Status-fn::getatt"></a>
The current status of the policy engine.

`StatusReasons`  <a name="StatusReasons-fn::getatt"></a>
Additional information about the current status of the policy engine.

`UpdatedAt`  <a name="UpdatedAt-fn::getatt"></a>
The timestamp when the policy engine was last updated.

# AWS::BedrockAgentCore::PolicyEngine Tag
<a name="aws-properties-bedrockagentcore-policyengine-tag"></a>

A key-value pair to associate with the policy engine resource.

For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).

## Syntax
<a name="aws-properties-bedrockagentcore-policyengine-tag-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-policyengine-tag-syntax.json"></a>

```
{
  "[Key](#cfn-bedrockagentcore-policyengine-tag-key)" : String,
  "[Value](#cfn-bedrockagentcore-policyengine-tag-value)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-policyengine-tag-syntax.yaml"></a>

```
  [Key](#cfn-bedrockagentcore-policyengine-tag-key): String
  [Value](#cfn-bedrockagentcore-policyengine-tag-value): String
```

## Properties
<a name="aws-properties-bedrockagentcore-policyengine-tag-properties"></a>

`Key`  <a name="cfn-bedrockagentcore-policyengine-tag-key"></a>
The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with `aws:`. digits, whitespace, `_`, `.`, `:`, `/`, `=`, `+`, `@`, `-`, and `"`.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-bedrockagentcore-policyengine-tag-value"></a>
The value for the tag. You can specify a value that's 1 to 256 characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Runtime
<a name="aws-resource-bedrockagentcore-runtime"></a>

Contains information about an agent runtime. An agent runtime is the execution environment for a Amazon Bedrock Agent.

AgentCore Runtime is a secure, serverless runtime purpose-built for deploying and scaling dynamic AI agents and tools using any open-source framework including LangGraph, CrewAI, and Strands Agents, any protocol, and any model.

For more information about using agent runtime in Amazon Bedrock AgentCore, see [Host agent or tools with Amazon Bedrock AgentCore Runtime](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/agents-tools-runtime.html).

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

## Syntax
<a name="aws-resource-bedrockagentcore-runtime-syntax"></a>

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

### JSON
<a name="aws-resource-bedrockagentcore-runtime-syntax.json"></a>

```
{
  "Type" : "AWS::BedrockAgentCore::Runtime",
  "Properties" : {
      "[AgentRuntimeArtifact](#cfn-bedrockagentcore-runtime-agentruntimeartifact)" : AgentRuntimeArtifact,
      "[AgentRuntimeName](#cfn-bedrockagentcore-runtime-agentruntimename)" : String,
      "[AuthorizerConfiguration](#cfn-bedrockagentcore-runtime-authorizerconfiguration)" : AuthorizerConfiguration,
      "[Description](#cfn-bedrockagentcore-runtime-description)" : String,
      "[EnvironmentVariables](#cfn-bedrockagentcore-runtime-environmentvariables)" : {Key: Value, ...},
      "[FilesystemConfigurations](#cfn-bedrockagentcore-runtime-filesystemconfigurations)" : [ FilesystemConfiguration, ... ],
      "[LifecycleConfiguration](#cfn-bedrockagentcore-runtime-lifecycleconfiguration)" : LifecycleConfiguration,
      "[NetworkConfiguration](#cfn-bedrockagentcore-runtime-networkconfiguration)" : NetworkConfiguration,
      "[ProtocolConfiguration](#cfn-bedrockagentcore-runtime-protocolconfiguration)" : String,
      "[RequestHeaderConfiguration](#cfn-bedrockagentcore-runtime-requestheaderconfiguration)" : RequestHeaderConfiguration,
      "[RoleArn](#cfn-bedrockagentcore-runtime-rolearn)" : String,
      "[Tags](#cfn-bedrockagentcore-runtime-tags)" : {Key: Value, ...}
    }
}
```

### YAML
<a name="aws-resource-bedrockagentcore-runtime-syntax.yaml"></a>

```
Type: AWS::BedrockAgentCore::Runtime
Properties:
  [AgentRuntimeArtifact](#cfn-bedrockagentcore-runtime-agentruntimeartifact): 
    AgentRuntimeArtifact
  [AgentRuntimeName](#cfn-bedrockagentcore-runtime-agentruntimename): String
  [AuthorizerConfiguration](#cfn-bedrockagentcore-runtime-authorizerconfiguration): 
    AuthorizerConfiguration
  [Description](#cfn-bedrockagentcore-runtime-description): String
  [EnvironmentVariables](#cfn-bedrockagentcore-runtime-environmentvariables): 
    Key: Value
  [FilesystemConfigurations](#cfn-bedrockagentcore-runtime-filesystemconfigurations): 
    - FilesystemConfiguration
  [LifecycleConfiguration](#cfn-bedrockagentcore-runtime-lifecycleconfiguration): 
    LifecycleConfiguration
  [NetworkConfiguration](#cfn-bedrockagentcore-runtime-networkconfiguration): 
    NetworkConfiguration
  [ProtocolConfiguration](#cfn-bedrockagentcore-runtime-protocolconfiguration): String
  [RequestHeaderConfiguration](#cfn-bedrockagentcore-runtime-requestheaderconfiguration): 
    RequestHeaderConfiguration
  [RoleArn](#cfn-bedrockagentcore-runtime-rolearn): String
  [Tags](#cfn-bedrockagentcore-runtime-tags): 
    Key: Value
```

## Properties
<a name="aws-resource-bedrockagentcore-runtime-properties"></a>

`AgentRuntimeArtifact`  <a name="cfn-bedrockagentcore-runtime-agentruntimeartifact"></a>
The artifact of the AgentCore Runtime.  
*Required*: Yes  
*Type*: [AgentRuntimeArtifact](aws-properties-bedrockagentcore-runtime-agentruntimeartifact.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AgentRuntimeName`  <a name="cfn-bedrockagentcore-runtime-agentruntimename"></a>
The name of the AgentCore Runtime.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-zA-Z][a-zA-Z0-9_]{0,47}`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`AuthorizerConfiguration`  <a name="cfn-bedrockagentcore-runtime-authorizerconfiguration"></a>
The authorizer configuration for the AgentCore Runtime.  
*Required*: No  
*Type*: [AuthorizerConfiguration](aws-properties-bedrockagentcore-runtime-authorizerconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-bedrockagentcore-runtime-description"></a>
The description of the AgentCore Runtime.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnvironmentVariables`  <a name="cfn-bedrockagentcore-runtime-environmentvariables"></a>
Environment variables to set in the AgentCore Runtime environment.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `^[a-zA-Z_][a-zA-Z0-9_]*$`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FilesystemConfigurations`  <a name="cfn-bedrockagentcore-runtime-filesystemconfigurations"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [FilesystemConfiguration](aws-properties-bedrockagentcore-runtime-filesystemconfiguration.md)  
*Minimum*: `0`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LifecycleConfiguration`  <a name="cfn-bedrockagentcore-runtime-lifecycleconfiguration"></a>
The lifecycle configuration for the AgentCore Runtime.  
*Required*: No  
*Type*: [LifecycleConfiguration](aws-properties-bedrockagentcore-runtime-lifecycleconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NetworkConfiguration`  <a name="cfn-bedrockagentcore-runtime-networkconfiguration"></a>
The network configuration for the AgentCore Runtime.  
*Required*: Yes  
*Type*: [NetworkConfiguration](aws-properties-bedrockagentcore-runtime-networkconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProtocolConfiguration`  <a name="cfn-bedrockagentcore-runtime-protocolconfiguration"></a>
The protocol configuration for an agent runtime. This structure defines how the agent runtime communicates with clients.  
*Required*: No  
*Type*: String  
*Allowed values*: `MCP | HTTP | A2A | AGUI`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RequestHeaderConfiguration`  <a name="cfn-bedrockagentcore-runtime-requestheaderconfiguration"></a>
Configuration for HTTP request headers that will be passed through to the runtime.  
*Required*: No  
*Type*: [RequestHeaderConfiguration](aws-properties-bedrockagentcore-runtime-requestheaderconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleArn`  <a name="cfn-bedrockagentcore-runtime-rolearn"></a>
The IAM role ARN that provides permissions for the AgentCore Runtime.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-bedrockagentcore-runtime-tags"></a>
The tags for the agent.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-bedrockagentcore-runtime-return-values"></a>

### Ref
<a name="aws-resource-bedrockagentcore-runtime-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the agent runtime. For example:

 `arn:aws:bedrock-agentcore:us-east-1:123456789012:runtime/MyRuntime-a1b2c3d4e5` 

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-bedrockagentcore-runtime-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-bedrockagentcore-runtime-return-values-fn--getatt-fn--getatt"></a>

`AgentRuntimeArn`  <a name="AgentRuntimeArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the AgentCore Runtime.

`AgentRuntimeId`  <a name="AgentRuntimeId-fn::getatt"></a>
The unique identifier of the AgentCore Runtime.

`AgentRuntimeVersion`  <a name="AgentRuntimeVersion-fn::getatt"></a>
The version of the AgentCore Runtime.

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
The timestamp when the AgentCore Runtime was created.

`FailureReason`  <a name="FailureReason-fn::getatt"></a>
The reason for failure if the AgentCore Runtime is in a failed state.

`LastUpdatedAt`  <a name="LastUpdatedAt-fn::getatt"></a>
The timestamp when the AgentCore Runtime was last updated.

`Status`  <a name="Status-fn::getatt"></a>
The current status of the AgentCore Runtime.

# AWS::BedrockAgentCore::Runtime AgentRuntimeArtifact
<a name="aws-properties-bedrockagentcore-runtime-agentruntimeartifact"></a>

The artifact of the agent.

## Syntax
<a name="aws-properties-bedrockagentcore-runtime-agentruntimeartifact-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-runtime-agentruntimeartifact-syntax.json"></a>

```
{
  "[CodeConfiguration](#cfn-bedrockagentcore-runtime-agentruntimeartifact-codeconfiguration)" : CodeConfiguration,
  "[ContainerConfiguration](#cfn-bedrockagentcore-runtime-agentruntimeartifact-containerconfiguration)" : ContainerConfiguration
}
```

### YAML
<a name="aws-properties-bedrockagentcore-runtime-agentruntimeartifact-syntax.yaml"></a>

```
  [CodeConfiguration](#cfn-bedrockagentcore-runtime-agentruntimeartifact-codeconfiguration): 
    CodeConfiguration
  [ContainerConfiguration](#cfn-bedrockagentcore-runtime-agentruntimeartifact-containerconfiguration): 
    ContainerConfiguration
```

## Properties
<a name="aws-properties-bedrockagentcore-runtime-agentruntimeartifact-properties"></a>

`CodeConfiguration`  <a name="cfn-bedrockagentcore-runtime-agentruntimeartifact-codeconfiguration"></a>
The code configuration for the agent runtime artifact, including the source code location and execution settings.  
*Required*: No  
*Type*: [CodeConfiguration](aws-properties-bedrockagentcore-runtime-codeconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ContainerConfiguration`  <a name="cfn-bedrockagentcore-runtime-agentruntimeartifact-containerconfiguration"></a>
The container configuration for the agent artifact.  
*Required*: No  
*Type*: [ContainerConfiguration](aws-properties-bedrockagentcore-runtime-containerconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Runtime AuthorizerConfiguration
<a name="aws-properties-bedrockagentcore-runtime-authorizerconfiguration"></a>

Represents inbound authorization configuration options used to authenticate incoming requests. 

## Syntax
<a name="aws-properties-bedrockagentcore-runtime-authorizerconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-runtime-authorizerconfiguration-syntax.json"></a>

```
{
  "[CustomJWTAuthorizer](#cfn-bedrockagentcore-runtime-authorizerconfiguration-customjwtauthorizer)" : CustomJWTAuthorizerConfiguration
}
```

### YAML
<a name="aws-properties-bedrockagentcore-runtime-authorizerconfiguration-syntax.yaml"></a>

```
  [CustomJWTAuthorizer](#cfn-bedrockagentcore-runtime-authorizerconfiguration-customjwtauthorizer): 
    CustomJWTAuthorizerConfiguration
```

## Properties
<a name="aws-properties-bedrockagentcore-runtime-authorizerconfiguration-properties"></a>

`CustomJWTAuthorizer`  <a name="cfn-bedrockagentcore-runtime-authorizerconfiguration-customjwtauthorizer"></a>
The inbound JWT-based authorization, specifying how incoming requests should be authenticated.  
*Required*: No  
*Type*: [CustomJWTAuthorizerConfiguration](aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Runtime AuthorizingClaimMatchValueType
<a name="aws-properties-bedrockagentcore-runtime-authorizingclaimmatchvaluetype"></a>

Defines the value or values to match for and the relationship of the match.

## Syntax
<a name="aws-properties-bedrockagentcore-runtime-authorizingclaimmatchvaluetype-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-runtime-authorizingclaimmatchvaluetype-syntax.json"></a>

```
{
  "[ClaimMatchOperator](#cfn-bedrockagentcore-runtime-authorizingclaimmatchvaluetype-claimmatchoperator)" : String,
  "[ClaimMatchValue](#cfn-bedrockagentcore-runtime-authorizingclaimmatchvaluetype-claimmatchvalue)" : ClaimMatchValueType
}
```

### YAML
<a name="aws-properties-bedrockagentcore-runtime-authorizingclaimmatchvaluetype-syntax.yaml"></a>

```
  [ClaimMatchOperator](#cfn-bedrockagentcore-runtime-authorizingclaimmatchvaluetype-claimmatchoperator): String
  [ClaimMatchValue](#cfn-bedrockagentcore-runtime-authorizingclaimmatchvaluetype-claimmatchvalue): 
    ClaimMatchValueType
```

## Properties
<a name="aws-properties-bedrockagentcore-runtime-authorizingclaimmatchvaluetype-properties"></a>

`ClaimMatchOperator`  <a name="cfn-bedrockagentcore-runtime-authorizingclaimmatchvaluetype-claimmatchoperator"></a>
Defines the relationship between the claim field value and the value or values you're matching for.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `EQUALS | CONTAINS | CONTAINS_ANY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClaimMatchValue`  <a name="cfn-bedrockagentcore-runtime-authorizingclaimmatchvaluetype-claimmatchvalue"></a>
The value or values to match for.  
*Required*: Yes  
*Type*: [ClaimMatchValueType](aws-properties-bedrockagentcore-runtime-claimmatchvaluetype.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Runtime ClaimMatchValueType
<a name="aws-properties-bedrockagentcore-runtime-claimmatchvaluetype"></a>

The value or values to match for.
+ Include a `matchValueString` with the `EQUALS` operator to specify a string that matches the claim field value.
+ Include a `matchValueArray` to specify an array of string values. You can use the following operators:
  + Use `CONTAINS` to yield a match if the claim field value is in the array.
  + Use `CONTAINS_ANY` to yield a match if the claim field value contains any of the strings in the array.

## Syntax
<a name="aws-properties-bedrockagentcore-runtime-claimmatchvaluetype-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-runtime-claimmatchvaluetype-syntax.json"></a>

```
{
  "[MatchValueString](#cfn-bedrockagentcore-runtime-claimmatchvaluetype-matchvaluestring)" : String,
  "[MatchValueStringList](#cfn-bedrockagentcore-runtime-claimmatchvaluetype-matchvaluestringlist)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-bedrockagentcore-runtime-claimmatchvaluetype-syntax.yaml"></a>

```
  [MatchValueString](#cfn-bedrockagentcore-runtime-claimmatchvaluetype-matchvaluestring): 
    String
  [MatchValueStringList](#cfn-bedrockagentcore-runtime-claimmatchvaluetype-matchvaluestringlist): 
    - String
```

## Properties
<a name="aws-properties-bedrockagentcore-runtime-claimmatchvaluetype-properties"></a>

`MatchValueString`  <a name="cfn-bedrockagentcore-runtime-claimmatchvaluetype-matchvaluestring"></a>
The string value to match for.  
*Required*: No  
*Type*: String  
*Pattern*: `[A-Za-z0-9_.-]+`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MatchValueStringList`  <a name="cfn-bedrockagentcore-runtime-claimmatchvaluetype-matchvaluestringlist"></a>
An array of strings to check for a match.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Runtime Code
<a name="aws-properties-bedrockagentcore-runtime-code"></a>

The source code configuration that specifies the location and details of the code to be executed.

## Syntax
<a name="aws-properties-bedrockagentcore-runtime-code-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-runtime-code-syntax.json"></a>

```
{
  "[S3](#cfn-bedrockagentcore-runtime-code-s3)" : S3Location
}
```

### YAML
<a name="aws-properties-bedrockagentcore-runtime-code-syntax.yaml"></a>

```
  [S3](#cfn-bedrockagentcore-runtime-code-s3): 
    S3Location
```

## Properties
<a name="aws-properties-bedrockagentcore-runtime-code-properties"></a>

`S3`  <a name="cfn-bedrockagentcore-runtime-code-s3"></a>
The Amazon Amazon S3 object that contains the source code for the agent runtime.  
*Required*: No  
*Type*: [S3Location](aws-properties-bedrockagentcore-runtime-s3location.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Runtime CodeConfiguration
<a name="aws-properties-bedrockagentcore-runtime-codeconfiguration"></a>

The configuration for the source code that defines how the agent runtime code should be executed, including the code location, runtime environment, and entry point.

## Syntax
<a name="aws-properties-bedrockagentcore-runtime-codeconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-runtime-codeconfiguration-syntax.json"></a>

```
{
  "[Code](#cfn-bedrockagentcore-runtime-codeconfiguration-code)" : Code,
  "[EntryPoint](#cfn-bedrockagentcore-runtime-codeconfiguration-entrypoint)" : [ String, ... ],
  "[Runtime](#cfn-bedrockagentcore-runtime-codeconfiguration-runtime)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-runtime-codeconfiguration-syntax.yaml"></a>

```
  [Code](#cfn-bedrockagentcore-runtime-codeconfiguration-code): 
    Code
  [EntryPoint](#cfn-bedrockagentcore-runtime-codeconfiguration-entrypoint): 
    - String
  [Runtime](#cfn-bedrockagentcore-runtime-codeconfiguration-runtime): String
```

## Properties
<a name="aws-properties-bedrockagentcore-runtime-codeconfiguration-properties"></a>

`Code`  <a name="cfn-bedrockagentcore-runtime-codeconfiguration-code"></a>
The source code location and configuration details.  
*Required*: Yes  
*Type*: [Code](aws-properties-bedrockagentcore-runtime-code.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EntryPoint`  <a name="cfn-bedrockagentcore-runtime-codeconfiguration-entrypoint"></a>
The entry point for the code execution, specifying the function or method that should be invoked when the code runs.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `2`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Runtime`  <a name="cfn-bedrockagentcore-runtime-codeconfiguration-runtime"></a>
The runtime environment for executing the code (for example, Python 3.9 or Node.js 18).  
*Required*: Yes  
*Type*: String  
*Allowed values*: `PYTHON_3_10 | PYTHON_3_11 | PYTHON_3_12 | PYTHON_3_13 | PYTHON_3_14`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Runtime ContainerConfiguration
<a name="aws-properties-bedrockagentcore-runtime-containerconfiguration"></a>

Representation of a container configuration.

## Syntax
<a name="aws-properties-bedrockagentcore-runtime-containerconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-runtime-containerconfiguration-syntax.json"></a>

```
{
  "[ContainerUri](#cfn-bedrockagentcore-runtime-containerconfiguration-containeruri)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-runtime-containerconfiguration-syntax.yaml"></a>

```
  [ContainerUri](#cfn-bedrockagentcore-runtime-containerconfiguration-containeruri): String
```

## Properties
<a name="aws-properties-bedrockagentcore-runtime-containerconfiguration-properties"></a>

`ContainerUri`  <a name="cfn-bedrockagentcore-runtime-containerconfiguration-containeruri"></a>
The ECR URI of the container.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^\d{12}\.dkr\.ecr\.([a-z0-9-]+)\.amazonaws\.com/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)([:@]\S+)$`  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Runtime CustomClaimValidationType
<a name="aws-properties-bedrockagentcore-runtime-customclaimvalidationtype"></a>

Defines the name of a custom claim field and rules for finding matches to authenticate its value.

## Syntax
<a name="aws-properties-bedrockagentcore-runtime-customclaimvalidationtype-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-runtime-customclaimvalidationtype-syntax.json"></a>

```
{
  "[AuthorizingClaimMatchValue](#cfn-bedrockagentcore-runtime-customclaimvalidationtype-authorizingclaimmatchvalue)" : AuthorizingClaimMatchValueType,
  "[InboundTokenClaimName](#cfn-bedrockagentcore-runtime-customclaimvalidationtype-inboundtokenclaimname)" : String,
  "[InboundTokenClaimValueType](#cfn-bedrockagentcore-runtime-customclaimvalidationtype-inboundtokenclaimvaluetype)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-runtime-customclaimvalidationtype-syntax.yaml"></a>

```
  [AuthorizingClaimMatchValue](#cfn-bedrockagentcore-runtime-customclaimvalidationtype-authorizingclaimmatchvalue): 
    AuthorizingClaimMatchValueType
  [InboundTokenClaimName](#cfn-bedrockagentcore-runtime-customclaimvalidationtype-inboundtokenclaimname): String
  [InboundTokenClaimValueType](#cfn-bedrockagentcore-runtime-customclaimvalidationtype-inboundtokenclaimvaluetype): String
```

## Properties
<a name="aws-properties-bedrockagentcore-runtime-customclaimvalidationtype-properties"></a>

`AuthorizingClaimMatchValue`  <a name="cfn-bedrockagentcore-runtime-customclaimvalidationtype-authorizingclaimmatchvalue"></a>
Defines the value or values to match for and the relationship of the match.  
*Required*: Yes  
*Type*: [AuthorizingClaimMatchValueType](aws-properties-bedrockagentcore-runtime-authorizingclaimmatchvaluetype.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InboundTokenClaimName`  <a name="cfn-bedrockagentcore-runtime-customclaimvalidationtype-inboundtokenclaimname"></a>
The name of the custom claim field to check.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[A-Za-z0-9_.-:]+`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InboundTokenClaimValueType`  <a name="cfn-bedrockagentcore-runtime-customclaimvalidationtype-inboundtokenclaimvaluetype"></a>
The data type of the claim value to check for.  
+ Use `STRING` if you want to find an exact match to a string you define.
+ Use `STRING_ARRAY` if you want to fnd a match to at least one value in an array you define.
*Required*: Yes  
*Type*: String  
*Allowed values*: `STRING | STRING_ARRAY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Runtime CustomJWTAuthorizerConfiguration
<a name="aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration"></a>

Configuration for inbound JWT-based authorization, specifying how incoming requests should be authenticated.

## Syntax
<a name="aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration-syntax.json"></a>

```
{
  "[AllowedAudience](#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-allowedaudience)" : [ String, ... ],
  "[AllowedClients](#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-allowedclients)" : [ String, ... ],
  "[AllowedScopes](#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-allowedscopes)" : [ String, ... ],
  "[CustomClaims](#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-customclaims)" : [ CustomClaimValidationType, ... ],
  "[DiscoveryUrl](#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-discoveryurl)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration-syntax.yaml"></a>

```
  [AllowedAudience](#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-allowedaudience): 
    - String
  [AllowedClients](#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-allowedclients): 
    - String
  [AllowedScopes](#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-allowedscopes): 
    - String
  [CustomClaims](#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-customclaims): 
    - CustomClaimValidationType
  [DiscoveryUrl](#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-discoveryurl): String
```

## Properties
<a name="aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration-properties"></a>

`AllowedAudience`  <a name="cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-allowedaudience"></a>
Represents individual audience values that are validated in the incoming JWT token validation process.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AllowedClients`  <a name="cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-allowedclients"></a>
Represents individual client IDs that are validated in the incoming JWT token validation process.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AllowedScopes`  <a name="cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-allowedscopes"></a>
An array of scopes that are allowed to access the token.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CustomClaims`  <a name="cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-customclaims"></a>
An array of objects that define a custom claim validation name, value, and operation   
*Required*: No  
*Type*: Array of [CustomClaimValidationType](aws-properties-bedrockagentcore-runtime-customclaimvalidationtype.md)  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DiscoveryUrl`  <a name="cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-discoveryurl"></a>
This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^.+/\.well-known/openid-configuration$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Runtime FilesystemConfiguration
<a name="aws-properties-bedrockagentcore-runtime-filesystemconfiguration"></a>

<a name="aws-properties-bedrockagentcore-runtime-filesystemconfiguration-description"></a>The `FilesystemConfiguration` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Runtime](aws-resource-bedrockagentcore-runtime.md).

## Syntax
<a name="aws-properties-bedrockagentcore-runtime-filesystemconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-runtime-filesystemconfiguration-syntax.json"></a>

```
{
  "[SessionStorage](#cfn-bedrockagentcore-runtime-filesystemconfiguration-sessionstorage)" : SessionStorageConfiguration
}
```

### YAML
<a name="aws-properties-bedrockagentcore-runtime-filesystemconfiguration-syntax.yaml"></a>

```
  [SessionStorage](#cfn-bedrockagentcore-runtime-filesystemconfiguration-sessionstorage): 
    SessionStorageConfiguration
```

## Properties
<a name="aws-properties-bedrockagentcore-runtime-filesystemconfiguration-properties"></a>

`SessionStorage`  <a name="cfn-bedrockagentcore-runtime-filesystemconfiguration-sessionstorage"></a>
Property description not available.  
*Required*: No  
*Type*: [SessionStorageConfiguration](aws-properties-bedrockagentcore-runtime-sessionstorageconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Runtime LifecycleConfiguration
<a name="aws-properties-bedrockagentcore-runtime-lifecycleconfiguration"></a>

The lifecycle configuration for the AgentCore Runtime.

## Syntax
<a name="aws-properties-bedrockagentcore-runtime-lifecycleconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-runtime-lifecycleconfiguration-syntax.json"></a>

```
{
  "[IdleRuntimeSessionTimeout](#cfn-bedrockagentcore-runtime-lifecycleconfiguration-idleruntimesessiontimeout)" : Integer,
  "[MaxLifetime](#cfn-bedrockagentcore-runtime-lifecycleconfiguration-maxlifetime)" : Integer
}
```

### YAML
<a name="aws-properties-bedrockagentcore-runtime-lifecycleconfiguration-syntax.yaml"></a>

```
  [IdleRuntimeSessionTimeout](#cfn-bedrockagentcore-runtime-lifecycleconfiguration-idleruntimesessiontimeout): Integer
  [MaxLifetime](#cfn-bedrockagentcore-runtime-lifecycleconfiguration-maxlifetime): Integer
```

## Properties
<a name="aws-properties-bedrockagentcore-runtime-lifecycleconfiguration-properties"></a>

`IdleRuntimeSessionTimeout`  <a name="cfn-bedrockagentcore-runtime-lifecycleconfiguration-idleruntimesessiontimeout"></a>
The idle session timeout for the AgentCore Runtime.  
*Required*: No  
*Type*: Integer  
*Minimum*: `60`  
*Maximum*: `28800`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaxLifetime`  <a name="cfn-bedrockagentcore-runtime-lifecycleconfiguration-maxlifetime"></a>
The maximum lifetime for the AgentCore Runtime.  
*Required*: No  
*Type*: Integer  
*Minimum*: `60`  
*Maximum*: `28800`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Runtime NetworkConfiguration
<a name="aws-properties-bedrockagentcore-runtime-networkconfiguration"></a>

SecurityConfig for the Agent.

## Syntax
<a name="aws-properties-bedrockagentcore-runtime-networkconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-runtime-networkconfiguration-syntax.json"></a>

```
{
  "[NetworkMode](#cfn-bedrockagentcore-runtime-networkconfiguration-networkmode)" : String,
  "[NetworkModeConfig](#cfn-bedrockagentcore-runtime-networkconfiguration-networkmodeconfig)" : VpcConfig
}
```

### YAML
<a name="aws-properties-bedrockagentcore-runtime-networkconfiguration-syntax.yaml"></a>

```
  [NetworkMode](#cfn-bedrockagentcore-runtime-networkconfiguration-networkmode): String
  [NetworkModeConfig](#cfn-bedrockagentcore-runtime-networkconfiguration-networkmodeconfig): 
    VpcConfig
```

## Properties
<a name="aws-properties-bedrockagentcore-runtime-networkconfiguration-properties"></a>

`NetworkMode`  <a name="cfn-bedrockagentcore-runtime-networkconfiguration-networkmode"></a>
The network mode for the AgentCore Runtime.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `PUBLIC | VPC`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NetworkModeConfig`  <a name="cfn-bedrockagentcore-runtime-networkconfiguration-networkmodeconfig"></a>
The network mode configuration for the AgentCore Runtime.  
*Required*: No  
*Type*: [VpcConfig](aws-properties-bedrockagentcore-runtime-vpcconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Runtime RequestHeaderConfiguration
<a name="aws-properties-bedrockagentcore-runtime-requestheaderconfiguration"></a>

Configuration for HTTP request headers that will be passed through to the runtime.

## Syntax
<a name="aws-properties-bedrockagentcore-runtime-requestheaderconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-runtime-requestheaderconfiguration-syntax.json"></a>

```
{
  "[RequestHeaderAllowlist](#cfn-bedrockagentcore-runtime-requestheaderconfiguration-requestheaderallowlist)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-bedrockagentcore-runtime-requestheaderconfiguration-syntax.yaml"></a>

```
  [RequestHeaderAllowlist](#cfn-bedrockagentcore-runtime-requestheaderconfiguration-requestheaderallowlist): 
    - String
```

## Properties
<a name="aws-properties-bedrockagentcore-runtime-requestheaderconfiguration-properties"></a>

`RequestHeaderAllowlist`  <a name="cfn-bedrockagentcore-runtime-requestheaderconfiguration-requestheaderallowlist"></a>
A list of HTTP headers that are allowed to be passed through to the runtime.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `20`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Runtime S3Location
<a name="aws-properties-bedrockagentcore-runtime-s3location"></a>

The Amazon S3 location for storing data. This structure defines where in Amazon S3 data is stored.

## Syntax
<a name="aws-properties-bedrockagentcore-runtime-s3location-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-runtime-s3location-syntax.json"></a>

```
{
  "[Bucket](#cfn-bedrockagentcore-runtime-s3location-bucket)" : String,
  "[Prefix](#cfn-bedrockagentcore-runtime-s3location-prefix)" : String,
  "[VersionId](#cfn-bedrockagentcore-runtime-s3location-versionid)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-runtime-s3location-syntax.yaml"></a>

```
  [Bucket](#cfn-bedrockagentcore-runtime-s3location-bucket): String
  [Prefix](#cfn-bedrockagentcore-runtime-s3location-prefix): String
  [VersionId](#cfn-bedrockagentcore-runtime-s3location-versionid): String
```

## Properties
<a name="aws-properties-bedrockagentcore-runtime-s3location-properties"></a>

`Bucket`  <a name="cfn-bedrockagentcore-runtime-s3location-bucket"></a>
The name of the Amazon S3 bucket.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Prefix`  <a name="cfn-bedrockagentcore-runtime-s3location-prefix"></a>
The prefix for objects in the Amazon S3 bucket.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VersionId`  <a name="cfn-bedrockagentcore-runtime-s3location-versionid"></a>
The version ID of the Amazon Amazon S3 object. If not specified, the latest version of the object is used.  
*Required*: No  
*Type*: String  
*Minimum*: `3`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Runtime SessionStorageConfiguration
<a name="aws-properties-bedrockagentcore-runtime-sessionstorageconfiguration"></a>

<a name="aws-properties-bedrockagentcore-runtime-sessionstorageconfiguration-description"></a>The `SessionStorageConfiguration` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Runtime](aws-resource-bedrockagentcore-runtime.md).

## Syntax
<a name="aws-properties-bedrockagentcore-runtime-sessionstorageconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-runtime-sessionstorageconfiguration-syntax.json"></a>

```
{
  "[MountPath](#cfn-bedrockagentcore-runtime-sessionstorageconfiguration-mountpath)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-runtime-sessionstorageconfiguration-syntax.yaml"></a>

```
  [MountPath](#cfn-bedrockagentcore-runtime-sessionstorageconfiguration-mountpath): String
```

## Properties
<a name="aws-properties-bedrockagentcore-runtime-sessionstorageconfiguration-properties"></a>

`MountPath`  <a name="cfn-bedrockagentcore-runtime-sessionstorageconfiguration-mountpath"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^/mnt/[a-zA-Z0-9._-]+/?$`  
*Minimum*: `6`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Runtime VpcConfig
<a name="aws-properties-bedrockagentcore-runtime-vpcconfig"></a>

VpcConfig for the Agent.

## Syntax
<a name="aws-properties-bedrockagentcore-runtime-vpcconfig-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-runtime-vpcconfig-syntax.json"></a>

```
{
  "[SecurityGroups](#cfn-bedrockagentcore-runtime-vpcconfig-securitygroups)" : [ String, ... ],
  "[Subnets](#cfn-bedrockagentcore-runtime-vpcconfig-subnets)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-bedrockagentcore-runtime-vpcconfig-syntax.yaml"></a>

```
  [SecurityGroups](#cfn-bedrockagentcore-runtime-vpcconfig-securitygroups): 
    - String
  [Subnets](#cfn-bedrockagentcore-runtime-vpcconfig-subnets): 
    - String
```

## Properties
<a name="aws-properties-bedrockagentcore-runtime-vpcconfig-properties"></a>

`SecurityGroups`  <a name="cfn-bedrockagentcore-runtime-vpcconfig-securitygroups"></a>
The security groups associated with the VPC configuration.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `16`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Subnets`  <a name="cfn-bedrockagentcore-runtime-vpcconfig-subnets"></a>
The subnets associated with the VPC configuration.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `16`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::Runtime WorkloadIdentityDetails
<a name="aws-properties-bedrockagentcore-runtime-workloadidentitydetails"></a>

The workload identity details for the AgentCore Runtime.

## Syntax
<a name="aws-properties-bedrockagentcore-runtime-workloadidentitydetails-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-runtime-workloadidentitydetails-syntax.json"></a>

```
{
  "[WorkloadIdentityArn](#cfn-bedrockagentcore-runtime-workloadidentitydetails-workloadidentityarn)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-runtime-workloadidentitydetails-syntax.yaml"></a>

```
  [WorkloadIdentityArn](#cfn-bedrockagentcore-runtime-workloadidentitydetails-workloadidentityarn): String
```

## Properties
<a name="aws-properties-bedrockagentcore-runtime-workloadidentitydetails-properties"></a>

`WorkloadIdentityArn`  <a name="cfn-bedrockagentcore-runtime-workloadidentitydetails-workloadidentityarn"></a>
The Amazon Resource Name (ARN) of the workload identity.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::BedrockAgentCore::RuntimeEndpoint
<a name="aws-resource-bedrockagentcore-runtimeendpoint"></a>

AgentCore Runtime is a secure, serverless runtime purpose-built for deploying and scaling dynamic AI agents and tools using any open-source framework including LangGraph, CrewAI, and Strands Agents, any protocol, and any model.

For more information about using agent runtime endpoints in Amazon Bedrock AgentCore, see [AgentCore Runtime versioning and endpoints](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/agent-runtime-versioning.html).

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

## Syntax
<a name="aws-resource-bedrockagentcore-runtimeendpoint-syntax"></a>

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

### JSON
<a name="aws-resource-bedrockagentcore-runtimeendpoint-syntax.json"></a>

```
{
  "Type" : "AWS::BedrockAgentCore::RuntimeEndpoint",
  "Properties" : {
      "[AgentRuntimeId](#cfn-bedrockagentcore-runtimeendpoint-agentruntimeid)" : String,
      "[AgentRuntimeVersion](#cfn-bedrockagentcore-runtimeendpoint-agentruntimeversion)" : String,
      "[Description](#cfn-bedrockagentcore-runtimeendpoint-description)" : String,
      "[Name](#cfn-bedrockagentcore-runtimeendpoint-name)" : String,
      "[Tags](#cfn-bedrockagentcore-runtimeendpoint-tags)" : {Key: Value, ...}
    }
}
```

### YAML
<a name="aws-resource-bedrockagentcore-runtimeendpoint-syntax.yaml"></a>

```
Type: AWS::BedrockAgentCore::RuntimeEndpoint
Properties:
  [AgentRuntimeId](#cfn-bedrockagentcore-runtimeendpoint-agentruntimeid): String
  [AgentRuntimeVersion](#cfn-bedrockagentcore-runtimeendpoint-agentruntimeversion): String
  [Description](#cfn-bedrockagentcore-runtimeendpoint-description): String
  [Name](#cfn-bedrockagentcore-runtimeendpoint-name): String
  [Tags](#cfn-bedrockagentcore-runtimeendpoint-tags): 
    Key: Value
```

## Properties
<a name="aws-resource-bedrockagentcore-runtimeendpoint-properties"></a>

`AgentRuntimeId`  <a name="cfn-bedrockagentcore-runtimeendpoint-agentruntimeid"></a>
The unique identifier of the AgentCore Runtime.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`AgentRuntimeVersion`  <a name="cfn-bedrockagentcore-runtimeendpoint-agentruntimeversion"></a>
The version of the AgentCore Runtime to use for the endpoint.  
*Required*: No  
*Type*: String  
*Pattern*: `^([1-9][0-9]{0,4})$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-bedrockagentcore-runtimeendpoint-description"></a>
The description of the AgentCore Runtime endpoint.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-bedrockagentcore-runtimeendpoint-name"></a>
The name of the AgentCore Runtime endpoint.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,47}$`  
*Minimum*: `1`  
*Maximum*: `48`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-bedrockagentcore-runtimeendpoint-tags"></a>
The tags for the AgentCore Runtime endpoint.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-bedrockagentcore-runtimeendpoint-return-values"></a>

### Ref
<a name="aws-resource-bedrockagentcore-runtimeendpoint-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the runtime endpoint. For example:

 `arn:aws:bedrock-agentcore:us-east-1:123456789012:runtime/MyRuntime-a1b2c3d4e5/runtime-endpoint/MyEndpoint-f6g7h8i9j0` 

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-bedrockagentcore-runtimeendpoint-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-bedrockagentcore-runtimeendpoint-return-values-fn--getatt-fn--getatt"></a>

`AgentRuntimeArn`  <a name="AgentRuntimeArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the AgentCore Runtime.

`AgentRuntimeEndpointArn`  <a name="AgentRuntimeEndpointArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
The timestamp when the AgentCore Runtime endpoint was created.

`FailureReason`  <a name="FailureReason-fn::getatt"></a>
The reason for failure if the AgentCore Runtime endpoint is in a failed state.

`Id`  <a name="Id-fn::getatt"></a>
The unique identifier of the AgentCore Runtime endpoint.

`LastUpdatedAt`  <a name="LastUpdatedAt-fn::getatt"></a>
The timestamp when the AgentCore Runtime endpoint was last updated.

`LiveVersion`  <a name="LiveVersion-fn::getatt"></a>
The currently deployed version of the AgentCore Runtime on the endpoint.

`Status`  <a name="Status-fn::getatt"></a>
The current status of the AgentCore Runtime endpoint.

`TargetVersion`  <a name="TargetVersion-fn::getatt"></a>
The target version of the AgentCore Runtime for the endpoint.

# AWS::BedrockAgentCore::WorkloadIdentity
<a name="aws-resource-bedrockagentcore-workloadidentity"></a>

Creates a workload identity for Amazon Bedrock AgentCore. A workload identity provides OAuth2-based authentication for resources associated with agent runtimes.

For more information about using workload identities in Amazon Bedrock AgentCore, see [Managing workload identities](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/workload-identity.html).

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

## Syntax
<a name="aws-resource-bedrockagentcore-workloadidentity-syntax"></a>

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

### JSON
<a name="aws-resource-bedrockagentcore-workloadidentity-syntax.json"></a>

```
{
  "Type" : "AWS::BedrockAgentCore::WorkloadIdentity",
  "Properties" : {
      "[AllowedResourceOauth2ReturnUrls](#cfn-bedrockagentcore-workloadidentity-allowedresourceoauth2returnurls)" : [ String, ... ],
      "[Name](#cfn-bedrockagentcore-workloadidentity-name)" : String,
      "[Tags](#cfn-bedrockagentcore-workloadidentity-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-bedrockagentcore-workloadidentity-syntax.yaml"></a>

```
Type: AWS::BedrockAgentCore::WorkloadIdentity
Properties:
  [AllowedResourceOauth2ReturnUrls](#cfn-bedrockagentcore-workloadidentity-allowedresourceoauth2returnurls): 
    - String
  [Name](#cfn-bedrockagentcore-workloadidentity-name): String
  [Tags](#cfn-bedrockagentcore-workloadidentity-tags): 
    - Tag
```

## Properties
<a name="aws-resource-bedrockagentcore-workloadidentity-properties"></a>

`AllowedResourceOauth2ReturnUrls`  <a name="cfn-bedrockagentcore-workloadidentity-allowedresourceoauth2returnurls"></a>
The list of allowed OAuth2 return URLs for resources associated with this workload identity.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-bedrockagentcore-workloadidentity-name"></a>
The name of the workload identity. The name must be unique within your account.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[A-Za-z0-9_.-]+`  
*Minimum*: `3`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-bedrockagentcore-workloadidentity-tags"></a>
The tags for the workload identity.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-bedrockagentcore-workloadidentity-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-bedrockagentcore-workloadidentity-return-values"></a>

### Ref
<a name="aws-resource-bedrockagentcore-workloadidentity-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the workload identity name.

### Fn::GetAtt
<a name="aws-resource-bedrockagentcore-workloadidentity-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-bedrockagentcore-workloadidentity-return-values-fn--getatt-fn--getatt"></a>

`CreatedTime`  <a name="CreatedTime-fn::getatt"></a>
The timestamp when the workload identity was created.

`LastUpdatedTime`  <a name="LastUpdatedTime-fn::getatt"></a>
The timestamp when the workload identity was last updated.

`WorkloadIdentityArn`  <a name="WorkloadIdentityArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the workload identity.

# AWS::BedrockAgentCore::WorkloadIdentity Tag
<a name="aws-properties-bedrockagentcore-workloadidentity-tag"></a>

A key-value pair to associate with the workload identity.

## Syntax
<a name="aws-properties-bedrockagentcore-workloadidentity-tag-syntax"></a>

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

### JSON
<a name="aws-properties-bedrockagentcore-workloadidentity-tag-syntax.json"></a>

```
{
  "[Key](#cfn-bedrockagentcore-workloadidentity-tag-key)" : String,
  "[Value](#cfn-bedrockagentcore-workloadidentity-tag-value)" : String
}
```

### YAML
<a name="aws-properties-bedrockagentcore-workloadidentity-tag-syntax.yaml"></a>

```
  [Key](#cfn-bedrockagentcore-workloadidentity-tag-key): String
  [Value](#cfn-bedrockagentcore-workloadidentity-tag-value): String
```

## Properties
<a name="aws-properties-bedrockagentcore-workloadidentity-tag-properties"></a>

`Key`  <a name="cfn-bedrockagentcore-workloadidentity-tag-key"></a>
The key name of the tag.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-bedrockagentcore-workloadidentity-tag-value"></a>
The value for the tag.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)