Package software.amazon.awscdk.services.iot

Class CfnFleetMetricProps.Builder

java.lang.Object

software.amazon.awscdk.services.iot.CfnFleetMetricProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFleetMetricProps>

Enclosing interface:

CfnFleetMetricProps

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

A builder for CfnFleetMetricProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnFleetMetricProps.Builder	aggregationField(String aggregationField)	Sets the value of CfnFleetMetricProps.getAggregationField()
CfnFleetMetricProps.Builder	aggregationType(IResolvable aggregationType)	Sets the value of CfnFleetMetricProps.getAggregationType()
CfnFleetMetricProps.Builder	aggregationType(CfnFleetMetric.AggregationTypeProperty aggregationType)	Sets the value of CfnFleetMetricProps.getAggregationType()
CfnFleetMetricProps	build()	Builds the configured instance.
CfnFleetMetricProps.Builder	description(String description)	Sets the value of CfnFleetMetricProps.getDescription()
CfnFleetMetricProps.Builder	indexName(String indexName)	Sets the value of CfnFleetMetricProps.getIndexName()
CfnFleetMetricProps.Builder	metricName(String metricName)	Sets the value of CfnFleetMetricProps.getMetricName()
CfnFleetMetricProps.Builder	period(Number period)	Sets the value of CfnFleetMetricProps.getPeriod()
CfnFleetMetricProps.Builder	queryString(String queryString)	Sets the value of CfnFleetMetricProps.getQueryString()
CfnFleetMetricProps.Builder	queryVersion(String queryVersion)	Sets the value of CfnFleetMetricProps.getQueryVersion()
CfnFleetMetricProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnFleetMetricProps.getTags()
CfnFleetMetricProps.Builder	unit(String unit)	Sets the value of CfnFleetMetricProps.getUnit()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

metricName

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

Sets the value of CfnFleetMetricProps.getMetricName()

Parameters:

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

Returns:

this

aggregationField

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

Sets the value of CfnFleetMetricProps.getAggregationField()

Parameters:

aggregationField - The field to aggregate.

Returns:

this

aggregationType

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

Sets the value of CfnFleetMetricProps.getAggregationType()

Parameters:

aggregationType - The type of the aggregation query.

Returns:

this

aggregationType

@Stability(Stable)
public CfnFleetMetricProps.Builder aggregationType(CfnFleetMetric.AggregationTypeProperty aggregationType)

Sets the value of CfnFleetMetricProps.getAggregationType()

Parameters:

aggregationType - The type of the aggregation query.

Returns:

this

description

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

Sets the value of CfnFleetMetricProps.getDescription()

Parameters:

description - The fleet metric description.

Returns:

this

indexName

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

Sets the value of CfnFleetMetricProps.getIndexName()

Parameters:

indexName - The name of the index to search.

Returns:

this

period

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

Sets the value of CfnFleetMetricProps.getPeriod()

Parameters:

period - The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

Returns:

this

queryString

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

Sets the value of CfnFleetMetricProps.getQueryString()

Parameters:

queryString - The search query string.

Returns:

this

queryVersion

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

Sets the value of CfnFleetMetricProps.getQueryVersion()

Parameters:

queryVersion - The query version.

Returns:

this

tags

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

Sets the value of CfnFleetMetricProps.getTags()

Parameters:

tags - Metadata which can be used to manage the fleet metric.

Returns:

this

unit

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

Sets the value of CfnFleetMetricProps.getUnit()

Parameters:

unit - Used to support unit transformation such as milliseconds to seconds. Must be a unit supported by CW metric. Default to null.

Returns:

this

build

@Stability(Stable)
public CfnFleetMetricProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnFleetMetricProps

Throws:

NullPointerException - if any required attribute was not provided