Class CfnEnvironment
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.workspacesthinclient.CfnEnvironment
- All Implemented Interfaces:
IInspectable
,ITaggableV2
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-05T03:43:52.691Z")
@Stability(Stable)
public class CfnEnvironment
extends CfnResource
implements IInspectable, ITaggableV2
Describes an environment.
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.workspacesthinclient.*; CfnEnvironment cfnEnvironment = CfnEnvironment.Builder.create(this, "MyCfnEnvironment") .desktopArn("desktopArn") // the properties below are optional .desiredSoftwareSetId("desiredSoftwareSetId") .desktopEndpoint("desktopEndpoint") .deviceCreationTags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .kmsKeyArn("kmsKeyArn") .maintenanceWindow(MaintenanceWindowProperty.builder() .type("type") // the properties below are optional .applyTimeOf("applyTimeOf") .daysOfTheWeek(List.of("daysOfTheWeek")) .endTimeHour(123) .endTimeMinute(123) .startTimeHour(123) .startTimeMinute(123) .build()) .name("name") .softwareSetUpdateMode("softwareSetUpdateMode") .softwareSetUpdateSchedule("softwareSetUpdateSchedule") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnEnvironment
.static interface
Describes the maintenance window for a thin client device.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnEnvironment
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnEnvironment
(software.amazon.jsii.JsiiObjectRef objRef) CfnEnvironment
(software.constructs.Construct scope, String id, CfnEnvironmentProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe activation code to register a device to the environment.The Amazon Resource Name (ARN) of the environment.The timestamp of when the environment was created.The type of streaming desktop for the environment.Unique identifier of the environment.The ID of the software set that is pending to be installed.The version of the software set that is pending to be installed.The number of devices registered to the environment.Describes if the software currently installed on all devices in the environment is a supported version.The timestamp of when the device was updated.Tag Manager which manages the tags for this resource.The ID of the software set to apply.The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.The URL for the identity provider login (only for environments that use AppStream 2.0).The tag keys and optional values for the newly created devices for this environment.The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.A specification for a time window to apply software updates.getName()
The name of the environment.An option to define which software updates to apply.An option to define if software updates should be applied within a maintenance window.getTags()
An array of key-value pairs to apply to this resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDesiredSoftwareSetId
(String value) The ID of the software set to apply.void
setDesktopArn
(String value) The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.void
setDesktopEndpoint
(String value) The URL for the identity provider login (only for environments that use AppStream 2.0).void
setDeviceCreationTags
(List<Object> value) The tag keys and optional values for the newly created devices for this environment.void
setDeviceCreationTags
(IResolvable value) The tag keys and optional values for the newly created devices for this environment.void
setKmsKeyArn
(String value) The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.void
setMaintenanceWindow
(IResolvable value) A specification for a time window to apply software updates.void
A specification for a time window to apply software updates.void
The name of the environment.void
setSoftwareSetUpdateMode
(String value) An option to define which software updates to apply.void
An option to define if software updates should be applied within a maintenance window.void
An array of key-value pairs to apply to this resource.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnEnvironment
protected CfnEnvironment(software.amazon.jsii.JsiiObjectRef objRef) -
CfnEnvironment
protected CfnEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnEnvironment
@Stability(Stable) public CfnEnvironment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnEnvironmentProps props) - 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
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrActivationCode
The activation code to register a device to the environment. -
getAttrArn
The Amazon Resource Name (ARN) of the environment. -
getAttrCreatedAt
The timestamp of when the environment was created. -
getAttrDesktopType
The type of streaming desktop for the environment. -
getAttrId
Unique identifier of the environment. -
getAttrPendingSoftwareSetId
The ID of the software set that is pending to be installed. -
getAttrPendingSoftwareSetVersion
The version of the software set that is pending to be installed. -
getAttrRegisteredDevicesCount
The number of devices registered to the environment. -
getAttrSoftwareSetComplianceStatus
Describes if the software currently installed on all devices in the environment is a supported version. -
getAttrUpdatedAt
The timestamp of when the device was updated. -
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getDesktopArn
The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0. -
setDesktopArn
The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0. -
getDesiredSoftwareSetId
The ID of the software set to apply. -
setDesiredSoftwareSetId
The ID of the software set to apply. -
getDesktopEndpoint
The URL for the identity provider login (only for environments that use AppStream 2.0). -
setDesktopEndpoint
The URL for the identity provider login (only for environments that use AppStream 2.0). -
getDeviceCreationTags
The tag keys and optional values for the newly created devices for this environment. -
setDeviceCreationTags
The tag keys and optional values for the newly created devices for this environment. -
setDeviceCreationTags
The tag keys and optional values for the newly created devices for this environment. -
getKmsKeyArn
The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment. -
setKmsKeyArn
The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment. -
getMaintenanceWindow
A specification for a time window to apply software updates. -
setMaintenanceWindow
A specification for a time window to apply software updates. -
setMaintenanceWindow
@Stability(Stable) public void setMaintenanceWindow(@Nullable CfnEnvironment.MaintenanceWindowProperty value) A specification for a time window to apply software updates. -
getName
The name of the environment. -
setName
The name of the environment. -
getSoftwareSetUpdateMode
An option to define which software updates to apply. -
setSoftwareSetUpdateMode
An option to define which software updates to apply. -
getSoftwareSetUpdateSchedule
An option to define if software updates should be applied within a maintenance window. -
setSoftwareSetUpdateSchedule
An option to define if software updates should be applied within a maintenance window. -
getTags
An array of key-value pairs to apply to this resource. -
setTags
An array of key-value pairs to apply to this resource.
-