software.amazon.awscdk.services.iotsitewise

Class CfnProject

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iotsitewise.CfnProject

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.061Z")
 @Stability(value=Stable)
public class CfnProject
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTSiteWise::Project`.

Creates a project in the specified portal.

Make sure that the project name and description don't contain confidential information.

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.*;
 CfnProject cfnProject = CfnProject.Builder.create(this, "MyCfnProject")
         .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	Class and Description
static class	CfnProject.Builder A fluent builder for CfnProject.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnProject(software.constructs.Construct scope, String id, CfnProjectProps props) Create a new `AWS::IoTSiteWise::Project`.
protected	CfnProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnProject(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
List<String>	getAssetIds() A list that contains the IDs of each asset associated with the project.
String	getAttrProjectArn() The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the project, which has the following format.
String	getAttrProjectId() The ID of the project.
protected Map<String,Object>	getCfnProperties()
String	getPortalId() The ID of the portal in which to create the project.
String	getProjectDescription() A description for the project.
String	getProjectName() A friendly name for the project.
TagManager	getTags() A list of key-value pairs that contain metadata for the project.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAssetIds(List<String> value) A list that contains the IDs of each asset associated with the project.
void	setPortalId(String value) The ID of the portal in which to create the project.
void	setProjectDescription(String value) A description for the project.
void	setProjectName(String value) A friendly name for the project.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnProject

protected CfnProject(software.amazon.jsii.JsiiObjectRef objRef)

CfnProject

protected CfnProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnProject

@Stability(value=Stable)
public CfnProject(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id,
                                           @NotNull
                                           CfnProjectProps props)

Create a new `AWS::IoTSiteWise::Project`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrProjectArn

@Stability(value=Stable)
 @NotNull
public String getAttrProjectArn()

The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the project, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}

getAttrProjectId

@Stability(value=Stable)
 @NotNull
public String getAttrProjectId()

The ID of the project.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager 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 .

getPortalId

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

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

setPortalId

@Stability(value=Stable)
public void setPortalId(@NotNull
                                                 String value)

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

getProjectName

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

A friendly name for the project.

setProjectName

@Stability(value=Stable)
public void setProjectName(@NotNull
                                                    String value)

A friendly name for the project.

getAssetIds

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

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

setAssetIds

@Stability(value=Stable)
public void setAssetIds(@Nullable
                                                 List<String> value)

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

getProjectDescription

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

A description for the project.

setProjectDescription

@Stability(value=Stable)
public void setProjectDescription(@Nullable
                                                           String value)

A description for the project.