Package software.amazon.awscdk.cfnpropertymixins.services.iot

Class CfnFleetMetricPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.iot.CfnFleetMetricPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFleetMetricPropsMixin>

Enclosing class:

CfnFleetMetricPropsMixin

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

A fluent builder for CfnFleetMetricPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnFleetMetricPropsMixin.Builder	aggregationField(String aggregationField)	The field to aggregate.
CfnFleetMetricPropsMixin.Builder	aggregationType(CfnFleetMetricPropsMixin.AggregationTypeProperty aggregationType)	The type of the aggregation query.
CfnFleetMetricPropsMixin.Builder	aggregationType(IResolvable aggregationType)	The type of the aggregation query.
CfnFleetMetricPropsMixin	build()
static CfnFleetMetricPropsMixin.Builder	create()
static CfnFleetMetricPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnFleetMetricPropsMixin.Builder	description(String description)	The fleet metric description.
CfnFleetMetricPropsMixin.Builder	indexName(String indexName)	The name of the index to search.
CfnFleetMetricPropsMixin.Builder	metricName(String metricName)	The name of the fleet metric to create.
CfnFleetMetricPropsMixin.Builder	period(Number period)	The time in seconds between fleet metric emissions.
CfnFleetMetricPropsMixin.Builder	queryString(String queryString)	The search query string.
CfnFleetMetricPropsMixin.Builder	queryVersion(String queryVersion)	The query version.
CfnFleetMetricPropsMixin.Builder	tags(List<? extends CfnTag> tags)	Metadata which can be used to manage the fleet metric.
CfnFleetMetricPropsMixin.Builder	unit(String unit)	Used to support unit transformation such as milliseconds to seconds.

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 CfnFleetMetricPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnFleetMetricPropsMixin.Builder.

create

@Stability(Stable)
public static CfnFleetMetricPropsMixin.Builder create()

Returns:

a new instance of CfnFleetMetricPropsMixin.Builder.

aggregationField

@Stability(Stable)
public CfnFleetMetricPropsMixin.Builder aggregationField(String aggregationField)

The field to aggregate.

Parameters:

aggregationField - The field to aggregate. This parameter is required.

Returns:

this

See Also:

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

aggregationType

@Stability(Stable)
public CfnFleetMetricPropsMixin.Builder aggregationType(IResolvable aggregationType)

The type of the aggregation query.

Parameters:

aggregationType - The type of the aggregation query. This parameter is required.

Returns:

this

See Also:

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

aggregationType

@Stability(Stable)
public CfnFleetMetricPropsMixin.Builder aggregationType(CfnFleetMetricPropsMixin.AggregationTypeProperty aggregationType)

The type of the aggregation query.

Parameters:

aggregationType - The type of the aggregation query. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnFleetMetricPropsMixin.Builder description(String description)

The fleet metric description.

Parameters:

description - The fleet metric description. This parameter is required.

Returns:

this

See Also:

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

indexName

@Stability(Stable)
public CfnFleetMetricPropsMixin.Builder indexName(String indexName)

The name of the index to search.

Parameters:

indexName - The name of the index to search. This parameter is required.

Returns:

this

See Also:

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

metricName

@Stability(Stable)
public CfnFleetMetricPropsMixin.Builder metricName(String metricName)

The name of the fleet metric to create.

Parameters:

metricName - The name of the fleet metric to create. This parameter is required.

Returns:

this

See Also:

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

period

@Stability(Stable)
public CfnFleetMetricPropsMixin.Builder period(Number period)

The time in seconds between fleet metric emissions.

Range [60(1 min), 86400(1 day)] and must be multiple of 60.

Parameters:

period - The time in seconds between fleet metric emissions. This parameter is required.

Returns:

this

See Also:

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

queryString

@Stability(Stable)
public CfnFleetMetricPropsMixin.Builder queryString(String queryString)

The search query string.

Parameters:

queryString - The search query string. This parameter is required.

Returns:

this

See Also:

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

queryVersion

@Stability(Stable)
public CfnFleetMetricPropsMixin.Builder queryVersion(String queryVersion)

The query version.

Parameters:

queryVersion - The query version. This parameter is required.

Returns:

this

See Also:

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

tags

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

Metadata which can be used to manage the fleet metric.

Parameters:

tags - Metadata which can be used to manage the fleet metric. This parameter is required.

Returns:

this

See Also:

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

unit

@Stability(Stable)
public CfnFleetMetricPropsMixin.Builder unit(String unit)

Used to support unit transformation such as milliseconds to seconds.

Must be a unit supported by CW metric. Default to null.

Parameters:

unit - Used to support unit transformation such as milliseconds to seconds. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnFleetMetricPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnFleetMetricPropsMixin.