CfnIdentitySourceProps

class aws_cdk.aws_verifiedpermissions.CfnIdentitySourceProps(*, configuration, policy_store_id, principal_entity_type=None)

Bases: object

Properties for defining a CfnIdentitySource.

Parameters:
  • configuration (Union[IResolvable, IdentitySourceConfigurationProperty, Dict[str, Any]]) – Contains configuration information about an identity source.

  • policy_store_id (str) – Specifies the ID of the policy store in which you want to store this identity source. Only policies and requests made using this policy store can reference identities from the identity provider configured in the new identity source.

  • principal_entity_type (Optional[str]) – Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-identitysource.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_verifiedpermissions as verifiedpermissions

cfn_identity_source_props = verifiedpermissions.CfnIdentitySourceProps(
    configuration=verifiedpermissions.CfnIdentitySource.IdentitySourceConfigurationProperty(
        cognito_user_pool_configuration=verifiedpermissions.CfnIdentitySource.CognitoUserPoolConfigurationProperty(
            user_pool_arn="userPoolArn",

            # the properties below are optional
            client_ids=["clientIds"],
            group_configuration=verifiedpermissions.CfnIdentitySource.CognitoGroupConfigurationProperty(
                group_entity_type="groupEntityType"
            )
        )
    ),
    policy_store_id="policyStoreId",

    # the properties below are optional
    principal_entity_type="principalEntityType"
)

Attributes

configuration

Contains configuration information about an identity source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-identitysource.html#cfn-verifiedpermissions-identitysource-configuration

policy_store_id

Specifies the ID of the policy store in which you want to store this identity source.

Only policies and requests made using this policy store can reference identities from the identity provider configured in the new identity source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-identitysource.html#cfn-verifiedpermissions-identitysource-policystoreid

principal_entity_type

Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-identitysource.html#cfn-verifiedpermissions-identitysource-principalentitytype