OAuth2CredentialProvider

class aws_cdk.aws_bedrock_agentcore_alpha.OAuth2CredentialProvider(scope, id, *, credential_provider_vendor, oauth2_provider_config_input, o_auth2_credential_provider_name=None, tags=None)

Bases: Resource

(experimental) L2 construct for AWS::BedrockAgentCore::OAuth2CredentialProvider.

Prefer the static factories (for example {@link OAuth2CredentialProvider.usingSlack}) so you only pass the OAuth2 settings that apply to that vendor. To attach the identity to a gateway target, use {@link GatewayCredentialProvider.fromOauthIdentity } with this construct, or {@link OAuth2CredentialProvider.bindForGatewayOAuthTarget} with {@link GatewayCredentialProvider.fromOauthIdentityArn }.

See:: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-oauth2credentialprovider.html
Stability:: experimental
Resource:: AWS::BedrockAgentCore::OAuth2CredentialProvider
ExampleMetadata:: fixture=default infused

Example:

agentcore.OAuth2CredentialProvider.using_custom(self, "CustomOAuthMeta",
    client_id="your-client-id",
    client_secret=cdk.SecretValue.unsafe_plain_text("your-client-secret"),
    authorization_server_metadata=agentcore.OAuth2AuthorizationServerMetadata(
        issuer="https://idp.example.com",
        authorization_endpoint="https://idp.example.com/oauth2/authorize",
        token_endpoint="https://idp.example.com/oauth2/token"
    )
)

Parameters:

scope (Construct)
id (str)
credential_provider_vendor (str) – (experimental) OAuth2 vendor string for CloudFormation CredentialProviderVendor.
oauth2_provider_config_input (Union[Oauth2ProviderConfigInputProperty, Dict[str, Any]]) – (experimental) OAuth2 provider configuration passed through to Oauth2ProviderConfigInput.
o_auth2_credential_provider_name (Optional[str]) – (experimental) Name of the credential provider. Default: a name generated by CDK
tags (Optional[Mapping[str, str]]) – (experimental) Tags for this credential provider. Default: - no tags

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 {@link GatewayCredentialProvider.fromOauthIdentity } / {@link GatewayCredentialProvider.fromOauthIdentityArn }.

Parameters:

scopes (Sequence[str]) – OAuth scopes the gateway target should request (see vendor documentation).
custom_parameters (Optional[Mapping[str, str]]) – Optional custom parameters for the OAuth flow.

Stability:

experimental

Return type:

GatewayOAuth2IdentityBinding

grant(grantee, *actions)

(experimental) [disable-awslint:no-grants].

Parameters:

grantee (IGrantable)
actions (str)

Stability:

experimental

Return type:

Grant

grant_admin(grantee)

(experimental) [disable-awslint:no-grants].

Parameters:: grantee (IGrantable)
Stability:: experimental
Return type:: Grant

grant_full_access(grantee)

(experimental) [disable-awslint:no-grants].

Parameters:: grantee (IGrantable)
Stability:: experimental
Return type:: Grant

grant_read(grantee)

(experimental) [disable-awslint:no-grants].

Parameters:: grantee (IGrantable)
Stability:: experimental
Return type:: Grant

grant_use(grantee)

(experimental) [disable-awslint:no-grants].

Parameters:: grantee (IGrantable)
Stability:: experimental
Return type:: Grant

to_string()

Returns a string representation of this construct.

Return type:: str

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. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:: mixins (IMixin)
Return type:: IConstruct

Attributes

PROPERTY_INJECTION_ID = '@aws-cdk.aws-bedrock-agentcore-alpha.OAuth2CredentialProvider'

callback_url

(experimental) Callback URL for the OAuth2 authorization flow.

Stability:: experimental

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

created_time

(experimental) Timestamp when the credential provider was created.

Stability:: experimental

credential_provider_arn

(experimental) The ARN of this credential provider.

Stability:: experimental

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

(experimental) The principal to grant permissions to.

Stability:: experimental

last_updated_time

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

Stability:: experimental

node: The tree node.

o_auth2_credential_provider_name

(experimental) The name of this OAuth2 credential provider.

Stability:: experimental
Attribute:: true

o_auth2_credential_provider_ref

(experimental) A reference to a OAuth2CredentialProvider resource.

Stability:: experimental

stack: The stack in which this resource is defined.

Static Methods

classmethod from_o_auth2_credential_provider_attributes(scope, id, *, credential_provider_arn, credential_provider_vendor, callback_url=None, client_secret_arn=None, created_time=None, last_updated_time=None)

(experimental) Import an existing OAuth2 credential provider.

Parameters:

scope (Construct)
id (str)
credential_provider_arn (str) – (experimental) ARN of the credential provider.
credential_provider_vendor (str) – (experimental) Vendor string for this provider.
callback_url (Optional[str]) – (experimental) Callback URL from the deployed provider, if known. Default: - not set
client_secret_arn (Optional[str]) – (experimental) ARN of the Secrets Manager secret for OAuth2 client credentials, if known. Default: - not set; required for {@link OAuth2CredentialProvider.bindForGatewayOAuthTarget } on imported providers
created_time (Optional[str]) – (experimental) Resource creation time. Default: - not set
last_updated_time (Optional[str]) – (experimental) Resource last-updated time. Default: - not set

Stability:

experimental

Return type:

IOAuth2CredentialProvider

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod using_atlassian(scope, id, *, o_auth2_credential_provider_name=None, tags=None, client_id, client_secret)

(experimental) Create a credential provider for Atlassian OAuth2.

Parameters:

scope (Construct)
id (str)
o_auth2_credential_provider_name (Optional[str]) – (experimental) Name of the credential provider. Default: a name generated by CDK
tags (Optional[Mapping[str, str]]) – (experimental) Tags for this credential provider. Default: - no tags
client_id (str) – (experimental) OAuth2 client identifier.
client_secret (SecretValue) – (experimental) OAuth2 client secret. NOTE: The client secret will be included in the CloudFormation template as part of synthesis. The service stores the secret in Secrets Manager after creation, but the value is visible in the template and deployment history. Use SecretValue.unsafePlainText() to explicitly acknowledge plaintext, or pass a reference from another construct to avoid embedding the literal value.

Stability:

experimental

Return type: