software.amazon.awscdk.services.iot

Class CfnMitigationAction

java.lang.Object

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

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:04.848Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnMitigationAction(Construct scope, java.lang.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
java.lang.String	getActionName() The friendly name of the mitigation action.
java.lang.Object	getActionParams() The set of parameters for this mitigation action.
java.lang.String	getAttrMitigationActionArn() The Amazon Resource Name (ARN) of the mitigation action.
java.lang.String	getAttrMitigationActionId() The ID of the mitigation action.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setActionName(java.lang.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(java.lang.String value) The IAM role ARN used to apply this mitigation action.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnMitigationAction(Construct scope,
                           java.lang.String id,
                           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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrMitigationActionArn

public java.lang.String getAttrMitigationActionArn()

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

getAttrMitigationActionId

public java.lang.String getAttrMitigationActionId()

The ID of the mitigation action.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

Metadata that can be used to manage the mitigation action.

getActionParams

public java.lang.Object getActionParams()

The set of parameters for this mitigation action.

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

setActionParams

public void setActionParams(IResolvable value)

The set of parameters for this mitigation action.

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

setActionParams

public void setActionParams(CfnMitigationAction.ActionParamsProperty value)

The set of parameters for this mitigation action.

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

getRoleArn

public java.lang.String getRoleArn()

The IAM role ARN used to apply this mitigation action.

setRoleArn

public void setRoleArn(java.lang.String value)

The IAM role ARN used to apply this mitigation action.

getActionName

public java.lang.String getActionName()

The friendly name of the mitigation action.

setActionName

public void setActionName(java.lang.String value)

The friendly name of the mitigation action.