CfnOAuth2CredentialProvider

class aws_cdk.aws_bedrockagentcore.CfnOAuth2CredentialProvider(scope, id, *, credential_provider_vendor, name, oauth2_provider_config_input=None, tags=None)

Bases: CfnResource

Resource Type definition for AWS::BedrockAgentCore::OAuth2CredentialProvider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-oauth2credentialprovider.html

CloudformationResource:

AWS::BedrockAgentCore::OAuth2CredentialProvider

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

cfn_oAuth2_credential_provider = bedrockagentcore.CfnOAuth2CredentialProvider(self, "MyCfnOAuth2CredentialProvider",
    credential_provider_vendor="credentialProviderVendor",
    name="name",

    # the properties below are optional
    oauth2_provider_config_input=bedrockagentcore.CfnOAuth2CredentialProvider.Oauth2ProviderConfigInputProperty(
        atlassian_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.AtlassianOauth2ProviderConfigInputProperty(
            client_id="clientId",
            client_secret="clientSecret"
        ),
        custom_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.CustomOauth2ProviderConfigInputProperty(
            client_id="clientId",
            client_secret="clientSecret",
            oauth_discovery=bedrockagentcore.CfnOAuth2CredentialProvider.Oauth2DiscoveryProperty(
                authorization_server_metadata=bedrockagentcore.CfnOAuth2CredentialProvider.Oauth2AuthorizationServerMetadataProperty(
                    authorization_endpoint="authorizationEndpoint",
                    issuer="issuer",
                    token_endpoint="tokenEndpoint",

                    # the properties below are optional
                    response_types=["responseTypes"]
                ),
                discovery_url="discoveryUrl"
            )
        ),
        github_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.GithubOauth2ProviderConfigInputProperty(
            client_id="clientId",
            client_secret="clientSecret"
        ),
        google_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.GoogleOauth2ProviderConfigInputProperty(
            client_id="clientId",
            client_secret="clientSecret"
        ),
        included_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.IncludedOauth2ProviderConfigInputProperty(
            client_id="clientId",
            client_secret="clientSecret",

            # the properties below are optional
            authorization_endpoint="authorizationEndpoint",
            issuer="issuer",
            token_endpoint="tokenEndpoint"
        ),
        linkedin_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.LinkedinOauth2ProviderConfigInputProperty(
            client_id="clientId",
            client_secret="clientSecret"
        ),
        microsoft_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.MicrosoftOauth2ProviderConfigInputProperty(
            client_id="clientId",
            client_secret="clientSecret",

            # the properties below are optional
            tenant_id="tenantId"
        ),
        salesforce_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.SalesforceOauth2ProviderConfigInputProperty(
            client_id="clientId",
            client_secret="clientSecret"
        ),
        slack_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.SlackOauth2ProviderConfigInputProperty(
            client_id="clientId",
            client_secret="clientSecret"
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::BedrockAgentCore::OAuth2CredentialProvider.

Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • credential_provider_vendor (str) – The vendor of the OAuth2 credential provider.

  • name (str) – The name of the OAuth2 credential provider.

  • oauth2_provider_config_input (Union[IResolvable, Oauth2ProviderConfigInputProperty, Dict[str, Any], None]) – Input configuration for an OAuth2 provider.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags to assign to the OAuth2 credential provider.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource)

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str)

  • value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy])

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

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

CFN_RESOURCE_TYPE_NAME = 'AWS::BedrockAgentCore::OAuth2CredentialProvider'
attr_callback_url

The callback URL for the OAuth2 authorization flow.

CloudformationAttribute:

CallbackUrl

attr_client_secret_arn

Contains information about a secret in AWS Secrets Manager.

CloudformationAttribute:

ClientSecretArn

attr_created_time

The timestamp when the credential provider was created.

CloudformationAttribute:

CreatedTime

attr_credential_provider_arn

The Amazon Resource Name (ARN) of the OAuth2 credential provider.

CloudformationAttribute:

CredentialProviderArn

attr_last_updated_time

The timestamp when the credential provider was last updated.

CloudformationAttribute:

LastUpdatedTime

attr_oauth2_provider_config_output

Output configuration for an OAuth2 provider.

CloudformationAttribute:

Oauth2ProviderConfigOutput

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

