iot/aws.sdk.kotlin.services.iot.model/CreateCommandRequest/Builder

Builder

Properties

A unique identifier for the command. We recommend using UUID. Alpha-numeric characters, hyphens, and underscores are valid for use here.

description

var description: String?

A short text decription of the command.

displayName

var displayName: String?

The user-friendly name in the console for the command. This name doesn't have to be unique. You can update the user-friendly name after you define it.

mandatoryParameters

var mandatoryParameters: List<CommandParameter>?

A list of parameters that are used by StartCommandExecution API for execution payload generation.

namespace

var namespace: CommandNamespace?

The namespace of the command. The MQTT reserved topics and validations will be used for command executions according to the namespace setting.

payload

var payload: CommandPayload?

The payload object for the static command.

payloadTemplate

var payloadTemplate: String?

The payload template for the dynamic command.

preprocessor

var preprocessor: CommandPreprocessor?

Configuration that determines how payloadTemplate is processed to generate command execution payload.

roleArn

var roleArn: String?

The IAM role that you must provide when using the AWS-IoT-FleetWise namespace. The role grants IoT Device Management the permission to access IoT FleetWise resources for generating the payload for the command. This field is not supported when you use the AWS-IoT namespace.

Functions

payload

fun payload(block: CommandPayload.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.iot.model.CommandPayload inside the given block

preprocessor

fun preprocessor(block: CommandPreprocessor.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.iot.model.CommandPreprocessor inside the given block