OAuthConfiguration

class aws_cdk.aws_bedrock_agentcore_alpha.OAuthConfiguration(*, provider_arn, scopes, secret_arn, custom_parameters=None)

Bases: object

(experimental) OAuth configuration.

Parameters:

provider_arn (str) – (experimental) The OAuth credential provider ARN. This is returned when creating the OAuth credential provider via Console or API. Format: arn:aws:bedrock-agentcore:region:account:token-vault/id/oauth2credentialprovider/name Required: Yes
scopes (Sequence[str]) – (experimental) The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider. Array Members: Minimum number of 0 items. Maximum number of 100 items. Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes
secret_arn (str) – (experimental) The ARN of the Secrets Manager secret containing OAuth credentials (client ID and secret). This is returned when creating the OAuth credential provider via Console or API. Format: arn:aws:secretsmanager:region:account:secret:name Required: Yes
custom_parameters (Optional[Mapping[str, str]]) – (experimental) Custom parameters for the OAuth flow. Default: - No custom parameters

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_bedrock_agentcore_alpha as bedrock_agentcore_alpha

o_auth_configuration = bedrock_agentcore_alpha.OAuthConfiguration(
    provider_arn="providerArn",
    scopes=["scopes"],
    secret_arn="secretArn",

    # the properties below are optional
    custom_parameters={
        "custom_parameters_key": "customParameters"
    }
)

Attributes

custom_parameters

(experimental) Custom parameters for the OAuth flow.

Default:

No custom parameters

Stability:

experimental

provider_arn

(experimental) The OAuth credential provider ARN.

This is returned when creating the OAuth credential provider via Console or API. Format: arn:aws:bedrock-agentcore:region:account:token-vault/id/oauth2credentialprovider/name Required: Yes

Stability:: experimental

scopes

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

Array Members: Minimum number of 0 items. Maximum number of 100 items. Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes

Stability:: experimental

secret_arn

(experimental) The ARN of the Secrets Manager secret containing OAuth credentials (client ID and secret).

This is returned when creating the OAuth credential provider via Console or API. Format: arn:aws:secretsmanager:region:account:secret:name Required: Yes

Stability:: experimental