CfnEntitlementPropsMixin

class aws_cdk.cfn_property_mixins.aws_accountaccess.CfnEntitlementPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::AccountAccess::Entitlement specifying an entitlement for account access.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accountaccess-entitlement.html
CloudformationResource:: AWS::AccountAccess::Entitlement
Mixin:: true
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.cfn_property_mixins import aws_accountaccess as accountaccess
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_entitlement_props_mixin = accountaccess.CfnEntitlementPropsMixin(accountaccess.CfnEntitlementMixinProps(
    application_arn="applicationArn",
    entitlement=accountaccess.CfnEntitlementPropsMixin.EntitlementProperty(
        principal_role=accountaccess.CfnEntitlementPropsMixin.PrincipalRoleEntitlementProperty(
            account="account",
            principal=accountaccess.CfnEntitlementPropsMixin.PrincipalProperty(
                identity_center=accountaccess.CfnEntitlementPropsMixin.IdentityCenterPrincipalProperty(
                    group_id="groupId",
                    user_id="userId"
                )
            ),
            role_arn="roleArn"
        )
    )
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::AccountAccess::Entitlement.

Parameters:

props (Union[CfnEntitlementMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['applicationArn', 'entitlement']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

EntitlementProperty

class CfnEntitlementPropsMixin.EntitlementProperty(*, principal_role=None)

Bases: object

Parameters:: principal_role (Union[IResolvable, PrincipalRoleEntitlementProperty, Dict[str, Any], None])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accountaccess-entitlement-entitlement.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.cfn_property_mixins import aws_accountaccess as accountaccess

entitlement_property = accountaccess.CfnEntitlementPropsMixin.EntitlementProperty(
    principal_role=accountaccess.CfnEntitlementPropsMixin.PrincipalRoleEntitlementProperty(
        account="account",
        principal=accountaccess.CfnEntitlementPropsMixin.PrincipalProperty(
            identity_center=accountaccess.CfnEntitlementPropsMixin.IdentityCenterPrincipalProperty(
                group_id="groupId",
                user_id="userId"
            )
        ),
        role_arn="roleArn"
    )
)

Attributes

principal_role

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accountaccess-entitlement-entitlement.html#cfn-accountaccess-entitlement-entitlement-principalrole

Type:: see

IdentityCenterPrincipalProperty

class CfnEntitlementPropsMixin.IdentityCenterPrincipalProperty(*, group_id=None, user_id=None)

Bases: object

Parameters:

group_id (Optional[str]) – The ID of the group.
user_id (Optional[str]) – The ID of the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accountaccess-entitlement-identitycenterprincipal.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.cfn_property_mixins import aws_accountaccess as accountaccess

identity_center_principal_property = accountaccess.CfnEntitlementPropsMixin.IdentityCenterPrincipalProperty(
    group_id="groupId",
    user_id="userId"
)

Attributes

group_id

The ID of the group.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accountaccess-entitlement-identitycenterprincipal.html#cfn-accountaccess-entitlement-identitycenterprincipal-groupid

user_id

The ID of the user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accountaccess-entitlement-identitycenterprincipal.html#cfn-accountaccess-entitlement-identitycenterprincipal-userid

PrincipalProperty

class CfnEntitlementPropsMixin.PrincipalProperty(*, identity_center=None)

Bases: object

Parameters:: identity_center (Union[IResolvable, IdentityCenterPrincipalProperty, Dict[str, Any], None])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accountaccess-entitlement-principal.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.cfn_property_mixins import aws_accountaccess as accountaccess

principal_property = accountaccess.CfnEntitlementPropsMixin.PrincipalProperty(
    identity_center=accountaccess.CfnEntitlementPropsMixin.IdentityCenterPrincipalProperty(
        group_id="groupId",
        user_id="userId"
    )
)

Attributes

identity_center

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accountaccess-entitlement-principal.html#cfn-accountaccess-entitlement-principal-identitycenter

Type:: see

PrincipalRoleEntitlementProperty

class CfnEntitlementPropsMixin.PrincipalRoleEntitlementProperty(*, account=None, principal=None, role_arn=None)

Bases: object

Parameters:

account (Optional[str]) – The AWS account ID.
principal (Union[IResolvable, PrincipalProperty, Dict[str, Any], None])
role_arn (Optional[str]) – The ARN of the IAM role.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accountaccess-entitlement-principalroleentitlement.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.cfn_property_mixins import aws_accountaccess as accountaccess

principal_role_entitlement_property = accountaccess.CfnEntitlementPropsMixin.PrincipalRoleEntitlementProperty(
    account="account",
    principal=accountaccess.CfnEntitlementPropsMixin.PrincipalProperty(
        identity_center=accountaccess.CfnEntitlementPropsMixin.IdentityCenterPrincipalProperty(
            group_id="groupId",
            user_id="userId"
        )
    ),
    role_arn="roleArn"
)

Attributes

account

The AWS account ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accountaccess-entitlement-principalroleentitlement.html#cfn-accountaccess-entitlement-principalroleentitlement-account

principal

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accountaccess-entitlement-principalroleentitlement.html#cfn-accountaccess-entitlement-principalroleentitlement-principal

Type:: see

role_arn

The ARN of the IAM role.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accountaccess-entitlement-principalroleentitlement.html#cfn-accountaccess-entitlement-principalroleentitlement-rolearn