Package software.amazon.awscdk.services.iot

Interface CfnMitigationActionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMitigationActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:44.626Z")
@Stability(Stable)
public interface CfnMitigationActionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnMitigationAction.

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.*;
 CfnMitigationActionProps cfnMitigationActionProps = CfnMitigationActionProps.builder()
         .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-mitigationaction.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMitigationActionProps.Builder	A builder for CfnMitigationActionProps
static final class	CfnMitigationActionProps.Jsii$Proxy	An implementation for CfnMitigationActionProps

Method Summary

Modifier and Type	Method	Description
static CfnMitigationActionProps.Builder	builder()
default String	getActionName()	The friendly name of the mitigation action.
Object	getActionParams()	The set of parameters for this mitigation action.
String	getRoleArn()	The IAM role ARN used to apply this mitigation action.
default List<CfnTag>	getTags()	Metadata that can be used to manage the mitigation action.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActionParams

@Stability(Stable)
@NotNull
Object getActionParams()

The set of parameters for this mitigation action.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-mitigationaction.html#cfn-iot-mitigationaction-actionparams

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The IAM role ARN used to apply this mitigation action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-mitigationaction.html#cfn-iot-mitigationaction-rolearn

getActionName

@Stability(Stable)
@Nullable
default String getActionName()

The friendly name of the mitigation action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-mitigationaction.html#cfn-iot-mitigationaction-actionname

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Metadata that can be used to manage the mitigation action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-mitigationaction.html#cfn-iot-mitigationaction-tags

builder

@Stability(Stable)
static CfnMitigationActionProps.Builder builder()

Returns:

a CfnMitigationActionProps.Builder of CfnMitigationActionProps