View a markdown version of this page

AWS::BedrockAgentCore::ApiKeyCredentialProvider - AWS CloudFormation
SyntaxPropertiesReturn values

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

AWS::BedrockAgentCore::ApiKeyCredentialProvider

Specifies an API key credential provider for Amazon Bedrock AgentCore. An API key credential provider stores and manages API keys that agents use to authenticate with external services and third-party APIs through AgentCore Gateway.

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

Syntax

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

JSON

{
  "Type" : "AWS::BedrockAgentCore::ApiKeyCredentialProvider",
  "Properties" : {
      "ApiKey" : String,
      "ApiKeySecretConfig" : SecretReference,
      "ApiKeySecretSource" : String,
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::BedrockAgentCore::ApiKeyCredentialProvider
Properties:
  ApiKey: String
  ApiKeySecretConfig: 
    SecretReference
  ApiKeySecretSource: String
  Name: String
  Tags: 
    - Tag

Properties

ApiKey

The API key to use for authentication. This value is encrypted and stored securely.

Required: No

Type: String

Minimum: 1

Maximum: 65536

Update requires: No interruption

ApiKeySecretConfig

Property description not available.

Required: No

Type: SecretReference

Update requires: No interruption

ApiKeySecretSource

Property description not available.

Required: No

Type: String

Allowed values: MANAGED | EXTERNAL

Update requires: No interruption

Name

The name of the API key credential provider.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9\-_]+$

Minimum: 1

Maximum: 128

Update requires: Replacement

Tags

A map of tag keys and values to assign to the API key credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

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

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

ApiKeySecretJsonKey

Property description not available.

CreatedTime

The timestamp when the API key credential provider was created.

CredentialProviderArn

The Amazon Resource Name (ARN) of the API key credential provider.

LastUpdatedTime

The timestamp when the API key credential provider was last updated.