OAuth2CredentialProviderProps

class aws_cdk.aws_bedrock_agentcore_alpha.OAuth2CredentialProviderProps(*, credential_provider_vendor, oauth2_provider_config_input, o_auth2_credential_provider_name=None, tags=None)

Bases: object

(experimental) Low-level properties when you need full control (prefer {@link OAuth2CredentialProvider.usingSlack} and other factories).

Parameters:
  • 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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk.aws_bedrockagentcore.Oauth2ProviderConfigInputProperty import Oauth2ProviderConfigInputProperty
from aws_cdk.aws_bedrockagentcore.AtlassianOauth2ProviderConfigInputProperty import AtlassianOauth2ProviderConfigInputProperty
from aws_cdk.aws_bedrockagentcore.CustomOauth2ProviderConfigInputProperty import CustomOauth2ProviderConfigInputProperty
from aws_cdk.aws_bedrockagentcore.Oauth2DiscoveryProperty import Oauth2DiscoveryProperty
from aws_cdk.aws_bedrockagentcore.Oauth2AuthorizationServerMetadataProperty import Oauth2AuthorizationServerMetadataProperty
from aws_cdk.aws_bedrockagentcore.OnBehalfOfTokenExchangeConfigProperty import OnBehalfOfTokenExchangeConfigProperty
from aws_cdk.aws_bedrockagentcore.TokenExchangeGrantTypeConfigProperty import TokenExchangeGrantTypeConfigProperty
from aws_cdk.aws_bedrockagentcore.GithubOauth2ProviderConfigInputProperty import GithubOauth2ProviderConfigInputProperty
from aws_cdk.aws_bedrockagentcore.GoogleOauth2ProviderConfigInputProperty import GoogleOauth2ProviderConfigInputProperty
from aws_cdk.aws_bedrockagentcore.IncludedOauth2ProviderConfigInputProperty import IncludedOauth2ProviderConfigInputProperty
from aws_cdk.aws_bedrockagentcore.LinkedinOauth2ProviderConfigInputProperty import LinkedinOauth2ProviderConfigInputProperty
from aws_cdk.aws_bedrockagentcore.MicrosoftOauth2ProviderConfigInputProperty import MicrosoftOauth2ProviderConfigInputProperty
from aws_cdk.aws_bedrockagentcore.SalesforceOauth2ProviderConfigInputProperty import SalesforceOauth2ProviderConfigInputProperty
from aws_cdk.aws_bedrockagentcore.SlackOauth2ProviderConfigInputProperty import SlackOauth2ProviderConfigInputProperty
# 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_auth2_credential_provider_props = bedrock_agentcore_alpha.OAuth2CredentialProviderProps(
    credential_provider_vendor="credentialProviderVendor",
    oauth2_provider_config_input=Oauth2ProviderConfigInputProperty(
        atlassian_oauth2_provider_config=AtlassianOauth2ProviderConfigInputProperty(
            client_id="clientId",
            client_secret="clientSecret"
        ),
        custom_oauth2_provider_config=CustomOauth2ProviderConfigInputProperty(
            oauth_discovery=Oauth2DiscoveryProperty(
                authorization_server_metadata=Oauth2AuthorizationServerMetadataProperty(
                    authorization_endpoint="authorizationEndpoint",
                    issuer="issuer",
                    token_endpoint="tokenEndpoint",

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

            # the properties below are optional
            client_id="clientId",
            client_secret="clientSecret",
            on_behalf_of_token_exchange_config=OnBehalfOfTokenExchangeConfigProperty(
                grant_type="grantType",

                # the properties below are optional
                token_exchange_grant_type_config=TokenExchangeGrantTypeConfigProperty(
                    actor_token_content="actorTokenContent",

                    # the properties below are optional
                    actor_token_scopes=["actorTokenScopes"]
                )
            )
        ),
        github_oauth2_provider_config=GithubOauth2ProviderConfigInputProperty(
            client_id="clientId",
            client_secret="clientSecret"
        ),
        google_oauth2_provider_config=GoogleOauth2ProviderConfigInputProperty(
            client_id="clientId",
            client_secret="clientSecret"
        ),
        included_oauth2_provider_config=IncludedOauth2ProviderConfigInputProperty(
            client_id="clientId",
            client_secret="clientSecret",

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

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

    # the properties below are optional
    o_auth2_credential_provider_name="oAuth2CredentialProviderName",
    tags={
        "tags_key": "tags"
    }
)

Attributes

credential_provider_vendor

(experimental) OAuth2 vendor string for CloudFormation CredentialProviderVendor.

Stability:

experimental

o_auth2_credential_provider_name

(experimental) Name of the credential provider.

Default:

a name generated by CDK

Stability:

experimental

oauth2_provider_config_input

(experimental) OAuth2 provider configuration passed through to Oauth2ProviderConfigInput.

Stability:

experimental

tags

(experimental) Tags for this credential provider.

Default:
  • no tags

Stability:

experimental