CfnEntitlementPropsMixin

class aws_cdk.mixins_preview.aws_appstream.mixins.CfnEntitlementPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates an entitlement to control access, based on user attributes, to specific applications within a stack.

Entitlements apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all applications in a stack. Entitlements don’t apply to the desktop stream view application or to applications managed by a dynamic app provider using the Dynamic Application Framework.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html
CloudformationResource:: AWS::AppStream::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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_appstream import mixins as appstream_mixins

cfn_entitlement_props_mixin = appstream_mixins.CfnEntitlementPropsMixin(appstream_mixins.CfnEntitlementMixinProps(
    app_visibility="appVisibility",
    attributes=[appstream_mixins.CfnEntitlementPropsMixin.AttributeProperty(
        name="name",
        value="value"
    )],
    description="description",
    name="name",
    stack_name="stackName"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['appVisibility', 'attributes', 'description', 'name', 'stackName']

Static Methods

classmethod is_mixin(x)

(experimental) 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.
Stability:: experimental

AttributeProperty

class CfnEntitlementPropsMixin.AttributeProperty(*, name=None, value=None)

Bases: object

An attribute that belongs to an entitlement.

Application entitlements work by matching a supported SAML 2.0 attribute name to a value when a user identity federates to an AppStream 2.0 SAML application.

Parameters:

name (Optional[str]) – A supported AWS IAM SAML PrincipalTag attribute that is matched to a value when a user identity federates to an AppStream 2.0 SAML application. The following are supported values: - roles - department - organization - groups - title - costCenter - userType
value (Optional[str]) – A value that is matched to a supported SAML attribute name when a user identity federates to an AppStream 2.0 SAML application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-entitlement-attribute.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.mixins_preview.aws_appstream import mixins as appstream_mixins

attribute_property = appstream_mixins.CfnEntitlementPropsMixin.AttributeProperty(
    name="name",
    value="value"
)

Attributes

name

A supported AWS IAM SAML PrincipalTag attribute that is matched to a value when a user identity federates to an AppStream 2.0 SAML application.

The following are supported values:

roles
department
organization
groups
title
costCenter
userType

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-entitlement-attribute.html#cfn-appstream-entitlement-attribute-name

value

A value that is matched to a supported SAML attribute name when a user identity federates to an AppStream 2.0 SAML application.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-entitlement-attribute.html#cfn-appstream-entitlement-attribute-value