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 identity provider name.

  • provider_type (str) – The identity provider type.

  • user_pool_id (str) – The user pool ID.

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

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

  • provider_details (Optional[Any]) – The identity provider details. The following list describes the provider detail keys for each identity provider 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 - authorize_url if not available from discovery URL specified by oidc_issuer key - token_url if not available from discovery URL specified by oidc_issuer key - attributes_url if not available from discovery URL specified by oidc_issuer key - jwks_uri if not available from discovery URL specified by oidc_issuer key - attributes_url_add_attributes a read-only property that is set automatically - 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.
import aws_cdk.aws_cognito as cognito

# attribute_mapping is of type object
# provider_details is of type object

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 identity provider 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 identity provider 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 identity provider details. The following list describes the provider detail keys for each identity provider 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

  • authorize_url if not available from discovery URL specified by oidc_issuer key

  • token_url if not available from discovery URL specified by oidc_issuer key

  • attributes_url if not available from discovery URL specified by oidc_issuer key

  • jwks_uri if not available from discovery URL specified by oidc_issuer key

  • attributes_url_add_attributes a read-only property that is set automatically

  • 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 identity provider 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 identity provider 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