GradientEdge CDK Utils
    Preparing search index...

    Interface SfnDynamoDeleteItemProps

    interface SfnDynamoDeleteItemProps {
        assign?: { [name: string]: any };
        comment?: string;
        conditionExpression?: string;
        credentials?: Credentials;
        expressionAttributeNames?: { [key: string]: string };
        expressionAttributeValues?: { [key: string]: DynamoAttributeValue };
        heartbeat?: Duration;
        heartbeatTimeout?: Timeout;
        inputPath?: string;
        integrationPattern?: IntegrationPattern;
        key: { [key: string]: DynamoAttributeValue };
        name: string;
        outputPath?: string;
        outputs?: any;
        queryLanguage?: QueryLanguage;
        resultPath?: string;
        resultSelector?: { [key: string]: any };
        retries?: SfnRetryProps[];
        returnConsumedCapacity?: DynamoConsumedCapacity;
        returnItemCollectionMetrics?: DynamoItemCollectionMetrics;
        returnValues?: DynamoReturnValues;
        stateName?: string;
        table: ITableRef;
        taskTimeout?: Timeout;
        timeout?: Duration;
    }

    Hierarchy

    • DynamoDeleteItemProps
      • SfnDynamoDeleteItemProps
    Index

    Properties

    assign? comment? conditionExpression? credentials? expressionAttributeNames? expressionAttributeValues? heartbeat? heartbeatTimeout? inputPath? integrationPattern? key name outputPath? outputs? queryLanguage? resultPath? resultSelector? retries? returnConsumedCapacity? returnItemCollectionMetrics? returnValues? stateName? table taskTimeout? timeout?

    Properties

    assign?: { [name: string]: any }

    Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps.

    https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

    - Not assign variables
    comment?: string

    A comment describing this state

    No comment
    conditionExpression?: string

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

    https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteItem.html#DDB-DeleteItem-request-ConditionExpression

    - No condition expression
    credentials?: Credentials

    Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations.

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

    - None (Task is executed using the State Machine's execution role)
    expressionAttributeNames?: { [key: string]: string }

    One or more substitution tokens for attribute names in an expression

    https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteItem.html#DDB-DeleteItem-request-ExpressionAttributeNames

    - No expression attribute names
    expressionAttributeValues?: { [key: string]: DynamoAttributeValue }

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

    https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteItem.html#DDB-DeleteItem-request-ExpressionAttributeValues

    - No expression attribute values
    heartbeat?: Duration

    Timeout for the heartbeat

    - None

    use heartbeatTimeout

    heartbeatTimeout?: Timeout

    Timeout for the heartbeat

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

    - None
    inputPath?: string

    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 {}.

    $
    integrationPattern?: IntegrationPattern

    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.

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

    • IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.
    key: { [key: string]: DynamoAttributeValue }

    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.

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

    name: string
    outputPath?: string

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

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

    $
    outputs?: any

    Used to specify and transform output from the state. When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

    https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

    - $states.result or $states.errorOutput
    queryLanguage?: QueryLanguage

    The name of the query language used by the state. If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

    - JSONPath
    resultPath?: string

    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.

    $
    resultSelector?: { [key: string]: any }

    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.

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

    - None
    retries?: SfnRetryProps[]
    returnConsumedCapacity?: DynamoConsumedCapacity

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

    https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteItem.html#DDB-DeleteItem-request-ReturnConsumedCapacity

    DynamoConsumedCapacity.NONE
    returnItemCollectionMetrics?: DynamoItemCollectionMetrics

    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.

    DynamoItemCollectionMetrics.NONE
    returnValues?: DynamoReturnValues

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

    https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteItem.html#DDB-DeleteItem-request-ReturnValues

    DynamoReturnValues.NONE
    stateName?: string

    Optional name for this state

    - The construct ID will be used as state name
    table: ITableRef

    The name of the table containing the requested item.

    taskTimeout?: Timeout

    Timeout for the task

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

    - None
    timeout?: Duration

    Timeout for the task

    - None

    use taskTimeout

    Settings

    Member Visibility

    On This Page

    Properties