CfnQueueProps

class aws_cdk.aws_sqs.CfnQueueProps(*, content_based_deduplication=None, deduplication_scope=None, delay_seconds=None, fifo_queue=None, fifo_throughput_limit=None, kms_data_key_reuse_period_seconds=None, kms_master_key_id=None, maximum_message_size=None, message_retention_period=None, queue_name=None, receive_message_wait_time_seconds=None, redrive_allow_policy=None, redrive_policy=None, tags=None, visibility_timeout=None)

Bases: object

Properties for defining a AWS::SQS::Queue.

Parameters
  • content_based_deduplication (Union[bool, IResolvable, None]) – AWS::SQS::Queue.ContentBasedDeduplication.

  • deduplication_scope (Optional[str]) – AWS::SQS::Queue.DeduplicationScope.

  • delay_seconds (Union[int, float, None]) – AWS::SQS::Queue.DelaySeconds.

  • fifo_queue (Union[bool, IResolvable, None]) – AWS::SQS::Queue.FifoQueue.

  • fifo_throughput_limit (Optional[str]) – AWS::SQS::Queue.FifoThroughputLimit.

  • kms_data_key_reuse_period_seconds (Union[int, float, None]) – AWS::SQS::Queue.KmsDataKeyReusePeriodSeconds.

  • kms_master_key_id (Optional[str]) – AWS::SQS::Queue.KmsMasterKeyId.

  • maximum_message_size (Union[int, float, None]) – AWS::SQS::Queue.MaximumMessageSize.

  • message_retention_period (Union[int, float, None]) – AWS::SQS::Queue.MessageRetentionPeriod.

  • queue_name (Optional[str]) – AWS::SQS::Queue.QueueName.

  • receive_message_wait_time_seconds (Union[int, float, None]) – AWS::SQS::Queue.ReceiveMessageWaitTimeSeconds.

  • redrive_allow_policy (Optional[Any]) – AWS::SQS::Queue.RedriveAllowPolicy.

  • redrive_policy (Optional[Any]) – AWS::SQS::Queue.RedrivePolicy.

  • tags (Optional[Sequence[CfnTag]]) – AWS::SQS::Queue.Tags.

  • visibility_timeout (Union[int, float, None]) – AWS::SQS::Queue.VisibilityTimeout.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_sqs as sqs

# redrive_allow_policy is of type object
# redrive_policy is of type object

cfn_queue_props = sqs.CfnQueueProps(
    content_based_deduplication=False,
    deduplication_scope="deduplicationScope",
    delay_seconds=123,
    fifo_queue=False,
    fifo_throughput_limit="fifoThroughputLimit",
    kms_data_key_reuse_period_seconds=123,
    kms_master_key_id="kmsMasterKeyId",
    maximum_message_size=123,
    message_retention_period=123,
    queue_name="queueName",
    receive_message_wait_time_seconds=123,
    redrive_allow_policy=redrive_allow_policy,
    redrive_policy=redrive_policy,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    visibility_timeout=123
)

Attributes

content_based_deduplication

AWS::SQS::Queue.ContentBasedDeduplication.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-contentbaseddeduplication

Return type

Union[bool, IResolvable, None]

deduplication_scope

AWS::SQS::Queue.DeduplicationScope.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-deduplicationscope

Return type

Optional[str]

delay_seconds

AWS::SQS::Queue.DelaySeconds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-delayseconds

Return type

Union[int, float, None]

fifo_queue

AWS::SQS::Queue.FifoQueue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-fifoqueue

Return type

Union[bool, IResolvable, None]

fifo_throughput_limit

AWS::SQS::Queue.FifoThroughputLimit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-fifothroughputlimit

Return type

Optional[str]

kms_data_key_reuse_period_seconds

AWS::SQS::Queue.KmsDataKeyReusePeriodSeconds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-kmsdatakeyreuseperiodseconds

Return type

Union[int, float, None]

kms_master_key_id

AWS::SQS::Queue.KmsMasterKeyId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-kmsmasterkeyid

Return type

Optional[str]

maximum_message_size

AWS::SQS::Queue.MaximumMessageSize.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-maxmesgsize

Return type

Union[int, float, None]

message_retention_period

AWS::SQS::Queue.MessageRetentionPeriod.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-msgretentionperiod

Return type

Union[int, float, None]

queue_name

AWS::SQS::Queue.QueueName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-name

Return type

Optional[str]

receive_message_wait_time_seconds

AWS::SQS::Queue.ReceiveMessageWaitTimeSeconds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-receivemsgwaittime

Return type

Union[int, float, None]

redrive_allow_policy

AWS::SQS::Queue.RedriveAllowPolicy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-redriveallowpolicy

Return type

Any

redrive_policy

AWS::SQS::Queue.RedrivePolicy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-redrive

Return type

Any

tags

AWS::SQS::Queue.Tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#cfn-sqs-queue-tags

Return type

Optional[List[CfnTag]]

visibility_timeout

AWS::SQS::Queue.VisibilityTimeout.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-visiblitytimeout

Return type

Union[int, float, None]