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:

from aws_cdk import CfnTag
# 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",
        type="type",
        value=iot_mixins.CfnCommandPropsMixin.CommandParameterValueProperty(
            b=False,
            bin="bin",
            d=123,
            i=123,
            l="l",
            s="s",
            ul="ul"
        ),
        value_conditions=[iot_mixins.CfnCommandPropsMixin.CommandParameterValueConditionProperty(
            comparison_operator="comparisonOperator",
            operand=iot_mixins.CfnCommandPropsMixin.CommandParameterValueComparisonOperandProperty(
                number="number",
                number_range=iot_mixins.CfnCommandPropsMixin.CommandParameterValueNumberRangeProperty(
                    max="max",
                    min="min"
                ),
                numbers=["numbers"],
                string="string",
                strings=["strings"]
            )
        )]
    )],
    namespace="namespace",
    payload=iot_mixins.CfnCommandPropsMixin.CommandPayloadProperty(
        content="content",
        content_type="contentType"
    ),
    payload_template="payloadTemplate",
    pending_deletion=False,
    preprocessor=iot_mixins.CfnCommandPropsMixin.CommandPreprocessorProperty(
        aws_json_substitution=iot_mixins.CfnCommandPropsMixin.AwsJsonSubstitutionCommandPreprocessorConfigProperty(
            output_format="outputFormat"
        )
    ),
    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:: None

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', 'payloadTemplate', 'pendingDeletion', 'preprocessor', '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

AwsJsonSubstitutionCommandPreprocessorConfigProperty

class CfnCommandPropsMixin.AwsJsonSubstitutionCommandPreprocessorConfigProperty(*, output_format=None)

Bases: object

Parameters:: output_format (Optional[str])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-awsjsonsubstitutioncommandpreprocessorconfig.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

aws_json_substitution_command_preprocessor_config_property = iot_mixins.CfnCommandPropsMixin.AwsJsonSubstitutionCommandPreprocessorConfigProperty(
    output_format="outputFormat"
)

Attributes

output_format

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

Type:: see

CommandParameterProperty

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

Bases: object

Parameters:

default_value (Union[IResolvable, CommandParameterValueProperty, Dict[str, Any], None])
description (Optional[str])
name (Optional[str])
type (Optional[str])
value (Union[IResolvable, CommandParameterValueProperty, Dict[str, Any], None])
value_conditions (Union[IResolvable, Sequence[Union[IResolvable, CommandParameterValueConditionProperty, 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",
    type="type",
    value=iot_mixins.CfnCommandPropsMixin.CommandParameterValueProperty(
        b=False,
        bin="bin",
        d=123,
        i=123,
        l="l",
        s="s",
        ul="ul"
    ),
    value_conditions=[iot_mixins.CfnCommandPropsMixin.CommandParameterValueConditionProperty(
        comparison_operator="comparisonOperator",
        operand=iot_mixins.CfnCommandPropsMixin.CommandParameterValueComparisonOperandProperty(
            number="number",
            number_range=iot_mixins.CfnCommandPropsMixin.CommandParameterValueNumberRangeProperty(
                max="max",
                min="min"
            ),
            numbers=["numbers"],
            string="string",
            strings=["strings"]
        )
    )]
)

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

type

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

Type:: see

value

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

Type:: see

value_conditions

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

Type:: see

CommandParameterValueComparisonOperandProperty

class CfnCommandPropsMixin.CommandParameterValueComparisonOperandProperty(*, number=None, number_range=None, numbers=None, string=None, strings=None)

Bases: object

Parameters:

number (Optional[str])
number_range (Union[IResolvable, CommandParameterValueNumberRangeProperty, Dict[str, Any], None])
numbers (Optional[Sequence[str]])
string (Optional[str])
strings (Optional[Sequence[str]])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparametervaluecomparisonoperand.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_comparison_operand_property = iot_mixins.CfnCommandPropsMixin.CommandParameterValueComparisonOperandProperty(
    number="number",
    number_range=iot_mixins.CfnCommandPropsMixin.CommandParameterValueNumberRangeProperty(
        max="max",
        min="min"
    ),
    numbers=["numbers"],
    string="string",
    strings=["strings"]
)

Attributes

number

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

Type:: see

number_range

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

Type:: see

numbers

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

Type:: see

string

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

Type:: see

strings

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

Type:: see

CommandParameterValueConditionProperty

class CfnCommandPropsMixin.CommandParameterValueConditionProperty(*, comparison_operator=None, operand=None)

Bases: object

Parameters:

comparison_operator (Optional[str])
operand (Union[IResolvable, CommandParameterValueComparisonOperandProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparametervaluecondition.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_condition_property = iot_mixins.CfnCommandPropsMixin.CommandParameterValueConditionProperty(
    comparison_operator="comparisonOperator",
    operand=iot_mixins.CfnCommandPropsMixin.CommandParameterValueComparisonOperandProperty(
        number="number",
        number_range=iot_mixins.CfnCommandPropsMixin.CommandParameterValueNumberRangeProperty(
            max="max",
            min="min"
        ),
        numbers=["numbers"],
        string="string",
        strings=["strings"]
    )
)

Attributes

comparison_operator

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

Type:: see

operand

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

Type:: see

CommandParameterValueNumberRangeProperty

class CfnCommandPropsMixin.CommandParameterValueNumberRangeProperty(*, max=None, min=None)

Bases: object

Parameters:

max (Optional[str])
min (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparametervaluenumberrange.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_number_range_property = iot_mixins.CfnCommandPropsMixin.CommandParameterValueNumberRangeProperty(
    max="max",
    min="min"
)

Attributes

max

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

Type:: see

min

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

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

CommandPreprocessorProperty

class CfnCommandPropsMixin.CommandPreprocessorProperty(*, aws_json_substitution=None)

Bases: object

Parameters:: aws_json_substitution (Union[IResolvable, AwsJsonSubstitutionCommandPreprocessorConfigProperty, Dict[str, Any], None])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandpreprocessor.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_preprocessor_property = iot_mixins.CfnCommandPropsMixin.CommandPreprocessorProperty(
    aws_json_substitution=iot_mixins.CfnCommandPropsMixin.AwsJsonSubstitutionCommandPreprocessorConfigProperty(
        output_format="outputFormat"
    )
)

Attributes

aws_json_substitution

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

Type:: see