Package software.amazon.awssdk.services.iotevents.model

Interface CreateAlarmModelRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateAlarmModelRequest.Builder,CreateAlarmModelRequest>, IotEventsRequest.Builder, SdkBuilder<CreateAlarmModelRequest.Builder,CreateAlarmModelRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateAlarmModelRequest

public static interface CreateAlarmModelRequest.Builder
extends IotEventsRequest.Builder, SdkPojo, CopyableBuilder<CreateAlarmModelRequest.Builder,CreateAlarmModelRequest>

Method Summary

Modifier and Type	Method	Description
default CreateAlarmModelRequest.Builder	alarmCapabilities(Consumer<AlarmCapabilities.Builder> alarmCapabilities)	Contains the configuration information of alarm state changes.
CreateAlarmModelRequest.Builder	alarmCapabilities(AlarmCapabilities alarmCapabilities)	Contains the configuration information of alarm state changes.
default CreateAlarmModelRequest.Builder	alarmEventActions(Consumer<AlarmEventActions.Builder> alarmEventActions)	Contains information about one or more alarm actions.
CreateAlarmModelRequest.Builder	alarmEventActions(AlarmEventActions alarmEventActions)	Contains information about one or more alarm actions.
CreateAlarmModelRequest.Builder	alarmModelDescription(String alarmModelDescription)	A description that tells you what the alarm model detects.
CreateAlarmModelRequest.Builder	alarmModelName(String alarmModelName)	A unique name that helps you identify the alarm model.
default CreateAlarmModelRequest.Builder	alarmNotification(Consumer<AlarmNotification.Builder> alarmNotification)	Contains information about one or more notification actions.
CreateAlarmModelRequest.Builder	alarmNotification(AlarmNotification alarmNotification)	Contains information about one or more notification actions.
default CreateAlarmModelRequest.Builder	alarmRule(Consumer<AlarmRule.Builder> alarmRule)	Defines when your alarm is invoked.
CreateAlarmModelRequest.Builder	alarmRule(AlarmRule alarmRule)	Defines when your alarm is invoked.
CreateAlarmModelRequest.Builder	key(String key)	An input attribute used as a key to create an alarm.
CreateAlarmModelRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateAlarmModelRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateAlarmModelRequest.Builder	roleArn(String roleArn)	The ARN of the IAM role that allows the alarm to perform actions and access AWS resources.
CreateAlarmModelRequest.Builder	severity(Integer severity)	A non-negative integer that reflects the severity level of the alarm.
CreateAlarmModelRequest.Builder	tags(Collection<Tag> tags)	A list of key-value pairs that contain metadata for the alarm model.
CreateAlarmModelRequest.Builder	tags(Consumer<Tag.Builder>... tags)	A list of key-value pairs that contain metadata for the alarm model.
CreateAlarmModelRequest.Builder	tags(Tag... tags)	A list of key-value pairs that contain metadata for the alarm model.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.iotevents.model.IotEventsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

alarmModelName

CreateAlarmModelRequest.Builder alarmModelName(String alarmModelName)

A unique name that helps you identify the alarm model. You can't change this name after you create the alarm model.

Parameters:

alarmModelName - A unique name that helps you identify the alarm model. You can't change this name after you create the alarm model.

Returns:

Returns a reference to this object so that method calls can be chained together.

alarmModelDescription

CreateAlarmModelRequest.Builder alarmModelDescription(String alarmModelDescription)

A description that tells you what the alarm model detects.

Parameters:

alarmModelDescription - A description that tells you what the alarm model detects.

Returns:

Returns a reference to this object so that method calls can be chained together.

roleArn

CreateAlarmModelRequest.Builder roleArn(String roleArn)

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

Parameters:

roleArn - The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateAlarmModelRequest.Builder tags(Collection<Tag> tags)

A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see Tagging your AWS IoT Events resources in the AWS IoT Events Developer Guide.

You can create up to 50 tags for one alarm model.

Parameters:

tags - A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see Tagging your AWS IoT Events resources in the AWS IoT Events Developer Guide.

You can create up to 50 tags for one alarm model.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateAlarmModelRequest.Builder tags(Tag... tags)

