AWS::IoT::Command - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::IoT::Command

The AWS::IoT::Command resource Property description not available. for IoT.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IoT::Command",
  "Properties" : {
      "CommandId" : String,
      "CreatedAt" : String,
      "Deprecated" : Boolean,
      "Description" : String,
      "DisplayName" : String,
      "LastUpdatedAt" : String,
      "MandatoryParameters" : [ CommandParameter, ... ],
      "Namespace" : String,
      "Payload" : CommandPayload,
      "PendingDeletion" : Boolean,
      "RoleArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::IoT::Command
Properties:
  CommandId: String
  CreatedAt: String
  Deprecated: Boolean
  Description: String
  DisplayName: String
  LastUpdatedAt: String
  MandatoryParameters: 
    - CommandParameter
  Namespace: String
  Payload: 
    CommandPayload
  PendingDeletion: Boolean
  RoleArn: String
  Tags: 
    - Tag

Properties

CommandId

The unique identifier of the command.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]+$

Minimum: 1

Maximum: 64

Update requires: Replacement

CreatedAt

The timestamp, when the command was created.

Required: No

Type: String

Update requires: No interruption

Deprecated

Indicates whether the command has been deprecated.

Required: No

Type: Boolean

Update requires: No interruption

Description

The description of the command parameter.

Required: No

Type: String

Maximum: 2028

Update requires: No interruption

DisplayName

The display name of the command.

Required: No

Type: String

Update requires: No interruption

LastUpdatedAt

The timestamp, when the command was last updated.

Required: No

Type: String

Update requires: No interruption

MandatoryParameters

Property description not available.

Required: No

Type: Array of CommandParameter

Minimum: 1

Update requires: No interruption

Namespace

Property description not available.

Required: No

Type: String

Allowed values: AWS-IoT | AWS-IoT-FleetWise

Update requires: No interruption

Payload

Property description not available.

Required: No

Type: CommandPayload

Update requires: No interruption

PendingDeletion

Indicates whether the command is pending deletion.

Required: No

Type: Boolean

Update requires: No interruption

RoleArn

Property description not available.

Required: No

Type: String

Minimum: 20

Maximum: 2028

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

CommandArn

The Amazon Resource Name (ARN) of the command.