Package software.amazon.awscdk.services.iot

Class CfnFleetMetric.Builder

java.lang.Object

software.amazon.awscdk.services.iot.CfnFleetMetric.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFleetMetric>

Enclosing class:

CfnFleetMetric

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

A fluent builder for CfnFleetMetric.

Method Summary

Modifier and Type	Method	Description
CfnFleetMetric.Builder	aggregationField(String aggregationField)	The field to aggregate.
CfnFleetMetric.Builder	aggregationType(IResolvable aggregationType)	The type of the aggregation query.
CfnFleetMetric.Builder	aggregationType(CfnFleetMetric.AggregationTypeProperty aggregationType)	The type of the aggregation query.
CfnFleetMetric	build()
static CfnFleetMetric.Builder	create(software.constructs.Construct scope, String id)
CfnFleetMetric.Builder	description(String description)	The fleet metric description.
CfnFleetMetric.Builder	indexName(String indexName)	The name of the index to search.
CfnFleetMetric.Builder	metricName(String metricName)	The name of the fleet metric to create.
CfnFleetMetric.Builder	period(Number period)	The time in seconds between fleet metric emissions.
CfnFleetMetric.Builder	queryString(String queryString)	The search query string.
CfnFleetMetric.Builder	queryVersion(String queryVersion)	The query version.
CfnFleetMetric.Builder	tags(List<? extends CfnTag> tags)	Metadata which can be used to manage the fleet metric.
CfnFleetMetric.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 CfnFleetMetric.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 CfnFleetMetric.Builder.

metricName

@Stability(Stable)
public CfnFleetMetric.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

aggregationField

@Stability(Stable)
public CfnFleetMetric.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 CfnFleetMetric.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 CfnFleetMetric.Builder aggregationType(CfnFleetMetric.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 CfnFleetMetric.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 CfnFleetMetric.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

period

@Stability(Stable)
public CfnFleetMetric.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 CfnFleetMetric.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 CfnFleetMetric.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 CfnFleetMetric.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 CfnFleetMetric.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 CfnFleetMetric build()

Specified by:

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

Returns:

a newly built instance of CfnFleetMetric.