CfnWorkspaceProps

class aws_cdk.aws_iottwinmaker.CfnWorkspaceProps(*, role, s3_location, workspace_id, description=None, tags=None)

Bases: object

Properties for defining a CfnWorkspace.

Parameters
  • role (str) – The ARN of the execution role associated with the workspace.

  • s3_location (str) – The ARN of the S3 bucket where resources associated with the workspace are stored.

  • workspace_id (str) – The ID of the workspace.

  • description (Optional[str]) – The description of the workspace.

  • tags (Optional[Mapping[str, str]]) – Metadata that you can use to manage the workspace.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iottwinmaker as iottwinmaker

cfn_workspace_props = iottwinmaker.CfnWorkspaceProps(
    role="role",
    s3_location="s3Location",
    workspace_id="workspaceId",

    # the properties below are optional
    description="description",
    tags={
        "tags_key": "tags"
    }
)

Attributes

description

The description of the workspace.

Link

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

Return type

Optional[str]

role

The ARN of the execution role associated with the workspace.

Link

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

Return type

str

s3_location

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

Link

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

Return type

str

tags

Metadata that you can use to manage the workspace.

Link

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

Return type

Optional[Mapping[str, str]]

workspace_id

The ID of the workspace.

Link

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

Return type

str