AWS::IoT::MitigationAction
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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::IoT::MitigationAction", "Properties" : { "ActionName" :
String
, "ActionParams" :ActionParams
, "RoleArn" :String
, "Tags" :[ Tag, ... ]
} }
YAML
Type: AWS::IoT::MitigationAction Properties: ActionName:
String
ActionParams:ActionParams
RoleArn:String
Tags:- Tag
Properties
ActionName
-
The friendly name of the mitigation action.
Required: No
Type: String
Pattern:
[a-zA-Z0-9:_-]+
Minimum:
1
Maximum:
128
Update requires: Replacement
ActionParams
-
The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.
Required: Yes
Type: ActionParams
Update requires: No interruption
RoleArn
-
The IAM role ARN used to apply this mitigation action.
Required: Yes
Type: String
Minimum:
20
Maximum:
2048
Update requires: No interruption
-
Metadata that can be used to manage the mitigation action.
Required: No
Type: Array of Tag
Maximum:
50
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the mitigation action name.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
MitigationActionArn
-
The Amazon Resource Name (ARN) of the mitigation action.
MitigationActionId
-
The ID of the mitigation action.
Examples
JSON
{ "AWSTemplateFormatVersion": "2010-09-09", "Description": "Amazon Web Services IoT MitigationAction Sample Template", "Resources": { "PublishToSnsMitigationAction": { "Type": "AWS::IoT::MitigationAction", "Properties": { "ActionName": "PublishToSns", "RoleArn": "arn:aws:us-east-1:123456789012:iam:role/RoleForIoTMitigationActions", "ActionParams": { "PublishFindingToSnsParams": { "TopicArn": "arn:aws:sns:us-east-1:123456789012:IoTFindingNotifications" } } } } } }
YAML
AWSTemplateFormatVersion: '2010-09-09' Description: Amazon Web Services IoT MitigationAction Sample Template Resources: 'PublishToSnsMitigationAction': Type: AWS::IoT::MitigationAction Properties: ActionName: PublishToSns RoleArn: arn:aws:us-east-1:123456789012:iam:role/RoleForIoTMitigationActions ActionParams: PublishFindingToSnsParams: TopicArn: arn:aws:sns:us-east-1:123456789012:IoTFindingNotifications