Package 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:
IEnvironmentAware, IInspectable, ITaggable, IProjectRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:07.968Z") @Stability(Stable) public class CfnProject extends CfnResource implements IInspectable, IProjectRef, ITaggable

The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

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();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnProjectProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromProjectArn

      @Stability(Stable) @NotNull public static IProjectRef fromProjectArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IProjectRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromProjectId

      @Stability(Stable) @NotNull public static IProjectRef fromProjectId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String projectId)
      Creates a new IProjectRef from a projectId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      projectId - This parameter is required.

    • 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

    • getProjectRef

      @Stability(Stable) @NotNull public ProjectReference getProjectRef()
      A reference to a Project resource.
      Specified by:
      getProjectRef in interface IProjectRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • 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.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of key-value pairs that contain metadata for the project.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of key-value pairs that contain metadata for the project.