CfnCommandPropsMixin

class aws_cdk.mixins_preview.aws_iot.mixins.CfnCommandPropsMixin(props, *, strategy=None)

Bases: Mixin

Represents the resource definition of AWS IoT Command.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-command.html
CloudformationResource:: AWS::IoT::Command
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_iot import mixins as iot_mixins

cfn_command_props_mixin = iot_mixins.CfnCommandPropsMixin(iot_mixins.CfnCommandMixinProps(
    command_id="commandId",
    created_at="createdAt",
    deprecated=False,
    description="description",
    display_name="displayName",
    last_updated_at="lastUpdatedAt",
    mandatory_parameters=[iot_mixins.CfnCommandPropsMixin.CommandParameterProperty(
        default_value=iot_mixins.CfnCommandPropsMixin.CommandParameterValueProperty(
            b=False,
            bin="bin",
            d=123,
            i=123,
            l="l",
            s="s",
            ul="ul"
        ),
        description="description",
        name="name",
        value=iot_mixins.CfnCommandPropsMixin.CommandParameterValueProperty(
            b=False,
            bin="bin",
            d=123,
            i=123,
            l="l",
            s="s",
            ul="ul"
        )
    )],
    namespace="namespace",
    payload=iot_mixins.CfnCommandPropsMixin.CommandPayloadProperty(
        content="content",
        content_type="contentType"
    ),
    pending_deletion=False,
    role_arn="roleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoT::Command.

Parameters:

props (Union[CfnCommandMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['commandId', 'createdAt', 'deprecated', 'description', 'displayName', 'lastUpdatedAt', 'mandatoryParameters', 'namespace', 'payload', 'pendingDeletion', 'roleArn', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CommandParameterProperty

class CfnCommandPropsMixin.CommandParameterProperty(*, default_value=None, description=None, name=None, value=None)

Bases: object

Parameters:

default_value (Union[IResolvable, CommandParameterValueProperty, Dict[str, Any], None])
description (Optional[str])
name (Optional[str])
value (Union[IResolvable, CommandParameterValueProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparameter.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.mixins_preview.aws_iot import mixins as iot_mixins

command_parameter_property = iot_mixins.CfnCommandPropsMixin.CommandParameterProperty(
    default_value=iot_mixins.CfnCommandPropsMixin.CommandParameterValueProperty(
        b=False,
        bin="bin",
        d=123,
        i=123,
        l="l",
        s="s",
        ul="ul"
    ),
    description="description",
    name="name",
    value=iot_mixins.CfnCommandPropsMixin.CommandParameterValueProperty(
        b=False,
        bin="bin",
        d=123,
        i=123,
        l="l",
        s="s",
        ul="ul"
    )
)

Attributes

default_value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparameter.html#cfn-iot-command-commandparameter-defaultvalue

Type:: see

description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparameter.html#cfn-iot-command-commandparameter-description

Type:: see

name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparameter.html#cfn-iot-command-commandparameter-name

Type:: see

value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparameter.html#cfn-iot-command-commandparameter-value

Type:: see

CommandParameterValueProperty

class CfnCommandPropsMixin.CommandParameterValueProperty(*, b=None, bin=None, d=None, i=None, l=None, s=None, ul=None)

Bases: object

Parameters:

b (Union[bool, IResolvable, None])
bin (Optional[str])
d (Union[int, float, None])
i (Union[int, float, None])
l (Optional[str])
s (Optional[str])
ul (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparametervalue.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.mixins_preview.aws_iot import mixins as iot_mixins

command_parameter_value_property = iot_mixins.CfnCommandPropsMixin.CommandParameterValueProperty(
    b=False,
    bin="bin",
    d=123,
    i=123,
    l="l",
    s="s",
    ul="ul"
)

Attributes

b

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparametervalue.html#cfn-iot-command-commandparametervalue-b

Type:: see

bin

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparametervalue.html#cfn-iot-command-commandparametervalue-bin

Type:: see

d

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparametervalue.html#cfn-iot-command-commandparametervalue-d

Type:: see

i

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparametervalue.html#cfn-iot-command-commandparametervalue-i

Type:: see

l

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparametervalue.html#cfn-iot-command-commandparametervalue-l

Type:: see

s

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparametervalue.html#cfn-iot-command-commandparametervalue-s

Type:: see

ul

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparametervalue.html#cfn-iot-command-commandparametervalue-ul

Type:: see

CommandPayloadProperty

class CfnCommandPropsMixin.CommandPayloadProperty(*, content=None, content_type=None)

Bases: object

Parameters:

content (Optional[str])
content_type (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandpayload.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.mixins_preview.aws_iot import mixins as iot_mixins

command_payload_property = iot_mixins.CfnCommandPropsMixin.CommandPayloadProperty(
    content="content",
    content_type="contentType"
)

Attributes

content

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandpayload.html#cfn-iot-command-commandpayload-content

Type:: see

content_type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandpayload.html#cfn-iot-command-commandpayload-contenttype

Type:: see