credential_provider_vendor

The vendor of the OAuth2 credential provider.

env
logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

The name of the OAuth2 credential provider.

node

The tree node.

o_auth2_credential_provider_ref

A reference to a OAuth2CredentialProvider resource.

oauth2_provider_config_input

Input configuration for an OAuth2 provider.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Tags to assign to the OAuth2 credential provider.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_o_auth2_credential_provider(x)

Checks whether the given object is a CfnOAuth2CredentialProvider.

Parameters:

x (Any)

Return type:

bool

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any)

Return type:

bool

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.

AtlassianOauth2ProviderConfigInputProperty

class CfnOAuth2CredentialProvider.AtlassianOauth2ProviderConfigInputProperty(*, client_id, client_secret)

Bases: object

Input configuration for an Atlassian OAuth2 provider.

Parameters:

  • client_id (str)

  • client_secret (str)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput.html

ExampleMetadata:

fixture=_generated

Example:

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

atlassian_oauth2_provider_config_input_property = bedrockagentcore.CfnOAuth2CredentialProvider.AtlassianOauth2ProviderConfigInputProperty(
    client_id="clientId",
    client_secret="clientSecret"
)

Attributes

client_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput-clientid

Type:

see

client_secret

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput-clientsecret

Type:

see

ClientSecretArnProperty

class CfnOAuth2CredentialProvider.ClientSecretArnProperty(*, secret_arn)

Bases: object

Contains information about a secret in AWS Secrets Manager.

Parameters:

secret_arn (str) – The ARN of the secret in AWS Secrets Manager.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-clientsecretarn.html

ExampleMetadata:

fixture=_generated

Example:

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

client_secret_arn_property = bedrockagentcore.CfnOAuth2CredentialProvider.ClientSecretArnProperty(
    secret_arn="secretArn"
)

Attributes

secret_arn

The ARN of the secret in AWS Secrets Manager.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-clientsecretarn.html#cfn-bedrockagentcore-oauth2credentialprovider-clientsecretarn-secretarn

CustomOauth2ProviderConfigInputProperty

class CfnOAuth2CredentialProvider.CustomOauth2ProviderConfigInputProperty(*, client_id, client_secret, oauth_discovery)

Bases: object

Input configuration for a custom OAuth2 provider.

Parameters:

  • client_id (str) – The client ID for the custom OAuth2 provider.

  • client_secret (str) – The client secret for the custom OAuth2 provider.

  • oauth_discovery (Union[IResolvable, Oauth2DiscoveryProperty, Dict[str, Any]]) – Discovery information for an OAuth2 provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html

ExampleMetadata:

fixture=_generated

Example:

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

custom_oauth2_provider_config_input_property = bedrockagentcore.CfnOAuth2CredentialProvider.CustomOauth2ProviderConfigInputProperty(
    client_id="clientId",
    client_secret="clientSecret",
    oauth_discovery=bedrockagentcore.CfnOAuth2CredentialProvider.Oauth2DiscoveryProperty(
        authorization_server_metadata=bedrockagentcore.CfnOAuth2CredentialProvider.Oauth2AuthorizationServerMetadataProperty(
            authorization_endpoint="authorizationEndpoint",
            issuer="issuer",
            token_endpoint="tokenEndpoint",

            # the properties below are optional
            response_types=["responseTypes"]
        ),
        discovery_url="discoveryUrl"
    )
)

Attributes

client_id

The client ID for the custom OAuth2 provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientid

client_secret

The client secret for the custom OAuth2 provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientsecret

oauth_discovery

Discovery information for an OAuth2 provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-oauthdiscovery

GithubOauth2ProviderConfigInputProperty

class CfnOAuth2CredentialProvider.GithubOauth2ProviderConfigInputProperty(*, client_id, client_secret)

Bases: object

Input configuration for a GitHub OAuth2 provider.

Parameters:

  • client_id (str)

  • client_secret (str)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput.html

ExampleMetadata:

fixture=_generated

Example:

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

github_oauth2_provider_config_input_property = bedrockagentcore.CfnOAuth2CredentialProvider.GithubOauth2ProviderConfigInputProperty(
    client_id="clientId",
    client_secret="clientSecret"
)

Attributes

client_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput-clientid

