sqs

package
v0.104.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 30, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type LookupQueueArgs added in v0.12.0 

type LookupQueueArgs struct {
	QueueUrl string `pulumi:"queueUrl"`
}

type LookupQueueInlinePolicyArgs added in v0.71.0 

type LookupQueueInlinePolicyArgs struct {
	// The URL of the SQS queue.
	Queue string `pulumi:"queue"`
}

type LookupQueueInlinePolicyOutputArgs added in v0.71.0 

type LookupQueueInlinePolicyOutputArgs struct {
	// The URL of the SQS queue.
	Queue pulumi.StringInput `pulumi:"queue"`
}

func (LookupQueueInlinePolicyOutputArgs) ElementType added in v0.71.0 

func (LookupQueueInlinePolicyOutputArgs) ElementType() reflect.Type

type LookupQueueInlinePolicyResult added in v0.71.0 

type LookupQueueInlinePolicyResult struct {
	// A policy document that contains permissions to add to the specified SQS queue
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SQS::QueueInlinePolicy` for more information about the expected schema for this property.
	PolicyDocument interface{} `pulumi:"policyDocument"`
}

func LookupQueueInlinePolicy added in v0.71.0 

func LookupQueueInlinePolicy(ctx *pulumi.Context, args *LookupQueueInlinePolicyArgs, opts ...pulumi.InvokeOption) (*LookupQueueInlinePolicyResult, error)

Schema for SQS QueueInlinePolicy

type LookupQueueInlinePolicyResultOutput added in v0.71.0 

type LookupQueueInlinePolicyResultOutput struct{ *pulumi.OutputState }

func LookupQueueInlinePolicyOutput added in v0.71.0 

func LookupQueueInlinePolicyOutput(ctx *pulumi.Context, args LookupQueueInlinePolicyOutputArgs, opts ...pulumi.InvokeOption) LookupQueueInlinePolicyResultOutput

func (LookupQueueInlinePolicyResultOutput) ElementType added in v0.71.0 

func (LookupQueueInlinePolicyResultOutput) ElementType() reflect.Type

func (LookupQueueInlinePolicyResultOutput) PolicyDocument added in v0.71.0 

func (o LookupQueueInlinePolicyResultOutput) PolicyDocument() pulumi.AnyOutput

A policy document that contains permissions to add to the specified SQS queue

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SQS::QueueInlinePolicy` for more information about the expected schema for this property.

func (LookupQueueInlinePolicyResultOutput) ToLookupQueueInlinePolicyResultOutput added in v0.71.0 

func (o LookupQueueInlinePolicyResultOutput) ToLookupQueueInlinePolicyResultOutput() LookupQueueInlinePolicyResultOutput

func (LookupQueueInlinePolicyResultOutput) ToLookupQueueInlinePolicyResultOutputWithContext added in v0.71.0 

func (o LookupQueueInlinePolicyResultOutput) ToLookupQueueInlinePolicyResultOutputWithContext(ctx context.Context) LookupQueueInlinePolicyResultOutput

type LookupQueueOutputArgs added in v0.12.0 

type LookupQueueOutputArgs struct {
	QueueUrl pulumi.StringInput `pulumi:"queueUrl"`
}

func (LookupQueueOutputArgs) ElementType added in v0.12.0 

func (LookupQueueOutputArgs) ElementType() reflect.Type

type LookupQueueResult added in v0.12.0 

type LookupQueueResult struct {
	Arn *string `pulumi:"arn"`
	// For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the “ContentBasedDeduplication“ attribute for the “CreateQueue“ action in the *API Reference*.
	ContentBasedDeduplication *bool `pulumi:"contentBasedDeduplication"`
	// For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are “messageGroup“ and “queue“.
	//  To enable high throughput for a FIFO queue, set this attribute to “messageGroup“ *and* set the “FifoThroughputLimit“ attribute to “perMessageGroupId“. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.
	DeduplicationScope *string `pulumi:"deduplicationScope"`
	// The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of “0“ to “900“ (15 minutes). The default value is “0“.
	DelaySeconds *int `pulumi:"delaySeconds"`
	// For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are “perQueue“ and “perMessageGroupId“.
	//  To enable high throughput for a FIFO queue, set this attribute to “perMessageGroupId“ *and* set the “DeduplicationScope“ attribute to “messageGroup“. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.
	FifoThroughputLimit *string `pulumi:"fifoThroughputLimit"`
	// The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).
	//   A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Developer Guide*.
	KmsDataKeyReusePeriodSeconds *int `pulumi:"kmsDataKeyReusePeriodSeconds"`
	// The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. “alias/aws/sqs“), key ARN, or key ID. For more information, see the following:
	//   +   [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide*
	//   +   [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference*
	//   +   [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference*
	//   +   The Key Management Service (KMS) section of the [Best Practices](https://docs.aws.amazon.com/https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper
	KmsMasterKeyId *string `pulumi:"kmsMasterKeyId"`
	// The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from “1,024“ bytes (1 KiB) to “262,144“ bytes (256 KiB). The default value is “262,144“ (256 KiB).
	MaximumMessageSize *int `pulumi:"maximumMessageSize"`
	// The number of seconds that SQS retains a message. You can specify an integer value from “60“ seconds (1 minute) to “1,209,600“ seconds (14 days). The default value is “345,600“ seconds (4 days).
	MessageRetentionPeriod *int    `pulumi:"messageRetentionPeriod"`
	QueueUrl               *string `pulumi:"queueUrl"`
	// 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. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*.
	ReceiveMessageWaitTimeSeconds *int `pulumi:"receiveMessageWaitTimeSeconds"`
	// 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. The parameters are as follows:
	//   +  “redrivePermission“: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:
	//   +  “allowAll“: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.
	//   +  “denyAll“: No source queues can specify this queue as the dead-letter queue.
	//   +  “byQueue“: Only queues specified by the “sourceQueueArns“ parameter can specify this queue as the dead-letter queue.
	//
	//   +  “sourceQueueArns“: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the “redrivePermission“ parameter is set to “byQueue“. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the “redrivePermission“ parameter to “allowAll“.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SQS::Queue` for more information about the expected schema for this property.
	RedriveAllowPolicy interface{} `pulumi:"redriveAllowPolicy"`
	// The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:
	//   +  “deadLetterTargetArn“: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of “maxReceiveCount“ is exceeded.
	//   +  “maxReceiveCount“: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the “ReceiveCount“ for a message exceeds the “maxReceiveCount“ for a queue, SQS moves the message to the dead-letter-queue.
	//
	//   The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
	//    *JSON*
	//   “{ "deadLetterTargetArn" : String, "maxReceiveCount" : Integer }“
	//   *YAML*
	//   “deadLetterTargetArn : String“
	//   “maxReceiveCount : Integer“
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SQS::Queue` for more information about the expected schema for this property.
	RedrivePolicy interface{} `pulumi:"redrivePolicy"`
	// Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When “SqsManagedSseEnabled“ is not defined, “SSE-SQS“ encryption is enabled by default.
	SqsManagedSseEnabled *bool `pulumi:"sqsManagedSseEnabled"`
	// The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*.
	Tags []aws.Tag `pulumi:"tags"`
	// The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue.
	//  Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.
	//  For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*.
	VisibilityTimeout *int `pulumi:"visibilityTimeout"`
}

func LookupQueue added in v0.12.0 

func LookupQueue(ctx *pulumi.Context, args *LookupQueueArgs, opts ...pulumi.InvokeOption) (*LookupQueueResult, error)

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

Keep the following caveats in mind:
 +  If you don't specify the ``FifoQueue`` property, 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-moving.html) in the *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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) and is unique within the scope of your queues.

For more information about creating FIFO (first-in-first-out) queues, see [Creating an queue ()](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/screate-queue-cloudformation.html) in the *Developer Guide*.

type LookupQueueResultOutput added in v0.12.0 

type LookupQueueResultOutput struct{ *pulumi.OutputState }

func LookupQueueOutput added in v0.12.0 

func LookupQueueOutput(ctx *pulumi.Context, args LookupQueueOutputArgs, opts ...pulumi.InvokeOption) LookupQueueResultOutput

func (LookupQueueResultOutput) Arn added in v0.12.0 

func (o LookupQueueResultOutput) Arn() pulumi.StringPtrOutput

func (LookupQueueResultOutput) ContentBasedDeduplication added in v0.12.0 

func (o LookupQueueResultOutput) ContentBasedDeduplication() pulumi.BoolPtrOutput

For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the “ContentBasedDeduplication“ attribute for the “CreateQueue“ action in the *API Reference*.

func (LookupQueueResultOutput) DeduplicationScope added in v0.12.0 

func (o LookupQueueResultOutput) DeduplicationScope() pulumi.StringPtrOutput

For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are “messageGroup“ and “queue“. 

To enable high throughput for a FIFO queue, set this attribute to ``messageGroup`` *and* set the ``FifoThroughputLimit`` attribute to ``perMessageGroupId``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.

func (LookupQueueResultOutput) DelaySeconds added in v0.12.0 

func (o LookupQueueResultOutput) DelaySeconds() pulumi.IntPtrOutput

The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of “0“ to “900“ (15 minutes). The default value is “0“.

func (LookupQueueResultOutput) ElementType added in v0.12.0 

func (LookupQueueResultOutput) ElementType() reflect.Type

func (LookupQueueResultOutput) FifoThroughputLimit added in v0.12.0 

func (o LookupQueueResultOutput) FifoThroughputLimit() pulumi.StringPtrOutput

For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are “perQueue“ and “perMessageGroupId“. 

To enable high throughput for a FIFO queue, set this attribute to ``perMessageGroupId`` *and* set the ``DeduplicationScope`` attribute to ``messageGroup``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.

func (LookupQueueResultOutput) KmsDataKeyReusePeriodSeconds added in v0.12.0 

func (o LookupQueueResultOutput) KmsDataKeyReusePeriodSeconds() pulumi.IntPtrOutput

The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes). 

A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Developer Guide*.

func (LookupQueueResultOutput) KmsMasterKeyId added in v0.12.0 

func (o LookupQueueResultOutput) KmsMasterKeyId() pulumi.StringPtrOutput

The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. “alias/aws/sqs“), key ARN, or key ID. For more information, see the following:

func (LookupQueueResultOutput) MaximumMessageSize added in v0.12.0 

func (o LookupQueueResultOutput) MaximumMessageSize() pulumi.IntPtrOutput

The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from “1,024“ bytes (1 KiB) to “262,144“ bytes (256 KiB). The default value is “262,144“ (256 KiB).

func (LookupQueueResultOutput) MessageRetentionPeriod added in v0.12.0 

func (o LookupQueueResultOutput) MessageRetentionPeriod() pulumi.IntPtrOutput

The number of seconds that SQS retains a message. You can specify an integer value from “60“ seconds (1 minute) to “1,209,600“ seconds (14 days). The default value is “345,600“ seconds (4 days).

func (LookupQueueResultOutput) QueueUrl added in v0.12.0 

func (o LookupQueueResultOutput) QueueUrl() pulumi.StringPtrOutput

func (LookupQueueResultOutput) ReceiveMessageWaitTimeSeconds added in v0.12.0 

func (o LookupQueueResultOutput) ReceiveMessageWaitTimeSeconds() pulumi.IntPtrOutput

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. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*.

func (LookupQueueResultOutput) RedriveAllowPolicy added in v0.12.0 

func (o LookupQueueResultOutput) RedriveAllowPolicy() pulumi.AnyOutput

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. The parameters are as follows:

  • “redrivePermission“: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:

  • “allowAll“: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.

  • “denyAll“: No source queues can specify this queue as the dead-letter queue.

  • “byQueue“: Only queues specified by the “sourceQueueArns“ parameter can specify this queue as the dead-letter queue.

  • “sourceQueueArns“: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the “redrivePermission“ parameter is set to “byQueue“. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the “redrivePermission“ parameter to “allowAll“.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SQS::Queue` for more information about the expected schema for this property.

func (LookupQueueResultOutput) RedrivePolicy added in v0.12.0 

func (o LookupQueueResultOutput) RedrivePolicy() pulumi.AnyOutput

The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:

  • “deadLetterTargetArn“: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of “maxReceiveCount“ is exceeded.

  • “maxReceiveCount“: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the “ReceiveCount“ for a message exceeds the “maxReceiveCount“ for a queue, SQS moves the message to the dead-letter-queue.

    The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. *JSON* “{ "deadLetterTargetArn" : String, "maxReceiveCount" : Integer }“ *YAML* “deadLetterTargetArn : String“ “maxReceiveCount : Integer“

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SQS::Queue` for more information about the expected schema for this property.

func (LookupQueueResultOutput) SqsManagedSseEnabled added in v0.17.0 

func (o LookupQueueResultOutput) SqsManagedSseEnabled() pulumi.BoolPtrOutput

Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When “SqsManagedSseEnabled“ is not defined, “SSE-SQS“ encryption is enabled by default.

func (LookupQueueResultOutput) Tags added in v0.12.0 

func (o LookupQueueResultOutput) Tags() aws.TagArrayOutput

The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*.

func (LookupQueueResultOutput) ToLookupQueueResultOutput added in v0.12.0 

func (o LookupQueueResultOutput) ToLookupQueueResultOutput() LookupQueueResultOutput

func (LookupQueueResultOutput) ToLookupQueueResultOutputWithContext added in v0.12.0 

func (o LookupQueueResultOutput) ToLookupQueueResultOutputWithContext(ctx context.Context) LookupQueueResultOutput

func (LookupQueueResultOutput) VisibilityTimeout added in v0.12.0 

func (o LookupQueueResultOutput) VisibilityTimeout() pulumi.IntPtrOutput

The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. 

Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.
For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*.

type Queue 

type Queue struct {
	pulumi.CustomResourceState

	Arn pulumi.StringOutput `pulumi:"arn"`
	// For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the “ContentBasedDeduplication“ attribute for the “CreateQueue“ action in the *API Reference*.
	ContentBasedDeduplication pulumi.BoolPtrOutput `pulumi:"contentBasedDeduplication"`
	// For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are “messageGroup“ and “queue“.
	//  To enable high throughput for a FIFO queue, set this attribute to “messageGroup“ *and* set the “FifoThroughputLimit“ attribute to “perMessageGroupId“. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.
	DeduplicationScope pulumi.StringPtrOutput `pulumi:"deduplicationScope"`
	// The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of “0“ to “900“ (15 minutes). The default value is “0“.
	DelaySeconds pulumi.IntPtrOutput `pulumi:"delaySeconds"`
	// If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.
	FifoQueue pulumi.BoolPtrOutput `pulumi:"fifoQueue"`
	// For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are “perQueue“ and “perMessageGroupId“.
	//  To enable high throughput for a FIFO queue, set this attribute to “perMessageGroupId“ *and* set the “DeduplicationScope“ attribute to “messageGroup“. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.
	FifoThroughputLimit pulumi.StringPtrOutput `pulumi:"fifoThroughputLimit"`
	// The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).
	//   A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Developer Guide*.
	KmsDataKeyReusePeriodSeconds pulumi.IntPtrOutput `pulumi:"kmsDataKeyReusePeriodSeconds"`
	// The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. “alias/aws/sqs“), key ARN, or key ID. For more information, see the following:
	//   +   [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide*
	//   +   [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference*
	//   +   [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference*
	//   +   The Key Management Service (KMS) section of the [Best Practices](https://docs.aws.amazon.com/https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper
	KmsMasterKeyId pulumi.StringPtrOutput `pulumi:"kmsMasterKeyId"`
	// The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from “1,024“ bytes (1 KiB) to “262,144“ bytes (256 KiB). The default value is “262,144“ (256 KiB).
	MaximumMessageSize pulumi.IntPtrOutput `pulumi:"maximumMessageSize"`
	// The number of seconds that SQS retains a message. You can specify an integer value from “60“ seconds (1 minute) to “1,209,600“ seconds (14 days). The default value is “345,600“ seconds (4 days).
	MessageRetentionPeriod pulumi.IntPtrOutput `pulumi:"messageRetentionPeriod"`
	// A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the “.fifo“ suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.
	//  If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*.
	//   If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
	QueueName pulumi.StringPtrOutput `pulumi:"queueName"`
	QueueUrl  pulumi.StringOutput    `pulumi:"queueUrl"`
	// 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. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*.
	ReceiveMessageWaitTimeSeconds pulumi.IntPtrOutput `pulumi:"receiveMessageWaitTimeSeconds"`
	// 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. The parameters are as follows:
	//   +  “redrivePermission“: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:
	//   +  “allowAll“: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.
	//   +  “denyAll“: No source queues can specify this queue as the dead-letter queue.
	//   +  “byQueue“: Only queues specified by the “sourceQueueArns“ parameter can specify this queue as the dead-letter queue.
	//
	//   +  “sourceQueueArns“: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the “redrivePermission“ parameter is set to “byQueue“. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the “redrivePermission“ parameter to “allowAll“.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SQS::Queue` for more information about the expected schema for this property.
	RedriveAllowPolicy pulumi.AnyOutput `pulumi:"redriveAllowPolicy"`
	// The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:
	//   +  “deadLetterTargetArn“: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of “maxReceiveCount“ is exceeded.
	//   +  “maxReceiveCount“: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the “ReceiveCount“ for a message exceeds the “maxReceiveCount“ for a queue, SQS moves the message to the dead-letter-queue.
	//
	//   The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
	//    *JSON*
	//   “{ "deadLetterTargetArn" : String, "maxReceiveCount" : Integer }“
	//   *YAML*
	//   “deadLetterTargetArn : String“
	//   “maxReceiveCount : Integer“
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SQS::Queue` for more information about the expected schema for this property.
	RedrivePolicy pulumi.AnyOutput `pulumi:"redrivePolicy"`
	// Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When “SqsManagedSseEnabled“ is not defined, “SSE-SQS“ encryption is enabled by default.
	SqsManagedSseEnabled pulumi.BoolPtrOutput `pulumi:"sqsManagedSseEnabled"`
	// The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*.
	Tags aws.TagArrayOutput `pulumi:"tags"`
	// The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue.
	//  Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.
	//  For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*.
	VisibilityTimeout pulumi.IntPtrOutput `pulumi:"visibilityTimeout"`
}

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

Keep the following caveats in mind:
 +  If you don't specify the ``FifoQueue`` property, 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-moving.html) in the *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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) and is unique within the scope of your queues.

For more information about creating FIFO (first-in-first-out) queues, see [Creating an queue ()](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/screate-queue-cloudformation.html) in the *Developer Guide*.

## Example Usage ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/cloudwatch"
"github.com/pulumi/pulumi-aws-native/sdk/go/aws/sns"
"github.com/pulumi/pulumi-aws-native/sdk/go/aws/sqs"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		alarmEmail := "jane.doe@example.com"
		if param := cfg.Get("alarmEmail"); param != "" {
			alarmEmail = param
		}
		myQueue, err := sqs.NewQueue(ctx, "myQueue", &sqs.QueueArgs{
			QueueName: pulumi.String("SampleQueue"),
		})
		if err != nil {
			return err
		}
		alarmTopic, err := sns.NewTopic(ctx, "alarmTopic", &sns.TopicArgs{
			Subscription: sns.TopicSubscriptionArray{
				&sns.TopicSubscriptionArgs{
					Endpoint: pulumi.String(alarmEmail),
					Protocol: pulumi.String("email"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = cloudwatch.NewAlarm(ctx, "queueDepthAlarm", &cloudwatch.AlarmArgs{
			AlarmDescription: pulumi.String("Alarm if queue depth increases to more than 10 messages"),
			Namespace:        pulumi.String("AWS/SQS"),
			MetricName:       pulumi.String("ApproximateNumberOfMessagesVisible"),
			Dimensions: cloudwatch.AlarmDimensionArray{
				&cloudwatch.AlarmDimensionArgs{
					Name:  pulumi.String("QueueName"),
					Value: myQueue.QueueName,
				},
			},
			Statistic:          pulumi.String("Sum"),
			Period:             pulumi.Int(300),
			EvaluationPeriods:  pulumi.Int(1),
			Threshold:          pulumi.Float64(10),
			ComparisonOperator: pulumi.String("GreaterThanThreshold"),
			AlarmActions: pulumi.StringArray{
				alarmTopic.ID(),
			},
			InsufficientDataActions: pulumi.StringArray{
				alarmTopic.ID(),
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("queueURL", myQueue.ID())
		ctx.Export("queueARN", myQueue.Arn)
		ctx.Export("queueName", myQueue.QueueName)
		return nil
	})
}

``` ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/cloudwatch"
"github.com/pulumi/pulumi-aws-native/sdk/go/aws/sns"
"github.com/pulumi/pulumi-aws-native/sdk/go/aws/sqs"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		alarmEmail := "jane.doe@example.com"
		if param := cfg.Get("alarmEmail"); param != "" {
			alarmEmail = param
		}
		myQueue, err := sqs.NewQueue(ctx, "myQueue", &sqs.QueueArgs{
			QueueName: pulumi.String("SampleQueue"),
		})
		if err != nil {
			return err
		}
		alarmTopic, err := sns.NewTopic(ctx, "alarmTopic", &sns.TopicArgs{
			Subscription: sns.TopicSubscriptionArray{
				&sns.TopicSubscriptionArgs{
					Endpoint: pulumi.String(alarmEmail),
					Protocol: pulumi.String("email"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = cloudwatch.NewAlarm(ctx, "queueDepthAlarm", &cloudwatch.AlarmArgs{
			AlarmDescription: pulumi.String("Alarm if queue depth increases to more than 10 messages"),
			Namespace:        pulumi.String("AWS/SQS"),
			MetricName:       pulumi.String("ApproximateNumberOfMessagesVisible"),
			Dimensions: cloudwatch.AlarmDimensionArray{
				&cloudwatch.AlarmDimensionArgs{
					Name:  pulumi.String("QueueName"),
					Value: myQueue.QueueName,
				},
			},
			Statistic:          pulumi.String("Sum"),
			Period:             pulumi.Int(300),
			EvaluationPeriods:  pulumi.Int(1),
			Threshold:          pulumi.Float64(10),
			ComparisonOperator: pulumi.String("GreaterThanThreshold"),
			AlarmActions: pulumi.StringArray{
				alarmTopic.ID(),
			},
			InsufficientDataActions: pulumi.StringArray{
				alarmTopic.ID(),
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("queueURL", myQueue.ID())
		ctx.Export("queueARN", myQueue.Arn)
		ctx.Export("queueName", myQueue.QueueName)
		return nil
	})
}

``` ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/sqs"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myDeadLetterQueue, err := sqs.NewQueue(ctx, "myDeadLetterQueue", nil)
		if err != nil {
			return err
		}
		mySourceQueue, err := sqs.NewQueue(ctx, "mySourceQueue", &sqs.QueueArgs{
			RedrivePolicy: pulumi.Any(map[string]interface{}{
				"deadLetterTargetArn": myDeadLetterQueue.Arn,
				"maxReceiveCount":     5,
			}),
		})
		if err != nil {
			return err
		}
		ctx.Export("sourceQueueURL", mySourceQueue.ID())
		ctx.Export("sourceQueueARN", mySourceQueue.Arn)
		ctx.Export("deadLetterQueueURL", myDeadLetterQueue.ID())
		ctx.Export("deadLetterQueueARN", myDeadLetterQueue.Arn)
		return nil
	})
}

``` ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/sqs"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myDeadLetterQueue, err := sqs.NewQueue(ctx, "myDeadLetterQueue", nil)
		if err != nil {
			return err
		}
		mySourceQueue, err := sqs.NewQueue(ctx, "mySourceQueue", &sqs.QueueArgs{
			RedrivePolicy: pulumi.Any(map[string]interface{}{
				"deadLetterTargetArn": myDeadLetterQueue.Arn,
				"maxReceiveCount":     5,
			}),
		})
		if err != nil {
			return err
		}
		ctx.Export("sourceQueueURL", mySourceQueue.ID())
		ctx.Export("sourceQueueARN", mySourceQueue.Arn)
		ctx.Export("deadLetterQueueURL", myDeadLetterQueue.ID())
		ctx.Export("deadLetterQueueARN", myDeadLetterQueue.Arn)
		return nil
	})
}

```

func GetQueue 

func GetQueue(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *QueueState, opts ...pulumi.ResourceOption) (*Queue, error)

GetQueue gets an existing Queue resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewQueue 

func NewQueue(ctx *pulumi.Context,
	name string, args *QueueArgs, opts ...pulumi.ResourceOption) (*Queue, error)

NewQueue registers a new resource with the given unique name, arguments, and options.

func (*Queue) ElementType 

func (*Queue) ElementType() reflect.Type

func (*Queue) ToQueueOutput 

func (i *Queue) ToQueueOutput() QueueOutput

func (*Queue) ToQueueOutputWithContext 

func (i *Queue) ToQueueOutputWithContext(ctx context.Context) QueueOutput

type QueueArgs 

type QueueArgs struct {
	// For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the “ContentBasedDeduplication“ attribute for the “CreateQueue“ action in the *API Reference*.
	ContentBasedDeduplication pulumi.BoolPtrInput
	// For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are “messageGroup“ and “queue“.
	//  To enable high throughput for a FIFO queue, set this attribute to “messageGroup“ *and* set the “FifoThroughputLimit“ attribute to “perMessageGroupId“. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.
	DeduplicationScope pulumi.StringPtrInput
	// The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of “0“ to “900“ (15 minutes). The default value is “0“.
	DelaySeconds pulumi.IntPtrInput
	// If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.
	FifoQueue pulumi.BoolPtrInput
	// For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are “perQueue“ and “perMessageGroupId“.
	//  To enable high throughput for a FIFO queue, set this attribute to “perMessageGroupId“ *and* set the “DeduplicationScope“ attribute to “messageGroup“. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.
	FifoThroughputLimit pulumi.StringPtrInput
	// The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).
	//   A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Developer Guide*.
	KmsDataKeyReusePeriodSeconds pulumi.IntPtrInput
	// The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. “alias/aws/sqs“), key ARN, or key ID. For more information, see the following:
	//   +   [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide*
	//   +   [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference*
	//   +   [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference*
	//   +   The Key Management Service (KMS) section of the [Best Practices](https://docs.aws.amazon.com/https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper
	KmsMasterKeyId pulumi.StringPtrInput
	// The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from “1,024“ bytes (1 KiB) to “262,144“ bytes (256 KiB). The default value is “262,144“ (256 KiB).
	MaximumMessageSize pulumi.IntPtrInput
	// The number of seconds that SQS retains a message. You can specify an integer value from “60“ seconds (1 minute) to “1,209,600“ seconds (14 days). The default value is “345,600“ seconds (4 days).
	MessageRetentionPeriod pulumi.IntPtrInput
	// A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the “.fifo“ suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.
	//  If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*.
	//   If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
	QueueName pulumi.StringPtrInput
	// 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. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*.
	ReceiveMessageWaitTimeSeconds pulumi.IntPtrInput
	// 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. The parameters are as follows:
	//   +  “redrivePermission“: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:
	//   +  “allowAll“: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.
	//   +  “denyAll“: No source queues can specify this queue as the dead-letter queue.
	//   +  “byQueue“: Only queues specified by the “sourceQueueArns“ parameter can specify this queue as the dead-letter queue.
	//
	//   +  “sourceQueueArns“: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the “redrivePermission“ parameter is set to “byQueue“. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the “redrivePermission“ parameter to “allowAll“.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SQS::Queue` for more information about the expected schema for this property.
	RedriveAllowPolicy pulumi.Input
	// The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:
	//   +  “deadLetterTargetArn“: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of “maxReceiveCount“ is exceeded.
	//   +  “maxReceiveCount“: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the “ReceiveCount“ for a message exceeds the “maxReceiveCount“ for a queue, SQS moves the message to the dead-letter-queue.
	//
	//   The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
	//    *JSON*
	//   “{ "deadLetterTargetArn" : String, "maxReceiveCount" : Integer }“
	//   *YAML*
	//   “deadLetterTargetArn : String“
	//   “maxReceiveCount : Integer“
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SQS::Queue` for more information about the expected schema for this property.
	RedrivePolicy pulumi.Input
	// Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When “SqsManagedSseEnabled“ is not defined, “SSE-SQS“ encryption is enabled by default.
	SqsManagedSseEnabled pulumi.BoolPtrInput
	// The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*.
	Tags aws.TagArrayInput
	// The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue.
	//  Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.
	//  For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*.
	VisibilityTimeout pulumi.IntPtrInput
}

The set of arguments for constructing a Queue resource.

func (QueueArgs) ElementType 

func (QueueArgs) ElementType() reflect.Type

type QueueInlinePolicy added in v0.71.0 

type QueueInlinePolicy struct {
	pulumi.CustomResourceState

	// A policy document that contains permissions to add to the specified SQS queue
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SQS::QueueInlinePolicy` for more information about the expected schema for this property.
	PolicyDocument pulumi.AnyOutput `pulumi:"policyDocument"`
	// The URL of the SQS queue.
	Queue pulumi.StringOutput `pulumi:"queue"`
}

Schema for SQS QueueInlinePolicy

func GetQueueInlinePolicy added in v0.71.0 

func GetQueueInlinePolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *QueueInlinePolicyState, opts ...pulumi.ResourceOption) (*QueueInlinePolicy, error)

GetQueueInlinePolicy gets an existing QueueInlinePolicy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewQueueInlinePolicy added in v0.71.0 

func NewQueueInlinePolicy(ctx *pulumi.Context,
	name string, args *QueueInlinePolicyArgs, opts ...pulumi.ResourceOption) (*QueueInlinePolicy, error)

NewQueueInlinePolicy registers a new resource with the given unique name, arguments, and options.

func (*QueueInlinePolicy) ElementType added in v0.71.0 

func (*QueueInlinePolicy) ElementType() reflect.Type

func (*QueueInlinePolicy) ToQueueInlinePolicyOutput added in v0.71.0 

func (i *QueueInlinePolicy) ToQueueInlinePolicyOutput() QueueInlinePolicyOutput

func (*QueueInlinePolicy) ToQueueInlinePolicyOutputWithContext added in v0.71.0 

func (i *QueueInlinePolicy) ToQueueInlinePolicyOutputWithContext(ctx context.Context) QueueInlinePolicyOutput

type QueueInlinePolicyArgs added in v0.71.0 

type QueueInlinePolicyArgs struct {
	// A policy document that contains permissions to add to the specified SQS queue
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SQS::QueueInlinePolicy` for more information about the expected schema for this property.
	PolicyDocument pulumi.Input
	// The URL of the SQS queue.
	Queue pulumi.StringInput
}

The set of arguments for constructing a QueueInlinePolicy resource.

func (QueueInlinePolicyArgs) ElementType added in v0.71.0 

func (QueueInlinePolicyArgs) ElementType() reflect.Type

type QueueInlinePolicyInput added in v0.71.0 

type QueueInlinePolicyInput interface {
	pulumi.Input

	ToQueueInlinePolicyOutput() QueueInlinePolicyOutput
	ToQueueInlinePolicyOutputWithContext(ctx context.Context) QueueInlinePolicyOutput
}

type QueueInlinePolicyOutput added in v0.71.0 

type QueueInlinePolicyOutput struct{ *pulumi.OutputState }

func (QueueInlinePolicyOutput) ElementType added in v0.71.0 

func (QueueInlinePolicyOutput) ElementType() reflect.Type

func (QueueInlinePolicyOutput) PolicyDocument added in v0.71.0 

func (o QueueInlinePolicyOutput) PolicyDocument() pulumi.AnyOutput

A policy document that contains permissions to add to the specified SQS queue

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SQS::QueueInlinePolicy` for more information about the expected schema for this property.

func (QueueInlinePolicyOutput) Queue added in v0.71.0 

func (o QueueInlinePolicyOutput) Queue() pulumi.StringOutput

The URL of the SQS queue.

func (QueueInlinePolicyOutput) ToQueueInlinePolicyOutput added in v0.71.0 

func (o QueueInlinePolicyOutput) ToQueueInlinePolicyOutput() QueueInlinePolicyOutput

func (QueueInlinePolicyOutput) ToQueueInlinePolicyOutputWithContext added in v0.71.0 

func (o QueueInlinePolicyOutput) ToQueueInlinePolicyOutputWithContext(ctx context.Context) QueueInlinePolicyOutput

type QueueInlinePolicyState added in v0.71.0 

type QueueInlinePolicyState struct {
}

func (QueueInlinePolicyState) ElementType added in v0.71.0 

func (QueueInlinePolicyState) ElementType() reflect.Type

type QueueInput 

type QueueInput interface {
	pulumi.Input

	ToQueueOutput() QueueOutput
	ToQueueOutputWithContext(ctx context.Context) QueueOutput
}

type QueueOutput 

type QueueOutput struct{ *pulumi.OutputState }

func (QueueOutput) Arn added in v0.17.0 

func (o QueueOutput) Arn() pulumi.StringOutput

func (QueueOutput) ContentBasedDeduplication added in v0.17.0 

func (o QueueOutput) ContentBasedDeduplication() pulumi.BoolPtrOutput

For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the “ContentBasedDeduplication“ attribute for the “CreateQueue“ action in the *API Reference*.

func (QueueOutput) DeduplicationScope added in v0.17.0 

func (o QueueOutput) DeduplicationScope() pulumi.StringPtrOutput

For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are “messageGroup“ and “queue“. 

To enable high throughput for a FIFO queue, set this attribute to ``messageGroup`` *and* set the ``FifoThroughputLimit`` attribute to ``perMessageGroupId``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.

func (QueueOutput) DelaySeconds added in v0.17.0 

func (o QueueOutput) DelaySeconds() pulumi.IntPtrOutput

The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of “0“ to “900“ (15 minutes). The default value is “0“.

func (QueueOutput) ElementType 

func (QueueOutput) ElementType() reflect.Type

func (QueueOutput) FifoQueue added in v0.17.0 

func (o QueueOutput) FifoQueue() pulumi.BoolPtrOutput

If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.

func (QueueOutput) FifoThroughputLimit added in v0.17.0 

func (o QueueOutput) FifoThroughputLimit() pulumi.StringPtrOutput

For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are “perQueue“ and “perMessageGroupId“. 

To enable high throughput for a FIFO queue, set this attribute to ``perMessageGroupId`` *and* set the ``DeduplicationScope`` attribute to ``messageGroup``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.

func (QueueOutput) KmsDataKeyReusePeriodSeconds added in v0.17.0 

func (o QueueOutput) KmsDataKeyReusePeriodSeconds() pulumi.IntPtrOutput

The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes). 

A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Developer Guide*.

func (QueueOutput) KmsMasterKeyId added in v0.17.0 

func (o QueueOutput) KmsMasterKeyId() pulumi.StringPtrOutput

The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. “alias/aws/sqs“), key ARN, or key ID. For more information, see the following:

func (QueueOutput) MaximumMessageSize added in v0.17.0 

func (o QueueOutput) MaximumMessageSize() pulumi.IntPtrOutput

The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from “1,024“ bytes (1 KiB) to “262,144“ bytes (256 KiB). The default value is “262,144“ (256 KiB).

func (QueueOutput) MessageRetentionPeriod added in v0.17.0 

func (o QueueOutput) MessageRetentionPeriod() pulumi.IntPtrOutput

The number of seconds that SQS retains a message. You can specify an integer value from “60“ seconds (1 minute) to “1,209,600“ seconds (14 days). The default value is “345,600“ seconds (4 days).

func (QueueOutput) QueueName added in v0.17.0 

func (o QueueOutput) QueueName() pulumi.StringPtrOutput

A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the “.fifo“ suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*. 

If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*.
 If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

func (QueueOutput) QueueUrl added in v0.17.0 

func (o QueueOutput) QueueUrl() pulumi.StringOutput

func (QueueOutput) ReceiveMessageWaitTimeSeconds added in v0.17.0 

func (o QueueOutput) ReceiveMessageWaitTimeSeconds() pulumi.IntPtrOutput

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. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*.

func (QueueOutput) RedriveAllowPolicy added in v0.17.0 

func (o QueueOutput) RedriveAllowPolicy() pulumi.AnyOutput

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. The parameters are as follows:

  • “redrivePermission“: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:

  • “allowAll“: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.

  • “denyAll“: No source queues can specify this queue as the dead-letter queue.

  • “byQueue“: Only queues specified by the “sourceQueueArns“ parameter can specify this queue as the dead-letter queue.

  • “sourceQueueArns“: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the “redrivePermission“ parameter is set to “byQueue“. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the “redrivePermission“ parameter to “allowAll“.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SQS::Queue` for more information about the expected schema for this property.

func (QueueOutput) RedrivePolicy added in v0.17.0 

func (o QueueOutput) RedrivePolicy() pulumi.AnyOutput

The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:

  • “deadLetterTargetArn“: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of “maxReceiveCount“ is exceeded.

  • “maxReceiveCount“: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the “ReceiveCount“ for a message exceeds the “maxReceiveCount“ for a queue, SQS moves the message to the dead-letter-queue.

    The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. *JSON* “{ "deadLetterTargetArn" : String, "maxReceiveCount" : Integer }“ *YAML* “deadLetterTargetArn : String“ “maxReceiveCount : Integer“

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SQS::Queue` for more information about the expected schema for this property.

func (QueueOutput) SqsManagedSseEnabled added in v0.17.0 

func (o QueueOutput) SqsManagedSseEnabled() pulumi.BoolPtrOutput

Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When “SqsManagedSseEnabled“ is not defined, “SSE-SQS“ encryption is enabled by default.

func (QueueOutput) Tags added in v0.17.0 

func (o QueueOutput) Tags() aws.TagArrayOutput

The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*.

func (QueueOutput) ToQueueOutput 

func (o QueueOutput) ToQueueOutput() QueueOutput

func (QueueOutput) ToQueueOutputWithContext 

func (o QueueOutput) ToQueueOutputWithContext(ctx context.Context) QueueOutput

func (QueueOutput) VisibilityTimeout added in v0.17.0 

func (o QueueOutput) VisibilityTimeout() pulumi.IntPtrOutput

The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. 

Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.
For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*.

type QueueState 

type QueueState struct {
}

func (QueueState) ElementType 

func (QueueState) ElementType() reflect.Type

type QueueTag 

type QueueTag struct {
	// The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Key string `pulumi:"key"`
	// The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Value string `pulumi:"value"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.