CfnWorkspaceProps
- class aws_cdk.aws_iotsitewise.CfnWorkspaceProps(*, encryption_configuration, workspace_name, kms_key_id=None, tags=None, workspace_description=None)
Bases:
objectProperties for defining a
CfnWorkspace.- Parameters:
encryption_configuration (
Union[IResolvable,EncryptionConfigurationProperty,Dict[str,Any]]) – The encryption configuration for the workspace.workspace_name (
str) – The name of the workspace.kms_key_id (
Optional[str]) – The ARN of the AWS KMS key used for KMS_BASED_ENCRYPTION. Required when EncryptionConfiguration.EncryptionType is KMS_BASED_ENCRYPTION.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – An array of key-value pairs to apply to this resource.workspace_description (
Optional[str]) – A description of the workspace.
- See:
- ExampleMetadata:
fixture=_generated
Example:
from aws_cdk import CfnTag # The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_iotsitewise as iotsitewise cfn_workspace_props = iotsitewise.CfnWorkspaceProps( encryption_configuration=iotsitewise.CfnWorkspace.EncryptionConfigurationProperty( encryption_type="encryptionType" ), workspace_name="workspaceName", # the properties below are optional kms_key_id="kmsKeyId", tags=[CfnTag( key="key", value="value" )], workspace_description="workspaceDescription" )
Attributes
- encryption_configuration
The encryption configuration for the workspace.
- kms_key_id
The ARN of the AWS KMS key used for KMS_BASED_ENCRYPTION.
Required when EncryptionConfiguration.EncryptionType is KMS_BASED_ENCRYPTION.
- tags
An array of key-value pairs to apply to this resource.
- workspace_description
A description of the workspace.
- workspace_name
The name of the workspace.