Class CfnEntitlement
A CloudFormation AWS::AppStream::Entitlement
.
Inherited Members
Namespace: Amazon.CDK.AWS.AppStream
Assembly: Amazon.CDK.AWS.AppStream.dll
Syntax (csharp)
public class CfnEntitlement : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnEntitlement
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::AppStream::Entitlement
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppStream;
var cfnEntitlement = new CfnEntitlement(this, "MyCfnEntitlement", new CfnEntitlementProps {
AppVisibility = "appVisibility",
Attributes = new [] { new AttributeProperty {
Name = "name",
Value = "value"
} },
Name = "name",
StackName = "stackName",
// the properties below are optional
Description = "description"
});
Synopsis
Constructors
CfnEntitlement(Construct, String, ICfnEntitlementProps) | Create a new |
CfnEntitlement(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEntitlement(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AppVisibility | Specifies whether to entitle all apps or only selected apps. |
AttrCreatedTime | The time when the entitlement was created. |
Attributes | The attributes of the entitlement. |
AttrLastModifiedTime | The time when the entitlement was last modified. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The description of the entitlement. |
Name | The name of the entitlement. |
StackName | The name of the stack. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEntitlement(Construct, String, ICfnEntitlementProps)
Create a new AWS::AppStream::Entitlement
.
public CfnEntitlement(Construct scope, string id, ICfnEntitlementProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnEntitlementProps
- resource properties.
CfnEntitlement(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEntitlement(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEntitlement(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEntitlement(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AppVisibility
Specifies whether to entitle all apps or only selected apps.
public virtual string AppVisibility { get; set; }
Property Value
System.String
Remarks
AttrCreatedTime
The time when the entitlement was created.
public virtual string AttrCreatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedTime
Attributes
The attributes of the entitlement.
public virtual object Attributes { get; set; }
Property Value
System.Object
Remarks
AttrLastModifiedTime
The time when the entitlement was last modified.
public virtual string AttrLastModifiedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LastModifiedTime
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
The description of the entitlement.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Name
The name of the entitlement.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
StackName
The name of the stack.
public virtual string StackName { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>