View a markdown version of this page

AWS::BedrockAgentCore::OAuth2CredentialProvider - AWS CloudFormation

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::OAuth2CredentialProvider

Specifies an OAuth2 credential provider for Amazon Bedrock AgentCore. An OAuth2 credential provider manages OAuth2 client credentials, authorization codes, or token exchange flows that agents use to authenticate with external services 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::OAuth2CredentialProvider", "Properties" : { "CredentialProviderVendor" : String, "Name" : String, "Oauth2ProviderConfigInput" : Oauth2ProviderConfigInput, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::BedrockAgentCore::OAuth2CredentialProvider Properties: CredentialProviderVendor: String Name: String Oauth2ProviderConfigInput: Oauth2ProviderConfigInput Tags: - Tag

Properties

CredentialProviderVendor

The vendor of the OAuth2 credential provider. This specifies which OAuth2 implementation to use.

Required: Yes

Type: String

Allowed values: GoogleOauth2 | GithubOauth2 | SlackOauth2 | SalesforceOauth2 | MicrosoftOauth2 | CustomOauth2 | AtlassianOauth2 | LinkedinOauth2 | XOauth2 | OktaOauth2 | OneLoginOauth2 | PingOneOauth2 | FacebookOauth2 | YandexOauth2 | RedditOauth2 | ZoomOauth2 | TwitchOauth2 | SpotifyOauth2 | DropboxOauth2 | NotionOauth2 | HubspotOauth2 | CyberArkOauth2 | FusionAuthOauth2 | Auth0Oauth2 | CognitoOauth2

Update requires: Replacement

Name

The name of the OAuth2 credential provider. The name must be unique within your account.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 128

Update requires: Replacement

Oauth2ProviderConfigInput

Contains the input configuration for an OAuth2 provider.

Required: No

Type: Oauth2ProviderConfigInput

Update requires: No interruption

Tags

A map of tag keys and values to assign to the OAuth2 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.

CallbackUrl

Property description not available.

ClientSecretJsonKey

Property description not available.

ClientSecretSource

Property description not available.

CreatedTime

Property description not available.

CredentialProviderArn

Property description not available.

LastUpdatedTime

Property description not available.