Class CfnQueue
The AWS::SQS::Queue
resource creates an Amazon SQS standard or FIFO queue.
Inherited Members
Namespace: Amazon.CDK.AWS.SQS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnQueue : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnQueue
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
Keep the following caveats in mind:
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 <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-moving.html">Moving from a standard queue to a FIFO queue</a> in the <em>Amazon SQS Developer Guide</em> .
For more information about creating FIFO (first-in-first-out) queues, see Creating an Amazon SQS queue ( AWS 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
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SQS;
var redriveAllowPolicy;
var redrivePolicy;
var cfnQueue = new CfnQueue(this, "MyCfnQueue", new CfnQueueProps {
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 = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VisibilityTimeout = 123
});
Synopsis
Constructors
CfnQueue(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnQueue(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnQueue(Construct, String, ICfnQueueProps) |
Properties
AttrArn | Returns the Amazon Resource Name (ARN) of the queue. |
AttrQueueName | Returns the queue name. |
AttrQueueUrl | Returns the URLs of the queues from the policy. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ContentBasedDeduplication | For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. |
DeduplicationScope | For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. |
DelaySeconds | The time in seconds for which the delivery of all messages in the queue is delayed. |
FifoQueue | If set to true, creates a FIFO queue. |
FifoThroughputLimit | For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. |
KmsDataKeyReusePeriodSeconds | The length of time in seconds for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. |
KmsMasterKeyId | The ID of an AWS Key Management Service (KMS) for Amazon SQS , or a custom KMS. |
MaximumMessageSize | The limit of how many bytes that a message can contain before Amazon SQS rejects it. |
MessageRetentionPeriod | The number of seconds that Amazon SQS retains a message. |
QueueName | A name for the queue. |
ReceiveMessageWaitTimeSeconds | Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. |
RedriveAllowPolicy | The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. |
RedrivePolicy | The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. |
SqsManagedSseEnabled | Enables server-side queue encryption using SQS owned encryption keys. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags that you attach to this queue. |
VisibilityTimeout | The length of time during which a message will be unavailable after a message is delivered from the queue. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnQueue(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnQueue(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnQueue(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnQueue(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnQueue(Construct, String, ICfnQueueProps)
public CfnQueue(Construct scope, string id, ICfnQueueProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnQueueProps
Resource properties.
Properties
AttrArn
Returns the Amazon Resource Name (ARN) of the queue.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example: arn:aws:sqs:us-east-2:123456789012:mystack-myqueue-15PG5C2FC1CW8
.
CloudformationAttribute: Arn
AttrQueueName
Returns the queue name.
public virtual string AttrQueueName { get; }
Property Value
System.String
Remarks
For example: mystack-myqueue-1VF9BKQH5BJVI
.
CloudformationAttribute: QueueName
AttrQueueUrl
Returns the URLs of the queues from the policy.
public virtual string AttrQueueUrl { get; }
Property Value
System.String
Remarks
CloudformationAttribute: QueueUrl
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ContentBasedDeduplication
For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication.
public virtual object ContentBasedDeduplication { get; set; }
Property Value
System.Object
DeduplicationScope
For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level.
public virtual string DeduplicationScope { get; set; }
Property Value
System.String
DelaySeconds
The time in seconds for which the delivery of all messages in the queue is delayed.
public virtual Nullable<double> DelaySeconds { get; set; }
Property Value
System.Nullable<System.Double>
FifoQueue
If set to true, creates a FIFO queue.
public virtual object FifoQueue { get; set; }
Property Value
System.Object
FifoThroughputLimit
For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group.
public virtual string FifoThroughputLimit { get; set; }
Property Value
System.String
KmsDataKeyReusePeriodSeconds
The length of time in seconds for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again.
public virtual Nullable<double> KmsDataKeyReusePeriodSeconds { get; set; }
Property Value
System.Nullable<System.Double>
KmsMasterKeyId
The ID of an AWS Key Management Service (KMS) for Amazon SQS , or a custom KMS.
public virtual string KmsMasterKeyId { get; set; }
Property Value
System.String
MaximumMessageSize
The limit of how many bytes that a message can contain before Amazon SQS rejects it.
public virtual Nullable<double> MaximumMessageSize { get; set; }
Property Value
System.Nullable<System.Double>
MessageRetentionPeriod
The number of seconds that Amazon SQS retains a message.
public virtual Nullable<double> MessageRetentionPeriod { get; set; }
Property Value
System.Nullable<System.Double>
QueueName
A name for the queue.
public virtual string QueueName { get; set; }
Property Value
System.String
ReceiveMessageWaitTimeSeconds
Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available.
public virtual Nullable<double> ReceiveMessageWaitTimeSeconds { get; set; }
Property Value
System.Nullable<System.Double>
RedriveAllowPolicy
The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object.
public virtual object RedriveAllowPolicy { get; set; }
Property Value
System.Object
RedrivePolicy
The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object.
public virtual object RedrivePolicy { get; set; }
Property Value
System.Object
SqsManagedSseEnabled
Enables server-side queue encryption using SQS owned encryption keys.
public virtual object SqsManagedSseEnabled { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The tags that you attach to this queue.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
VisibilityTimeout
The length of time during which a message will be unavailable after a message is delivered from the queue.
public virtual Nullable<double> VisibilityTimeout { get; set; }
Property Value
System.Nullable<System.Double>
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>