CfnIdentityProviderProps

class aws_cdk.aws_workspacesweb.CfnIdentityProviderProps(*, identity_provider_details, identity_provider_name, identity_provider_type, portal_arn=None)

Bases: object

Properties for defining a CfnIdentityProvider.

Parameters:

  • identity_provider_details (Union[IResolvable, Mapping[str, str]]) – 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 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 - For SAML providers: - MetadataFile OR MetadataURL - IDPSignout (boolean) optional - IDPInit (boolean) optional - RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256 - EncryptedResponses (boolean) optional

  • identity_provider_name (str) – The identity provider name.

  • identity_provider_type (str) – The identity provider type.

  • portal_arn (Optional[str]) – The ARN of the identity provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-identityprovider.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_workspacesweb as workspacesweb

cfn_identity_provider_props = workspacesweb.CfnIdentityProviderProps(
    identity_provider_details={
        "identity_provider_details_key": "identityProviderDetails"
    },
    identity_provider_name="identityProviderName",
    identity_provider_type="identityProviderType",

    # the properties below are optional
    portal_arn="portalArn"
)

Attributes

identity_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 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

  • For SAML providers:

  • MetadataFile OR MetadataURL

  • IDPSignout (boolean) optional

  • IDPInit (boolean) optional

  • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

  • EncryptedResponses (boolean) optional

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-identityprovider.html#cfn-workspacesweb-identityprovider-identityproviderdetails

identity_provider_name

The identity provider name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-identityprovider.html#cfn-workspacesweb-identityprovider-identityprovidername

identity_provider_type

The identity provider type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-identityprovider.html#cfn-workspacesweb-identityprovider-identityprovidertype

portal_arn

The ARN of the identity provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-identityprovider.html#cfn-workspacesweb-identityprovider-portalarn