CfnApplication

java.lang.Object
- 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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.428Z")
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();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnApplication.Builder` A fluent builder for `CfnApplication`.
`static interface`	`CfnApplication.S3LocationProperty` The S3 location of the application icon.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnApplication(Construct scope, java.lang.String id, CfnApplicationProps props)` Create a new `AWS::AppStream::Application`.
`protected`	`CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnApplication(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAppBlockArn()` The app block ARN with which the application should be associated.
`java.lang.String`	`getAttrArn()` The ARN of the application.
`java.lang.String`	`getAttrCreatedTime()` The time when the application was created.
`java.util.List<java.lang.String>`	`getAttributesToDelete()` A list of attributes to delete from an application.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getDescription()` The description of the application.
`java.lang.String`	`getDisplayName()` The display name of the application.
`java.lang.Object`	`getIconS3Location()` The icon S3 location of the application.
`java.util.List<java.lang.String>`	`getInstanceFamilies()` The instance families the application supports.
`java.lang.String`	`getLaunchParameters()` The launch parameters of the application.
`java.lang.String`	`getLaunchPath()` The launch path of the application.
`java.lang.String`	`getName()` The name of the application.
`java.util.List<java.lang.String>`	`getPlatforms()` The platforms the application supports.
`TagManager`	`getTags()` The tags of the application.
`java.lang.String`	`getWorkingDirectory()` The working directory of the application.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAppBlockArn(java.lang.String value)` The app block ARN with which the application should be associated.
`void`	`setAttributesToDelete(java.util.List<java.lang.String> value)` A list of attributes to delete from an application.
`void`	`setDescription(java.lang.String value)` The description of the application.
`void`	`setDisplayName(java.lang.String value)` The display name of the application.
`void`	`setIconS3Location(CfnApplication.S3LocationProperty value)` The icon S3 location of the application.
`void`	`setIconS3Location(IResolvable value)` The icon S3 location of the application.
`void`	`setInstanceFamilies(java.util.List<java.lang.String> value)` The instance families the application supports.
`void`	`setLaunchParameters(java.lang.String value)` The launch parameters of the application.
`void`	`setLaunchPath(java.lang.String value)` The launch path of the application.
`void`	`setName(java.lang.String value)` The name of the application.
`void`	`setPlatforms(java.util.List<java.lang.String> value)` The platforms the application supports.
`void`	`setWorkingDirectory(java.lang.String value)` The working directory of the application.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnApplication
```
protected CfnApplication(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnApplication
```
protected CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnApplication
```
public CfnApplication(Construct scope,
                      java.lang.String id,
                      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 Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    The ARN of the application.
  - getAttrCreatedTime
```
public java.lang.String getAttrCreatedTime()
```
    The time when the application was created.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    The tags of the application.
  - getAppBlockArn
```
public java.lang.String getAppBlockArn()
```
    The app block ARN with which the application should be associated.
  - setAppBlockArn
```
public void setAppBlockArn(java.lang.String value)
```
    The app block ARN with which the application should be associated.
  - getIconS3Location
```
public java.lang.Object getIconS3Location()
```
    The icon S3 location of the application.
  - setIconS3Location
```
public void setIconS3Location(IResolvable value)
```
    The icon S3 location of the application.
  - setIconS3Location
```
public void setIconS3Location(CfnApplication.S3LocationProperty value)
```
    The icon S3 location of the application.
  - getInstanceFamilies
```
public java.util.List<java.lang.String> getInstanceFamilies()
```
    The instance families the application supports.
    Allowed Values : GENERAL_PURPOSE | GRAPHICS_G4
  - setInstanceFamilies
```
public void setInstanceFamilies(java.util.List<java.lang.String> value)
```
    The instance families the application supports.
    Allowed Values : GENERAL_PURPOSE | GRAPHICS_G4
  - getLaunchPath
```
public java.lang.String getLaunchPath()
```
    The launch path of the application.
  - setLaunchPath
```
public void setLaunchPath(java.lang.String value)
```
    The launch path of the application.
  - getName
```
public java.lang.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
```
public void setName(java.lang.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
```
public java.util.List<java.lang.String> getPlatforms()
```
    The platforms the application supports.
    Allowed Values : WINDOWS_SERVER_2019 | AMAZON_LINUX2
  - setPlatforms
```
public void setPlatforms(java.util.List<java.lang.String> value)
```
    The platforms the application supports.
    Allowed Values : WINDOWS_SERVER_2019 | AMAZON_LINUX2
  - getAttributesToDelete
```
public java.util.List<java.lang.String> getAttributesToDelete()
```
    A list of attributes to delete from an application.
  - setAttributesToDelete
```
public void setAttributesToDelete(java.util.List<java.lang.String> value)
```
    A list of attributes to delete from an application.
  - getDescription
```
public java.lang.String getDescription()
```
    The description of the application.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    The description of the application.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    The display name of the application.
    This name is visible to users in the application catalog.
  - setDisplayName
```
public void setDisplayName(java.lang.String value)
```
    The display name of the application.
    This name is visible to users in the application catalog.
  - getLaunchParameters
```
public java.lang.String getLaunchParameters()
```
    The launch parameters of the application.
  - setLaunchParameters
```
public void setLaunchParameters(java.lang.String value)
```
    The launch parameters of the application.
  - getWorkingDirectory
```
public java.lang.String getWorkingDirectory()
```
    The working directory of the application.
  - setWorkingDirectory
```
public void setWorkingDirectory(java.lang.String value)
```
    The working directory of the application.

Class CfnApplication

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnApplication

CfnApplication

CfnApplication

Method Detail

inspect

renderProperties

getAttrArn

getAttrCreatedTime

getCfnProperties

getTags

getAppBlockArn

setAppBlockArn

getIconS3Location

setIconS3Location

setIconS3Location

getInstanceFamilies

setInstanceFamilies

getLaunchPath

setLaunchPath

getName

setName

getPlatforms

setPlatforms

getAttributesToDelete

setAttributesToDelete

getDescription

setDescription

getDisplayName

setDisplayName

getLaunchParameters

setLaunchParameters

getWorkingDirectory

setWorkingDirectory