AWS::AppStream::Entitlement
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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::AppStream::Entitlement", "Properties" : { "AppVisibility" :
String
, "Attributes" :[ Attribute, ... ]
, "Description" :String
, "Name" :String
, "StackName" :String
} }
YAML
Type: AWS::AppStream::Entitlement Properties: AppVisibility:
String
Attributes:- Attribute
Description:String
Name:String
StackName:String
Properties
AppVisibility
-
Specifies whether to entitle all apps or only selected apps.
Required: Yes
Type: String
Allowed values:
ALL | ASSOCIATED
Update requires: No interruption
Attributes
-
The attributes of the entitlement.
Required: Yes
Type: Array of Attribute
Minimum:
1
Update requires: No interruption
Description
-
The description of the entitlement.
Required: No
Type: String
Maximum:
256
Update requires: No interruption
Name
-
The name of the entitlement.
Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$
Update requires: Replacement
StackName
-
The name of the stack.
Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function,
Ref
returns the combination of the StackName
and
Name
, such as abcdefStack|abcdefEntitlement
.
For more information about using the Ref
function, see Ref.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
CreatedTime
-
The time when the entitlement was created.
LastModifiedTime
-
The time when the entitlement was last modified.