CfnCommandProps
- class aws_cdk.aws_iot.CfnCommandProps(*, command_id, created_at=None, deprecated=None, description=None, display_name=None, last_updated_at=None, mandatory_parameters=None, namespace=None, payload=None, pending_deletion=None, role_arn=None, tags=None)
Bases:
object
Properties for defining a
CfnCommand
.- Parameters:
command_id (
str
) – The unique identifier of the command.created_at (
Optional
[str
]) – The timestamp, when the command was created.deprecated (
Union
[bool
,IResolvable
,None
]) – Indicates whether the command has been deprecated.description (
Optional
[str
]) – The description of the command parameter.display_name (
Optional
[str
]) – The display name of the command.last_updated_at (
Optional
[str
]) – The timestamp, when the command was last updated.mandatory_parameters (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,CommandParameterProperty
,Dict
[str
,Any
]]],None
])namespace (
Optional
[str
]) – The namespace to which the command belongs.payload (
Union
[IResolvable
,CommandPayloadProperty
,Dict
[str
,Any
],None
])pending_deletion (
Union
[bool
,IResolvable
,None
]) – Indicates whether the command is pending deletion.role_arn (
Optional
[str
]) – The customer role associated with the command.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – The tags to be associated with the command.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-command.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_iot as iot cfn_command_props = iot.CfnCommandProps( command_id="commandId", # the properties below are optional created_at="createdAt", deprecated=False, description="description", display_name="displayName", last_updated_at="lastUpdatedAt", mandatory_parameters=[iot.CfnCommand.CommandParameterProperty( name="name", # the properties below are optional default_value=iot.CfnCommand.CommandParameterValueProperty( b=False, bin="bin", d=123, i=123, l="l", s="s", ul="ul" ), description="description", value=iot.CfnCommand.CommandParameterValueProperty( b=False, bin="bin", d=123, i=123, l="l", s="s", ul="ul" ) )], namespace="namespace", payload=iot.CfnCommand.CommandPayloadProperty( content="content", content_type="contentType" ), pending_deletion=False, role_arn="roleArn", tags=[CfnTag( key="key", value="value" )] )
Attributes
- command_id
The unique identifier of the command.
- created_at
The timestamp, when the command was created.
- deprecated
Indicates whether the command has been deprecated.
- description
The description of the command parameter.
- display_name
The display name of the command.
- last_updated_at
The timestamp, when the command was last updated.
- mandatory_parameters
-
- Type:
see
- namespace
The namespace to which the command belongs.
- payload
-
- Type:
see
- pending_deletion
Indicates whether the command is pending deletion.
- role_arn
The customer role associated with the command.
- tags
The tags to be associated with the command.