Package software.amazon.awscdk.services.iotsitewise

Interface CfnProjectProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProjectProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:03.270Z")
@Stability(Stable)
public interface CfnProjectProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnProject.

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.iotsitewise.*;
 CfnProjectProps cfnProjectProps = CfnProjectProps.builder()
         .portalId("portalId")
         .projectName("projectName")
         // the properties below are optional
         .assetIds(List.of("assetIds"))
         .projectDescription("projectDescription")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnProjectProps.Builder	builder()
default List<String>	getAssetIds()	A list that contains the IDs of each asset associated with the project.
String	getPortalId()	The ID of the portal in which to create the project.
default String	getProjectDescription()	A description for the project.
String	getProjectName()	A friendly name for the project.
default List<CfnTag>	getTags()	A list of key-value pairs that contain metadata for the project.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPortalId

@Stability(Stable)
@NotNull
String getPortalId()

The ID of the portal in which to create the project.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html#cfn-iotsitewise-project-portalid

getProjectName

@Stability(Stable)
@NotNull
String getProjectName()

A friendly name for the project.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html#cfn-iotsitewise-project-projectname

getAssetIds

@Stability(Stable)
@Nullable
default List<String> getAssetIds()

A list that contains the IDs of each asset associated with the project.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html#cfn-iotsitewise-project-assetids

getProjectDescription

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

A description for the project.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html#cfn-iotsitewise-project-projectdescription

getTags

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

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 Also:

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

builder

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

Returns:

a CfnProjectProps.Builder of CfnProjectProps