Package software.amazon.awscdk.services.iot1click

Class CfnDevice

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.iot1click.CfnDevice

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:09.563Z")
@Stability(Stable)
public class CfnDevice
extends CfnResource
implements IInspectable

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-device.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnDevice.Builder	A fluent builder for CfnDevice.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDevice(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDevice(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDevice(software.constructs.Construct scope, String id, CfnDeviceProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The ARN of the device, such as arn:aws:iot1click:us-west-2:123456789012:devices/G030PX0312744DWM .
String	getAttrDeviceId()	The unique identifier of the device.
IResolvable	getAttrEnabled()	A Boolean value indicating whether the device is enabled ( true ) or not ( false ).
protected Map<String,Object>	getCfnProperties()
String	getDeviceId()	The ID of the device, such as G030PX0312744DWM .
Object	getEnabled()	A Boolean value indicating whether the device is enabled ( true ) or not ( false ).
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDeviceId(String value)	The ID of the device, such as G030PX0312744DWM .
void	setEnabled(Boolean value)	A Boolean value indicating whether the device is enabled ( true ) or not ( false ).
void	setEnabled(IResolvable value)	A Boolean value indicating whether the device is enabled ( true ) or not ( false ).

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDeviceProps 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

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