CfnProjectProps
- class aws_cdk.aws_iotsitewise.CfnProjectProps(*, portal_id, project_name, asset_ids=None, project_description=None, tags=None)
Bases:
object
Properties for defining a
CfnProject
.- Parameters:
portal_id (
str
) – The ID of the portal in which to create the project.project_name (
str
) – A friendly name for the project.asset_ids (
Optional
[Sequence
[str
]]) – A list that contains the IDs of each asset associated with the project.project_description (
Optional
[str
]) – A description for the project.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – A list of key-value pairs that contain metadata for the project. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html
- ExampleMetadata:
fixture=_generated
Example:
# 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_project_props = iotsitewise.CfnProjectProps( portal_id="portalId", project_name="projectName", # the properties below are optional asset_ids=["assetIds"], project_description="projectDescription", tags=[CfnTag( key="key", value="value" )] )
Attributes
- asset_ids
A list that contains the IDs of each asset associated with the project.
- portal_id
The ID of the portal in which to create the project.
- project_description
A description for the project.
- project_name
A friendly name for the project.
- tags
A list of key-value pairs that contain metadata for the project.
For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .