Package software.amazon.awscdk.services.iot1click

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.iot1click.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.731Z") @Stability(Stable) public class CfnProject extends CfnResource implements IInspectable
A CloudFormation AWS::IoT1Click::Project.

The AWS::IoT1Click::Project resource creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project. For more information, see CreateProject in the AWS IoT 1-Click Projects API Reference .

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.iot1click.*;
 Object callbackOverrides;
 Object defaultAttributes;
 CfnProject cfnProject = CfnProject.Builder.create(this, "MyCfnProject")
         .placementTemplate(PlacementTemplateProperty.builder()
                 .defaultAttributes(defaultAttributes)
                 .deviceTemplates(Map.of(
                         "deviceTemplatesKey", DeviceTemplateProperty.builder()
                                 .callbackOverrides(callbackOverrides)
                                 .deviceType("deviceType")
                                 .build()))
                 .build())
         // the properties below are optional
         .description("description")
         .projectName("projectName")
         .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::IoT1Click::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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the project, such as arn:aws:iot1click:us-east-1:123456789012:projects/project-a1bzhi .

    • getAttrProjectName

      @Stability(Stable) @NotNull public String getAttrProjectName()
      The name of the project, such as project-a1bzhi .

    • getCfnProperties

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

    • getPlacementTemplate

      @Stability(Stable) @NotNull public Object getPlacementTemplate()
      An object describing the project's placement specifications.

    • setPlacementTemplate

      @Stability(Stable) public void setPlacementTemplate(@NotNull IResolvable value)
      An object describing the project's placement specifications.

    • setPlacementTemplate

      @Stability(Stable) public void setPlacementTemplate(@NotNull CfnProject.PlacementTemplateProperty value)
      An object describing the project's placement specifications.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the project.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the project.

    • getProjectName

      @Stability(Stable) @Nullable public String getProjectName()
      The name of the project from which to obtain information.

    • setProjectName

      @Stability(Stable) public void setProjectName(@Nullable String value)
      The name of the project from which to obtain information.