interface CfnCommandProps

Language	Type name
.NET	`Amazon.CDK.AWS.IoT.CfnCommandProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnCommandProps`
Java	`software.amazon.awscdk.services.iot.CfnCommandProps`
Python	`aws_cdk.aws_iot.CfnCommandProps`
TypeScript	`aws-cdk-lib` » `aws_iot` » `CfnCommandProps`

Properties for defining a CfnCommand.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iot as iot } from 'aws-cdk-lib';
const cfnCommandProps: iot.CfnCommandProps = {
  commandId: 'commandId',

  // the properties below are optional
  createdAt: 'createdAt',
  deprecated: false,
  description: 'description',
  displayName: 'displayName',
  lastUpdatedAt: 'lastUpdatedAt',
  mandatoryParameters: [{
    name: 'name',

    // the properties below are optional
    defaultValue: {
      b: false,
      bin: 'bin',
      d: 123,
      i: 123,
      l: 'l',
      s: 's',
      ul: 'ul',
    },
    description: 'description',
    value: {
      b: false,
      bin: 'bin',
      d: 123,
      i: 123,
      l: 'l',
      s: 's',
      ul: 'ul',
    },
  }],
  namespace: 'namespace',
  payload: {
    content: 'content',
    contentType: 'contentType',
  },
  pendingDeletion: false,
  roleArn: 'roleArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
commandId	`string`	The unique identifier of the command.
createdAt?	`string`	The timestamp, when the command was created.
deprecated?	`boolean \|` `IResolvable`	Indicates whether the command has been deprecated.
description?	`string`	The description of the command parameter.
displayName?	`string`	The display name of the command.
lastUpdatedAt?	`string`	The timestamp, when the command was last updated.
mandatoryParameters?	`IResolvable` `\| (IResolvable` `\|` `CommandParameterProperty)[]`
namespace?	`string`	The namespace to which the command belongs.
payload?	`IResolvable` `\|` `CommandPayloadProperty`
pendingDeletion?	`boolean \|` `IResolvable`	Indicates whether the command is pending deletion.
roleArn?	`string`	The customer role associated with the command.
tags?	`CfnTag[]`	The tags to be associated with the command.