AWS::BedrockAgentCore::GatewayTarget OAuthCredentialProvider - 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::BedrockAgentCore::GatewayTarget OAuthCredentialProvider

An OAuth credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using OAuth.

Syntax

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

JSON

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

YAML

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

Properties

CustomParameters

The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.

Required: No

Type: Object of String

Pattern: .+

Minimum: 1

Maximum: 2048

Update requires: No interruption

DefaultReturnUrl

The URL where the end user's browser is redirected after obtaining the authorization code. Generally points to the customer's application.

Required: No

Type: String

Pattern: \w+:(\/?\/?)[^\s]+

Minimum: 1

Maximum: 2048

Update requires: No interruption

GrantType

Specifies the kind of credentials to use for authorization:

  • CLIENT_CREDENTIALS - Authorization with a client ID and secret.

  • AUTHORIZATION_CODE - Authorization with a token that is specific to an individual end user.

Required: No

Type: String

Allowed values: AUTHORIZATION_CODE | CLIENT_CREDENTIALS

Update requires: No interruption

ProviderArn

The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in AWS.

Required: Yes

Type: String

Pattern: ^arn:([^:]*):([^:]*):([^:]*):([0-9]{12})?:(.+)$

Update requires: No interruption

Scopes

The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.

Required: Yes

Type: Array of String

Minimum: 1

Maximum: 64 | 100

Update requires: No interruption