Package software.amazon.awscdk.services.appstream

Class CfnApplication

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.CfnApplication
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.685Z") @Stability(Stable) public class CfnApplication extends CfnResource implements IInspectable
A CloudFormation AWS::AppStream::Application.

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();

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

    • 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()
      The tags of the application.

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

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

      Allowed Values : GENERAL_PURPOSE | GRAPHICS_G4

    • setInstanceFamilies

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

      Allowed Values : GENERAL_PURPOSE | GRAPHICS_G4

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

      This name is visible to users when a name is not specified in the DisplayName property.

      Pattern : ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

    • setName

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

      This name is visible to users when a name is not specified in the DisplayName property.

      Pattern : ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

    • getPlatforms

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

      Allowed Values : WINDOWS_SERVER_2019 | AMAZON_LINUX2

    • setPlatforms

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

      Allowed Values : WINDOWS_SERVER_2019 | AMAZON_LINUX2

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

      This name is visible to users in the application catalog.

    • setDisplayName

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

      This name is visible to users in the application catalog.

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

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