View a markdown version of this page

AWS::BedrockAgentCore::OAuth2CredentialProvider PrivateKeyJwtConfig - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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.

AWS::BedrockAgentCore::OAuth2CredentialProvider PrivateKeyJwtConfig

The private key configuration for private_key_jwt client authentication.

Syntax

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

JSON

{
  "AdditionalHeaderClaims" : {Key: Value, ...},
  "AdditionalPayloadClaims" : {Key: Value, ...},
  "PrivateKeySource" : PrivateKeySource,
  "SigningAlgorithm" : String
}

Properties

AdditionalHeaderClaims

A map of additional claims to include in the JWT client assertion header. Standard header claims such as alg and typ cannot be added.

Required: No

Type: Object of String

Pattern: ^[A-Za-z0-9_.:#-]+$

Minimum: 1

Maximum: 2048

Update requires: No interruption

AdditionalPayloadClaims

A map of additional claims to include in the JWT client assertion payload. Payload claims generated by the service, such as iss, sub, jti, and exp, cannot be added.

Required: No

Type: Object of String

Pattern: ^[A-Za-z0-9_.:#-]+$

Minimum: 1

Maximum: 2048

Update requires: No interruption

PrivateKeySource

The private key source for the JWT client assertion.

Required: No

Type: PrivateKeySource

Update requires: No interruption

SigningAlgorithm

The algorithm used to sign the JWT client assertion. Valid values are RS256, PS256, and ES256.

Required: No

Type: String

Allowed values: RS256 | PS256 | ES256

Update requires: No interruption