Type:

see

client_secret

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput-clientsecret

Type:

see

GoogleOauth2ProviderConfigInputProperty

class CfnOAuth2CredentialProvider.GoogleOauth2ProviderConfigInputProperty(*, client_id, client_secret)

Bases: object

Input configuration for a Google OAuth2 provider.

Parameters:

  • client_id (str)

  • client_secret (str)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput.html

ExampleMetadata:

fixture=_generated

Example:

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

google_oauth2_provider_config_input_property = bedrockagentcore.CfnOAuth2CredentialProvider.GoogleOauth2ProviderConfigInputProperty(
    client_id="clientId",
    client_secret="clientSecret"
)

Attributes

client_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput-clientid

Type:

see

client_secret

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput-clientsecret

Type:

see

IncludedOauth2ProviderConfigInputProperty

class CfnOAuth2CredentialProvider.IncludedOauth2ProviderConfigInputProperty(*, client_id, client_secret, authorization_endpoint=None, issuer=None, token_endpoint=None)

Bases: object

Input configuration for a supported non-custom OAuth2 provider.

Parameters:

  • client_id (str)

  • client_secret (str)

  • authorization_endpoint (Optional[str]) – OAuth2 authorization endpoint for your isolated OAuth2 application tenant.

  • issuer (Optional[str]) – Token issuer of your isolated OAuth2 application tenant.

  • token_endpoint (Optional[str]) – OAuth2 token endpoint for your isolated OAuth2 application tenant.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput.html

ExampleMetadata:

fixture=_generated

Example:

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

included_oauth2_provider_config_input_property = bedrockagentcore.CfnOAuth2CredentialProvider.IncludedOauth2ProviderConfigInputProperty(
    client_id="clientId",
    client_secret="clientSecret",

    # the properties below are optional
    authorization_endpoint="authorizationEndpoint",
    issuer="issuer",
    token_endpoint="tokenEndpoint"
)

Attributes

authorization_endpoint

OAuth2 authorization endpoint for your isolated OAuth2 application tenant.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-authorizationendpoint

client_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-clientid

Type:

see

client_secret

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-clientsecret

Type:

see

issuer

Token issuer of your isolated OAuth2 application tenant.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-issuer

token_endpoint

OAuth2 token endpoint for your isolated OAuth2 application tenant.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-tokenendpoint

LinkedinOauth2ProviderConfigInputProperty

class CfnOAuth2CredentialProvider.LinkedinOauth2ProviderConfigInputProperty(*, client_id, client_secret)

Bases: object

Input configuration for a LinkedIn OAuth2 provider.

Parameters:

  • client_id (str)

  • client_secret (str)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput.html

ExampleMetadata:

fixture=_generated

Example:

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

linkedin_oauth2_provider_config_input_property = bedrockagentcore.CfnOAuth2CredentialProvider.LinkedinOauth2ProviderConfigInputProperty(
    client_id="clientId",
    client_secret="clientSecret"
)

Attributes

client_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput-clientid

Type:

see

client_secret

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput-clientsecret

Type:

see

MicrosoftOauth2ProviderConfigInputProperty

class CfnOAuth2CredentialProvider.MicrosoftOauth2ProviderConfigInputProperty(*, client_id, client_secret, tenant_id=None)

Bases: object

Input configuration for a Microsoft OAuth2 provider.

Parameters:

  • client_id (str)

  • client_secret (str)

  • tenant_id (Optional[str]) – The Microsoft Entra ID tenant ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput.html

ExampleMetadata:

fixture=_generated

Example:

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

microsoft_oauth2_provider_config_input_property = bedrockagentcore.CfnOAuth2CredentialProvider.MicrosoftOauth2ProviderConfigInputProperty(
    client_id="clientId",
    client_secret="clientSecret",

    # the properties below are optional
    tenant_id="tenantId"
)

Attributes

client_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput-clientid

Type:

see

client_secret

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput-clientsecret

Type:

see

tenant_id

The Microsoft Entra ID tenant ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput-tenantid

Oauth2AuthorizationServerMetadataProperty

class CfnOAuth2CredentialProvider.Oauth2AuthorizationServerMetadataProperty(*, authorization_endpoint, issuer, token_endpoint, response_types=None)

Bases: object

