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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.062Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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 Detail

getPortalId

@Stability(value=Stable)
 @NotNull
String getPortalId()

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

getProjectName

@Stability(value=Stable)
 @NotNull
String getProjectName()

A friendly name for the project.

getAssetIds

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

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

getProjectDescription

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

A description for the project.

getTags

@Stability(value=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 .

builder

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

Returns:

a CfnProjectProps.Builder of CfnProjectProps