CfnOAuth2CredentialProviderProps

class aws_cdk.aws_bedrockagentcore.CfnOAuth2CredentialProviderProps(*, credential_provider_vendor, name, oauth2_provider_config_input=None, tags=None)

Bases: object

Properties for defining a CfnOAuth2CredentialProvider.

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

See:

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

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_o_auth2_credential_provider_props = bedrockagentcore.CfnOAuth2CredentialProviderProps(
    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",

            # the properties below are optional
            client_secret="clientSecret",
            client_secret_config=bedrockagentcore.CfnOAuth2CredentialProvider.SecretReferenceProperty(
                json_key="jsonKey",
                secret_id="secretId"
            ),
            client_secret_source="clientSecretSource"
        ),
        custom_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.CustomOauth2ProviderConfigInputProperty(
            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"
            ),

            # the properties below are optional
            client_authentication_method="clientAuthenticationMethod",
            client_id="clientId",
            client_secret="clientSecret",
            client_secret_config=bedrockagentcore.CfnOAuth2CredentialProvider.SecretReferenceProperty(
                json_key="jsonKey",
                secret_id="secretId"
            ),
            client_secret_source="clientSecretSource",
            on_behalf_of_token_exchange_config=bedrockagentcore.CfnOAuth2CredentialProvider.OnBehalfOfTokenExchangeConfigProperty(
                grant_type="grantType",

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

                    # the properties below are optional
                    actor_token_scopes=["actorTokenScopes"]
                )
            ),
            private_endpoint=bedrockagentcore.CfnOAuth2CredentialProvider.PrivateEndpointProperty(
                managed_vpc_resource=bedrockagentcore.CfnOAuth2CredentialProvider.ManagedVpcResourceProperty(
                    endpoint_ip_address_type="endpointIpAddressType",
                    subnet_ids=["subnetIds"],
                    vpc_identifier="vpcIdentifier",

                    # the properties below are optional
                    routing_domain="routingDomain",
                    security_group_ids=["securityGroupIds"],
                    tags={
                        "tags_key": "tags"
                    }
                ),
                self_managed_lattice_resource=bedrockagentcore.CfnOAuth2CredentialProvider.SelfManagedLatticeResourceProperty(
                    resource_configuration_identifier="resourceConfigurationIdentifier"
                )
            ),
            private_endpoint_overrides=[bedrockagentcore.CfnOAuth2CredentialProvider.PrivateEndpointOverrideProperty(
                domain="domain",
                private_endpoint=bedrockagentcore.CfnOAuth2CredentialProvider.PrivateEndpointProperty(
                    managed_vpc_resource=bedrockagentcore.CfnOAuth2CredentialProvider.ManagedVpcResourceProperty(
                        endpoint_ip_address_type="endpointIpAddressType",
                        subnet_ids=["subnetIds"],
                        vpc_identifier="vpcIdentifier",

                        # the properties below are optional
                        routing_domain="routingDomain",
                        security_group_ids=["securityGroupIds"],
                        tags={
                            "tags_key": "tags"
                        }
                    ),
                    self_managed_lattice_resource=bedrockagentcore.CfnOAuth2CredentialProvider.SelfManagedLatticeResourceProperty(
                        resource_configuration_identifier="resourceConfigurationIdentifier"
                    )
                )
            )],
            private_key_jwt_config=bedrockagentcore.CfnOAuth2CredentialProvider.PrivateKeyJwtConfigProperty(
                additional_header_claims={
                    "additional_header_claims_key": "additionalHeaderClaims"
                },
                additional_payload_claims={
                    "additional_payload_claims_key": "additionalPayloadClaims"
                },
                private_key_source=bedrockagentcore.CfnOAuth2CredentialProvider.PrivateKeySourceProperty(
                    kms_key_source=bedrockagentcore.CfnOAuth2CredentialProvider.KmsKeySourceTypeProperty(
                        kms_key_arn="kmsKeyArn"
                    )
                ),
                signing_algorithm="signingAlgorithm"
            )
        ),
        github_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.GithubOauth2ProviderConfigInputProperty(
            client_id="clientId",

            # the properties below are optional
            client_secret="clientSecret",
            client_secret_config=bedrockagentcore.CfnOAuth2CredentialProvider.SecretReferenceProperty(
                json_key="jsonKey",
                secret_id="secretId"
            ),
            client_secret_source="clientSecretSource"
        ),
        google_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.GoogleOauth2ProviderConfigInputProperty(
            client_id="clientId",

            # the properties below are optional
            client_secret="clientSecret",
            client_secret_config=bedrockagentcore.CfnOAuth2CredentialProvider.SecretReferenceProperty(
                json_key="jsonKey",
                secret_id="secretId"
            ),
            client_secret_source="clientSecretSource"
        ),
        included_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.IncludedOauth2ProviderConfigInputProperty(
            client_id="clientId",

            # the properties below are optional
            authorization_endpoint="authorizationEndpoint",
            client_secret="clientSecret",
            client_secret_config=bedrockagentcore.CfnOAuth2CredentialProvider.SecretReferenceProperty(
                json_key="jsonKey",
                secret_id="secretId"
            ),
            client_secret_source="clientSecretSource",
            issuer="issuer",
            token_endpoint="tokenEndpoint"
        ),
        linkedin_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.LinkedinOauth2ProviderConfigInputProperty(
            client_id="clientId",

            # the properties below are optional
            client_secret="clientSecret",
            client_secret_config=bedrockagentcore.CfnOAuth2CredentialProvider.SecretReferenceProperty(
                json_key="jsonKey",
                secret_id="secretId"
            ),
            client_secret_source="clientSecretSource"
        ),
        microsoft_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.MicrosoftOauth2ProviderConfigInputProperty(
            client_id="clientId",

            # the properties below are optional
            client_secret="clientSecret",
            client_secret_config=bedrockagentcore.CfnOAuth2CredentialProvider.SecretReferenceProperty(
                json_key="jsonKey",
                secret_id="secretId"
            ),
            client_secret_source="clientSecretSource",
            tenant_id="tenantId"
        ),
        salesforce_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.SalesforceOauth2ProviderConfigInputProperty(
            client_id="clientId",

            # the properties below are optional
            client_secret="clientSecret",
            client_secret_config=bedrockagentcore.CfnOAuth2CredentialProvider.SecretReferenceProperty(
                json_key="jsonKey",
                secret_id="secretId"
            ),
            client_secret_source="clientSecretSource"
        ),
        slack_oauth2_provider_config=bedrockagentcore.CfnOAuth2CredentialProvider.SlackOauth2ProviderConfigInputProperty(
            client_id="clientId",

            # the properties below are optional
            client_secret="clientSecret",
            client_secret_config=bedrockagentcore.CfnOAuth2CredentialProvider.SecretReferenceProperty(
                json_key="jsonKey",
                secret_id="secretId"
            ),
            client_secret_source="clientSecretSource"
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

credential_provider_vendor

The vendor of the OAuth2 credential provider.

See:

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

name

The name of the OAuth2 credential provider.

See:

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

oauth2_provider_config_input

Input configuration for an OAuth2 provider.

See:

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

tags

Tags to assign to the OAuth2 credential provider.

See:

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