CfnQueuePropsMixin

class aws_cdk.mixins_preview.aws_sqs.mixins.CfnQueuePropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::SQS::Queue resource creates an Amazon SQS standard or FIFO queue.

Keep the following caveats in mind:

  • If you don’t specify the FifoQueue property, Amazon SQS creates a standard queue.

You can’t change the queue type after you create it and you can’t convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving from a standard queue to a FIFO queue in the Amazon SQS Developer Guide .

  • If you don’t provide a value for a property, the queue is created with the default value for the property.

  • If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

  • To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.

For more information about creating FIFO (first-in-first-out) queues, see Creating an Amazon SQS queue ( CloudFormation ) in the Amazon SQS Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html

CloudformationResource:

AWS::SQS::Queue

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

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

# redrive_allow_policy: Any
# redrive_policy: Any

cfn_queue_props_mixin = sqs_mixins.CfnQueuePropsMixin(sqs_mixins.CfnQueueMixinProps(
    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,
    sqs_managed_sse_enabled=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    visibility_timeout=123
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SQS::Queue.

Parameters:

  • props (Union[CfnQueueMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['contentBasedDeduplication', 'deduplicationScope', 'delaySeconds', 'fifoQueue', 'fifoThroughputLimit', 'kmsDataKeyReusePeriodSeconds', 'kmsMasterKeyId', 'maximumMessageSize', 'messageRetentionPeriod', 'queueName', 'receiveMessageWaitTimeSeconds', 'redriveAllowPolicy', 'redrivePolicy', 'sqsManagedSseEnabled', 'tags', 'visibilityTimeout']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental