sqs

class pulumi_aws.sqs.GetQueueResult(arn=None, url=None, id=None)

A collection of values returned by getQueue.

arn = None

The Amazon Resource Name (ARN) of the queue.

url = None

The URL of the queue.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.sqs.Queue(resource_name, opts=None, content_based_deduplication=None, delay_seconds=None, fifo_queue=None, kms_data_key_reuse_period_seconds=None, kms_master_key_id=None, max_message_size=None, message_retention_seconds=None, name=None, name_prefix=None, policy=None, receive_wait_time_seconds=None, redrive_policy=None, tags=None, visibility_timeout_seconds=None, __name__=None, __opts__=None)

Create a Queue resource with the given unique name, props, and options.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • content_based_deduplication (pulumi.Input[bool]) – Enables content-based deduplication for FIFO queues. For more information, see the related documentation
  • delay_seconds (pulumi.Input[float]) – The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 seconds.
  • fifo_queue (pulumi.Input[bool]) – Boolean designating a FIFO queue. If not set, it defaults to false making it standard.
  • kms_data_key_reuse_period_seconds (pulumi.Input[float]) – 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. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
  • kms_master_key_id (pulumi.Input[str]) – The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
  • max_message_size (pulumi.Input[float]) – The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).
  • message_retention_seconds (pulumi.Input[float]) – The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).
  • name (pulumi.Input[str]) – This is the human-readable name of the queue. If omitted, Terraform will assign a random name.
  • name_prefix (pulumi.Input[str]) – Creates a unique name beginning with the specified prefix. Conflicts with name.
  • policy (pulumi.Input[str]) – The JSON policy for the SQS queue. For more information about building AWS IAM policy documents with Terraform, see the AWS IAM Policy Document Guide.
  • receive_wait_time_seconds (pulumi.Input[float]) – The time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default for this attribute is 0, meaning that the call will return immediately.
  • redrive_policy (pulumi.Input[str]) – The JSON policy to set up the Dead Letter Queue, see AWS docs. Note: when specifying maxReceiveCount, you must specify it as an integer (5), and not a string ("5").
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the queue.
  • visibility_timeout_seconds (pulumi.Input[float]) –

    The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see AWS docs.

arn = None

The ARN of the SQS queue

content_based_deduplication = None

Enables content-based deduplication for FIFO queues. For more information, see the related documentation

delay_seconds = None

The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 seconds.

fifo_queue = None

Boolean designating a FIFO queue. If not set, it defaults to false making it standard.

kms_data_key_reuse_period_seconds = None

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. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).

kms_master_key_id = None

The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.

max_message_size = None

The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).

message_retention_seconds = None

The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).

name = None

This is the human-readable name of the queue. If omitted, Terraform will assign a random name.

name_prefix = None

Creates a unique name beginning with the specified prefix. Conflicts with name.

policy = None

The JSON policy for the SQS queue. For more information about building AWS IAM policy documents with Terraform, see the AWS IAM Policy Document Guide.

receive_wait_time_seconds = None

The time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default for this attribute is 0, meaning that the call will return immediately.

redrive_policy = None

The JSON policy to set up the Dead Letter Queue, see AWS docs. Note: when specifying maxReceiveCount, you must specify it as an integer (5), and not a string ("5").

tags = None

A mapping of tags to assign to the queue.

visibility_timeout_seconds = None

The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see AWS docs.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.sqs.QueuePolicy(resource_name, opts=None, policy=None, queue_url=None, __name__=None, __opts__=None)

Allows you to set a policy of an SQS Queue while referencing ARN of the queue within the policy.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • policy (pulumi.Input[str]) –

    The JSON policy for the SQS queue. For more information about building AWS IAM policy documents with Terraform, see the AWS IAM Policy Document Guide.

  • queue_url (pulumi.Input[str]) – The URL of the SQS Queue to which to attach the policy
policy = None

The JSON policy for the SQS queue. For more information about building AWS IAM policy documents with Terraform, see the AWS IAM Policy Document Guide.

queue_url = None

The URL of the SQS Queue to which to attach the policy

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_aws.sqs.get_queue(name=None, opts=None)

Use this data source to get the ARN and URL of queue in AWS Simple Queue Service (SQS). By using this data source, you can reference SQS queues without having to hardcode the ARNs as input.