CfnMitigationActionProps

class aws_cdk.aws_iot.CfnMitigationActionProps(*, action_params, role_arn, action_name=None, tags=None)

Bases: object

Properties for defining a CfnMitigationAction.

Parameters
  • action_params (Union[IResolvable, ActionParamsProperty, Dict[str, Any]]) – The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.

  • role_arn (str) – The IAM role ARN used to apply this mitigation action.

  • action_name (Optional[str]) – The friendly name of the mitigation action.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Metadata that can be used to manage the mitigation action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-mitigationaction.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iot as iot

cfn_mitigation_action_props = iot.CfnMitigationActionProps(
    action_params=iot.CfnMitigationAction.ActionParamsProperty(
        add_things_to_thing_group_params=iot.CfnMitigationAction.AddThingsToThingGroupParamsProperty(
            thing_group_names=["thingGroupNames"],

            # the properties below are optional
            override_dynamic_groups=False
        ),
        enable_io_tLogging_params=iot.CfnMitigationAction.EnableIoTLoggingParamsProperty(
            log_level="logLevel",
            role_arn_for_logging="roleArnForLogging"
        ),
        publish_finding_to_sns_params=iot.CfnMitigationAction.PublishFindingToSnsParamsProperty(
            topic_arn="topicArn"
        ),
        replace_default_policy_version_params=iot.CfnMitigationAction.ReplaceDefaultPolicyVersionParamsProperty(
            template_name="templateName"
        ),
        update_ca_certificate_params=iot.CfnMitigationAction.UpdateCACertificateParamsProperty(
            action="action"
        ),
        update_device_certificate_params=iot.CfnMitigationAction.UpdateDeviceCertificateParamsProperty(
            action="action"
        )
    ),
    role_arn="roleArn",

    # the properties below are optional
    action_name="actionName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

action_name

The friendly name of the mitigation action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-mitigationaction.html#cfn-iot-mitigationaction-actionname

Return type

Optional[str]

action_params

The set of parameters for this mitigation action.

The parameters vary, depending on the kind of action you apply.

Link

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

Return type

Union[IResolvable, ActionParamsProperty]

role_arn

The IAM role ARN used to apply this mitigation action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-mitigationaction.html#cfn-iot-mitigationaction-rolearn

Return type

str

tags

Metadata that can be used to manage the mitigation action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-mitigationaction.html#cfn-iot-mitigationaction-tags

Return type

Optional[List[CfnTag]]