Package software.amazon.awscdk.services.iot

Class CfnSecurityProfile.Builder

java.lang.Object

software.amazon.awscdk.services.iot.CfnSecurityProfile.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSecurityProfile>

Enclosing class:

CfnSecurityProfile

@Stability(Stable)
public static final class CfnSecurityProfile.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSecurityProfile>

A fluent builder for CfnSecurityProfile.

Method Summary

Modifier and Type	Method	Description
CfnSecurityProfile.Builder	additionalMetricsToRetainV2(List<? extends Object> additionalMetricsToRetainV2)	A list of metrics whose data is retained (stored).
CfnSecurityProfile.Builder	additionalMetricsToRetainV2(IResolvable additionalMetricsToRetainV2)	A list of metrics whose data is retained (stored).
CfnSecurityProfile.Builder	alertTargets(Map<String,? extends Object> alertTargets)	Specifies the destinations to which alerts are sent.
CfnSecurityProfile.Builder	alertTargets(IResolvable alertTargets)	Specifies the destinations to which alerts are sent.
CfnSecurityProfile.Builder	behaviors(List<? extends Object> behaviors)	Specifies the behaviors that, when violated by a device (thing), cause an alert.
CfnSecurityProfile.Builder	behaviors(IResolvable behaviors)	Specifies the behaviors that, when violated by a device (thing), cause an alert.
CfnSecurityProfile	build()
static CfnSecurityProfile.Builder	create(software.constructs.Construct scope, String id)
CfnSecurityProfile.Builder	metricsExportConfig(IResolvable metricsExportConfig)	Specifies the MQTT topic and role ARN required for metric export.
CfnSecurityProfile.Builder	metricsExportConfig(CfnSecurityProfile.MetricsExportConfigProperty metricsExportConfig)	Specifies the MQTT topic and role ARN required for metric export.
CfnSecurityProfile.Builder	securityProfileDescription(String securityProfileDescription)	A description of the security profile.
CfnSecurityProfile.Builder	securityProfileName(String securityProfileName)	The name you gave to the security profile.
CfnSecurityProfile.Builder	tags(List<? extends CfnTag> tags)	Metadata that can be used to manage the security profile.
CfnSecurityProfile.Builder	targetArns(List<String> targetArns)	The ARN of the target (thing group) to which the security profile is attached.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnSecurityProfile.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnSecurityProfile.Builder.

additionalMetricsToRetainV2

@Stability(Stable)
public CfnSecurityProfile.Builder additionalMetricsToRetainV2(IResolvable additionalMetricsToRetainV2)

A list of metrics whose data is retained (stored).

By default, data is retained for any metric used in the profile's behaviors , but it's also retained for any metric specified here. Can be used with custom metrics; can't be used with dimensions.

Parameters:

additionalMetricsToRetainV2 - A list of metrics whose data is retained (stored). This parameter is required.

Returns:

this

See Also:

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

additionalMetricsToRetainV2

@Stability(Stable)
public CfnSecurityProfile.Builder additionalMetricsToRetainV2(List<? extends Object> additionalMetricsToRetainV2)

A list of metrics whose data is retained (stored).

By default, data is retained for any metric used in the profile's behaviors , but it's also retained for any metric specified here. Can be used with custom metrics; can't be used with dimensions.

Parameters:

additionalMetricsToRetainV2 - A list of metrics whose data is retained (stored). This parameter is required.

Returns:

this

See Also:

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

alertTargets

@Stability(Stable)
public CfnSecurityProfile.Builder alertTargets(IResolvable alertTargets)

Specifies the destinations to which alerts are sent.

(Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

Parameters:

alertTargets - Specifies the destinations to which alerts are sent. This parameter is required.

Returns:

this

See Also:

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

alertTargets

@Stability(Stable)
public CfnSecurityProfile.Builder alertTargets(Map<String,? extends Object> alertTargets)

Specifies the destinations to which alerts are sent.

(Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

Parameters:

alertTargets - Specifies the destinations to which alerts are sent. This parameter is required.

Returns:

this

See Also:

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

behaviors

@Stability(Stable)
public CfnSecurityProfile.Builder behaviors(IResolvable behaviors)

Specifies the behaviors that, when violated by a device (thing), cause an alert.

Parameters:

behaviors - Specifies the behaviors that, when violated by a device (thing), cause an alert. This parameter is required.

Returns:

this

See Also:

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

behaviors

@Stability(Stable)
public CfnSecurityProfile.Builder behaviors(List<? extends Object> behaviors)

Specifies the behaviors that, when violated by a device (thing), cause an alert.

Parameters:

behaviors - Specifies the behaviors that, when violated by a device (thing), cause an alert. This parameter is required.

Returns:

this

See Also:

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

metricsExportConfig

@Stability(Stable)
public CfnSecurityProfile.Builder metricsExportConfig(IResolvable metricsExportConfig)

Specifies the MQTT topic and role ARN required for metric export.

Parameters:

metricsExportConfig - Specifies the MQTT topic and role ARN required for metric export. This parameter is required.

Returns:

this

See Also:

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

metricsExportConfig

@Stability(Stable)
public CfnSecurityProfile.Builder metricsExportConfig(CfnSecurityProfile.MetricsExportConfigProperty metricsExportConfig)

Specifies the MQTT topic and role ARN required for metric export.

Parameters:

metricsExportConfig - Specifies the MQTT topic and role ARN required for metric export. This parameter is required.

Returns:

this

See Also:

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

securityProfileDescription

@Stability(Stable)
public CfnSecurityProfile.Builder securityProfileDescription(String securityProfileDescription)

A description of the security profile.

Parameters:

securityProfileDescription - A description of the security profile. This parameter is required.

Returns:

this

See Also:

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

securityProfileName

@Stability(Stable)
public CfnSecurityProfile.Builder securityProfileName(String securityProfileName)

The name you gave to the security profile.

Parameters:

securityProfileName - The name you gave to the security profile. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnSecurityProfile.Builder tags(List<? extends CfnTag> tags)

Metadata that can be used to manage the security profile.

Parameters:

tags - Metadata that can be used to manage the security profile. This parameter is required.

Returns:

this

See Also:

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

targetArns

@Stability(Stable)
public CfnSecurityProfile.Builder targetArns(List<String> targetArns)

The ARN of the target (thing group) to which the security profile is attached.

Parameters:

targetArns - The ARN of the target (thing group) to which the security profile is attached. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnSecurityProfile build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnSecurityProfile>

Returns:

a newly built instance of CfnSecurityProfile.