software.amazon.awscdk.services.appstream

Class CfnFleet

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

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:05.086Z")
 @Stability(value=Stable)
public class CfnFleet
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppStream::Fleet`.

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.*;
 CfnFleet cfnFleet = CfnFleet.Builder.create(this, "MyCfnFleet")
         .instanceType("instanceType")
         .name("name")
         // the properties below are optional
         .computeCapacity(ComputeCapacityProperty.builder()
                 .desiredInstances(123)
                 .build())
         .description("description")
         .disconnectTimeoutInSeconds(123)
         .displayName("displayName")
         .domainJoinInfo(DomainJoinInfoProperty.builder()
                 .directoryName("directoryName")
                 .organizationalUnitDistinguishedName("organizationalUnitDistinguishedName")
                 .build())
         .enableDefaultInternetAccess(false)
         .fleetType("fleetType")
         .iamRoleArn("iamRoleArn")
         .idleDisconnectTimeoutInSeconds(123)
         .imageArn("imageArn")
         .imageName("imageName")
         .maxConcurrentSessions(123)
         .maxUserDurationInSeconds(123)
         .platform("platform")
         .streamView("streamView")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .usbDeviceFilterStrings(List.of("usbDeviceFilterStrings"))
         .vpcConfig(VpcConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnFleet.Builder A fluent builder for CfnFleet.
static interface	CfnFleet.ComputeCapacityProperty Example:
static interface	CfnFleet.DomainJoinInfoProperty Example:
static interface	CfnFleet.VpcConfigProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFleet(software.constructs.Construct scope, String id, CfnFleetProps props) Create a new `AWS::AppStream::Fleet`.
protected	CfnFleet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFleet(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
Object	getComputeCapacity() `AWS::AppStream::Fleet.ComputeCapacity`.
String	getDescription() `AWS::AppStream::Fleet.Description`.
Number	getDisconnectTimeoutInSeconds() `AWS::AppStream::Fleet.DisconnectTimeoutInSeconds`.
String	getDisplayName() `AWS::AppStream::Fleet.DisplayName`.
Object	getDomainJoinInfo() `AWS::AppStream::Fleet.DomainJoinInfo`.
Object	getEnableDefaultInternetAccess() `AWS::AppStream::Fleet.EnableDefaultInternetAccess`.
String	getFleetType() `AWS::AppStream::Fleet.FleetType`.
String	getIamRoleArn() `AWS::AppStream::Fleet.IamRoleArn`.
Number	getIdleDisconnectTimeoutInSeconds() `AWS::AppStream::Fleet.IdleDisconnectTimeoutInSeconds`.
String	getImageArn() `AWS::AppStream::Fleet.ImageArn`.
String	getImageName() `AWS::AppStream::Fleet.ImageName`.
String	getInstanceType() `AWS::AppStream::Fleet.InstanceType`.
Number	getMaxConcurrentSessions() `AWS::AppStream::Fleet.MaxConcurrentSessions`.
Number	getMaxUserDurationInSeconds() `AWS::AppStream::Fleet.MaxUserDurationInSeconds`.
String	getName() `AWS::AppStream::Fleet.Name`.
String	getPlatform() `AWS::AppStream::Fleet.Platform`.
String	getStreamView() `AWS::AppStream::Fleet.StreamView`.
TagManager	getTags() `AWS::AppStream::Fleet.Tags`.
List<String>	getUsbDeviceFilterStrings() `AWS::AppStream::Fleet.UsbDeviceFilterStrings`.
Object	getVpcConfig() `AWS::AppStream::Fleet.VpcConfig`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setComputeCapacity(CfnFleet.ComputeCapacityProperty value) `AWS::AppStream::Fleet.ComputeCapacity`.
void	setComputeCapacity(IResolvable value) `AWS::AppStream::Fleet.ComputeCapacity`.
void	setDescription(String value) `AWS::AppStream::Fleet.Description`.
void	setDisconnectTimeoutInSeconds(Number value) `AWS::AppStream::Fleet.DisconnectTimeoutInSeconds`.
void	setDisplayName(String value) `AWS::AppStream::Fleet.DisplayName`.
void	setDomainJoinInfo(CfnFleet.DomainJoinInfoProperty value) `AWS::AppStream::Fleet.DomainJoinInfo`.
void	setDomainJoinInfo(IResolvable value) `AWS::AppStream::Fleet.DomainJoinInfo`.
void	setEnableDefaultInternetAccess(Boolean value) `AWS::AppStream::Fleet.EnableDefaultInternetAccess`.
void	setEnableDefaultInternetAccess(IResolvable value) `AWS::AppStream::Fleet.EnableDefaultInternetAccess`.
void	setFleetType(String value) `AWS::AppStream::Fleet.FleetType`.
void	setIamRoleArn(String value) `AWS::AppStream::Fleet.IamRoleArn`.
void	setIdleDisconnectTimeoutInSeconds(Number value) `AWS::AppStream::Fleet.IdleDisconnectTimeoutInSeconds`.
void	setImageArn(String value) `AWS::AppStream::Fleet.ImageArn`.
void	setImageName(String value) `AWS::AppStream::Fleet.ImageName`.
void	setInstanceType(String value) `AWS::AppStream::Fleet.InstanceType`.
void	setMaxConcurrentSessions(Number value) `AWS::AppStream::Fleet.MaxConcurrentSessions`.
void	setMaxUserDurationInSeconds(Number value) `AWS::AppStream::Fleet.MaxUserDurationInSeconds`.
void	setName(String value) `AWS::AppStream::Fleet.Name`.
void	setPlatform(String value) `AWS::AppStream::Fleet.Platform`.
void	setStreamView(String value) `AWS::AppStream::Fleet.StreamView`.
void	setUsbDeviceFilterStrings(List<String> value) `AWS::AppStream::Fleet.UsbDeviceFilterStrings`.
void	setVpcConfig(CfnFleet.VpcConfigProperty value) `AWS::AppStream::Fleet.VpcConfig`.
void	setVpcConfig(IResolvable value) `AWS::AppStream::Fleet.VpcConfig`.

Methods inherited from class software.amazon.awscdk.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.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnFleet

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

CfnFleet

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

CfnFleet

@Stability(value=Stable)
public CfnFleet(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         CfnFleetProps props)

Create a new `AWS::AppStream::Fleet`.

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

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getComputeCapacity

@Stability(value=Stable)
 @Nullable
public Object getComputeCapacity()

`AWS::AppStream::Fleet.ComputeCapacity`.

setComputeCapacity

@Stability(value=Stable)
public void setComputeCapacity(@Nullable
                                                        CfnFleet.ComputeCapacityProperty value)

`AWS::AppStream::Fleet.ComputeCapacity`.

setComputeCapacity

@Stability(value=Stable)
public void setComputeCapacity(@Nullable
                                                        IResolvable value)

`AWS::AppStream::Fleet.ComputeCapacity`.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

`AWS::AppStream::Fleet.Description`.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

`AWS::AppStream::Fleet.Description`.

getDisconnectTimeoutInSeconds

@Stability(value=Stable)
 @Nullable
public Number getDisconnectTimeoutInSeconds()

`AWS::AppStream::Fleet.DisconnectTimeoutInSeconds`.

setDisconnectTimeoutInSeconds

@Stability(value=Stable)
public void setDisconnectTimeoutInSeconds(@Nullable
                                                                   Number value)

`AWS::AppStream::Fleet.DisconnectTimeoutInSeconds`.

getDisplayName

@Stability(value=Stable)
 @Nullable
public String getDisplayName()

`AWS::AppStream::Fleet.DisplayName`.

setDisplayName

@Stability(value=Stable)
public void setDisplayName(@Nullable
                                                    String value)

`AWS::AppStream::Fleet.DisplayName`.

getDomainJoinInfo

@Stability(value=Stable)
 @Nullable
public Object getDomainJoinInfo()

`AWS::AppStream::Fleet.DomainJoinInfo`.

setDomainJoinInfo

@Stability(value=Stable)
public void setDomainJoinInfo(@Nullable
                                                       CfnFleet.DomainJoinInfoProperty value)

`AWS::AppStream::Fleet.DomainJoinInfo`.

setDomainJoinInfo

@Stability(value=Stable)
public void setDomainJoinInfo(@Nullable
                                                       IResolvable value)

`AWS::AppStream::Fleet.DomainJoinInfo`.

getEnableDefaultInternetAccess

@Stability(value=Stable)
 @Nullable
public Object getEnableDefaultInternetAccess()

`AWS::AppStream::Fleet.EnableDefaultInternetAccess`.

setEnableDefaultInternetAccess

@Stability(value=Stable)
public void setEnableDefaultInternetAccess(@Nullable
                                                                    Boolean value)

`AWS::AppStream::Fleet.EnableDefaultInternetAccess`.

setEnableDefaultInternetAccess

@Stability(value=Stable)
public void setEnableDefaultInternetAccess(@Nullable
                                                                    IResolvable value)

`AWS::AppStream::Fleet.EnableDefaultInternetAccess`.

getFleetType

@Stability(value=Stable)
 @Nullable
public String getFleetType()

`AWS::AppStream::Fleet.FleetType`.

setFleetType

@Stability(value=Stable)
public void setFleetType(@Nullable
                                                  String value)

`AWS::AppStream::Fleet.FleetType`.

getIamRoleArn

@Stability(value=Stable)
 @Nullable
public String getIamRoleArn()

`AWS::AppStream::Fleet.IamRoleArn`.

setIamRoleArn

@Stability(value=Stable)
public void setIamRoleArn(@Nullable
                                                   String value)

`AWS::AppStream::Fleet.IamRoleArn`.

getIdleDisconnectTimeoutInSeconds

@Stability(value=Stable)
 @Nullable
public Number getIdleDisconnectTimeoutInSeconds()

`AWS::AppStream::Fleet.IdleDisconnectTimeoutInSeconds`.

setIdleDisconnectTimeoutInSeconds

@Stability(value=Stable)
public void setIdleDisconnectTimeoutInSeconds(@Nullable
                                                                       Number value)

`AWS::AppStream::Fleet.IdleDisconnectTimeoutInSeconds`.

getImageArn

@Stability(value=Stable)
 @Nullable
public String getImageArn()

`AWS::AppStream::Fleet.ImageArn`.

setImageArn

@Stability(value=Stable)
public void setImageArn(@Nullable
                                                 String value)

`AWS::AppStream::Fleet.ImageArn`.

getImageName

@Stability(value=Stable)
 @Nullable
public String getImageName()

`AWS::AppStream::Fleet.ImageName`.

setImageName

@Stability(value=Stable)
public void setImageName(@Nullable
                                                  String value)

`AWS::AppStream::Fleet.ImageName`.

getInstanceType

@Stability(value=Stable)
 @NotNull
public String getInstanceType()

`AWS::AppStream::Fleet.InstanceType`.

setInstanceType

@Stability(value=Stable)
public void setInstanceType(@NotNull
                                                     String value)

`AWS::AppStream::Fleet.InstanceType`.

getMaxConcurrentSessions

@Stability(value=Stable)
 @Nullable
public Number getMaxConcurrentSessions()

`AWS::AppStream::Fleet.MaxConcurrentSessions`.

setMaxConcurrentSessions

@Stability(value=Stable)
public void setMaxConcurrentSessions(@Nullable
                                                              Number value)

`AWS::AppStream::Fleet.MaxConcurrentSessions`.

getMaxUserDurationInSeconds

@Stability(value=Stable)
 @Nullable
public Number getMaxUserDurationInSeconds()

`AWS::AppStream::Fleet.MaxUserDurationInSeconds`.

setMaxUserDurationInSeconds

@Stability(value=Stable)
public void setMaxUserDurationInSeconds(@Nullable
                                                                 Number value)

`AWS::AppStream::Fleet.MaxUserDurationInSeconds`.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

`AWS::AppStream::Fleet.Name`.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

`AWS::AppStream::Fleet.Name`.

getPlatform

@Stability(value=Stable)
 @Nullable
public String getPlatform()

`AWS::AppStream::Fleet.Platform`.

setPlatform

@Stability(value=Stable)
public void setPlatform(@Nullable
                                                 String value)

`AWS::AppStream::Fleet.Platform`.

getStreamView

@Stability(value=Stable)
 @Nullable
public String getStreamView()

`AWS::AppStream::Fleet.StreamView`.

setStreamView

@Stability(value=Stable)
public void setStreamView(@Nullable
                                                   String value)

`AWS::AppStream::Fleet.StreamView`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::AppStream::Fleet.Tags`.

getUsbDeviceFilterStrings

@Stability(value=Stable)
 @Nullable
public List<String> getUsbDeviceFilterStrings()

`AWS::AppStream::Fleet.UsbDeviceFilterStrings`.

setUsbDeviceFilterStrings

@Stability(value=Stable)
public void setUsbDeviceFilterStrings(@Nullable
                                                               List<String> value)

`AWS::AppStream::Fleet.UsbDeviceFilterStrings`.

getVpcConfig

@Stability(value=Stable)
 @Nullable
public Object getVpcConfig()

`AWS::AppStream::Fleet.VpcConfig`.

setVpcConfig

@Stability(value=Stable)
public void setVpcConfig(@Nullable
                                                  CfnFleet.VpcConfigProperty value)

`AWS::AppStream::Fleet.VpcConfig`.

setVpcConfig

@Stability(value=Stable)
public void setVpcConfig(@Nullable
                                                  IResolvable value)

`AWS::AppStream::Fleet.VpcConfig`.