Package software.amazon.awscdk.services.iot.actions

Class CloudWatchPutMetricAction.Builder

java.lang.Object

software.amazon.awscdk.services.iot.actions.CloudWatchPutMetricAction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CloudWatchPutMetricAction>

Enclosing class:

CloudWatchPutMetricAction

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

(experimental) A fluent builder for CloudWatchPutMetricAction.

Method Summary

Modifier and Type	Method	Description
CloudWatchPutMetricAction	build()
static CloudWatchPutMetricAction.Builder	create()
CloudWatchPutMetricAction.Builder	metricName(String metricName)	(experimental) The CloudWatch metric name.
CloudWatchPutMetricAction.Builder	metricNamespace(String metricNamespace)	(experimental) The CloudWatch metric namespace name.
CloudWatchPutMetricAction.Builder	metricTimestamp(String metricTimestamp)	(experimental) A string that contains the timestamp, expressed in seconds in Unix epoch time.
CloudWatchPutMetricAction.Builder	metricUnit(String metricUnit)	(experimental) The metric unit supported by CloudWatch.
CloudWatchPutMetricAction.Builder	metricValue(String metricValue)	(experimental) A string that contains the CloudWatch metric value.
CloudWatchPutMetricAction.Builder	role(IRole role)	(experimental) The IAM role that allows access to AWS service.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Experimental)
public static CloudWatchPutMetricAction.Builder create()

Returns:

a new instance of CloudWatchPutMetricAction.Builder.

role

@Stability(Experimental)
public CloudWatchPutMetricAction.Builder role(IRole role)

(experimental) The IAM role that allows access to AWS service.

Default: a new role will be created

Parameters:

role - The IAM role that allows access to AWS service. This parameter is required.

Returns:

this

metricName

@Stability(Experimental)
public CloudWatchPutMetricAction.Builder metricName(String metricName)

(experimental) The CloudWatch metric name.

Supports substitution templates.

Parameters:

metricName - The CloudWatch metric name. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html

metricNamespace

@Stability(Experimental)
public CloudWatchPutMetricAction.Builder metricNamespace(String metricNamespace)

(experimental) The CloudWatch metric namespace name.

Supports substitution templates.

Parameters:

metricNamespace - The CloudWatch metric namespace name. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html

metricUnit

@Stability(Experimental)
public CloudWatchPutMetricAction.Builder metricUnit(String metricUnit)

(experimental) The metric unit supported by CloudWatch.

Supports substitution templates.

Parameters:

metricUnit - The metric unit supported by CloudWatch. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html

metricValue

@Stability(Experimental)
public CloudWatchPutMetricAction.Builder metricValue(String metricValue)

(experimental) A string that contains the CloudWatch metric value.

Supports substitution templates.

Parameters:

metricValue - A string that contains the CloudWatch metric value. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html

metricTimestamp

@Stability(Experimental)
public CloudWatchPutMetricAction.Builder metricTimestamp(String metricTimestamp)

(experimental) A string that contains the timestamp, expressed in seconds in Unix epoch time.

Supports substitution templates.

Default: - none -- Defaults to the current Unix epoch time.

Parameters:

metricTimestamp - A string that contains the timestamp, expressed in seconds in Unix epoch time. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html

build

@Stability(Experimental)
public CloudWatchPutMetricAction build()

Specified by:

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

Returns:

a newly built instance of CloudWatchPutMetricAction.