IOAuth2CredentialProvider

class aws_cdk.aws_bedrock_agentcore_alpha.IOAuth2CredentialProvider(*args, **kwargs)

Bases: IResource, IGrantable, IOAuth2CredentialProviderRef, Protocol

(experimental) An OAuth2 credential provider registered in AgentCore Token Vault.

Stability:

experimental

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy)

Return type:

None

bind_for_gateway_o_auth_target(scopes, custom_parameters=None)

(experimental) ARNs and OAuth scopes for gateway targets (GatewayCredentialProvider.fromOauthIdentity or fromOauthIdentityArn).

Parameters:

  • scopes (Sequence[str])

  • custom_parameters (Optional[Mapping[str, str]])

Stability:

experimental

Return type:

GatewayOAuth2IdentityBinding

grant(grantee, *actions)

(experimental) Grants IAM actions to the IAM principal.

Parameters:
Stability:

experimental

Return type:

Grant

grant_admin(grantee)

(experimental) Grant control plane permissions to manage this provider.

Parameters:

grantee (IGrantable)

Stability:

experimental

Return type:

Grant

grant_full_access(grantee)

(experimental) Grant read, admin, and token retrieval permissions.

Parameters:

grantee (IGrantable)

Stability:

experimental

Return type:

Grant

grant_read(grantee)

(experimental) Grant GetOauth2CredentialProvider and ListOauth2CredentialProviders, scoped to this provider and parent resources required by the Bedrock AgentCore authorization model.

Parameters:

grantee (IGrantable)

Stability:

experimental

Return type:

Grant

grant_use(grantee)

(experimental) Grant permission to retrieve OAuth tokens (GetResourceOauth2Token, CompleteResourceTokenAuth).

Parameters:

grantee (IGrantable)

Stability:

experimental

Return type:

Grant

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

Parameters:

mixins (IMixin) – The mixins to apply.

Return type:

IConstruct

Returns:

This construct for chaining

Attributes

callback_url

(experimental) Callback URL for the OAuth2 authorization flow.

Stability:

experimental

Attribute:

true

client_secret_arn

(experimental) The ARN of the Secrets Manager secret for the OAuth2 client credentials.

May be undefined for resources imported without this attribute.

Stability:

experimental

Attribute:

true

created_time

(experimental) Timestamp when the credential provider was created.

Stability:

experimental

Attribute:

true

credential_provider_arn

(experimental) The ARN of this credential provider.

Stability:

experimental

Attribute:

true

credential_provider_vendor

(experimental) OAuth2 vendor string passed to CloudFormation.

Stability:

experimental

env

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

grant_principal

The principal to grant permissions to.

last_updated_time

(experimental) Timestamp when the credential provider was last updated.

Stability:

experimental

Attribute:

true

node

The tree node.

o_auth2_credential_provider_ref

(experimental) A reference to a OAuth2CredentialProvider resource.

Stability:

experimental

stack

The stack in which this resource is defined.