CfnMitigationActionPropsMixin

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

Bases: Mixin

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask.

For API reference, see CreateMitigationAction and for general information, see Mitigation actions .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-mitigationaction.html
CloudformationResource:: AWS::IoT::MitigationAction
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_mitigation_action_props_mixin = iot_mixins.CfnMitigationActionPropsMixin(iot_mixins.CfnMitigationActionMixinProps(
    action_name="actionName",
    action_params=iot_mixins.CfnMitigationActionPropsMixin.ActionParamsProperty(
        add_things_to_thing_group_params=iot_mixins.CfnMitigationActionPropsMixin.AddThingsToThingGroupParamsProperty(
            override_dynamic_groups=False,
            thing_group_names=["thingGroupNames"]
        ),
        enable_io_tLogging_params=iot_mixins.CfnMitigationActionPropsMixin.EnableIoTLoggingParamsProperty(
            log_level="logLevel",
            role_arn_for_logging="roleArnForLogging"
        ),
        publish_finding_to_sns_params=iot_mixins.CfnMitigationActionPropsMixin.PublishFindingToSnsParamsProperty(
            topic_arn="topicArn"
        ),
        replace_default_policy_version_params=iot_mixins.CfnMitigationActionPropsMixin.ReplaceDefaultPolicyVersionParamsProperty(
            template_name="templateName"
        ),
        update_ca_certificate_params=iot_mixins.CfnMitigationActionPropsMixin.UpdateCACertificateParamsProperty(
            action="action"
        ),
        update_device_certificate_params=iot_mixins.CfnMitigationActionPropsMixin.UpdateDeviceCertificateParamsProperty(
            action="action"
        )
    ),
    role_arn="roleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnMitigationActionMixinProps, 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 = ['actionName', 'actionParams', '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

ActionParamsProperty

class CfnMitigationActionPropsMixin.ActionParamsProperty(*, add_things_to_thing_group_params=None, enable_io_t_logging_params=None, publish_finding_to_sns_params=None, replace_default_policy_version_params=None, update_ca_certificate_params=None, update_device_certificate_params=None)

Bases: object

Defines the type of action and the parameters for that action.

Parameters:

add_things_to_thing_group_params (Union[IResolvable, AddThingsToThingGroupParamsProperty, Dict[str, Any], None]) – Specifies the group to which you want to add the devices.
enable_io_t_logging_params (Union[IResolvable, EnableIoTLoggingParamsProperty, Dict[str, Any], None]) – Specifies the logging level and the role with permissions for logging. You cannot specify a logging level of DISABLED .
publish_finding_to_sns_params (Union[IResolvable, PublishFindingToSnsParamsProperty, Dict[str, Any], None]) – Specifies the topic to which the finding should be published.
replace_default_policy_version_params (Union[IResolvable, ReplaceDefaultPolicyVersionParamsProperty, Dict[str, Any], None]) – Replaces the policy version with a default or blank policy. You specify the template name. Only a value of BLANK_POLICY is currently supported.
update_ca_certificate_params (Union[IResolvable, UpdateCACertificateParamsProperty, Dict[str, Any], None]) – Specifies the new state for the CA certificate. Only a value of DEACTIVATE is currently supported.
update_device_certificate_params (Union[IResolvable, UpdateDeviceCertificateParamsProperty, Dict[str, Any], None]) – Specifies the new state for a device certificate. Only a value of DEACTIVATE is currently supported.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-actionparams.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

action_params_property = iot_mixins.CfnMitigationActionPropsMixin.ActionParamsProperty(
    add_things_to_thing_group_params=iot_mixins.CfnMitigationActionPropsMixin.AddThingsToThingGroupParamsProperty(
        override_dynamic_groups=False,
        thing_group_names=["thingGroupNames"]
    ),
    enable_io_tLogging_params=iot_mixins.CfnMitigationActionPropsMixin.EnableIoTLoggingParamsProperty(
        log_level="logLevel",
        role_arn_for_logging="roleArnForLogging"
    ),
    publish_finding_to_sns_params=iot_mixins.CfnMitigationActionPropsMixin.PublishFindingToSnsParamsProperty(
        topic_arn="topicArn"
    ),
    replace_default_policy_version_params=iot_mixins.CfnMitigationActionPropsMixin.ReplaceDefaultPolicyVersionParamsProperty(
        template_name="templateName"
    ),
    update_ca_certificate_params=iot_mixins.CfnMitigationActionPropsMixin.UpdateCACertificateParamsProperty(
        action="action"
    ),
    update_device_certificate_params=iot_mixins.CfnMitigationActionPropsMixin.UpdateDeviceCertificateParamsProperty(
        action="action"
    )
)

Attributes

add_things_to_thing_group_params

Specifies the group to which you want to add the devices.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-actionparams.html#cfn-iot-mitigationaction-actionparams-addthingstothinggroupparams

enable_io_t_logging_params

Specifies the logging level and the role with permissions for logging.

You cannot specify a logging level of DISABLED .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-actionparams.html#cfn-iot-mitigationaction-actionparams-enableiotloggingparams

publish_finding_to_sns_params

Specifies the topic to which the finding should be published.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-actionparams.html#cfn-iot-mitigationaction-actionparams-publishfindingtosnsparams

replace_default_policy_version_params

Replaces the policy version with a default or blank policy.

You specify the template name. Only a value of BLANK_POLICY is currently supported.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-actionparams.html#cfn-iot-mitigationaction-actionparams-replacedefaultpolicyversionparams

update_ca_certificate_params

Specifies the new state for the CA certificate.

Only a value of DEACTIVATE is currently supported.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-actionparams.html#cfn-iot-mitigationaction-actionparams-updatecacertificateparams

update_device_certificate_params

Specifies the new state for a device certificate.

Only a value of DEACTIVATE is currently supported.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-actionparams.html#cfn-iot-mitigationaction-actionparams-updatedevicecertificateparams

AddThingsToThingGroupParamsProperty

class CfnMitigationActionPropsMixin.AddThingsToThingGroupParamsProperty(*, override_dynamic_groups=None, thing_group_names=None)

Bases: object

Parameters used when defining a mitigation action that move a set of things to a thing group.

Parameters:

override_dynamic_groups (Union[bool, IResolvable, None]) – Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic thing groups.
thing_group_names (Optional[Sequence[str]]) – The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you can’t add a thing to more than one group in the same hierarchy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-addthingstothinggroupparams.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

add_things_to_thing_group_params_property = iot_mixins.CfnMitigationActionPropsMixin.AddThingsToThingGroupParamsProperty(
    override_dynamic_groups=False,
    thing_group_names=["thingGroupNames"]
)

Attributes

override_dynamic_groups

Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic thing groups.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-addthingstothinggroupparams.html#cfn-iot-mitigationaction-addthingstothinggroupparams-overridedynamicgroups

thing_group_names

The list of groups to which you want to add the things that triggered the mitigation action.

You can add a thing to a maximum of 10 groups, but you can’t add a thing to more than one group in the same hierarchy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-addthingstothinggroupparams.html#cfn-iot-mitigationaction-addthingstothinggroupparams-thinggroupnames

EnableIoTLoggingParamsProperty

class CfnMitigationActionPropsMixin.EnableIoTLoggingParamsProperty(*, log_level=None, role_arn_for_logging=None)

Bases: object

Parameters used when defining a mitigation action that enable AWS IoT Core logging.

Parameters:

log_level (Optional[str]) – Specifies the type of information to be logged.
role_arn_for_logging (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role used for logging.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-enableiotloggingparams.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

enable_io_tLogging_params_property = iot_mixins.CfnMitigationActionPropsMixin.EnableIoTLoggingParamsProperty(
    log_level="logLevel",
    role_arn_for_logging="roleArnForLogging"
)

Attributes

log_level

Specifies the type of information to be logged.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-enableiotloggingparams.html#cfn-iot-mitigationaction-enableiotloggingparams-loglevel

role_arn_for_logging

The Amazon Resource Name (ARN) of the IAM role used for logging.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-enableiotloggingparams.html#cfn-iot-mitigationaction-enableiotloggingparams-rolearnforlogging

PublishFindingToSnsParamsProperty

class CfnMitigationActionPropsMixin.PublishFindingToSnsParamsProperty(*, topic_arn=None)

Bases: object

Parameters to define a mitigation action that publishes findings to Amazon SNS.

You can implement your own custom actions in response to the Amazon SNS messages.

Parameters:: topic_arn (Optional[str]) – The ARN of the topic to which you want to publish the findings.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-publishfindingtosnsparams.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

publish_finding_to_sns_params_property = iot_mixins.CfnMitigationActionPropsMixin.PublishFindingToSnsParamsProperty(
    topic_arn="topicArn"
)

Attributes

topic_arn

The ARN of the topic to which you want to publish the findings.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-publishfindingtosnsparams.html#cfn-iot-mitigationaction-publishfindingtosnsparams-topicarn

ReplaceDefaultPolicyVersionParamsProperty

class CfnMitigationActionPropsMixin.ReplaceDefaultPolicyVersionParamsProperty(*, template_name=None)

Bases: object

Parameters to define a mitigation action that adds a blank policy to restrict permissions.

Parameters:: template_name (Optional[str]) – The name of the template to be applied. The only supported value is BLANK_POLICY .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-replacedefaultpolicyversionparams.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

replace_default_policy_version_params_property = iot_mixins.CfnMitigationActionPropsMixin.ReplaceDefaultPolicyVersionParamsProperty(
    template_name="templateName"
)

Attributes

template_name

The name of the template to be applied.

The only supported value is BLANK_POLICY .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-replacedefaultpolicyversionparams.html#cfn-iot-mitigationaction-replacedefaultpolicyversionparams-templatename

UpdateCACertificateParamsProperty

class CfnMitigationActionPropsMixin.UpdateCACertificateParamsProperty(*, action=None)

Bases: object

Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

Parameters:: action (Optional[str]) – The action that you want to apply to the CA certificate. The only supported value is DEACTIVATE .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-updatecacertificateparams.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

update_cACertificate_params_property = iot_mixins.CfnMitigationActionPropsMixin.UpdateCACertificateParamsProperty(
    action="action"
)

Attributes

action

The action that you want to apply to the CA certificate.

The only supported value is DEACTIVATE .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-updatecacertificateparams.html#cfn-iot-mitigationaction-updatecacertificateparams-action

UpdateDeviceCertificateParamsProperty

class CfnMitigationActionPropsMixin.UpdateDeviceCertificateParamsProperty(*, action=None)

Bases: object

Parameters to define a mitigation action that changes the state of the device certificate to inactive.

Parameters:: action (Optional[str]) – The action that you want to apply to the device certificate. The only supported value is DEACTIVATE .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-updatedevicecertificateparams.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

update_device_certificate_params_property = iot_mixins.CfnMitigationActionPropsMixin.UpdateDeviceCertificateParamsProperty(
    action="action"
)

Attributes

action

The action that you want to apply to the device certificate.

The only supported value is DEACTIVATE .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-updatedevicecertificateparams.html#cfn-iot-mitigationaction-updatedevicecertificateparams-action