

This is the new *Amazon CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [Amazon CloudFormation User Guide](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html).

# 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 Amazon 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.amazonaws.cn/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.amazonaws.cn/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.amazonaws.cn/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.