Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-iot-mitigationaction.json
Parent schema serverless-framework-configuration
Type: object

Mitigation actions can be used to take actions to mitigate issues that were found in an Audit finding or Detect violation.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git

Properties

RoleArn string | Aws_CF_FunctionString required
ActionParams object required

The set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation action).

6 nested properties
AddThingsToThingGroupParams object

Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.

2 nested properties
ThingGroupNames string[] required

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

minItems=1maxItems=10uniqueItems=true
OverrideDynamicGroups boolean

Specifies if this mitigation action can move the things that triggered the mitigation action out of one or more dynamic thing groups.

EnableIoTLoggingParams object

Parameters to define a mitigation action that enables AWS IoT logging at a specified level of detail.

2 nested properties
LogLevel string | Aws_CF_FunctionString required

Specifies which types of information are logged.

RoleArnForLogging string | Aws_CF_FunctionString required

The ARN of the IAM role used for logging.

PublishFindingToSnsParams 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.

1 nested properties
TopicArn string | Aws_CF_FunctionString required

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

ReplaceDefaultPolicyVersionParams object

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

1 nested properties
TemplateName string | Aws_CF_FunctionString required
UpdateCACertificateParams object

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

1 nested properties
Action string | Aws_CF_FunctionString required
UpdateDeviceCertificateParams object

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

1 nested properties
Action string | Aws_CF_FunctionString required
ActionName string | Aws_CF_FunctionString

A unique identifier for the mitigation action.

Tags Tag[]

An array of key-value pairs to apply to this resource.

maxItems=50uniqueItems=true

Definitions

Tag object

A key-value pair to associate with a resource.

Key string | Aws_CF_FunctionString required

The tag's key.

Value string | Aws_CF_FunctionString required

The tag's value.

ActionParams object

The set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation action).

AddThingsToThingGroupParams object

Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.

2 nested properties
ThingGroupNames string[] required

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

minItems=1maxItems=10uniqueItems=true
OverrideDynamicGroups boolean

Specifies if this mitigation action can move the things that triggered the mitigation action out of one or more dynamic thing groups.

EnableIoTLoggingParams object

Parameters to define a mitigation action that enables AWS IoT logging at a specified level of detail.

2 nested properties
LogLevel string | Aws_CF_FunctionString required

Specifies which types of information are logged.

RoleArnForLogging string | Aws_CF_FunctionString required

The ARN of the IAM role used for logging.

PublishFindingToSnsParams 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.

1 nested properties
TopicArn string | Aws_CF_FunctionString required

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

ReplaceDefaultPolicyVersionParams object

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

1 nested properties
TemplateName string | Aws_CF_FunctionString required
UpdateCACertificateParams object

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

1 nested properties
Action string | Aws_CF_FunctionString required
UpdateDeviceCertificateParams object

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

1 nested properties
Action string | Aws_CF_FunctionString required
AddThingsToThingGroupParams object

Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.

ThingGroupNames string[] required

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

minItems=1maxItems=10uniqueItems=true
OverrideDynamicGroups boolean

Specifies if this mitigation action can move the things that triggered the mitigation action out of one or more dynamic thing groups.

EnableIoTLoggingParams object

Parameters to define a mitigation action that enables AWS IoT logging at a specified level of detail.

LogLevel string | Aws_CF_FunctionString required

Specifies which types of information are logged.

RoleArnForLogging string | Aws_CF_FunctionString required

The ARN of the IAM role used for logging.

PublishFindingToSnsParams 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.

TopicArn string | Aws_CF_FunctionString required

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

ReplaceDefaultPolicyVersionParams object

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

TemplateName string | Aws_CF_FunctionString required
UpdateCACertificateParams object

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

Action string | Aws_CF_FunctionString required
UpdateDeviceCertificateParams object

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

Action string | Aws_CF_FunctionString required