We recommend new projects start with resources from the AWS provider.
We recommend new projects start with resources from the AWS provider.
Represents the resource definition of AWS IoT Command.
Create Command Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Command(name: string, args: CommandArgs, opts?: CustomResourceOptions);@overload
def Command(resource_name: str,
args: CommandArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Command(resource_name: str,
opts: Optional[ResourceOptions] = None,
command_id: Optional[str] = None,
created_at: Optional[str] = None,
deprecated: Optional[bool] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
last_updated_at: Optional[str] = None,
mandatory_parameters: Optional[Sequence[CommandParameterArgs]] = None,
namespace: Optional[CommandNamespace] = None,
payload: Optional[CommandPayloadArgs] = None,
payload_template: Optional[str] = None,
pending_deletion: Optional[bool] = None,
preprocessor: Optional[CommandPreprocessorArgs] = None,
role_arn: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewCommand(ctx *Context, name string, args CommandArgs, opts ...ResourceOption) (*Command, error)public Command(string name, CommandArgs args, CustomResourceOptions? opts = null)
public Command(String name, CommandArgs args)
public Command(String name, CommandArgs args, CustomResourceOptions options)
type: aws-native:iot:Command
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args CommandArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CommandArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CommandArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CommandArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CommandArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Command Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Command resource accepts the following input properties:
- Command
Id string - The unique identifier for the command.
- Created
At string - The date and time when the command was created.
- Deprecated bool
- A flag indicating whether the command is deprecated.
- Description string
- The description of the command.
- Display
Name string - The display name for the command.
- Last
Updated stringAt - The date and time when the command was last updated.
- Mandatory
Parameters List<Pulumi.Aws Native. Io T. Inputs. Command Parameter> - The list of mandatory parameters for the command.
- Namespace
Pulumi.
Aws Native. Io T. Command Namespace - The namespace to which the command belongs.
- Payload
Pulumi.
Aws Native. Io T. Inputs. Command Payload - The payload associated with the command.
- Payload
Template string - The payload template associated with the command.
- Pending
Deletion bool - A flag indicating whether the command is pending deletion.
- Preprocessor
Pulumi.
Aws Native. Io T. Inputs. Command Preprocessor - The command preprocessor configuration.
- Role
Arn string - The customer role associated with the command.
-
List<Pulumi.
Aws Native. Inputs. Tag> - The tags to be associated with the command.
- Command
Id string - The unique identifier for the command.
- Created
At string - The date and time when the command was created.
- Deprecated bool
- A flag indicating whether the command is deprecated.
- Description string
- The description of the command.
- Display
Name string - The display name for the command.
- Last
Updated stringAt - The date and time when the command was last updated.
- Mandatory
Parameters []CommandParameter Args - The list of mandatory parameters for the command.
- Namespace
Command
Namespace - The namespace to which the command belongs.
- Payload
Command
Payload Args - The payload associated with the command.
- Payload
Template string - The payload template associated with the command.
- Pending
Deletion bool - A flag indicating whether the command is pending deletion.
- Preprocessor
Command
Preprocessor Args - The command preprocessor configuration.
- Role
Arn string - The customer role associated with the command.
-
Tag
Args - The tags to be associated with the command.
- command
Id String - The unique identifier for the command.
- created
At String - The date and time when the command was created.
- deprecated Boolean
- A flag indicating whether the command is deprecated.
- description String
- The description of the command.
- display
Name String - The display name for the command.
- last
Updated StringAt - The date and time when the command was last updated.
- mandatory
Parameters List<CommandParameter> - The list of mandatory parameters for the command.
- namespace
Command
Namespace - The namespace to which the command belongs.
- payload
Command
Payload - The payload associated with the command.
- payload
Template String - The payload template associated with the command.
- pending
Deletion Boolean - A flag indicating whether the command is pending deletion.
- preprocessor
Command
Preprocessor - The command preprocessor configuration.
- role
Arn String - The customer role associated with the command.
- List<Tag>
- The tags to be associated with the command.
- command
Id string - The unique identifier for the command.
- created
At string - The date and time when the command was created.
- deprecated boolean
- A flag indicating whether the command is deprecated.
- description string
- The description of the command.
- display
Name string - The display name for the command.
- last
Updated stringAt - The date and time when the command was last updated.
- mandatory
Parameters CommandParameter[] - The list of mandatory parameters for the command.
- namespace
Command
Namespace - The namespace to which the command belongs.
- payload
Command
Payload - The payload associated with the command.
- payload
Template string - The payload template associated with the command.
- pending
Deletion boolean - A flag indicating whether the command is pending deletion.
- preprocessor
Command
Preprocessor - The command preprocessor configuration.
- role
Arn string - The customer role associated with the command.
- Tag[]
- The tags to be associated with the command.
- command_
id str - The unique identifier for the command.
- created_
at str - The date and time when the command was created.
- deprecated bool
- A flag indicating whether the command is deprecated.
- description str
- The description of the command.
- display_
name str - The display name for the command.
- last_
updated_ strat - The date and time when the command was last updated.
- mandatory_
parameters Sequence[CommandParameter Args] - The list of mandatory parameters for the command.
- namespace
Command
Namespace - The namespace to which the command belongs.
- payload
Command
Payload Args - The payload associated with the command.
- payload_
template str - The payload template associated with the command.
- pending_
deletion bool - A flag indicating whether the command is pending deletion.
- preprocessor
Command
Preprocessor Args - The command preprocessor configuration.
- role_
arn str - The customer role associated with the command.
-
Sequence[Tag
Args] - The tags to be associated with the command.
- command
Id String - The unique identifier for the command.
- created
At String - The date and time when the command was created.
- deprecated Boolean
- A flag indicating whether the command is deprecated.
- description String
- The description of the command.
- display
Name String - The display name for the command.
- last
Updated StringAt - The date and time when the command was last updated.
- mandatory
Parameters List<Property Map> - The list of mandatory parameters for the command.
- namespace
"AWS-Io
T" | "AWS-Io T-Fleet Wise" - The namespace to which the command belongs.
- payload Property Map
- The payload associated with the command.
- payload
Template String - The payload template associated with the command.
- pending
Deletion Boolean - A flag indicating whether the command is pending deletion.
- preprocessor Property Map
- The command preprocessor configuration.
- role
Arn String - The customer role associated with the command.
- List<Property Map>
- The tags to be associated with the command.
Outputs
All input properties are implicitly available as output properties. Additionally, the Command resource produces the following output properties:
- Command
Arn string - The Amazon Resource Name (ARN) of the command.
- Id string
- The provider-assigned unique ID for this managed resource.
- Command
Arn string - The Amazon Resource Name (ARN) of the command.
- Id string
- The provider-assigned unique ID for this managed resource.
- command
Arn String - The Amazon Resource Name (ARN) of the command.
- id String
- The provider-assigned unique ID for this managed resource.
- command
Arn string - The Amazon Resource Name (ARN) of the command.
- id string
- The provider-assigned unique ID for this managed resource.
- command_
arn str - The Amazon Resource Name (ARN) of the command.
- id str
- The provider-assigned unique ID for this managed resource.
- command
Arn String - The Amazon Resource Name (ARN) of the command.
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
CommandAwsJsonSubstitutionCommandPreprocessorConfig, CommandAwsJsonSubstitutionCommandPreprocessorConfigArgs
CommandNamespace, CommandNamespaceArgs
- Aws
Io T AWS-IoT- Aws
Io TFleet Wise AWS-IoT-FleetWise
- Command
Namespace Aws Io T AWS-IoT- Command
Namespace Aws Io TFleet Wise AWS-IoT-FleetWise
- Aws
Io T AWS-IoT- Aws
Io TFleet Wise AWS-IoT-FleetWise
- Aws
Io T AWS-IoT- Aws
Io TFleet Wise AWS-IoT-FleetWise
- AWS_IO_T
AWS-IoT- AWS_IO_T_FLEET_WISE
AWS-IoT-FleetWise
- "AWS-Io
T" AWS-IoT- "AWS-Io
T-Fleet Wise" AWS-IoT-FleetWise
CommandOutputFormat, CommandOutputFormatArgs
- Json
JSON- Cbor
CBOR
- Command
Output Format Json JSON- Command
Output Format Cbor CBOR
- Json
JSON- Cbor
CBOR
- Json
JSON- Cbor
CBOR
- JSON
JSON- CBOR
CBOR
- "JSON"
JSON- "CBOR"
CBOR
CommandParameter, CommandParameterArgs
CommandParameterType, CommandParameterTypeArgs
- String
STRING- Integer
INTEGER- Double
DOUBLE- Long
LONG- Unsignedlong
UNSIGNEDLONG- Boolean
BOOLEAN- Binary
BINARY
- Command
Parameter Type String STRING- Command
Parameter Type Integer INTEGER- Command
Parameter Type Double DOUBLE- Command
Parameter Type Long LONG- Command
Parameter Type Unsignedlong UNSIGNEDLONG- Command
Parameter Type Boolean BOOLEAN- Command
Parameter Type Binary BINARY
- String
STRING- Integer
INTEGER- Double
DOUBLE- Long
LONG- Unsignedlong
UNSIGNEDLONG- Boolean
BOOLEAN- Binary
BINARY
- String
STRING- Integer
INTEGER- Double
DOUBLE- Long
LONG- Unsignedlong
UNSIGNEDLONG- Boolean
BOOLEAN- Binary
BINARY
- STRING
STRING- INTEGER
INTEGER- DOUBLE
DOUBLE- LONG
LONG- UNSIGNEDLONG
UNSIGNEDLONG- BOOLEAN
BOOLEAN- BINARY
BINARY
- "STRING"
STRING- "INTEGER"
INTEGER- "DOUBLE"
DOUBLE- "LONG"
LONG- "UNSIGNEDLONG"
UNSIGNEDLONG- "BOOLEAN"
BOOLEAN- "BINARY"
BINARY
CommandParameterValue, CommandParameterValueArgs
CommandParameterValueComparisonOperand, CommandParameterValueComparisonOperandArgs
- Number string
- Number
Range Pulumi.Aws Native. Io T. Inputs. Command Parameter Value Number Range - Numbers List<string>
- String string
- Strings List<string>
- Number string
- Number
Range CommandParameter Value Number Range - Numbers []string
- String string
- Strings []string
- number String
- number
Range CommandParameter Value Number Range - numbers List<String>
- string String
- strings List<String>
- number string
- number
Range CommandParameter Value Number Range - numbers string[]
- string string
- strings string[]
- number str
- number_
range CommandParameter Value Number Range - numbers Sequence[str]
- string str
- strings Sequence[str]
- number String
- number
Range Property Map - numbers List<String>
- string String
- strings List<String>
CommandParameterValueComparisonOperator, CommandParameterValueComparisonOperatorArgs
- Equals
Value EQUALS- Not
Equals NOT_EQUALS- Less
Than LESS_THAN- Less
Than Equals LESS_THAN_EQUALS- Greater
Than GREATER_THAN- Greater
Than Equals GREATER_THAN_EQUALS- In
Set IN_SET- Not
In Set NOT_IN_SET- In
Range IN_RANGE- Not
In Range NOT_IN_RANGE
- Command
Parameter Value Comparison Operator Equals EQUALS- Command
Parameter Value Comparison Operator Not Equals NOT_EQUALS- Command
Parameter Value Comparison Operator Less Than LESS_THAN- Command
Parameter Value Comparison Operator Less Than Equals LESS_THAN_EQUALS- Command
Parameter Value Comparison Operator Greater Than GREATER_THAN- Command
Parameter Value Comparison Operator Greater Than Equals GREATER_THAN_EQUALS- Command
Parameter Value Comparison Operator In Set IN_SET- Command
Parameter Value Comparison Operator Not In Set NOT_IN_SET- Command
Parameter Value Comparison Operator In Range IN_RANGE- Command
Parameter Value Comparison Operator Not In Range NOT_IN_RANGE
- Equals
EQUALS- Not
Equals NOT_EQUALS- Less
Than LESS_THAN- Less
Than Equals LESS_THAN_EQUALS- Greater
Than GREATER_THAN- Greater
Than Equals GREATER_THAN_EQUALS- In
Set IN_SET- Not
In Set NOT_IN_SET- In
Range IN_RANGE- Not
In Range NOT_IN_RANGE
- Equals
EQUALS- Not
Equals NOT_EQUALS- Less
Than LESS_THAN- Less
Than Equals LESS_THAN_EQUALS- Greater
Than GREATER_THAN- Greater
Than Equals GREATER_THAN_EQUALS- In
Set IN_SET- Not
In Set NOT_IN_SET- In
Range IN_RANGE- Not
In Range NOT_IN_RANGE
- EQUALS
EQUALS- NOT_EQUALS
NOT_EQUALS- LESS_THAN
LESS_THAN- LESS_THAN_EQUALS
LESS_THAN_EQUALS- GREATER_THAN
GREATER_THAN- GREATER_THAN_EQUALS
GREATER_THAN_EQUALS- IN_SET
IN_SET- NOT_IN_SET
NOT_IN_SET- IN_RANGE
IN_RANGE- NOT_IN_RANGE
NOT_IN_RANGE
- "EQUALS"
EQUALS- "NOT_EQUALS"
NOT_EQUALS- "LESS_THAN"
LESS_THAN- "LESS_THAN_EQUALS"
LESS_THAN_EQUALS- "GREATER_THAN"
GREATER_THAN- "GREATER_THAN_EQUALS"
GREATER_THAN_EQUALS- "IN_SET"
IN_SET- "NOT_IN_SET"
NOT_IN_SET- "IN_RANGE"
IN_RANGE- "NOT_IN_RANGE"
NOT_IN_RANGE
CommandParameterValueCondition, CommandParameterValueConditionArgs
CommandParameterValueNumberRange, CommandParameterValueNumberRangeArgs
CommandPayload, CommandPayloadArgs
- Content string
- Content
Type string
- Content string
- Content
Type string
- content String
- content
Type String
- content string
- content
Type string
- content str
- content_
type str
- content String
- content
Type String
CommandPreprocessor, CommandPreprocessorArgs
Tag, TagArgs
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
