Package software.amazon.awscdk.services.iot

Class CfnMitigationAction

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iot.CfnMitigationAction
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.577Z") @Stability(Stable) public class CfnMitigationAction extends CfnResource implements IInspectable
A CloudFormation 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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 CfnMitigationAction cfnMitigationAction = CfnMitigationAction.Builder.create(this, "MyCfnMitigationAction")
         .actionParams(ActionParamsProperty.builder()
                 .addThingsToThingGroupParams(AddThingsToThingGroupParamsProperty.builder()
                         .thingGroupNames(List.of("thingGroupNames"))
                         // the properties below are optional
                         .overrideDynamicGroups(false)
                         .build())
                 .enableIoTLoggingParams(EnableIoTLoggingParamsProperty.builder()
                         .logLevel("logLevel")
                         .roleArnForLogging("roleArnForLogging")
                         .build())
                 .publishFindingToSnsParams(PublishFindingToSnsParamsProperty.builder()
                         .topicArn("topicArn")
                         .build())
                 .replaceDefaultPolicyVersionParams(ReplaceDefaultPolicyVersionParamsProperty.builder()
                         .templateName("templateName")
                         .build())
                 .updateCaCertificateParams(UpdateCACertificateParamsProperty.builder()
                         .action("action")
                         .build())
                 .updateDeviceCertificateParams(UpdateDeviceCertificateParamsProperty.builder()
                         .action("action")
                         .build())
                 .build())
         .roleArn("roleArn")
         // the properties below are optional
         .actionName("actionName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnMitigationAction

      protected CfnMitigationAction(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnMitigationAction

      protected CfnMitigationAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnMitigationAction

      @Stability(Stable) public CfnMitigationAction(@NotNull Construct scope, @NotNull String id, @NotNull CfnMitigationActionProps props)
      Create a new AWS::IoT::MitigationAction.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrMitigationActionArn

      @Stability(Stable) @NotNull public String getAttrMitigationActionArn()
      The Amazon Resource Name (ARN) of the mitigation action.

    • getAttrMitigationActionId

      @Stability(Stable) @NotNull public String getAttrMitigationActionId()
      The ID of the mitigation action.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Metadata that can be used to manage the mitigation action.

    • getActionParams

      @Stability(Stable) @NotNull public Object getActionParams()
      The set of parameters for this mitigation action.

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

    • setActionParams

      @Stability(Stable) public void setActionParams(@NotNull IResolvable value)
      The set of parameters for this mitigation action.

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

    • setActionParams

      @Stability(Stable) public void setActionParams(@NotNull CfnMitigationAction.ActionParamsProperty value)
      The set of parameters for this mitigation action.

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

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The IAM role ARN used to apply this mitigation action.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The IAM role ARN used to apply this mitigation action.

    • getActionName

      @Stability(Stable) @Nullable public String getActionName()
      The friendly name of the mitigation action.

    • setActionName

      @Stability(Stable) public void setActionName(@Nullable String value)
      The friendly name of the mitigation action.