class CfnQueuePropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.SQS.Mixins.CfnQueuePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awssqs/mixins#CfnQueuePropsMixin
Java	software.amazon.awscdk.mixins.preview.services.sqs.mixins.CfnQueuePropsMixin
Python	aws_cdk.mixins_preview.aws_sqs.mixins.CfnQueuePropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_sqs » mixins » CfnQueuePropsMixin

Implements IMixin

Extends 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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as sqs_mixins } from '@aws-cdk/mixins-preview/aws-sqs';

declare const redriveAllowPolicy: any;
declare const redrivePolicy: any;
const cfnQueuePropsMixin = new sqs_mixins.CfnQueuePropsMixin({
  contentBasedDeduplication: false,
  deduplicationScope: 'deduplicationScope',
  delaySeconds: 123,
  fifoQueue: false,
  fifoThroughputLimit: 'fifoThroughputLimit',
  kmsDataKeyReusePeriodSeconds: 123,
  kmsMasterKeyId: 'kmsMasterKeyId',
  maximumMessageSize: 123,
  messageRetentionPeriod: 123,
  queueName: 'queueName',
  receiveMessageWaitTimeSeconds: 123,
  redriveAllowPolicy: redriveAllowPolicy,
  redrivePolicy: redrivePolicy,
  sqsManagedSseEnabled: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  visibilityTimeout: 123,
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnQueuePropsMixin(props: CfnQueueMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnQueueMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

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

Properties

Name	Type	Description
props	CfnQueueMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnQueueMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.