Package software.amazon.awscdk.services.appstream

Class CfnApplication

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.CfnApplication
All Implemented Interfaces:
IInspectable, IApplicationRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:28.747Z") @Stability(Stable) public class CfnApplication extends CfnResource implements IInspectable, IApplicationRef, ITaggable
This resource creates an application.

Applications store the details about how to launch applications on streaming instances. This is only supported for Elastic fleets.

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.*;
 CfnApplication cfnApplication = CfnApplication.Builder.create(this, "MyCfnApplication")
         .appBlockArn("appBlockArn")
         .iconS3Location(S3LocationProperty.builder()
                 .s3Bucket("s3Bucket")
                 .s3Key("s3Key")
                 .build())
         .instanceFamilies(List.of("instanceFamilies"))
         .launchPath("launchPath")
         .name("name")
         .platforms(List.of("platforms"))
         // the properties below are optional
         .attributesToDelete(List.of("attributesToDelete"))
         .description("description")
         .displayName("displayName")
         .launchParameters("launchParameters")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .workingDirectory("workingDirectory")
         .build();

See Also:

  • 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

    • CfnApplication

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

    • CfnApplication

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

    • CfnApplication

      @Stability(Stable) public CfnApplication(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnApplicationProps props)
      Create a new AWS::AppStream::Application.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForApplication

      @Stability(Stable) @NotNull public static String arnForApplication(@NotNull IApplicationRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnApplication

      @Stability(Stable) @NotNull public static Boolean isCfnApplication(@NotNull Object x)
      Checks whether the given object is a CfnApplication.

      Parameters:
      x - This parameter is required.

    • 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.

    • getApplicationRef

      @Stability(Stable) @NotNull public ApplicationReference getApplicationRef()
      A reference to a Application resource.
      Specified by:
      getApplicationRef in interface IApplicationRef

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the application.

    • getAttrCreatedTime

      @Stability(Stable) @NotNull public String getAttrCreatedTime()
      The time when the application was created.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAppBlockArn

      @Stability(Stable) @NotNull public String getAppBlockArn()
      The app block ARN with which the application should be associated.

    • setAppBlockArn

      @Stability(Stable) public void setAppBlockArn(@NotNull String value)
      The app block ARN with which the application should be associated.

    • getIconS3Location

      @Stability(Stable) @NotNull public Object getIconS3Location()
      The icon S3 location of the application.

      Returns union: either IResolvable or CfnApplication.S3LocationProperty

    • setIconS3Location

      @Stability(Stable) public void setIconS3Location(@NotNull IResolvable value)
      The icon S3 location of the application.

    • setIconS3Location

      @Stability(Stable) public void setIconS3Location(@NotNull CfnApplication.S3LocationProperty value)
      The icon S3 location of the application.

    • getInstanceFamilies

      @Stability(Stable) @NotNull public List<String> getInstanceFamilies()
      The instance families the application supports.

    • setInstanceFamilies

      @Stability(Stable) public void setInstanceFamilies(@NotNull List<String> value)
      The instance families the application supports.

    • getLaunchPath

      @Stability(Stable) @NotNull public String getLaunchPath()
      The launch path of the application.

    • setLaunchPath

      @Stability(Stable) public void setLaunchPath(@NotNull String value)
      The launch path of the application.

    • getName

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

    • setName

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

    • getPlatforms

      @Stability(Stable) @NotNull public List<String> getPlatforms()
      The platforms the application supports.

    • setPlatforms

      @Stability(Stable) public void setPlatforms(@NotNull List<String> value)
      The platforms the application supports.

    • getAttributesToDelete

      @Stability(Stable) @Nullable public List<String> getAttributesToDelete()
      A list of attributes to delete from an application.

    • setAttributesToDelete

      @Stability(Stable) public void setAttributesToDelete(@Nullable List<String> value)
      A list of attributes to delete from an application.

    • getDescription

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

    • setDescription

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

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The display name of the application.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The display name of the application.

    • getLaunchParameters

      @Stability(Stable) @Nullable public String getLaunchParameters()
      The launch parameters of the application.

    • setLaunchParameters

      @Stability(Stable) public void setLaunchParameters(@Nullable String value)
      The launch parameters of the application.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags of the application.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags of the application.

    • getWorkingDirectory

      @Stability(Stable) @Nullable public String getWorkingDirectory()
      The working directory of the application.

    • setWorkingDirectory

      @Stability(Stable) public void setWorkingDirectory(@Nullable String value)
      The working directory of the application.