Package software.amazon.awscdk.services.iot1click

Class CfnDevice

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

The AWS::IoT1Click::Device resource controls the enabled state of an AWS IoT 1-Click compatible device. For more information, see Device in the AWS IoT 1-Click Devices 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.*;
 CfnDevice cfnDevice = CfnDevice.Builder.create(this, "MyCfnDevice")
         .deviceId("deviceId")
         .enabled(false)
         .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

    • CfnDevice

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

    • CfnDevice

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

    • CfnDevice

      @Stability(Stable) public CfnDevice(@NotNull Construct scope, @NotNull String id, @NotNull CfnDeviceProps props)
      Create a new AWS::IoT1Click::Device.

      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 ARN of the device, such as arn:aws:iot1click:us-west-2:123456789012:devices/G030PX0312744DWM .

    • getAttrDeviceId

      @Stability(Stable) @NotNull public String getAttrDeviceId()
      The unique identifier of the device.

    • getAttrEnabled

      @Stability(Stable) @NotNull public IResolvable getAttrEnabled()
      A Boolean value indicating whether the device is enabled ( true ) or not ( false ).

    • getCfnProperties

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

    • getDeviceId

      @Stability(Stable) @NotNull public String getDeviceId()
      The ID of the device, such as G030PX0312744DWM .

    • setDeviceId

      @Stability(Stable) public void setDeviceId(@NotNull String value)
      The ID of the device, such as G030PX0312744DWM .

    • getEnabled

      @Stability(Stable) @NotNull public Object getEnabled()
      A Boolean value indicating whether the device is enabled ( true ) or not ( false ).

    • setEnabled

      @Stability(Stable) public void setEnabled(@NotNull Boolean value)
      A Boolean value indicating whether the device is enabled ( true ) or not ( false ).

    • setEnabled

      @Stability(Stable) public void setEnabled(@NotNull IResolvable value)
      A Boolean value indicating whether the device is enabled ( true ) or not ( false ).