Package software.amazon.awscdk.services.appstream

Class CfnEntitlement

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.appstream.CfnEntitlement
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.698Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEntitlement

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

    • CfnEntitlement

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

    • CfnEntitlement

      @Stability(Stable) public CfnEntitlement(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrCreatedTime()
      The time when the entitlement was created.

    • getAttrLastModifiedTime

      @Stability(Stable) @NotNull public String getAttrLastModifiedTime()
      The time when the entitlement was last modified.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAppVisibility

      @Stability(Stable) @NotNull public String getAppVisibility()
      Specifies whether to entitle all apps or only selected apps.

    • setAppVisibility

      @Stability(Stable) public void setAppVisibility(@NotNull String value)
      Specifies whether to entitle all apps or only selected apps.

    • getAttributes

      @Stability(Stable) @NotNull public Object getAttributes()
      The attributes of the entitlement.

    • setAttributes

      @Stability(Stable) public void setAttributes(@NotNull IResolvable value)
      The attributes of the entitlement.

    • setAttributes

      @Stability(Stable) public void setAttributes(@NotNull List<Object> value)
      The attributes of the entitlement.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the entitlement.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the entitlement.

    • getStackName

      @Stability(Stable) @NotNull public String getStackName()
      The name of the stack.

    • setStackName

      @Stability(Stable) public void setStackName(@NotNull String value)
      The name of the stack.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the entitlement.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the entitlement.