Package software.amazon.awscdk.services.workspacesinstances

Class CfnWorkspaceInstance

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.workspacesinstances.CfnWorkspaceInstance

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IWorkspaceInstanceRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-12-01T16:02:31.775Z")
@Stability(Stable)
public class CfnWorkspaceInstance
extends CfnResource
implements IInspectable, IWorkspaceInstanceRef, ITaggableV2

Resource Type definition for AWS::WorkspacesInstances::WorkspaceInstance.

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.workspacesinstances.*;
 CfnWorkspaceInstance cfnWorkspaceInstance = CfnWorkspaceInstance.Builder.create(this, "MyCfnWorkspaceInstance")
         .managedInstance(ManagedInstanceProperty.builder()
                 .imageId("imageId")
                 .instanceType("instanceType")
                 // the properties below are optional
                 .blockDeviceMappings(List.of(BlockDeviceMappingProperty.builder()
                         .deviceName("deviceName")
                         .ebs(EbsBlockDeviceProperty.builder()
                                 .encrypted(false)
                                 .iops(123)
                                 .kmsKeyId("kmsKeyId")
                                 .throughput(123)
                                 .volumeSize(123)
                                 .volumeType("volumeType")
                                 .build())
                         .noDevice("noDevice")
                         .virtualName("virtualName")
                         .build()))
                 .capacityReservationSpecification(CapacityReservationSpecificationProperty.builder()
                         .capacityReservationPreference("capacityReservationPreference")
                         .capacityReservationTarget(CapacityReservationTargetProperty.builder()
                                 .capacityReservationId("capacityReservationId")
                                 .capacityReservationResourceGroupArn("capacityReservationResourceGroupArn")
                                 .build())
                         .build())
                 .cpuOptions(CpuOptionsRequestProperty.builder()
                         .coreCount(123)
                         .threadsPerCore(123)
                         .build())
                 .creditSpecification(CreditSpecificationRequestProperty.builder()
                         .cpuCredits("cpuCredits")
                         .build())
                 .disableApiStop(false)
                 .ebsOptimized(false)
                 .enablePrimaryIpv6(false)
                 .enclaveOptions(EnclaveOptionsRequestProperty.builder()
                         .enabled(false)
                         .build())
                 .hibernationOptions(HibernationOptionsRequestProperty.builder()
                         .configured(false)
                         .build())
                 .iamInstanceProfile(IamInstanceProfileSpecificationProperty.builder()
                         .arn("arn")
                         .name("name")
                         .build())
                 .instanceMarketOptions(InstanceMarketOptionsRequestProperty.builder()
                         .marketType("marketType")
                         .spotOptions(SpotMarketOptionsProperty.builder()
                                 .instanceInterruptionBehavior("instanceInterruptionBehavior")
                                 .maxPrice("maxPrice")
                                 .spotInstanceType("spotInstanceType")
                                 .validUntilUtc("validUntilUtc")
                                 .build())
                         .build())
                 .ipv6AddressCount(123)
                 .keyName("keyName")
                 .licenseSpecifications(List.of(LicenseConfigurationRequestProperty.builder()
                         .licenseConfigurationArn("licenseConfigurationArn")
                         .build()))
                 .maintenanceOptions(InstanceMaintenanceOptionsRequestProperty.builder()
                         .autoRecovery("autoRecovery")
                         .build())
                 .metadataOptions(InstanceMetadataOptionsRequestProperty.builder()
                         .httpEndpoint("httpEndpoint")
                         .httpProtocolIpv6("httpProtocolIpv6")
                         .httpPutResponseHopLimit(123)
                         .httpTokens("httpTokens")
                         .instanceMetadataTags("instanceMetadataTags")
                         .build())
                 .monitoring(RunInstancesMonitoringEnabledProperty.builder()
                         .enabled(false)
                         .build())
                 .networkInterfaces(List.of(InstanceNetworkInterfaceSpecificationProperty.builder()
                         .description("description")
                         .deviceIndex(123)
                         .groups(List.of("groups"))
                         .subnetId("subnetId")
                         .build()))
                 .networkPerformanceOptions(InstanceNetworkPerformanceOptionsRequestProperty.builder()
                         .bandwidthWeighting("bandwidthWeighting")
                         .build())
                 .placement(PlacementProperty.builder()
                         .availabilityZone("availabilityZone")
                         .groupId("groupId")
                         .groupName("groupName")
                         .partitionNumber(123)
                         .tenancy("tenancy")
                         .build())
                 .privateDnsNameOptions(PrivateDnsNameOptionsRequestProperty.builder()
                         .enableResourceNameDnsAaaaRecord(false)
                         .enableResourceNameDnsARecord(false)
                         .hostnameType("hostnameType")
                         .build())
                 .subnetId("subnetId")
                 .tagSpecifications(List.of(TagSpecificationProperty.builder()
                         .resourceType("resourceType")
                         .tags(List.of(CfnTag.builder()
                                 .key("key")
                                 .value("value")
                                 .build()))
                         .build()))
                 .userData("userData")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-workspaceinstance.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnWorkspaceInstance.BlockDeviceMappingProperty	Example:
static final class	CfnWorkspaceInstance.Builder	A fluent builder for CfnWorkspaceInstance.
static interface	CfnWorkspaceInstance.CapacityReservationSpecificationProperty	Example:
static interface	CfnWorkspaceInstance.CapacityReservationTargetProperty	Example:
static interface	CfnWorkspaceInstance.CpuOptionsRequestProperty	Example:
static interface	CfnWorkspaceInstance.CreditSpecificationRequestProperty	Example:
static interface	CfnWorkspaceInstance.EbsBlockDeviceProperty	Example:
static interface	CfnWorkspaceInstance.EC2ManagedInstanceProperty	Example:
static interface	CfnWorkspaceInstance.EnclaveOptionsRequestProperty	Example:
static interface	CfnWorkspaceInstance.HibernationOptionsRequestProperty	Example:
static interface	CfnWorkspaceInstance.IamInstanceProfileSpecificationProperty	Example:
static interface	CfnWorkspaceInstance.InstanceMaintenanceOptionsRequestProperty	Example:
static interface	CfnWorkspaceInstance.InstanceMarketOptionsRequestProperty	Example:
static interface	CfnWorkspaceInstance.InstanceMetadataOptionsRequestProperty	Example:
static interface	CfnWorkspaceInstance.InstanceNetworkInterfaceSpecificationProperty	Example:
static interface	CfnWorkspaceInstance.InstanceNetworkPerformanceOptionsRequestProperty	Example:
static interface	CfnWorkspaceInstance.LicenseConfigurationRequestProperty	Example:
static interface	CfnWorkspaceInstance.ManagedInstanceProperty	Example:
static interface	CfnWorkspaceInstance.PlacementProperty	Example:
static interface	CfnWorkspaceInstance.PrivateDnsNameOptionsRequestProperty	Example:
static interface	CfnWorkspaceInstance.RunInstancesMonitoringEnabledProperty	Example:
static interface	CfnWorkspaceInstance.SpotMarketOptionsProperty	Example:
static interface	CfnWorkspaceInstance.TagSpecificationProperty	Example:

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.workspacesinstances.IWorkspaceInstanceRef

IWorkspaceInstanceRef.Jsii$Default, IWorkspaceInstanceRef.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnWorkspaceInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWorkspaceInstance(software.amazon.jsii.JsiiObjectRef objRef)
	CfnWorkspaceInstance(software.constructs.Construct scope, String id)	Create a new AWS::WorkspacesInstances::WorkspaceInstance.
	CfnWorkspaceInstance(software.constructs.Construct scope, String id, CfnWorkspaceInstanceProps props)	Create a new AWS::WorkspacesInstances::WorkspaceInstance.

Method Summary

Modifier and Type	Method	Description
static String	arnForWorkspaceInstance(IWorkspaceInstanceRef resource)
static IWorkspaceInstanceRef	fromWorkspaceInstanceId(software.constructs.Construct scope, String id, String workspaceInstanceId)	Creates a new IWorkspaceInstanceRef from a workspaceInstanceId.
IResolvable	getAttrEc2ManagedInstance()
String	getAttrEc2ManagedInstanceInstanceId()
String	getAttrProvisionState()	The current state of the workspace instance.
String	getAttrWorkspaceInstanceId()	Unique identifier for the workspace instance.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
Object	getManagedInstance()	Returns union: either IResolvable or CfnWorkspaceInstance.ManagedInstanceProperty
List<CfnTag>	getTags()
WorkspaceInstanceReference	getWorkspaceInstanceRef()	A reference to a WorkspaceInstance resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnWorkspaceInstance(Object x)	Checks whether the given object is a CfnWorkspaceInstance.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setManagedInstance(IResolvable value)
void	setManagedInstance(CfnWorkspaceInstance.ManagedInstanceProperty value)
void	setTags(List<CfnTag> value)

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, 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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

CfnWorkspaceInstance

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

CfnWorkspaceInstance

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

CfnWorkspaceInstance

@Stability(Stable)
public CfnWorkspaceInstance(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnWorkspaceInstanceProps props)

Create a new AWS::WorkspacesInstances::WorkspaceInstance.

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.

CfnWorkspaceInstance

@Stability(Stable)
public CfnWorkspaceInstance(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Create a new AWS::WorkspacesInstances::WorkspaceInstance.

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.

Method Details

arnForWorkspaceInstance

@Stability(Stable)
@NotNull
public static String arnForWorkspaceInstance(@NotNull
 IWorkspaceInstanceRef resource)

Parameters:

resource - This parameter is required.

fromWorkspaceInstanceId

@Stability(Stable)
@NotNull
public static IWorkspaceInstanceRef fromWorkspaceInstanceId(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String workspaceInstanceId)

Creates a new IWorkspaceInstanceRef from a workspaceInstanceId.

Parameters:

scope - This parameter is required.

id - This parameter is required.

workspaceInstanceId - This parameter is required.

isCfnWorkspaceInstance

@Stability(Stable)
@NotNull
public static Boolean isCfnWorkspaceInstance(@NotNull
 Object x)

Checks whether the given object is a CfnWorkspaceInstance.

Parameters:

x - This parameter is required.

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.

getAttrEc2ManagedInstance

@Stability(Stable)
@NotNull
public IResolvable getAttrEc2ManagedInstance()

getAttrEc2ManagedInstanceInstanceId

@Stability(Stable)
@NotNull
public String getAttrEc2ManagedInstanceInstanceId()

getAttrProvisionState

@Stability(Stable)
@NotNull
public String getAttrProvisionState()

The current state of the workspace instance.

getAttrWorkspaceInstanceId

@Stability(Stable)
@NotNull
public String getAttrWorkspaceInstanceId()

Unique identifier for the workspace instance.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getWorkspaceInstanceRef

@Stability(Stable)
@NotNull
public WorkspaceInstanceReference getWorkspaceInstanceRef()

A reference to a WorkspaceInstance resource.

Specified by:

getWorkspaceInstanceRef in interface IWorkspaceInstanceRef

getManagedInstance

@Stability(Stable)
@Nullable
public Object getManagedInstance()

Returns union: either IResolvable or CfnWorkspaceInstance.ManagedInstanceProperty

setManagedInstance

@Stability(Stable)
public void setManagedInstance(@Nullable
 IResolvable value)

setManagedInstance

@Stability(Stable)
public void setManagedInstance(@Nullable
 CfnWorkspaceInstance.ManagedInstanceProperty value)

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)