Package software.amazon.awscdk.services.iotsitewise

Class CfnProject

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iotsitewise.CfnProject
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.929Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnProject

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

    • CfnProject

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

    • CfnProject

      @Stability(Stable) public CfnProject(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrProjectArn()
      The ARN of the project, which has the following format.

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

    • getAttrProjectId

      @Stability(Stable) @NotNull public String getAttrProjectId()
      The ID of the project.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(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(Stable) @NotNull public String getPortalId()
      The ID of the portal in which to create the project.

    • setPortalId

      @Stability(Stable) public void setPortalId(@NotNull String value)
      The ID of the portal in which to create the project.

    • getProjectName

      @Stability(Stable) @NotNull public String getProjectName()
      A friendly name for the project.

    • setProjectName

      @Stability(Stable) public void setProjectName(@NotNull String value)
      A friendly name for the project.

    • getAssetIds

      @Stability(Stable) @Nullable public List<String> getAssetIds()
      A list that contains the IDs of each asset associated with the project.

    • setAssetIds

      @Stability(Stable) public void setAssetIds(@Nullable List<String> value)
      A list that contains the IDs of each asset associated with the project.

    • getProjectDescription

      @Stability(Stable) @Nullable public String getProjectDescription()
      A description for the project.

    • setProjectDescription

      @Stability(Stable) public void setProjectDescription(@Nullable String value)
      A description for the project.