Authorization server metadata for the OAuth2 provider.

Parameters:

  • authorization_endpoint (str) – The authorization endpoint URL.

  • issuer (str) – The issuer URL for the OAuth2 authorization server.

  • token_endpoint (str) – The token endpoint URL.

  • response_types (Optional[Sequence[str]]) – The supported response types.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata.html

ExampleMetadata:

fixture=_generated

Example:

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

oauth2_authorization_server_metadata_property = bedrockagentcore.CfnOAuth2CredentialProvider.Oauth2AuthorizationServerMetadataProperty(
    authorization_endpoint="authorizationEndpoint",
    issuer="issuer",
    token_endpoint="tokenEndpoint",

    # the properties below are optional
    response_types=["responseTypes"]
)

Attributes

authorization_endpoint

The authorization endpoint URL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-authorizationendpoint

issuer

The issuer URL for the OAuth2 authorization server.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-issuer

response_types

The supported response types.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-responsetypes

token_endpoint

The token endpoint URL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-tokenendpoint

Oauth2DiscoveryProperty

class CfnOAuth2CredentialProvider.Oauth2DiscoveryProperty(*, authorization_server_metadata=None, discovery_url=None)

Bases: object

Discovery information for an OAuth2 provider.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2discovery.html

ExampleMetadata:

fixture=_generated

Example:

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

oauth2_discovery_property = bedrockagentcore.CfnOAuth2CredentialProvider.Oauth2DiscoveryProperty(
    authorization_server_metadata=bedrockagentcore.CfnOAuth2CredentialProvider.Oauth2AuthorizationServerMetadataProperty(
        authorization_endpoint="authorizationEndpoint",
        issuer="issuer",
        token_endpoint="tokenEndpoint",

        # the properties below are optional
        response_types=["responseTypes"]
    ),
    discovery_url="discoveryUrl"
)

Attributes

authorization_server_metadata

Authorization server metadata for the OAuth2 provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2discovery.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2discovery-authorizationservermetadata

discovery_url

The discovery URL for the OAuth2 provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2discovery.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2discovery-discoveryurl

Oauth2ProviderConfigInputProperty

class CfnOAuth2CredentialProvider.Oauth2ProviderConfigInputProperty(*, atlassian_oauth2_provider_config=None, custom_oauth2_provider_config=None, github_oauth2_provider_config=None, google_oauth2_provider_config=None, included_oauth2_provider_config=None, linkedin_oauth2_provider_config=None, microsoft_oauth2_provider_config=None, salesforce_oauth2_provider_config=None, slack_oauth2_provider_config=None)

Bases: object

Input configuration for an OAuth2 provider.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.html

ExampleMetadata:

fixture=_generated

Example:

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

oauth2_provider_config_input_property = bedrockagentcore.CfnOAuth2CredentialProvider.Oauth2ProviderConfigInputProperty(
    atlassian_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.AtlassianOauth2ProviderConfigInputProperty(
        client_id="clientId",
        client_secret="clientSecret"
    ),
    custom_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.CustomOauth2ProviderConfigInputProperty(
        client_id="clientId",
        client_secret="clientSecret",
        oauth_discovery=bedrockagentcore.CfnOAuth2CredentialProvider.Oauth2DiscoveryProperty(
            authorization_server_metadata=bedrockagentcore.CfnOAuth2CredentialProvider.Oauth2AuthorizationServerMetadataProperty(
                authorization_endpoint="authorizationEndpoint",
                issuer="issuer",
                token_endpoint="tokenEndpoint",

                # the properties below are optional
                response_types=["responseTypes"]
            ),
            discovery_url="discoveryUrl"
        )
    ),
    github_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.GithubOauth2ProviderConfigInputProperty(
        client_id="clientId",
        client_secret="clientSecret"
    ),
    google_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.GoogleOauth2ProviderConfigInputProperty(
        client_id="clientId",
        client_secret="clientSecret"
    ),
    included_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.IncludedOauth2ProviderConfigInputProperty(
        client_id="clientId",
        client_secret="clientSecret",

        # the properties below are optional
        authorization_endpoint="authorizationEndpoint",
        issuer="issuer",
        token_endpoint="tokenEndpoint"
    ),
    linkedin_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.LinkedinOauth2ProviderConfigInputProperty(
        client_id="clientId",
        client_secret="clientSecret"
    ),
    microsoft_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.MicrosoftOauth2ProviderConfigInputProperty(
        client_id="clientId",
        client_secret="clientSecret",

        # the properties below are optional
        tenant_id="tenantId"
    ),
    salesforce_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.SalesforceOauth2ProviderConfigInputProperty(
        client_id="clientId",
        client_secret="clientSecret"
    ),
    slack_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.SlackOauth2ProviderConfigInputProperty(
        client_id="clientId",
        client_secret="clientSecret"
    )
)

