Package software.amazon.awscdk.services.iot

Interface CfnMitigationAction.ActionParamsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMitigationAction.ActionParamsProperty.Jsii$Proxy

Enclosing class:

CfnMitigationAction

@Stability(Stable)
public static interface CfnMitigationAction.ActionParamsProperty
extends software.amazon.jsii.JsiiSerializable

Defines the type of action and the parameters for that action.

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.*;
 ActionParamsProperty actionParamsProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnMitigationAction.ActionParamsProperty.Builder	builder()
default Object	getAddThingsToThingGroupParams()	Specifies the group to which you want to add the devices.
default Object	getEnableIoTLoggingParams()	Specifies the logging level and the role with permissions for logging.
default Object	getPublishFindingToSnsParams()	Specifies the topic to which the finding should be published.
default Object	getReplaceDefaultPolicyVersionParams()	Replaces the policy version with a default or blank policy.
default Object	getUpdateCaCertificateParams()	Specifies the new state for the CA certificate.
default Object	getUpdateDeviceCertificateParams()	Specifies the new state for a device certificate.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAddThingsToThingGroupParams

@Stability(Stable)
@Nullable
default Object getAddThingsToThingGroupParams()

Specifies the group to which you want to add the devices.

See Also:

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

getEnableIoTLoggingParams

@Stability(Stable)
@Nullable
default Object getEnableIoTLoggingParams()

Specifies the logging level and the role with permissions for logging.

You cannot specify a logging level of DISABLED .

See Also:

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

getPublishFindingToSnsParams

@Stability(Stable)
@Nullable
default Object getPublishFindingToSnsParams()

Specifies the topic to which the finding should be published.

See Also:

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

getReplaceDefaultPolicyVersionParams

@Stability(Stable)
@Nullable
default Object getReplaceDefaultPolicyVersionParams()

Replaces the policy version with a default or blank policy.

You specify the template name. Only a value of BLANK_POLICY is currently supported.

See Also:

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

getUpdateCaCertificateParams

@Stability(Stable)
@Nullable
default Object getUpdateCaCertificateParams()

Specifies the new state for the CA certificate.

Only a value of DEACTIVATE is currently supported.

See Also:

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

getUpdateDeviceCertificateParams

@Stability(Stable)
@Nullable
default Object getUpdateDeviceCertificateParams()

Specifies the new state for a device certificate.

Only a value of DEACTIVATE is currently supported.

See Also:

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

builder

@Stability(Stable)
static CfnMitigationAction.ActionParamsProperty.Builder builder()

Returns:

a CfnMitigationAction.ActionParamsProperty.Builder of CfnMitigationAction.ActionParamsProperty