Package software.amazon.awscdk.services.iotevents

Class CfnAlarmModel.DynamoDBProperty.Builder

java.lang.Object

software.amazon.awscdk.services.iotevents.CfnAlarmModel.DynamoDBProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAlarmModel.DynamoDBProperty>

Enclosing interface:

CfnAlarmModel.DynamoDBProperty

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

A builder for CfnAlarmModel.DynamoDBProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAlarmModel.DynamoDBProperty	build()	Builds the configured instance.
CfnAlarmModel.DynamoDBProperty.Builder	hashKeyField(String hashKeyField)	Sets the value of CfnAlarmModel.DynamoDBProperty.getHashKeyField()
CfnAlarmModel.DynamoDBProperty.Builder	hashKeyType(String hashKeyType)	Sets the value of CfnAlarmModel.DynamoDBProperty.getHashKeyType()
CfnAlarmModel.DynamoDBProperty.Builder	hashKeyValue(String hashKeyValue)	Sets the value of CfnAlarmModel.DynamoDBProperty.getHashKeyValue()
CfnAlarmModel.DynamoDBProperty.Builder	operation(String operation)	Sets the value of CfnAlarmModel.DynamoDBProperty.getOperation()
CfnAlarmModel.DynamoDBProperty.Builder	payload(IResolvable payload)	Sets the value of CfnAlarmModel.DynamoDBProperty.getPayload()
CfnAlarmModel.DynamoDBProperty.Builder	payload(CfnAlarmModel.PayloadProperty payload)	Sets the value of CfnAlarmModel.DynamoDBProperty.getPayload()
CfnAlarmModel.DynamoDBProperty.Builder	payloadField(String payloadField)	Sets the value of CfnAlarmModel.DynamoDBProperty.getPayloadField()
CfnAlarmModel.DynamoDBProperty.Builder	rangeKeyField(String rangeKeyField)	Sets the value of CfnAlarmModel.DynamoDBProperty.getRangeKeyField()
CfnAlarmModel.DynamoDBProperty.Builder	rangeKeyType(String rangeKeyType)	Sets the value of CfnAlarmModel.DynamoDBProperty.getRangeKeyType()
CfnAlarmModel.DynamoDBProperty.Builder	rangeKeyValue(String rangeKeyValue)	Sets the value of CfnAlarmModel.DynamoDBProperty.getRangeKeyValue()
CfnAlarmModel.DynamoDBProperty.Builder	tableName(String tableName)	Sets the value of CfnAlarmModel.DynamoDBProperty.getTableName()

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

hashKeyField

@Stability(Stable)
public CfnAlarmModel.DynamoDBProperty.Builder hashKeyField(String hashKeyField)

Sets the value of CfnAlarmModel.DynamoDBProperty.getHashKeyField()

Parameters:

hashKeyField - The name of the hash key (also called the partition key). This parameter is required. The hashKeyField value must match the partition key of the target DynamoDB table.

Returns:

this

hashKeyValue

@Stability(Stable)
public CfnAlarmModel.DynamoDBProperty.Builder hashKeyValue(String hashKeyValue)

Sets the value of CfnAlarmModel.DynamoDBProperty.getHashKeyValue()

Parameters:

hashKeyValue - The value of the hash key (also called the partition key). This parameter is required.

Returns:

this

tableName

@Stability(Stable)
public CfnAlarmModel.DynamoDBProperty.Builder tableName(String tableName)

Sets the value of CfnAlarmModel.DynamoDBProperty.getTableName()

Parameters:

tableName - The name of the DynamoDB table. This parameter is required. The tableName value must match the table name of the target DynamoDB table.

Returns:

this

hashKeyType

@Stability(Stable)
public CfnAlarmModel.DynamoDBProperty.Builder hashKeyType(String hashKeyType)

Sets the value of CfnAlarmModel.DynamoDBProperty.getHashKeyType()

Parameters:

hashKeyType - The data type for the hash key (also called the partition key). You can specify the following values:.

• 'STRING' - The hash key is a string.
• 'NUMBER' - The hash key is a number.

If you don't specify hashKeyType , the default value is 'STRING' .

Returns:

this

operation

@Stability(Stable)
public CfnAlarmModel.DynamoDBProperty.Builder operation(String operation)

Sets the value of CfnAlarmModel.DynamoDBProperty.getOperation()

Parameters:

operation - The type of operation to perform. You can specify the following values:.

• 'INSERT' - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.
• 'UPDATE' - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
• 'DELETE' - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.

If you don't specify this parameter, AWS IoT Events triggers the 'INSERT' operation.

Returns:

this

payload

@Stability(Stable)
public CfnAlarmModel.DynamoDBProperty.Builder payload(IResolvable payload)

Sets the value of CfnAlarmModel.DynamoDBProperty.getPayload()

Parameters:

payload - Information needed to configure the payload. By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression .

Returns:

this

payload

@Stability(Stable)
public CfnAlarmModel.DynamoDBProperty.Builder payload(CfnAlarmModel.PayloadProperty payload)

Sets the value of CfnAlarmModel.DynamoDBProperty.getPayload()

Parameters:

payload - Information needed to configure the payload. By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression .

Returns:

this

payloadField

@Stability(Stable)
public CfnAlarmModel.DynamoDBProperty.Builder payloadField(String payloadField)

Sets the value of CfnAlarmModel.DynamoDBProperty.getPayloadField()

Parameters:

payloadField - The name of the DynamoDB column that receives the action payload. If you don't specify this parameter, the name of the DynamoDB column is payload .

Returns:

this

rangeKeyField

@Stability(Stable)
public CfnAlarmModel.DynamoDBProperty.Builder rangeKeyField(String rangeKeyField)

Sets the value of CfnAlarmModel.DynamoDBProperty.getRangeKeyField()

Parameters:

rangeKeyField - The name of the range key (also called the sort key). The rangeKeyField value must match the sort key of the target DynamoDB table.

Returns:

this

rangeKeyType

@Stability(Stable)
public CfnAlarmModel.DynamoDBProperty.Builder rangeKeyType(String rangeKeyType)

Sets the value of CfnAlarmModel.DynamoDBProperty.getRangeKeyType()

Parameters:

rangeKeyType - The data type for the range key (also called the sort key), You can specify the following values:.

• 'STRING' - The range key is a string.
• 'NUMBER' - The range key is number.

If you don't specify rangeKeyField , the default value is 'STRING' .

Returns:

this

rangeKeyValue

@Stability(Stable)
public CfnAlarmModel.DynamoDBProperty.Builder rangeKeyValue(String rangeKeyValue)

Sets the value of CfnAlarmModel.DynamoDBProperty.getRangeKeyValue()

Parameters:

rangeKeyValue - The value of the range key (also called the sort key).

Returns:

this

build

@Stability(Stable)
public CfnAlarmModel.DynamoDBProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnAlarmModel.DynamoDBProperty>

Returns:

a new instance of CfnAlarmModel.DynamoDBProperty

Throws:

NullPointerException - if any required attribute was not provided