CfnUserPoolIdentityProviderProps

class aws_cdk.aws_cognito.CfnUserPoolIdentityProviderProps(*, provider_name, provider_type, user_pool_id, attribute_mapping=None, idp_identifiers=None, provider_details=None)

Bases: object

Properties for defining a CfnUserPoolIdentityProvider.

Parameters
  • provider_name (str) – The IdP name.

  • provider_type (str) – The IdP type.

  • user_pool_id (str) – The user pool ID.

  • attribute_mapping (Optional[Any]) – A mapping of IdP attributes to standard and custom user pool attributes.

  • idp_identifiers (Optional[Sequence[str]]) – A list of IdP identifiers.

  • provider_details (Optional[Any]) – The IdP details. The following list describes the provider detail keys for each IdP type. - For Google and Login with Amazon: - client_id - client_secret - authorize_scopes - For Facebook: - client_id - client_secret - authorize_scopes - api_version - For Sign in with Apple: - client_id - team_id - key_id - private_key - authorize_scopes - For OpenID Connect (OIDC) providers: - client_id - client_secret - attributes_request_method - oidc_issuer - authorize_scopes - The following keys are only present if Amazon Cognito didn’t discover them at the oidc_issuer URL. - authorize_url - token_url - attributes_url - jwks_uri - Amazon Cognito sets the value of the following keys automatically. They are read-only. - attributes_url_add_attributes - For SAML providers: - MetadataFile or MetadataURL - IDPSignout optional

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.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_cognito as cognito

# attribute_mapping: Any
# provider_details: Any

cfn_user_pool_identity_provider_props = cognito.CfnUserPoolIdentityProviderProps(
    provider_name="providerName",
    provider_type="providerType",
    user_pool_id="userPoolId",

    # the properties below are optional
    attribute_mapping=attribute_mapping,
    idp_identifiers=["idpIdentifiers"],
    provider_details=provider_details
)

Attributes

attribute_mapping

A mapping of IdP attributes to standard and custom user pool attributes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-attributemapping

Return type

Any

idp_identifiers

A list of IdP identifiers.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-idpidentifiers

Return type

Optional[List[str]]

provider_details

The IdP details. The following list describes the provider detail keys for each IdP type.

  • For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

  • For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

  • For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

  • authorize_scopes

  • For OpenID Connect (OIDC) providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • The following keys are only present if Amazon Cognito didn’t discover them at the oidc_issuer URL.

  • authorize_url

  • token_url

  • attributes_url

  • jwks_uri

  • Amazon Cognito sets the value of the following keys automatically. They are read-only.

  • attributes_url_add_attributes

  • For SAML providers:

  • MetadataFile or MetadataURL

  • IDPSignout optional

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-providerdetails

Return type

Any

provider_name

The IdP name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-providername

Return type

str

provider_type

The IdP type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-providertype

Return type

str

user_pool_id

The user pool ID.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-userpoolid

Return type

str