1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iot
  5. Command

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi

aws-native.iot.Command

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi

    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,
                pending_deletion: Optional[bool] = 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:

    CommandId string
    The unique identifier for the command.
    CreatedAt 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.
    DisplayName string
    The display name for the command.
    LastUpdatedAt string
    The date and time when the command was last updated.
    MandatoryParameters List<Pulumi.AwsNative.IoT.Inputs.CommandParameter>
    The list of mandatory parameters for the command.
    Namespace Pulumi.AwsNative.IoT.CommandNamespace
    The namespace to which the command belongs.
    Payload Pulumi.AwsNative.IoT.Inputs.CommandPayload
    The payload associated with the command.
    PendingDeletion bool
    A flag indicating whether the command is pending deletion.
    RoleArn string
    The customer role associated with the command.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags to be associated with the command.
    CommandId string
    The unique identifier for the command.
    CreatedAt 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.
    DisplayName string
    The display name for the command.
    LastUpdatedAt string
    The date and time when the command was last updated.
    MandatoryParameters []CommandParameterArgs
    The list of mandatory parameters for the command.
    Namespace CommandNamespace
    The namespace to which the command belongs.
    Payload CommandPayloadArgs
    The payload associated with the command.
    PendingDeletion bool
    A flag indicating whether the command is pending deletion.
    RoleArn string
    The customer role associated with the command.
    Tags TagArgs
    The tags to be associated with the command.
    commandId String
    The unique identifier for the command.
    createdAt 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.
    displayName String
    The display name for the command.
    lastUpdatedAt String
    The date and time when the command was last updated.
    mandatoryParameters List<CommandParameter>
    The list of mandatory parameters for the command.
    namespace CommandNamespace
    The namespace to which the command belongs.
    payload CommandPayload
    The payload associated with the command.
    pendingDeletion Boolean
    A flag indicating whether the command is pending deletion.
    roleArn String
    The customer role associated with the command.
    tags List<Tag>
    The tags to be associated with the command.
    commandId string
    The unique identifier for the command.
    createdAt 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.
    displayName string
    The display name for the command.
    lastUpdatedAt string
    The date and time when the command was last updated.
    mandatoryParameters CommandParameter[]
    The list of mandatory parameters for the command.
    namespace CommandNamespace
    The namespace to which the command belongs.
    payload CommandPayload
    The payload associated with the command.
    pendingDeletion boolean
    A flag indicating whether the command is pending deletion.
    roleArn string
    The customer role associated with the command.
    tags 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_at str
    The date and time when the command was last updated.
    mandatory_parameters Sequence[CommandParameterArgs]
    The list of mandatory parameters for the command.
    namespace CommandNamespace
    The namespace to which the command belongs.
    payload CommandPayloadArgs
    The payload associated with the command.
    pending_deletion bool
    A flag indicating whether the command is pending deletion.
    role_arn str
    The customer role associated with the command.
    tags Sequence[TagArgs]
    The tags to be associated with the command.
    commandId String
    The unique identifier for the command.
    createdAt 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.
    displayName String
    The display name for the command.
    lastUpdatedAt String
    The date and time when the command was last updated.
    mandatoryParameters List<Property Map>
    The list of mandatory parameters for the command.
    namespace "AWS-IoT" | "AWS-IoT-FleetWise"
    The namespace to which the command belongs.
    payload Property Map
    The payload associated with the command.
    pendingDeletion Boolean
    A flag indicating whether the command is pending deletion.
    roleArn String
    The customer role associated with the command.
    tags 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:

    CommandArn string
    The Amazon Resource Name (ARN) of the command.
    Id string
    The provider-assigned unique ID for this managed resource.
    CommandArn string
    The Amazon Resource Name (ARN) of the command.
    Id string
    The provider-assigned unique ID for this managed resource.
    commandArn String
    The Amazon Resource Name (ARN) of the command.
    id String
    The provider-assigned unique ID for this managed resource.
    commandArn 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.
    commandArn String
    The Amazon Resource Name (ARN) of the command.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    CommandNamespace, CommandNamespaceArgs

    AwsIoT
    AWS-IoT
    AwsIoTFleetWise
    AWS-IoT-FleetWise
    CommandNamespaceAwsIoT
    AWS-IoT
    CommandNamespaceAwsIoTFleetWise
    AWS-IoT-FleetWise
    AwsIoT
    AWS-IoT
    AwsIoTFleetWise
    AWS-IoT-FleetWise
    AwsIoT
    AWS-IoT
    AwsIoTFleetWise
    AWS-IoT-FleetWise
    AWS_IO_T
    AWS-IoT
    AWS_IO_T_FLEET_WISE
    AWS-IoT-FleetWise
    "AWS-IoT"
    AWS-IoT
    "AWS-IoT-FleetWise"
    AWS-IoT-FleetWise

    CommandParameter, CommandParameterArgs

    CommandParameterValue, CommandParameterValueArgs

    B bool
    Bin string
    D double
    I int
    L string
    S string
    Ul string
    B bool
    Bin string
    D float64
    I int
    L string
    S string
    Ul string
    b Boolean
    bin String
    d Double
    i Integer
    l String
    s String
    ul String
    b boolean
    bin string
    d number
    i number
    l string
    s string
    ul string
    b bool
    bin str
    d float
    i int
    l str
    s str
    ul str
    b Boolean
    bin String
    d Number
    i Number
    l String
    s String
    ul String

    CommandPayload, CommandPayloadArgs

    Content string
    ContentType string
    Content string
    ContentType string
    content String
    contentType String
    content string
    contentType string
    content String
    contentType String

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi