Package software.amazon.awscdk.services.iot

Interface CfnCommandProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCommandProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:40.065Z")
@Stability(Stable)
public interface CfnCommandProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCommand.

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.iot.*;
 CfnCommandProps cfnCommandProps = CfnCommandProps.builder()
         .commandId("commandId")
         // the properties below are optional
         .createdAt("createdAt")
         .deprecated(false)
         .description("description")
         .displayName("displayName")
         .lastUpdatedAt("lastUpdatedAt")
         .mandatoryParameters(List.of(CommandParameterProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .defaultValue(CommandParameterValueProperty.builder()
                         .b(false)
                         .bin("bin")
                         .d(123)
                         .i(123)
                         .l("l")
                         .s("s")
                         .ul("ul")
                         .build())
                 .description("description")
                 .value(CommandParameterValueProperty.builder()
                         .b(false)
                         .bin("bin")
                         .d(123)
                         .i(123)
                         .l("l")
                         .s("s")
                         .ul("ul")
                         .build())
                 .build()))
         .namespace("namespace")
         .payload(CommandPayloadProperty.builder()
                 .content("content")
                 .contentType("contentType")
                 .build())
         .pendingDeletion(false)
         .roleArn("roleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-command.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCommandProps.Builder	A builder for CfnCommandProps
static final class	CfnCommandProps.Jsii$Proxy	An implementation for CfnCommandProps

Method Summary

Modifier and Type	Method	Description
static CfnCommandProps.Builder	builder()
String	getCommandId()	The unique identifier of the command.
default String	getCreatedAt()	The timestamp, when the command was created.
default Object	getDeprecated()	Indicates whether the command has been deprecated.
default String	getDescription()	The description of the command parameter.
default String	getDisplayName()	The display name of the command.
default String	getLastUpdatedAt()	The timestamp, when the command was last updated.
default Object	getMandatoryParameters()	Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCommand.CommandParameterProperty>
default String	getNamespace()	The namespace to which the command belongs.
default Object	getPayload()	Returns union: either IResolvable or CfnCommand.CommandPayloadProperty
default Object	getPendingDeletion()	Indicates whether the command is pending deletion.
default String	getRoleArn()	The customer role associated with the command.
default List<CfnTag>	getTags()	The tags to be associated with the command.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCommandId

@Stability(Stable)
@NotNull
String getCommandId()

The unique identifier of the command.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-command.html#cfn-iot-command-commandid

getCreatedAt

@Stability(Stable)
@Nullable
default String getCreatedAt()

The timestamp, when the command was created.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-command.html#cfn-iot-command-createdat

getDeprecated

@Stability(Stable)
@Nullable
default Object getDeprecated()

Indicates whether the command has been deprecated.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-command.html#cfn-iot-command-deprecated

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the command parameter.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-command.html#cfn-iot-command-description

getDisplayName

@Stability(Stable)
@Nullable
default String getDisplayName()

The display name of the command.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-command.html#cfn-iot-command-displayname

getLastUpdatedAt

@Stability(Stable)
@Nullable
default String getLastUpdatedAt()

The timestamp, when the command was last updated.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-command.html#cfn-iot-command-lastupdatedat

getMandatoryParameters

@Stability(Stable)
@Nullable
default Object getMandatoryParameters()

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCommand.CommandParameterProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-command.html#cfn-iot-command-mandatoryparameters

getNamespace

@Stability(Stable)
@Nullable
default String getNamespace()

The namespace to which the command belongs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-command.html#cfn-iot-command-namespace

getPayload

@Stability(Stable)
@Nullable
default Object getPayload()

Returns union: either IResolvable or CfnCommand.CommandPayloadProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-command.html#cfn-iot-command-payload

getPendingDeletion

@Stability(Stable)
@Nullable
default Object getPendingDeletion()

Indicates whether the command is pending deletion.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-command.html#cfn-iot-command-pendingdeletion

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

The customer role associated with the command.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-command.html#cfn-iot-command-rolearn

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags to be associated with the command.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-command.html#cfn-iot-command-tags

builder

@Stability(Stable)
static CfnCommandProps.Builder builder()

Returns:

a CfnCommandProps.Builder of CfnCommandProps