Package software.amazon.awscdk.services.iot1click

Class CfnPlacement

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.CfnPlacement
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.729Z") @Stability(Stable) public class CfnPlacement extends CfnResource implements IInspectable
A CloudFormation AWS::IoT1Click::Placement.

The AWS::IoT1Click::Placement resource creates a placement to be associated with an AWS IoT 1-Click project. A placement is an instance of a device in a location. For more information, see Projects, Templates, and Placements in the AWS IoT 1-Click Developer Guide .

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 associatedDevices;
 Object attributes;
 CfnPlacement cfnPlacement = CfnPlacement.Builder.create(this, "MyCfnPlacement")
         .projectName("projectName")
         // the properties below are optional
         .associatedDevices(associatedDevices)
         .attributes(attributes)
         .placementName("placementName")
         .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

    • CfnPlacement

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

    • CfnPlacement

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

    • CfnPlacement

      @Stability(Stable) public CfnPlacement(@NotNull Construct scope, @NotNull String id, @NotNull CfnPlacementProps props)
      Create a new AWS::IoT1Click::Placement.

      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.

    • getAttrPlacementName

      @Stability(Stable) @NotNull public String getAttrPlacementName()
      The name of the placement, such as floor17 .

    • getAttrProjectName

      @Stability(Stable) @NotNull public String getAttrProjectName()
      The name of the project containing the placement, such as conference-rooms .

    • getCfnProperties

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

    • getAssociatedDevices

      @Stability(Stable) @NotNull public Object getAssociatedDevices()
      The devices to associate with the placement, as defined by a mapping of zero or more key-value pairs wherein the key is a template name and the value is a device ID.

    • setAssociatedDevices

      @Stability(Stable) public void setAssociatedDevices(@NotNull Object value)
      The devices to associate with the placement, as defined by a mapping of zero or more key-value pairs wherein the key is a template name and the value is a device ID.

    • getAttributes

      @Stability(Stable) @NotNull public Object getAttributes()
      The user-defined attributes associated with the placement.

    • setAttributes

      @Stability(Stable) public void setAttributes(@NotNull Object value)
      The user-defined attributes associated with the placement.

    • getProjectName

      @Stability(Stable) @NotNull public String getProjectName()
      The name of the project containing the placement.

    • setProjectName

      @Stability(Stable) public void setProjectName(@NotNull String value)
      The name of the project containing the placement.

    • getPlacementName

      @Stability(Stable) @Nullable public String getPlacementName()
      The name of the placement.

    • setPlacementName

      @Stability(Stable) public void setPlacementName(@Nullable String value)
      The name of the placement.