software.amazon.awscdk.services.iot

Class CfnMitigationAction

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iot.CfnMitigationAction

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.867Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnMitigationAction.ActionParamsProperty Defines the type of action and the parameters for that action.
static interface	CfnMitigationAction.AddThingsToThingGroupParamsProperty Parameters used when defining a mitigation action that move a set of things to a thing group.
static class	CfnMitigationAction.Builder A fluent builder for CfnMitigationAction.
static interface	CfnMitigationAction.EnableIoTLoggingParamsProperty Parameters used when defining a mitigation action that enable AWS IoT Core logging.
static interface	CfnMitigationAction.PublishFindingToSnsParamsProperty Parameters to define a mitigation action that publishes findings to Amazon SNS.
static interface	CfnMitigationAction.ReplaceDefaultPolicyVersionParamsProperty Parameters to define a mitigation action that adds a blank policy to restrict permissions.
static interface	CfnMitigationAction.UpdateCACertificateParamsProperty Parameters to define a mitigation action that changes the state of the CA certificate to inactive.
static interface	CfnMitigationAction.UpdateDeviceCertificateParamsProperty Parameters to define a mitigation action that changes the state of the device certificate to inactive.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnMitigationAction(software.constructs.Construct scope, String id, CfnMitigationActionProps props) Create a new `AWS::IoT::MitigationAction`.
protected	CfnMitigationAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMitigationAction(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getActionName() The friendly name of the mitigation action.
Object	getActionParams() The set of parameters for this mitigation action.
String	getAttrMitigationActionArn() The Amazon Resource Name (ARN) of the mitigation action.
String	getAttrMitigationActionId() The ID of the mitigation action.
protected Map<String,Object>	getCfnProperties()
String	getRoleArn() The IAM role ARN used to apply this mitigation action.
TagManager	getTags() Metadata that can be used to manage the mitigation action.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActionName(String value) The friendly name of the mitigation action.
void	setActionParams(CfnMitigationAction.ActionParamsProperty value) The set of parameters for this mitigation action.
void	setActionParams(IResolvable value) The set of parameters for this mitigation action.
void	setRoleArn(String value) The IAM role ARN used to apply this mitigation action.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnMitigationAction

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

CfnMitigationAction

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

CfnMitigationAction

@Stability(value=Stable)
public CfnMitigationAction(@NotNull
                                                    software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrMitigationActionArn()

The Amazon Resource Name (ARN) of the mitigation action.

getAttrMitigationActionId

@Stability(value=Stable)
 @NotNull
public String getAttrMitigationActionId()

The ID of the mitigation action.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Metadata that can be used to manage the mitigation action.

getActionParams

@Stability(value=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(value=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.

setActionParams

@Stability(value=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.

getRoleArn

@Stability(value=Stable)
 @NotNull
public String getRoleArn()

The IAM role ARN used to apply this mitigation action.

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@NotNull
                                                String value)

The IAM role ARN used to apply this mitigation action.

getActionName

@Stability(value=Stable)
 @Nullable
public String getActionName()

The friendly name of the mitigation action.

setActionName

@Stability(value=Stable)
public void setActionName(@Nullable
                                                   String value)

The friendly name of the mitigation action.