Documentation
¶
Index ¶
- type GetQueueArgs
- type GetQueueResult
- type Queue
- func (r *Queue) Arn() *pulumi.StringOutput
- func (r *Queue) ContentBasedDeduplication() *pulumi.BoolOutput
- func (r *Queue) DelaySeconds() *pulumi.IntOutput
- func (r *Queue) FifoQueue() *pulumi.BoolOutput
- func (r *Queue) ID() *pulumi.IDOutput
- func (r *Queue) KmsDataKeyReusePeriodSeconds() *pulumi.IntOutput
- func (r *Queue) KmsMasterKeyId() *pulumi.StringOutput
- func (r *Queue) MaxMessageSize() *pulumi.IntOutput
- func (r *Queue) MessageRetentionSeconds() *pulumi.IntOutput
- func (r *Queue) Name() *pulumi.StringOutput
- func (r *Queue) NamePrefix() *pulumi.StringOutput
- func (r *Queue) Policy() *pulumi.StringOutput
- func (r *Queue) ReceiveWaitTimeSeconds() *pulumi.IntOutput
- func (r *Queue) RedrivePolicy() *pulumi.StringOutput
- func (r *Queue) Tags() *pulumi.MapOutput
- func (r *Queue) URN() *pulumi.URNOutput
- func (r *Queue) VisibilityTimeoutSeconds() *pulumi.IntOutput
- type QueueArgs
- type QueuePolicy
- type QueuePolicyArgs
- type QueuePolicyState
- type QueueState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetQueueArgs ¶
type GetQueueArgs struct {
// The name of the queue to match.
Name interface{}
}
A collection of arguments for invoking getQueue.
type GetQueueResult ¶
type GetQueueResult struct {
// The Amazon Resource Name (ARN) of the queue.
Arn interface{}
// The URL of the queue.
Url interface{}
// id is the provider-assigned unique ID for this managed resource.
Id interface{}
}
A collection of values returned by getQueue.
func LookupQueue ¶
func LookupQueue(ctx *pulumi.Context, args *GetQueueArgs) (*GetQueueResult, error)
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.
type Queue ¶
type Queue struct {
// contains filtered or unexported fields
}
func GetQueue ¶
func GetQueue(ctx *pulumi.Context, name string, id pulumi.ID, state *QueueState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*Queue, error)
NewQueue registers a new resource with the given unique name, arguments, and options.
func (*Queue) ContentBasedDeduplication ¶
func (r *Queue) ContentBasedDeduplication() *pulumi.BoolOutput
Enables content-based deduplication for FIFO queues. For more information, see the [related documentation](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing)
func (*Queue) DelaySeconds ¶
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.
func (*Queue) FifoQueue ¶
func (r *Queue) FifoQueue() *pulumi.BoolOutput
Boolean designating a FIFO queue. If not set, it defaults to `false` making it standard.
func (*Queue) 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. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
func (*Queue) KmsMasterKeyId ¶
func (r *Queue) KmsMasterKeyId() *pulumi.StringOutput
The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see [Key Terms](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms).
func (*Queue) MaxMessageSize ¶
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).
func (*Queue) MessageRetentionSeconds ¶
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).
func (*Queue) Name ¶
func (r *Queue) Name() *pulumi.StringOutput
This is the human-readable name of the queue. If omitted, Terraform will assign a random name.
func (*Queue) NamePrefix ¶
func (r *Queue) NamePrefix() *pulumi.StringOutput
Creates a unique name beginning with the specified prefix. Conflicts with `name`.
func (*Queue) Policy ¶
func (r *Queue) Policy() *pulumi.StringOutput
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](https://www.terraform.io/docs/providers/aws/guides/iam-policy-documents.html).
func (*Queue) ReceiveWaitTimeSeconds ¶
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.
func (*Queue) RedrivePolicy ¶
func (r *Queue) RedrivePolicy() *pulumi.StringOutput
The JSON policy to set up the Dead Letter Queue, see [AWS docs](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html). **Note:** when specifying `maxReceiveCount`, you must specify it as an integer (`5`), and not a string (`"5"`).
func (*Queue) VisibilityTimeoutSeconds ¶
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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html).
type QueueArgs ¶
type QueueArgs struct {
// Enables content-based deduplication for FIFO queues. For more information, see the [related documentation](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing)
ContentBasedDeduplication interface{}
// 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.
DelaySeconds interface{}
// Boolean designating a FIFO queue. If not set, it defaults to `false` making it standard.
FifoQueue interface{}
// 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).
KmsDataKeyReusePeriodSeconds interface{}
// The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see [Key Terms](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms).
KmsMasterKeyId interface{}
// 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).
MaxMessageSize interface{}
// 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).
MessageRetentionSeconds interface{}
// This is the human-readable name of the queue. If omitted, Terraform will assign a random name.
Name interface{}
// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
NamePrefix interface{}
// 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](https://www.terraform.io/docs/providers/aws/guides/iam-policy-documents.html).
Policy interface{}
// 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.
ReceiveWaitTimeSeconds interface{}
// The JSON policy to set up the Dead Letter Queue, see [AWS docs](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html). **Note:** when specifying `maxReceiveCount`, you must specify it as an integer (`5`), and not a string (`"5"`).
RedrivePolicy interface{}
// A mapping of tags to assign to the queue.
Tags interface{}
// 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html).
VisibilityTimeoutSeconds interface{}
}
The set of arguments for constructing a Queue resource.
type QueuePolicy ¶
type QueuePolicy struct {
// contains filtered or unexported fields
}
Allows you to set a policy of an SQS Queue while referencing ARN of the queue within the policy.
func GetQueuePolicy ¶
func GetQueuePolicy(ctx *pulumi.Context, name string, id pulumi.ID, state *QueuePolicyState, opts ...pulumi.ResourceOpt) (*QueuePolicy, error)
GetQueuePolicy gets an existing QueuePolicy 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 NewQueuePolicy ¶
func NewQueuePolicy(ctx *pulumi.Context, name string, args *QueuePolicyArgs, opts ...pulumi.ResourceOpt) (*QueuePolicy, error)
NewQueuePolicy registers a new resource with the given unique name, arguments, and options.
func (*QueuePolicy) ID ¶
func (r *QueuePolicy) ID() *pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*QueuePolicy) Policy ¶
func (r *QueuePolicy) Policy() *pulumi.StringOutput
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](https://www.terraform.io/docs/providers/aws/guides/iam-policy-documents.html).
func (*QueuePolicy) QueueUrl ¶
func (r *QueuePolicy) QueueUrl() *pulumi.StringOutput
The URL of the SQS Queue to which to attach the policy
func (*QueuePolicy) URN ¶
func (r *QueuePolicy) URN() *pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
type QueuePolicyArgs ¶
type QueuePolicyArgs struct {
// 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](https://www.terraform.io/docs/providers/aws/guides/iam-policy-documents.html).
Policy interface{}
// The URL of the SQS Queue to which to attach the policy
QueueUrl interface{}
}
The set of arguments for constructing a QueuePolicy resource.
type QueuePolicyState ¶
type QueuePolicyState struct {
// 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](https://www.terraform.io/docs/providers/aws/guides/iam-policy-documents.html).
Policy interface{}
// The URL of the SQS Queue to which to attach the policy
QueueUrl interface{}
}
Input properties used for looking up and filtering QueuePolicy resources.
type QueueState ¶
type QueueState struct {
// The ARN of the SQS queue
Arn interface{}
// Enables content-based deduplication for FIFO queues. For more information, see the [related documentation](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing)
ContentBasedDeduplication interface{}
// 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.
DelaySeconds interface{}
// Boolean designating a FIFO queue. If not set, it defaults to `false` making it standard.
FifoQueue interface{}
// 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).
KmsDataKeyReusePeriodSeconds interface{}
// The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see [Key Terms](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms).
KmsMasterKeyId interface{}
// 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).
MaxMessageSize interface{}
// 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).
MessageRetentionSeconds interface{}
// This is the human-readable name of the queue. If omitted, Terraform will assign a random name.
Name interface{}
// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
NamePrefix interface{}
// 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](https://www.terraform.io/docs/providers/aws/guides/iam-policy-documents.html).
Policy interface{}
// 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.
ReceiveWaitTimeSeconds interface{}
// The JSON policy to set up the Dead Letter Queue, see [AWS docs](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html). **Note:** when specifying `maxReceiveCount`, you must specify it as an integer (`5`), and not a string (`"5"`).
RedrivePolicy interface{}
// A mapping of tags to assign to the queue.
Tags interface{}
// 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html).
VisibilityTimeoutSeconds interface{}
}
Input properties used for looking up and filtering Queue resources.
Source Files