@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-07-01T09:58:31.385Z") public class CfnMitigationAction extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnMitigationAction(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnMitigationAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnMitigationAction(Construct scope, java.lang.String id, CfnMitigationActionProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrMitigationActionArn()
public java.lang.String getAttrMitigationActionId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.Object getActionParams()
The parameters vary, depending on the kind of action you apply.
public void setActionParams(IResolvable value)
The parameters vary, depending on the kind of action you apply.
public void setActionParams(CfnMitigationAction.ActionParamsProperty value)
The parameters vary, depending on the kind of action you apply.
public java.lang.String getRoleArn()
public void setRoleArn(java.lang.String value)
public java.lang.String getActionName()
public void setActionName(java.lang.String value)