Package software.amazon.awscdk.services.iottwinmaker

Interface CfnWorkspaceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkspaceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:08.657Z")
@Stability(Stable)
public interface CfnWorkspaceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnWorkspace.

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.iottwinmaker.*;
 CfnWorkspaceProps cfnWorkspaceProps = CfnWorkspaceProps.builder()
         .role("role")
         .s3Location("s3Location")
         .workspaceId("workspaceId")
         // the properties below are optional
         .description("description")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWorkspaceProps.Builder	A builder for CfnWorkspaceProps
static final class	CfnWorkspaceProps.Jsii$Proxy	An implementation for CfnWorkspaceProps

Method Summary

Modifier and Type	Method	Description
static CfnWorkspaceProps.Builder	builder()
default String	getDescription()	The description of the workspace.
String	getRole()	The ARN of the execution role associated with the workspace.
String	getS3Location()	The ARN of the S3 bucket where resources associated with the workspace are stored.
default Map<String,String>	getTags()	Metadata that you can use to manage the workspace.
String	getWorkspaceId()	The ID of the workspace.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRole

@Stability(Stable)
@NotNull
String getRole()

The ARN of the execution role associated with the workspace.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html#cfn-iottwinmaker-workspace-role

getS3Location

@Stability(Stable)
@NotNull
String getS3Location()

The ARN of the S3 bucket where resources associated with the workspace are stored.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html#cfn-iottwinmaker-workspace-s3location

getWorkspaceId

@Stability(Stable)
@NotNull
String getWorkspaceId()

The ID of the workspace.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html#cfn-iottwinmaker-workspace-workspaceid

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the workspace.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html#cfn-iottwinmaker-workspace-description

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

Metadata that you can use to manage the workspace.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html#cfn-iottwinmaker-workspace-tags

builder

@Stability(Stable)
static CfnWorkspaceProps.Builder builder()

Returns:

a CfnWorkspaceProps.Builder of CfnWorkspaceProps