software.amazon.awscdk.services.appstream

Class CfnEntitlement

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.appstream.CfnEntitlement

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.625Z")
 @Stability(value=Stable)
public class CfnEntitlement
extends CfnResource
implements IInspectable

A CloudFormation `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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appstream.*;
 CfnEntitlement cfnEntitlement = CfnEntitlement.Builder.create(this, "MyCfnEntitlement")
         .appVisibility("appVisibility")
         .attributes(List.of(AttributeProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .name("name")
         .stackName("stackName")
         // the properties below are optional
         .description("description")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnEntitlement.AttributeProperty An attribute that belongs to an entitlement.
static class	CfnEntitlement.Builder A fluent builder for CfnEntitlement.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEntitlement(software.constructs.Construct scope, String id, CfnEntitlementProps props) Create a new `AWS::AppStream::Entitlement`.
protected	CfnEntitlement(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEntitlement(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAppVisibility() Specifies whether to entitle all apps or only selected apps.
String	getAttrCreatedTime() The time when the entitlement was created.
Object	getAttributes() The attributes of the entitlement.
String	getAttrLastModifiedTime() The time when the entitlement was last modified.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the entitlement.
String	getName() The name of the entitlement.
String	getStackName() The name of the stack.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAppVisibility(String value) Specifies whether to entitle all apps or only selected apps.
void	setAttributes(IResolvable value) The attributes of the entitlement.
void	setAttributes(List<Object> value) The attributes of the entitlement.
void	setDescription(String value) The description of the entitlement.
void	setName(String value) The name of the entitlement.
void	setStackName(String value) The name of the stack.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEntitlement

protected CfnEntitlement(software.amazon.jsii.JsiiObjectRef objRef)

CfnEntitlement

protected CfnEntitlement(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEntitlement

@Stability(value=Stable)
public CfnEntitlement(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnEntitlementProps props)

Create a new `AWS::AppStream::Entitlement`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreatedTime

@Stability(value=Stable)
 @NotNull
public String getAttrCreatedTime()

The time when the entitlement was created.

getAttrLastModifiedTime

@Stability(value=Stable)
 @NotNull
public String getAttrLastModifiedTime()

The time when the entitlement was last modified.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAppVisibility

@Stability(value=Stable)
 @NotNull
public String getAppVisibility()

Specifies whether to entitle all apps or only selected apps.

setAppVisibility

@Stability(value=Stable)
public void setAppVisibility(@NotNull
                                                      String value)

Specifies whether to entitle all apps or only selected apps.

getAttributes

@Stability(value=Stable)
 @NotNull
public Object getAttributes()

The attributes of the entitlement.

setAttributes

@Stability(value=Stable)
public void setAttributes(@NotNull
                                                   IResolvable value)

The attributes of the entitlement.

setAttributes

@Stability(value=Stable)
public void setAttributes(@NotNull
                                                   List<Object> value)

The attributes of the entitlement.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the entitlement.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the entitlement.

getStackName

@Stability(value=Stable)
 @NotNull
public String getStackName()

The name of the stack.

setStackName

@Stability(value=Stable)
public void setStackName(@NotNull
                                                  String value)

The name of the stack.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of the entitlement.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the entitlement.