View a markdown version of this page

AWS::AgentRegistry::RegistryRecord RegistryRecordOAuthCredentialProvider - AWS CloudFormation
SyntaxProperties

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::AgentRegistry::RegistryRecord RegistryRecordOAuthCredentialProvider

The configuration for an OAuth 2.0 credential provider that authenticates requests to a registry record's source.

Syntax

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

JSON

{
  "CustomParameters" : {Key: Value, ...},
  "GrantType" : String,
  "ProviderArn" : String,
  "Scopes" : [ String, ... ]
}

YAML

  CustomParameters: 
    Key: Value
  GrantType: String
  ProviderArn: String
  Scopes: 
    - String

Properties

CustomParameters

Additional parameters to include in the OAuth 2.0 token request.

Required: No

Type: Object of String

Pattern: ^.*$

Update requires: No interruption

GrantType

The OAuth 2.0 grant type used to obtain access tokens.

Required: No

Type: String

Allowed values: CLIENT_CREDENTIALS

Update requires: No interruption

ProviderArn

The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.

Required: Yes

Type: String

Pattern: ^arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:.*$

Minimum: 1

Maximum: 2048

Update requires: No interruption

Scopes

The OAuth 2.0 scopes to request when obtaining access tokens.

Required: No

Type: Array of String

Update requires: No interruption