awscc.iot_mitigationaction¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - iot:DescribeMitigationAction, iot:DeleteMitigationAction
update¶
Parent base class for filters and actions.
definitions:
ActionParams:
additionalProperties: false
description: 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).
properties:
AddThingsToThingGroupParams:
additionalProperties: false
description: Parameters to define a mitigation action that moves devices associated
with a certificate to one or more specified thing groups, typically for
quarantine.
properties:
OverrideDynamicGroups:
description: Specifies if this mitigation action can move the things that
triggered the mitigation action out of one or more dynamic thing groups.
type: boolean
ThingGroupNames:
description: The list of groups to which you want to add the things that
triggered the mitigation action.
insertionOrder: false
items:
maxLength: 128
minLength: 1
type: string
maxItems: 10
minItems: 1
type: array
uniqueItems: true
required:
- ThingGroupNames
type: object
EnableIoTLoggingParams:
additionalProperties: false
description: Parameters to define a mitigation action that enables AWS IoT
logging at a specified level of detail.
properties:
LogLevel:
description: ' Specifies which types of information are logged.'
enum:
- DEBUG
- INFO
- ERROR
- WARN
type: string
RoleArnForLogging:
description: ' The ARN of the IAM role used for logging.'
maxLength: 2048
minLength: 20
type: string
required:
- LogLevel
- RoleArnForLogging
type: object
PublishFindingToSnsParams:
additionalProperties: false
description: 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.
properties:
TopicArn:
description: The ARN of the topic to which you want to publish the findings.
maxLength: 2048
minLength: 20
type: string
required:
- TopicArn
type: object
ReplaceDefaultPolicyVersionParams:
additionalProperties: false
description: Parameters to define a mitigation action that adds a blank policy
to restrict permissions.
properties:
TemplateName:
enum:
- BLANK_POLICY
type: string
required:
- TemplateName
type: object
UpdateCACertificateParams:
additionalProperties: false
description: Parameters to define a mitigation action that changes the state
of the CA certificate to inactive.
properties:
Action:
enum:
- DEACTIVATE
type: string
required:
- Action
type: object
UpdateDeviceCertificateParams:
additionalProperties: false
description: Parameters to define a mitigation action that changes the state
of the device certificate to inactive.
properties:
Action:
enum:
- DEACTIVATE
type: string
required:
- Action
type: object
type: object
AddThingsToThingGroupParams:
additionalProperties: false
description: Parameters to define a mitigation action that moves devices associated
with a certificate to one or more specified thing groups, typically for quarantine.
properties:
OverrideDynamicGroups:
description: Specifies if this mitigation action can move the things that
triggered the mitigation action out of one or more dynamic thing groups.
type: boolean
ThingGroupNames:
description: The list of groups to which you want to add the things that triggered
the mitigation action.
insertionOrder: false
items:
maxLength: 128
minLength: 1
type: string
maxItems: 10
minItems: 1
type: array
uniqueItems: true
required:
- ThingGroupNames
type: object
EnableIoTLoggingParams:
additionalProperties: false
description: Parameters to define a mitigation action that enables AWS IoT logging
at a specified level of detail.
properties:
LogLevel:
description: ' Specifies which types of information are logged.'
enum:
- DEBUG
- INFO
- ERROR
- WARN
type: string
RoleArnForLogging:
description: ' The ARN of the IAM role used for logging.'
maxLength: 2048
minLength: 20
type: string
required:
- LogLevel
- RoleArnForLogging
type: object
PublishFindingToSnsParams:
additionalProperties: false
description: 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.
properties:
TopicArn:
description: The ARN of the topic to which you want to publish the findings.
maxLength: 2048
minLength: 20
type: string
required:
- TopicArn
type: object
ReplaceDefaultPolicyVersionParams:
additionalProperties: false
description: Parameters to define a mitigation action that adds a blank policy
to restrict permissions.
properties:
TemplateName:
enum:
- BLANK_POLICY
type: string
required:
- TemplateName
type: object
Tag:
additionalProperties: false
description: A key-value pair to associate with a resource.
properties:
Key:
description: The tag's key.
maxLength: 128
minLength: 1
type: string
Value:
description: The tag's value.
maxLength: 256
minLength: 1
type: string
required:
- Value
- Key
type: object
UpdateCACertificateParams:
additionalProperties: false
description: Parameters to define a mitigation action that changes the state of
the CA certificate to inactive.
properties:
Action:
enum:
- DEACTIVATE
type: string
required:
- Action
type: object
UpdateDeviceCertificateParams:
additionalProperties: false
description: Parameters to define a mitigation action that changes the state of
the device certificate to inactive.
properties:
Action:
enum:
- DEACTIVATE
type: string
required:
- Action
type: object
properties:
ActionParams:
additionalProperties: false
description: 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).
properties:
AddThingsToThingGroupParams:
additionalProperties: false
description: Parameters to define a mitigation action that moves devices associated
with a certificate to one or more specified thing groups, typically for
quarantine.
properties:
OverrideDynamicGroups:
description: Specifies if this mitigation action can move the things that
triggered the mitigation action out of one or more dynamic thing groups.
type: boolean
ThingGroupNames:
description: The list of groups to which you want to add the things that
triggered the mitigation action.
insertionOrder: false
items:
maxLength: 128
minLength: 1
type: string
maxItems: 10
minItems: 1
type: array
uniqueItems: true
required:
- ThingGroupNames
type: object
EnableIoTLoggingParams:
additionalProperties: false
description: Parameters to define a mitigation action that enables AWS IoT
logging at a specified level of detail.
properties:
LogLevel:
description: ' Specifies which types of information are logged.'
enum:
- DEBUG
- INFO
- ERROR
- WARN
type: string
RoleArnForLogging:
description: ' The ARN of the IAM role used for logging.'
maxLength: 2048
minLength: 20
type: string
required:
- LogLevel
- RoleArnForLogging
type: object
PublishFindingToSnsParams:
additionalProperties: false
description: 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.
properties:
TopicArn:
description: The ARN of the topic to which you want to publish the findings.
maxLength: 2048
minLength: 20
type: string
required:
- TopicArn
type: object
ReplaceDefaultPolicyVersionParams:
additionalProperties: false
description: Parameters to define a mitigation action that adds a blank policy
to restrict permissions.
properties:
TemplateName:
enum:
- BLANK_POLICY
type: string
required:
- TemplateName
type: object
UpdateCACertificateParams:
additionalProperties: false
description: Parameters to define a mitigation action that changes the state
of the CA certificate to inactive.
properties:
Action:
enum:
- DEACTIVATE
type: string
required:
- Action
type: object
UpdateDeviceCertificateParams:
additionalProperties: false
description: Parameters to define a mitigation action that changes the state
of the device certificate to inactive.
properties:
Action:
enum:
- DEACTIVATE
type: string
required:
- Action
type: object
type: object
RoleArn:
type: string
Tags:
description: An array of key-value pairs to apply to this resource.
insertionOrder: false
items:
additionalProperties: false
description: A key-value pair to associate with a resource.
properties:
Key:
description: The tag's key.
maxLength: 128
minLength: 1
type: string
Value:
description: The tag's value.
maxLength: 256
minLength: 1
type: string
required:
- Value
- Key
type: object
maxItems: 50
type: array
uniqueItems: true
type:
enum:
- update
Permissions - iot:UpdateMitigationAction, iot:ListTagsForResource, iot:UntagResource, iot:TagResource, iam:PassRole