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

Creates a new API key credential provider.

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

Property description not available.

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

Property description not available.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

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.