io.cloudshiftdev.awscdk.services.events.targets.SqsQueueProps.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.events.targets
import io.cloudshiftdev.awscdk.Duration
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import io.cloudshiftdev.awscdk.services.events.RuleTargetInput
import io.cloudshiftdev.awscdk.services.sqs.IQueue
import kotlin.Number
import kotlin.String
import kotlin.Unit
/**
* Customize the SQS Queue Event Target.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.*;
* import io.cloudshiftdev.awscdk.services.events.*;
* import io.cloudshiftdev.awscdk.services.events.targets.*;
* import io.cloudshiftdev.awscdk.services.sqs.*;
* Queue queue;
* RuleTargetInput ruleTargetInput;
* SqsQueueProps sqsQueueProps = SqsQueueProps.builder()
* .deadLetterQueue(queue)
* .maxEventAge(Duration.minutes(30))
* .message(ruleTargetInput)
* .messageGroupId("messageGroupId")
* .retryAttempts(123)
* .build();
* ```
*/
public interface SqsQueueProps : TargetBaseProps {
/**
* The message to send to the queue.
*
* Must be a valid JSON text passed to the target queue.
*
* Default: the entire EventBridge event
*/
public fun message(): RuleTargetInput? = unwrap(this).getMessage()?.let(RuleTargetInput::wrap)
/**
* Message Group ID for messages sent to this queue.
*
* Required for FIFO queues, leave empty for regular queues.
*
* Default: - no message group ID (regular queue)
*/
public fun messageGroupId(): String? = unwrap(this).getMessageGroupId()
/**
* A builder for [SqsQueueProps]
*/
@CdkDslMarker
public interface Builder {
/**
* @param deadLetterQueue The SQS queue to be used as deadLetterQueue. Check out the
* [considerations for using a dead-letter
* queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations).
* The events not successfully delivered are automatically retried for a specified period of
* time,
* depending on the retry policy of the target.
* If an event is not delivered before all retry attempts are exhausted, it will be sent to the
* dead letter queue.
*/
public fun deadLetterQueue(deadLetterQueue: IQueue)
/**
* @param maxEventAge The maximum age of a request that Lambda sends to a function for
* processing.
* Minimum value of 60.
* Maximum value of 86400.
*/
public fun maxEventAge(maxEventAge: Duration)
/**
* @param message The message to send to the queue.
* Must be a valid JSON text passed to the target queue.
*/
public fun message(message: RuleTargetInput)
/**
* @param messageGroupId Message Group ID for messages sent to this queue.
* Required for FIFO queues, leave empty for regular queues.
*/
public fun messageGroupId(messageGroupId: String)
/**
* @param retryAttempts The maximum number of times to retry when the function returns an error.
* Minimum value of 0.
* Maximum value of 185.
*/
public fun retryAttempts(retryAttempts: Number)
}
private class BuilderImpl : Builder {
private val cdkBuilder: software.amazon.awscdk.services.events.targets.SqsQueueProps.Builder =
software.amazon.awscdk.services.events.targets.SqsQueueProps.builder()
/**
* @param deadLetterQueue The SQS queue to be used as deadLetterQueue. Check out the
* [considerations for using a dead-letter
* queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations).
* The events not successfully delivered are automatically retried for a specified period of
* time,
* depending on the retry policy of the target.
* If an event is not delivered before all retry attempts are exhausted, it will be sent to the
* dead letter queue.
*/
override fun deadLetterQueue(deadLetterQueue: IQueue) {
cdkBuilder.deadLetterQueue(deadLetterQueue.let(IQueue.Companion::unwrap))
}
/**
* @param maxEventAge The maximum age of a request that Lambda sends to a function for
* processing.
* Minimum value of 60.
* Maximum value of 86400.
*/
override fun maxEventAge(maxEventAge: Duration) {
cdkBuilder.maxEventAge(maxEventAge.let(Duration.Companion::unwrap))
}
/**
* @param message The message to send to the queue.
* Must be a valid JSON text passed to the target queue.
*/
override fun message(message: RuleTargetInput) {
cdkBuilder.message(message.let(RuleTargetInput.Companion::unwrap))
}
/**
* @param messageGroupId Message Group ID for messages sent to this queue.
* Required for FIFO queues, leave empty for regular queues.
*/
override fun messageGroupId(messageGroupId: String) {
cdkBuilder.messageGroupId(messageGroupId)
}
/**
* @param retryAttempts The maximum number of times to retry when the function returns an error.
* Minimum value of 0.
* Maximum value of 185.
*/
override fun retryAttempts(retryAttempts: Number) {
cdkBuilder.retryAttempts(retryAttempts)
}
public fun build(): software.amazon.awscdk.services.events.targets.SqsQueueProps =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.events.targets.SqsQueueProps,
) : CdkObject(cdkObject),
SqsQueueProps {
/**
* The SQS queue to be used as deadLetterQueue. Check out the [considerations for using a
* dead-letter
* queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations).
*
* The events not successfully delivered are automatically retried for a specified period of
* time,
* depending on the retry policy of the target.
* If an event is not delivered before all retry attempts are exhausted, it will be sent to the
* dead letter queue.
*
* Default: - no dead-letter queue
*/
override fun deadLetterQueue(): IQueue? = unwrap(this).getDeadLetterQueue()?.let(IQueue::wrap)
/**
* The maximum age of a request that Lambda sends to a function for processing.
*
* Minimum value of 60.
* Maximum value of 86400.
*
* Default: Duration.hours(24)
*/
override fun maxEventAge(): Duration? = unwrap(this).getMaxEventAge()?.let(Duration::wrap)
/**
* The message to send to the queue.
*
* Must be a valid JSON text passed to the target queue.
*
* Default: the entire EventBridge event
*/
override fun message(): RuleTargetInput? = unwrap(this).getMessage()?.let(RuleTargetInput::wrap)
/**
* Message Group ID for messages sent to this queue.
*
* Required for FIFO queues, leave empty for regular queues.
*
* Default: - no message group ID (regular queue)
*/
override fun messageGroupId(): String? = unwrap(this).getMessageGroupId()
/**
* The maximum number of times to retry when the function returns an error.
*
* Minimum value of 0.
* Maximum value of 185.
*
* Default: 185
*/
override fun retryAttempts(): Number? = unwrap(this).getRetryAttempts()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): SqsQueueProps {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.events.targets.SqsQueueProps):
SqsQueueProps = CdkObjectWrappers.wrap(cdkObject) as? SqsQueueProps ?: Wrapper(cdkObject)
internal fun unwrap(wrapped: SqsQueueProps):
software.amazon.awscdk.services.events.targets.SqsQueueProps = (wrapped as
CdkObject).cdkObject as software.amazon.awscdk.services.events.targets.SqsQueueProps
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy