Class CfnEntitlement

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnEntitlement

Implements

IInspectable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.AppStream

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnEntitlement : CfnResource, IInspectable

Syntax (vb)

Public Class CfnEntitlement Inherits CfnResource Implements IInspectable

Remarks

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

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)

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

Properties

AppVisibility	Specifies whether to entitle all apps or only selected apps.
AttrCreatedTime	The time when the entitlement was created.
AttrLastModifiedTime	The time when the entitlement was last modified.
Attributes	The attributes of the entitlement.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Creates an entitlement to control access, based on user attributes, to specific applications within a stack.
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>)	Creates an entitlement to control access, based on user attributes, to specific applications within a stack.

Constructors

CfnEntitlement(Construct, string, ICfnEntitlementProps)

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

public CfnEntitlement(Construct scope, string id, ICfnEntitlementProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnEntitlementProps: Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html

CloudformationResource: AWS::AppStream::Entitlement

ExampleMetadata: fixture=_generated

Properties

AppVisibility

Specifies whether to entitle all apps or only selected apps.

public virtual string AppVisibility { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html

CloudformationResource: AWS::AppStream::Entitlement

ExampleMetadata: fixture=_generated

AttrCreatedTime

The time when the entitlement was created.

public virtual string AttrCreatedTime { get; }

Property Value

string

Remarks

CloudformationAttribute: CreatedTime

AttrLastModifiedTime

The time when the entitlement was last modified.

public virtual string AttrLastModifiedTime { get; }

Property Value

string

Remarks

CloudformationAttribute: LastModifiedTime

Attributes

The attributes of the entitlement.

public virtual object Attributes { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html

CloudformationResource: AWS::AppStream::Entitlement

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html

CloudformationResource: AWS::AppStream::Entitlement

ExampleMetadata: fixture=_generated

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }

CloudformationResource: AWS::AppStream::Entitlement

ExampleMetadata: fixture=_generated

Description

The description of the entitlement.

public virtual string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html

CloudformationResource: AWS::AppStream::Entitlement

ExampleMetadata: fixture=_generated

Name

The name of the entitlement.

public virtual string Name { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html

CloudformationResource: AWS::AppStream::Entitlement

ExampleMetadata: fixture=_generated

StackName

The name of the stack.

public virtual string StackName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html

CloudformationResource: AWS::AppStream::Entitlement

ExampleMetadata: fixture=_generated

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.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html

CloudformationResource: AWS::AppStream::Entitlement

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html

CloudformationResource: AWS::AppStream::Entitlement

ExampleMetadata: fixture=_generated

Implements

IInspectable