aws-cdk-lib/aws-stepfunctions-tasks/lib/sqs/send-message.d.ts

Version 2 of the AWS Cloud Development Kit library

import { Construct } from 'constructs';
import * as iam from '../../../aws-iam';
import * as sqs from '../../../aws-sqs';
import * as sfn from '../../../aws-stepfunctions';
import * as cdk from '../../../core';
interface SqsSendMessageOptions {
    /**
     * The SQS queue that messages will be sent to
     */
    readonly queue: sqs.IQueue;
    /**
     * The text message to send to the queue.
     */
    readonly messageBody: sfn.TaskInput;
    /**
     * The length of time, for which to delay a message.
     * Messages that you send to the queue remain invisible to consumers for the duration
     * of the delay period. The maximum allowed delay is 15 minutes.
     *
     * @default - delay set on the queue. If a delay is not set on the queue,
     *   messages are sent immediately (0 seconds).
     */
    readonly delay?: cdk.Duration;
    /**
     * The token used for deduplication of sent messages.
     * Any messages sent with the same deduplication ID are accepted successfully,
     * but aren't delivered during the 5-minute deduplication interval.
     *
     * @default - None
     */
    readonly messageDeduplicationId?: string;
    /**
     * The tag that specifies that a message belongs to a specific message group.
     *
     * Messages that belong to the same message group are processed in a FIFO manner.
     * Messages in different message groups might be processed out of order.
     *
     * @default - None
     */
    readonly messageGroupId?: string;
}
/**
 * Properties for sending a message to an SQS queue using JSONPath
 */
export interface SqsSendMessageJsonPathProps extends sfn.TaskStateJsonPathBaseProps, SqsSendMessageOptions {
}
/**
 * Properties for sending a message to an SQS queue using JSONata
 */
export interface SqsSendMessageJsonataProps extends sfn.TaskStateJsonataBaseProps, SqsSendMessageOptions {
}
/**
 * Properties for sending a message to an SQS queue
 */
export interface SqsSendMessageProps extends sfn.TaskStateBaseProps, SqsSendMessageOptions {
}
/**
 * A StepFunctions Task to send messages to SQS queue.
 */
export declare class SqsSendMessage extends sfn.TaskStateBase {
    private readonly props;
    /**
     * A StepFunctions Task to send messages to SQS queue using JSONPath.
     */
    static jsonPath(scope: Construct, id: string, props: SqsSendMessageJsonPathProps): SqsSendMessage;
    /**
     * A StepFunctions Task to send messages to SQS queue using JSONata.
     */
    static jsonata(scope: Construct, id: string, props: SqsSendMessageJsonataProps): SqsSendMessage;
    private static readonly SUPPORTED_INTEGRATION_PATTERNS;
    protected readonly taskMetrics?: sfn.TaskMetricsConfig;
    protected readonly taskPolicies?: iam.PolicyStatement[];
    private readonly integrationPattern;
    constructor(scope: Construct, id: string, props: SqsSendMessageProps);
    /**
     * @internal
     */
    protected _renderTask(topLevelQueryLanguage?: sfn.QueryLanguage): any;
}
export {};