A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see Tagging your AWS IoT Events resources in the AWS IoT Events Developer Guide.

You can create up to 50 tags for one alarm model.

Parameters:

tags - A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see Tagging your AWS IoT Events resources in the AWS IoT Events Developer Guide.

You can create up to 50 tags for one alarm model.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateAlarmModelRequest.Builder tags(Consumer<Tag.Builder>... tags)

A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see Tagging your AWS IoT Events resources in the AWS IoT Events Developer Guide.

You can create up to 50 tags for one alarm model.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• tags(java.util.Collection<Tag>)

key

CreateAlarmModelRequest.Builder key(String key)

An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.

Parameters:

key - An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.

Returns:

Returns a reference to this object so that method calls can be chained together.

severity

CreateAlarmModelRequest.Builder severity(Integer severity)

A non-negative integer that reflects the severity level of the alarm.

Parameters:

severity - A non-negative integer that reflects the severity level of the alarm.

Returns:

Returns a reference to this object so that method calls can be chained together.

alarmRule

CreateAlarmModelRequest.Builder alarmRule(AlarmRule alarmRule)

Defines when your alarm is invoked.

Parameters:

alarmRule - Defines when your alarm is invoked.

Returns:

Returns a reference to this object so that method calls can be chained together.

alarmRule

default CreateAlarmModelRequest.Builder alarmRule(Consumer<AlarmRule.Builder> alarmRule)

Defines when your alarm is invoked.

This is a convenience method that creates an instance of the AlarmRule.Builder avoiding the need to create one manually via AlarmRule.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to alarmRule(AlarmRule).

Parameters:

alarmRule - a consumer that will call methods on AlarmRule.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• alarmRule(AlarmRule)

alarmNotification

CreateAlarmModelRequest.Builder alarmNotification(AlarmNotification alarmNotification)

Contains information about one or more notification actions.

Parameters:

alarmNotification - Contains information about one or more notification actions.

Returns:

Returns a reference to this object so that method calls can be chained together.

alarmNotification

default CreateAlarmModelRequest.Builder alarmNotification(Consumer<AlarmNotification.Builder> alarmNotification)

Contains information about one or more notification actions.

This is a convenience method that creates an instance of the AlarmNotification.Builder avoiding the need to create one manually via AlarmNotification.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to alarmNotification(AlarmNotification).

Parameters:

alarmNotification - a consumer that will call methods on AlarmNotification.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• alarmNotification(AlarmNotification)

alarmEventActions

CreateAlarmModelRequest.Builder alarmEventActions(AlarmEventActions alarmEventActions)

Contains information about one or more alarm actions.

Parameters:

alarmEventActions - Contains information about one or more alarm actions.

Returns:

Returns a reference to this object so that method calls can be chained together.

alarmEventActions

default CreateAlarmModelRequest.Builder alarmEventActions(Consumer<AlarmEventActions.Builder> alarmEventActions)

Contains information about one or more alarm actions.

This is a convenience method that creates an instance of the AlarmEventActions.Builder avoiding the need to create one manually via AlarmEventActions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to alarmEventActions(AlarmEventActions).

Parameters:

alarmEventActions - a consumer that will call methods on AlarmEventActions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• alarmEventActions(AlarmEventActions)

alarmCapabilities

CreateAlarmModelRequest.Builder alarmCapabilities(AlarmCapabilities alarmCapabilities)

Contains the configuration information of alarm state changes.

Parameters:

alarmCapabilities - Contains the configuration information of alarm state changes.

Returns:

Returns a reference to this object so that method calls can be chained together.

alarmCapabilities

default CreateAlarmModelRequest.Builder alarmCapabilities(Consumer<AlarmCapabilities.Builder> alarmCapabilities)

Contains the configuration information of alarm state changes.

This is a convenience method that creates an instance of the AlarmCapabilities.Builder avoiding the need to create one manually via AlarmCapabilities.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to alarmCapabilities(AlarmCapabilities).

Parameters:

alarmCapabilities - a consumer that will call methods on AlarmCapabilities.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• alarmCapabilities(AlarmCapabilities)

overrideConfiguration

CreateAlarmModelRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateAlarmModelRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.