Class CfnApplication
A CloudFormation AWS::AppStream::Application
.
Inherited Members
Namespace: Amazon.CDK.AWS.AppStream
Assembly: Amazon.CDK.AWS.AppStream.dll
Syntax (csharp)
public class CfnApplication : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnApplication
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
This resource creates an application. Applications store the details about how to launch applications on streaming instances. This is only supported for Elastic fleets.
CloudformationResource: AWS::AppStream::Application
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppStream;
var cfnApplication = new CfnApplication(this, "MyCfnApplication", new CfnApplicationProps {
AppBlockArn = "appBlockArn",
IconS3Location = new S3LocationProperty {
S3Bucket = "s3Bucket",
S3Key = "s3Key"
},
InstanceFamilies = new [] { "instanceFamilies" },
LaunchPath = "launchPath",
Name = "name",
Platforms = new [] { "platforms" },
// the properties below are optional
AttributesToDelete = new [] { "attributesToDelete" },
Description = "description",
DisplayName = "displayName",
LaunchParameters = "launchParameters",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
WorkingDirectory = "workingDirectory"
});
Synopsis
Constructors
CfnApplication(Construct, String, ICfnApplicationProps) | Create a new |
CfnApplication(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnApplication(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AppBlockArn | The app block ARN with which the application should be associated. |
AttrArn | The ARN of the application. |
AttrCreatedTime | The time when the application was created. |
AttributesToDelete | A list of attributes to delete from an application. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The description of the application. |
DisplayName | The display name of the application. |
IconS3Location | The icon S3 location of the application. |
InstanceFamilies | The instance families the application supports. |
LaunchParameters | The launch parameters of the application. |
LaunchPath | The launch path of the application. |
Name | The name of the application. |
Platforms | The platforms the application supports. |
Tags | The tags of the application. |
WorkingDirectory | The working directory of the application. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnApplication(Construct, String, ICfnApplicationProps)
Create a new AWS::AppStream::Application
.
public CfnApplication(Construct scope, string id, ICfnApplicationProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnApplicationProps
- resource properties.
CfnApplication(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnApplication(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnApplication(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnApplication(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AppBlockArn
The app block ARN with which the application should be associated.
public virtual string AppBlockArn { get; set; }
Property Value
System.String
Remarks
AttrArn
The ARN of the application.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrCreatedTime
The time when the application was created.
public virtual string AttrCreatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedTime
AttributesToDelete
A list of attributes to delete from an application.
public virtual string[] AttributesToDelete { get; set; }
Property Value
System.String[]
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
The description of the application.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
DisplayName
The display name of the application.
public virtual string DisplayName { get; set; }
Property Value
System.String
Remarks
This name is visible to users in the application catalog.
IconS3Location
The icon S3 location of the application.
public virtual object IconS3Location { get; set; }
Property Value
System.Object
Remarks
InstanceFamilies
The instance families the application supports.
public virtual string[] InstanceFamilies { get; set; }
Property Value
System.String[]
Remarks
Allowed Values : GENERAL_PURPOSE
| GRAPHICS_G4
LaunchParameters
The launch parameters of the application.
public virtual string LaunchParameters { get; set; }
Property Value
System.String
Remarks
LaunchPath
The launch path of the application.
public virtual string LaunchPath { get; set; }
Property Value
System.String
Remarks
Name
The name of the application.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
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}$
Platforms
The platforms the application supports.
public virtual string[] Platforms { get; set; }
Property Value
System.String[]
Remarks
Allowed Values : WINDOWS_SERVER_2019
| AMAZON_LINUX2
Tags
The tags of the application.
public virtual TagManager Tags { get; }
Property Value
Remarks
WorkingDirectory
The working directory of the application.
public virtual string WorkingDirectory { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>