Attributes

atlassian_oauth2_provider_config

Input configuration for an Atlassian OAuth2 provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-atlassianoauth2providerconfig

custom_oauth2_provider_config

Input configuration for a custom OAuth2 provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-customoauth2providerconfig

github_oauth2_provider_config

Input configuration for a GitHub OAuth2 provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-githuboauth2providerconfig

google_oauth2_provider_config

Input configuration for a Google OAuth2 provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-googleoauth2providerconfig

included_oauth2_provider_config

Input configuration for a supported non-custom OAuth2 provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-includedoauth2providerconfig

linkedin_oauth2_provider_config

Input configuration for a LinkedIn OAuth2 provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-linkedinoauth2providerconfig

microsoft_oauth2_provider_config

Input configuration for a Microsoft OAuth2 provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-microsoftoauth2providerconfig

salesforce_oauth2_provider_config

Input configuration for a Salesforce OAuth2 provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-salesforceoauth2providerconfig

slack_oauth2_provider_config

Input configuration for a Slack OAuth2 provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-slackoauth2providerconfig

Oauth2ProviderConfigOutputProperty

class CfnOAuth2CredentialProvider.Oauth2ProviderConfigOutputProperty(*, client_id=None, oauth_discovery=None)

Bases: object

Output configuration for an OAuth2 provider.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput.html

ExampleMetadata:

fixture=_generated

Example:

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

oauth2_provider_config_output_property = bedrockagentcore.CfnOAuth2CredentialProvider.Oauth2ProviderConfigOutputProperty(
    client_id="clientId",
    oauth_discovery=bedrockagentcore.CfnOAuth2CredentialProvider.Oauth2DiscoveryProperty(
        authorization_server_metadata=bedrockagentcore.CfnOAuth2CredentialProvider.Oauth2AuthorizationServerMetadataProperty(
            authorization_endpoint="authorizationEndpoint",
            issuer="issuer",
            token_endpoint="tokenEndpoint",

            # the properties below are optional
            response_types=["responseTypes"]
        ),
        discovery_url="discoveryUrl"
    )
)

Attributes

client_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput-clientid

Type:

see

oauth_discovery

Discovery information for an OAuth2 provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput-oauthdiscovery

SalesforceOauth2ProviderConfigInputProperty

class CfnOAuth2CredentialProvider.SalesforceOauth2ProviderConfigInputProperty(*, client_id, client_secret)

Bases: object

Input configuration for a Salesforce OAuth2 provider.

Parameters:

  • client_id (str)

  • client_secret (str)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput.html

ExampleMetadata:

fixture=_generated

Example:

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

salesforce_oauth2_provider_config_input_property = bedrockagentcore.CfnOAuth2CredentialProvider.SalesforceOauth2ProviderConfigInputProperty(
    client_id="clientId",
    client_secret="clientSecret"
)

Attributes

client_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput-clientid

Type:

see

client_secret

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput-clientsecret

Type:

see

SlackOauth2ProviderConfigInputProperty

class CfnOAuth2CredentialProvider.SlackOauth2ProviderConfigInputProperty(*, client_id, client_secret)

Bases: object

Input configuration for a Slack OAuth2 provider.

Parameters:

  • client_id (str)

  • client_secret (str)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput.html

ExampleMetadata:

fixture=_generated

Example:

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

slack_oauth2_provider_config_input_property = bedrockagentcore.CfnOAuth2CredentialProvider.SlackOauth2ProviderConfigInputProperty(
    client_id="clientId",
    client_secret="clientSecret"
)

Attributes

client_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput-clientid

Type:

see

client_secret

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput-clientsecret

Type:

see