Package software.amazon.awscdk.services.stepfunctions.tasks

Class DynamoUpdateItemProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.stepfunctions.tasks.DynamoUpdateItemProps.Jsii$Proxy

All Implemented Interfaces:

DynamoUpdateItemProps, TaskStateBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

DynamoUpdateItemProps

@Stability(Stable)
@Internal
public static final class DynamoUpdateItemProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements DynamoUpdateItemProps

An implementation for DynamoUpdateItemProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.tasks.DynamoUpdateItemProps

DynamoUpdateItemProps.Builder, DynamoUpdateItemProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(DynamoUpdateItemProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the DynamoUpdateItemProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getComment()	An optional description for this state.
final String	getConditionExpression()	A condition that must be satisfied in order for a conditional DeleteItem to succeed.
final Credentials	getCredentials()	Credentials for an IAM Role that the State Machine assumes for executing the task.
final Map<String,String>	getExpressionAttributeNames()	One or more substitution tokens for attribute names in an expression.
final Map<String,DynamoAttributeValue>	getExpressionAttributeValues()	One or more values that can be substituted in an expression.
final Duration	getHeartbeat()	(deprecated) Timeout for the heartbeat.
final Timeout	getHeartbeatTimeout()	Timeout for the heartbeat.
final String	getInputPath()	JSONPath expression to select part of the state to be the input to this state.
final IntegrationPattern	getIntegrationPattern()	AWS Step Functions integrates with services directly in the Amazon States Language.
final Map<String,DynamoAttributeValue>	getKey()	Primary key of the item to retrieve.
final String	getOutputPath()	JSONPath expression to select select a portion of the state output to pass to the next state.
final String	getResultPath()	JSONPath expression to indicate where to inject the state's output.
final Map<String,Object>	getResultSelector()	The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
final DynamoConsumedCapacity	getReturnConsumedCapacity()	Determines the level of detail about provisioned throughput consumption that is returned in the response.
final DynamoItemCollectionMetrics	getReturnItemCollectionMetrics()	Determines whether item collection metrics are returned.
final DynamoReturnValues	getReturnValues()	Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
final String	getStateName()	Optional name for this state.
final ITable	getTable()	The name of the table containing the requested item.
final Timeout	getTaskTimeout()	Timeout for the task.
final Duration	getTimeout()	(deprecated) Timeout for the task.
final String	getUpdateExpression()	An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(DynamoUpdateItemProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the DynamoUpdateItemProps.Builder.

Method Details

getKey

public final Map<String,DynamoAttributeValue> getKey()

Description copied from interface: DynamoUpdateItemProps

Primary key of the item to retrieve.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Specified by:

getKey in interface DynamoUpdateItemProps

See Also:

• https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-Key

getTable

public final ITable getTable()

Description copied from interface: DynamoUpdateItemProps

The name of the table containing the requested item.

Specified by:

getTable in interface DynamoUpdateItemProps

getConditionExpression

public final String getConditionExpression()

Description copied from interface: DynamoUpdateItemProps

A condition that must be satisfied in order for a conditional DeleteItem to succeed.

Default: - No condition expression

Specified by:

getConditionExpression in interface DynamoUpdateItemProps

See Also:

• https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateItem.html#DDB-UpdateItem-request-ConditionExpression

getExpressionAttributeNames

public final Map<String,String> getExpressionAttributeNames()

Description copied from interface: DynamoUpdateItemProps

One or more substitution tokens for attribute names in an expression.

Default: - No expression attribute names

Specified by:

getExpressionAttributeNames in interface DynamoUpdateItemProps

See Also:

• https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateItem.html#DDB-UpdateItem-request-ExpressionAttributeNames

getExpressionAttributeValues

public final Map<String,DynamoAttributeValue> getExpressionAttributeValues()

Description copied from interface: DynamoUpdateItemProps

One or more values that can be substituted in an expression.

Default: - No expression attribute values

Specified by:

getExpressionAttributeValues in interface DynamoUpdateItemProps

See Also:

• https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateItem.html#DDB-UpdateItem-request-ExpressionAttributeValues

getReturnConsumedCapacity

public final DynamoConsumedCapacity getReturnConsumedCapacity()

Description copied from interface: DynamoUpdateItemProps

Determines the level of detail about provisioned throughput consumption that is returned in the response.

Default: DynamoConsumedCapacity.NONE

Specified by:

getReturnConsumedCapacity in interface DynamoUpdateItemProps

See Also:

• https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateItem.html#DDB-UpdateItem-request-ReturnConsumedCapacity

getReturnItemCollectionMetrics

public final DynamoItemCollectionMetrics getReturnItemCollectionMetrics()

Description copied from interface: DynamoUpdateItemProps

Determines whether item collection metrics are returned.

If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Default: DynamoItemCollectionMetrics.NONE

Specified by:

getReturnItemCollectionMetrics in interface DynamoUpdateItemProps

getReturnValues

public final DynamoReturnValues getReturnValues()

Description copied from interface: DynamoUpdateItemProps

Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.

Default: DynamoReturnValues.NONE

Specified by:

getReturnValues in interface DynamoUpdateItemProps

See Also:

• https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateItem.html#DDB-UpdateItem-request-ReturnValues

getUpdateExpression

public final String getUpdateExpression()

Description copied from interface: DynamoUpdateItemProps

An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

Default: - No update expression

Specified by:

getUpdateExpression in interface DynamoUpdateItemProps

See Also:

• https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateItem.html#DDB-UpdateItem-request-UpdateExpression

getComment

public final String getComment()

Description copied from interface: TaskStateBaseProps

An optional description for this state.

Default: - No comment

Specified by:

getComment in interface TaskStateBaseProps

getCredentials

public final Credentials getCredentials()

Description copied from interface: TaskStateBaseProps

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

Default: - None (Task is executed using the State Machine's execution role)

Specified by:

getCredentials in interface TaskStateBaseProps

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html

getHeartbeat

public final Duration getHeartbeat()

Description copied from interface: TaskStateBaseProps

(deprecated) Timeout for the heartbeat.

Default: - None

Specified by:

getHeartbeat in interface TaskStateBaseProps

getHeartbeatTimeout

public final Timeout getHeartbeatTimeout()

Description copied from interface: TaskStateBaseProps

Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Default: - None

Specified by:

getHeartbeatTimeout in interface TaskStateBaseProps

getInputPath

public final String getInputPath()

Description copied from interface: TaskStateBaseProps

JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Default: - The entire task input (JSON path '$')

Specified by:

getInputPath in interface TaskStateBaseProps

getIntegrationPattern

public final IntegrationPattern getIntegrationPattern()

Description copied from interface: TaskStateBaseProps

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.

Specified by:

getIntegrationPattern in interface TaskStateBaseProps

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html

getOutputPath

public final String getOutputPath()

Description copied from interface: TaskStateBaseProps

JSONPath expression to select select a portion of the state output to pass to the next state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')

Specified by:

getOutputPath in interface TaskStateBaseProps

getResultPath

public final String getResultPath()

Description copied from interface: TaskStateBaseProps

JSONPath expression to indicate where to inject the state's output.

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Default: - Replaces the entire input with the result (JSON path '$')

Specified by:

getResultPath in interface TaskStateBaseProps

getResultSelector

public final Map<String,Object> getResultSelector()

Description copied from interface: TaskStateBaseProps

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Default: - None

Specified by:

getResultSelector in interface TaskStateBaseProps

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

getStateName

public final String getStateName()

Description copied from interface: TaskStateBaseProps

Optional name for this state.

Default: - The construct ID will be used as state name

Specified by:

getStateName in interface TaskStateBaseProps

getTaskTimeout

public final Timeout getTaskTimeout()

Description copied from interface: TaskStateBaseProps

Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Default: - None

Specified by:

getTaskTimeout in interface TaskStateBaseProps

getTimeout

public final Duration getTimeout()

Description copied from interface: TaskStateBaseProps

(deprecated) Timeout for the task.

Default: - None

Specified by:

getTimeout in interface TaskStateBaseProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object