Package software.amazon.awscdk.services.iot

Class CfnCommand

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.iot.CfnCommand
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, ICommandRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:07.552Z") @Stability(Stable) public class CfnCommand extends CfnResource implements IInspectable, ICommandRef, ITaggableV2
Represents the resource definition of AWS IoT Command.

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.*;
 CfnCommand cfnCommand = CfnCommand.Builder.create(this, "MyCfnCommand")
         .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:

  • 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

    • CfnCommand

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

    • CfnCommand

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

    • CfnCommand

      @Stability(Stable) public CfnCommand(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCommandProps 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

    • fromCommandArn

      @Stability(Stable) @NotNull public static ICommandRef fromCommandArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new ICommandRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromCommandId

      @Stability(Stable) @NotNull public static ICommandRef fromCommandId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String commandId)
      Creates a new ICommandRef from a commandId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      commandId - This parameter is required.

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

    • getAttrCommandArn

      @Stability(Stable) @NotNull public String getAttrCommandArn()
      The Amazon Resource Name (ARN) of the command.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

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

    • getCommandRef

      @Stability(Stable) @NotNull public CommandReference getCommandRef()
      A reference to a Command resource.
      Specified by:
      getCommandRef in interface ICommandRef

    • getCommandId

      @Stability(Stable) @NotNull public String getCommandId()
      The unique identifier of the command.

    • setCommandId

      @Stability(Stable) public void setCommandId(@NotNull String value)
      The unique identifier of the command.

    • getCreatedAt

      @Stability(Stable) @Nullable public String getCreatedAt()
      The timestamp, when the command was created.

    • setCreatedAt

      @Stability(Stable) public void setCreatedAt(@Nullable String value)
      The timestamp, when the command was created.

    • getDeprecated

      @Stability(Stable) @Nullable public Object getDeprecated()
      Indicates whether the command has been deprecated.

      Returns union: either Boolean or IResolvable

    • setDeprecated

      @Stability(Stable) public void setDeprecated(@Nullable Boolean value)
      Indicates whether the command has been deprecated.

    • setDeprecated

      @Stability(Stable) public void setDeprecated(@Nullable IResolvable value)
      Indicates whether the command has been deprecated.

    • getDescription

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

    • setDescription

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

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The display name of the command.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The display name of the command.

    • getLastUpdatedAt

      @Stability(Stable) @Nullable public String getLastUpdatedAt()
      The timestamp, when the command was last updated.

    • setLastUpdatedAt

      @Stability(Stable) public void setLastUpdatedAt(@Nullable String value)
      The timestamp, when the command was last updated.

    • getMandatoryParameters

      @Stability(Stable) @Nullable public Object getMandatoryParameters()
      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCommand.CommandParameterProperty>

    • setMandatoryParameters

      @Stability(Stable) public void setMandatoryParameters(@Nullable IResolvable value)

    • setMandatoryParameters

      @Stability(Stable) public void setMandatoryParameters(@Nullable List<Object> value)

    • getNamespace

      @Stability(Stable) @Nullable public String getNamespace()
      The namespace to which the command belongs.

    • setNamespace

      @Stability(Stable) public void setNamespace(@Nullable String value)
      The namespace to which the command belongs.

    • getPayload

      @Stability(Stable) @Nullable public Object getPayload()
      Returns union: either IResolvable or CfnCommand.CommandPayloadProperty

    • setPayload

      @Stability(Stable) public void setPayload(@Nullable IResolvable value)

    • setPayload

      @Stability(Stable) public void setPayload(@Nullable CfnCommand.CommandPayloadProperty value)

    • getPendingDeletion

      @Stability(Stable) @Nullable public Object getPendingDeletion()
      Indicates whether the command is pending deletion.

      Returns union: either Boolean or IResolvable

    • setPendingDeletion

      @Stability(Stable) public void setPendingDeletion(@Nullable Boolean value)
      Indicates whether the command is pending deletion.

    • setPendingDeletion

      @Stability(Stable) public void setPendingDeletion(@Nullable IResolvable value)
      Indicates whether the command is pending deletion.

    • getRoleArn

      @Stability(Stable) @Nullable public String getRoleArn()
      The customer role associated with the command.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@Nullable String value)
      The customer role associated with the command.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags to be associated with the command.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags to be associated with the command.