sqs

package
v0.84.0 Latest Latest
Warning

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

 Go to latest Published: Nov 6, 2023 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 {
	// URL of the source queue.
	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
	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

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

func (LookupQueueInlinePolicyResultOutput) ToOutput added in v0.76.0 

func (o LookupQueueInlinePolicyResultOutput) ToOutput(ctx context.Context) pulumix.Output[LookupQueueInlinePolicyResult]

type LookupQueueOutputArgs added in v0.12.0 

type LookupQueueOutputArgs struct {
	// URL of the source queue.
	QueueUrl pulumi.StringInput `pulumi:"queueUrl"`
}

func (LookupQueueOutputArgs) ElementType added in v0.12.0 

func (LookupQueueOutputArgs) ElementType() reflect.Type

type LookupQueuePolicyArgs added in v0.12.0 

type LookupQueuePolicyArgs struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
}

type LookupQueuePolicyOutputArgs added in v0.12.0 

type LookupQueuePolicyOutputArgs struct {
	// The provider-assigned unique ID for this managed resource.
	Id pulumi.StringInput `pulumi:"id"`
}

func (LookupQueuePolicyOutputArgs) ElementType added in v0.12.0 

func (LookupQueuePolicyOutputArgs) ElementType() reflect.Type

type LookupQueuePolicyResult added in v0.12.0 

type LookupQueuePolicyResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id *string `pulumi:"id"`
	// A policy document that contains the permissions for the specified SQS queues. For more information about SQS policies, see [Using custom policies with the access policy language](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) in the *Developer Guide*.
	PolicyDocument interface{} `pulumi:"policyDocument"`
	// The URLs of the queues to which you want to add the policy. You can use the “Ref“ function to specify an “AWS::SQS::Queue“ resource.
	Queues []string `pulumi:"queues"`
}

func LookupQueuePolicy added in v0.12.0 

func LookupQueuePolicy(ctx *pulumi.Context, args *LookupQueuePolicyArgs, opts ...pulumi.InvokeOption) (*LookupQueuePolicyResult, error)

The “AWS::SQS::QueuePolicy“ type applies a policy to SQS queues. For an example snippet, see [Declaring an policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sqs-policy) in the *User Guide*.

type LookupQueuePolicyResultOutput added in v0.12.0 

type LookupQueuePolicyResultOutput struct{ *pulumi.OutputState }

func LookupQueuePolicyOutput added in v0.12.0 

func LookupQueuePolicyOutput(ctx *pulumi.Context, args LookupQueuePolicyOutputArgs, opts ...pulumi.InvokeOption) LookupQueuePolicyResultOutput

func (LookupQueuePolicyResultOutput) ElementType added in v0.12.0 

func (LookupQueuePolicyResultOutput) ElementType() reflect.Type

func (LookupQueuePolicyResultOutput) Id added in v0.12.0 

func (o LookupQueuePolicyResultOutput) Id() pulumi.StringPtrOutput

The provider-assigned unique ID for this managed resource.

func (LookupQueuePolicyResultOutput) PolicyDocument added in v0.12.0 

func (o LookupQueuePolicyResultOutput) PolicyDocument() pulumi.AnyOutput

A policy document that contains the permissions for the specified SQS queues. For more information about SQS policies, see [Using custom policies with the access policy language](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) in the *Developer Guide*.

func (LookupQueuePolicyResultOutput) Queues added in v0.12.0 

func (o LookupQueuePolicyResultOutput) Queues() pulumi.StringArrayOutput

The URLs of the queues to which you want to add the policy. You can use the “Ref“ function to specify an “AWS::SQS::Queue“ resource.

func (LookupQueuePolicyResultOutput) ToLookupQueuePolicyResultOutput added in v0.12.0 

func (o LookupQueuePolicyResultOutput) ToLookupQueuePolicyResultOutput() LookupQueuePolicyResultOutput

func (LookupQueuePolicyResultOutput) ToLookupQueuePolicyResultOutputWithContext added in v0.12.0 

func (o LookupQueuePolicyResultOutput) ToLookupQueuePolicyResultOutputWithContext(ctx context.Context) LookupQueuePolicyResultOutput

func (LookupQueuePolicyResultOutput) ToOutput added in v0.76.0 

func (o LookupQueuePolicyResultOutput) ToOutput(ctx context.Context) pulumix.Output[LookupQueuePolicyResult]

type LookupQueueResult added in v0.12.0 

type LookupQueueResult struct {
	// Amazon Resource Name (ARN) of the queue.
	Arn *string `pulumi:"arn"`
	// For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, Amazon SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message.
	ContentBasedDeduplication *bool `pulumi:"contentBasedDeduplication"`
	// Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.
	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"`
	// Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
	FifoThroughputLimit *string `pulumi:"fifoThroughputLimit"`
	// 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. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).
	KmsDataKeyReusePeriodSeconds *int `pulumi:"kmsDataKeyReusePeriodSeconds"`
	// The ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom CMK. To use the AWS managed CMK for Amazon SQS, specify the (default) alias alias/aws/sqs.
	KmsMasterKeyId *string `pulumi:"kmsMasterKeyId"`
	// The limit of how many bytes that a message can contain before Amazon 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 Amazon 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"`
	// URL of the source queue.
	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.
	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.
	RedriveAllowPolicy interface{} `pulumi:"redriveAllowPolicy"`
	// A string that includes the parameters for the dead-letter queue functionality (redrive policy) of the source queue.
	RedrivePolicy interface{} `pulumi:"redrivePolicy"`
	// Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS ).
	SqsManagedSseEnabled *bool `pulumi:"sqsManagedSseEnabled"`
	// The tags that you attach to this queue.
	Tags []QueueTag `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.
	VisibilityTimeout *int `pulumi:"visibilityTimeout"`
}

func LookupQueue added in v0.12.0 

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

Resource Type definition for AWS::SQS::Queue

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

Amazon Resource Name (ARN) of the queue.

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, Amazon SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message.

func (LookupQueueResultOutput) DeduplicationScope added in v0.12.0 

func (o LookupQueueResultOutput) DeduplicationScope() pulumi.StringPtrOutput

Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.

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

Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.

func (LookupQueueResultOutput) KmsDataKeyReusePeriodSeconds added in v0.12.0 

func (o LookupQueueResultOutput) KmsDataKeyReusePeriodSeconds() pulumi.IntPtrOutput

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

func (LookupQueueResultOutput) KmsMasterKeyId added in v0.12.0 

func (o LookupQueueResultOutput) KmsMasterKeyId() pulumi.StringPtrOutput

The ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom CMK. To use the AWS managed CMK for Amazon SQS, specify the (default) alias alias/aws/sqs.

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 Amazon 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 Amazon 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

URL of the source queue.

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.

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.

func (LookupQueueResultOutput) RedrivePolicy added in v0.12.0 

func (o LookupQueueResultOutput) RedrivePolicy() pulumi.AnyOutput

A string that includes the parameters for the dead-letter queue functionality (redrive policy) of the source queue.

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 (e.g. SSE-KMS or SSE-SQS ).

func (LookupQueueResultOutput) Tags added in v0.12.0 

func (o LookupQueueResultOutput) Tags() QueueTagArrayOutput

The tags that you attach to this queue.

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) ToOutput added in v0.76.0 

func (o LookupQueueResultOutput) ToOutput(ctx context.Context) pulumix.Output[LookupQueueResult]

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.

type Queue 

type Queue struct {
	pulumi.CustomResourceState

	// Amazon Resource Name (ARN) of the queue.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, Amazon SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message.
	ContentBasedDeduplication pulumi.BoolPtrOutput `pulumi:"contentBasedDeduplication"`
	// Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.
	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, Amazon SQS creates a standard queue.
	FifoQueue pulumi.BoolPtrOutput `pulumi:"fifoQueue"`
	// Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
	FifoThroughputLimit pulumi.StringPtrOutput `pulumi:"fifoThroughputLimit"`
	// 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. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).
	KmsDataKeyReusePeriodSeconds pulumi.IntPtrOutput `pulumi:"kmsDataKeyReusePeriodSeconds"`
	// The ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom CMK. To use the AWS managed CMK for Amazon SQS, specify the (default) alias alias/aws/sqs.
	KmsMasterKeyId pulumi.StringPtrOutput `pulumi:"kmsMasterKeyId"`
	// The limit of how many bytes that a message can contain before Amazon 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 Amazon 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.
	QueueName pulumi.StringPtrOutput `pulumi:"queueName"`
	// URL of the source queue.
	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.
	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.
	RedriveAllowPolicy pulumi.AnyOutput `pulumi:"redriveAllowPolicy"`
	// A string that includes the parameters for the dead-letter queue functionality (redrive policy) of the source queue.
	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 (e.g. SSE-KMS or SSE-SQS ).
	SqsManagedSseEnabled pulumi.BoolPtrOutput `pulumi:"sqsManagedSseEnabled"`
	// The tags that you attach to this queue.
	Tags QueueTagArrayOutput `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.
	VisibilityTimeout pulumi.IntPtrOutput `pulumi:"visibilityTimeout"`
}

Resource Type definition for AWS::SQS::Queue

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) ToOutput added in v0.76.0 

func (i *Queue) ToOutput(ctx context.Context) pulumix.Output[*Queue]

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, Amazon SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message.
	ContentBasedDeduplication pulumi.BoolPtrInput
	// Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.
	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, Amazon SQS creates a standard queue.
	FifoQueue pulumi.BoolPtrInput
	// Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
	FifoThroughputLimit pulumi.StringPtrInput
	// 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. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).
	KmsDataKeyReusePeriodSeconds pulumi.IntPtrInput
	// The ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom CMK. To use the AWS managed CMK for Amazon SQS, specify the (default) alias alias/aws/sqs.
	KmsMasterKeyId pulumi.StringPtrInput
	// The limit of how many bytes that a message can contain before Amazon 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 Amazon 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.
	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.
	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.
	RedriveAllowPolicy pulumi.Input
	// A string that includes the parameters for the dead-letter queue functionality (redrive policy) of the source queue.
	RedrivePolicy pulumi.Input
	// Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS ).
	SqsManagedSseEnabled pulumi.BoolPtrInput
	// The tags that you attach to this queue.
	Tags QueueTagArrayInput
	// 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.
	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
	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) ToOutput added in v0.76.0 

func (i *QueueInlinePolicy) ToOutput(ctx context.Context) pulumix.Output[*QueueInlinePolicy]

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
	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

func (QueueInlinePolicyOutput) Queue added in v0.71.0 

func (o QueueInlinePolicyOutput) Queue() pulumi.StringOutput

The URL of the SQS queue.

func (QueueInlinePolicyOutput) ToOutput added in v0.76.0 

func (o QueueInlinePolicyOutput) ToOutput(ctx context.Context) pulumix.Output[*QueueInlinePolicy]

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

Amazon Resource Name (ARN) of the queue.

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, Amazon SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message.

func (QueueOutput) DeduplicationScope added in v0.17.0 

func (o QueueOutput) DeduplicationScope() pulumi.StringPtrOutput

Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.

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, Amazon SQS creates a standard queue.

func (QueueOutput) FifoThroughputLimit added in v0.17.0 

func (o QueueOutput) FifoThroughputLimit() pulumi.StringPtrOutput

Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.

func (QueueOutput) KmsDataKeyReusePeriodSeconds added in v0.17.0 

func (o QueueOutput) KmsDataKeyReusePeriodSeconds() pulumi.IntPtrOutput

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

func (QueueOutput) KmsMasterKeyId added in v0.17.0 

func (o QueueOutput) KmsMasterKeyId() pulumi.StringPtrOutput

The ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom CMK. To use the AWS managed CMK for Amazon SQS, specify the (default) alias alias/aws/sqs.

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 Amazon 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 Amazon 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.

func (QueueOutput) QueueUrl added in v0.17.0 

func (o QueueOutput) QueueUrl() pulumi.StringOutput

URL of the source queue.

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.

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.

func (QueueOutput) RedrivePolicy added in v0.17.0 

func (o QueueOutput) RedrivePolicy() pulumi.AnyOutput

A string that includes the parameters for the dead-letter queue functionality (redrive policy) of the source queue.

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 (e.g. SSE-KMS or SSE-SQS ).

func (QueueOutput) Tags added in v0.17.0 

func (o QueueOutput) Tags() QueueTagArrayOutput

The tags that you attach to this queue.

func (QueueOutput) ToOutput added in v0.76.0 

func (o QueueOutput) ToOutput(ctx context.Context) pulumix.Output[*Queue]

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.

type QueuePolicy deprecated 

type QueuePolicy struct {
	pulumi.CustomResourceState

	// A policy document that contains the permissions for the specified SQS queues. For more information about SQS policies, see [Using custom policies with the access policy language](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) in the *Developer Guide*.
	PolicyDocument pulumi.AnyOutput `pulumi:"policyDocument"`
	// The URLs of the queues to which you want to add the policy. You can use the “Ref“ function to specify an “AWS::SQS::Queue“ resource.
	Queues pulumi.StringArrayOutput `pulumi:"queues"`
}

The “AWS::SQS::QueuePolicy“ type applies a policy to SQS queues. For an example snippet, see [Declaring an policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sqs-policy) in the *User Guide*.

Deprecated: QueuePolicy is not yet supported by AWS Native, so its creation will currently fail. Please use the classic AWS provider, if possible.

func GetQueuePolicy 

func GetQueuePolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *QueuePolicyState, opts ...pulumi.ResourceOption) (*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.ResourceOption) (*QueuePolicy, error)

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

func (*QueuePolicy) ElementType 

func (*QueuePolicy) ElementType() reflect.Type

func (*QueuePolicy) ToOutput added in v0.76.0 

func (i *QueuePolicy) ToOutput(ctx context.Context) pulumix.Output[*QueuePolicy]

func (*QueuePolicy) ToQueuePolicyOutput 

func (i *QueuePolicy) ToQueuePolicyOutput() QueuePolicyOutput

func (*QueuePolicy) ToQueuePolicyOutputWithContext 

func (i *QueuePolicy) ToQueuePolicyOutputWithContext(ctx context.Context) QueuePolicyOutput

type QueuePolicyArgs 

type QueuePolicyArgs struct {
	// A policy document that contains the permissions for the specified SQS queues. For more information about SQS policies, see [Using custom policies with the access policy language](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) in the *Developer Guide*.
	PolicyDocument pulumi.Input
	// The URLs of the queues to which you want to add the policy. You can use the “Ref“ function to specify an “AWS::SQS::Queue“ resource.
	Queues pulumi.StringArrayInput
}

The set of arguments for constructing a QueuePolicy resource.

func (QueuePolicyArgs) ElementType 

func (QueuePolicyArgs) ElementType() reflect.Type

type QueuePolicyInput 

type QueuePolicyInput interface {
	pulumi.Input

	ToQueuePolicyOutput() QueuePolicyOutput
	ToQueuePolicyOutputWithContext(ctx context.Context) QueuePolicyOutput
}

type QueuePolicyOutput 

type QueuePolicyOutput struct{ *pulumi.OutputState }

func (QueuePolicyOutput) ElementType 

func (QueuePolicyOutput) ElementType() reflect.Type

func (QueuePolicyOutput) PolicyDocument added in v0.17.0 

func (o QueuePolicyOutput) PolicyDocument() pulumi.AnyOutput

A policy document that contains the permissions for the specified SQS queues. For more information about SQS policies, see [Using custom policies with the access policy language](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) in the *Developer Guide*.

func (QueuePolicyOutput) Queues added in v0.17.0 

func (o QueuePolicyOutput) Queues() pulumi.StringArrayOutput

The URLs of the queues to which you want to add the policy. You can use the “Ref“ function to specify an “AWS::SQS::Queue“ resource.

func (QueuePolicyOutput) ToOutput added in v0.76.0 

func (o QueuePolicyOutput) ToOutput(ctx context.Context) pulumix.Output[*QueuePolicy]

func (QueuePolicyOutput) ToQueuePolicyOutput 

func (o QueuePolicyOutput) ToQueuePolicyOutput() QueuePolicyOutput

func (QueuePolicyOutput) ToQueuePolicyOutputWithContext 

func (o QueuePolicyOutput) ToQueuePolicyOutputWithContext(ctx context.Context) QueuePolicyOutput

type QueuePolicyState 

type QueuePolicyState struct {
}

func (QueuePolicyState) ElementType 

func (QueuePolicyState) ElementType() reflect.Type

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"`
}

type QueueTagArgs 

type QueueTagArgs 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 pulumi.StringInput `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 pulumi.StringInput `pulumi:"value"`
}

func (QueueTagArgs) ElementType 

func (QueueTagArgs) ElementType() reflect.Type

func (QueueTagArgs) ToOutput added in v0.76.0 

func (i QueueTagArgs) ToOutput(ctx context.Context) pulumix.Output[QueueTag]

func (QueueTagArgs) ToQueueTagOutput 

func (i QueueTagArgs) ToQueueTagOutput() QueueTagOutput

func (QueueTagArgs) ToQueueTagOutputWithContext 

func (i QueueTagArgs) ToQueueTagOutputWithContext(ctx context.Context) QueueTagOutput

type QueueTagArray 

type QueueTagArray []QueueTagInput

func (QueueTagArray) ElementType 

func (QueueTagArray) ElementType() reflect.Type

func (QueueTagArray) ToOutput added in v0.76.0 

func (i QueueTagArray) ToOutput(ctx context.Context) pulumix.Output[[]QueueTag]

func (QueueTagArray) ToQueueTagArrayOutput 

func (i QueueTagArray) ToQueueTagArrayOutput() QueueTagArrayOutput

func (QueueTagArray) ToQueueTagArrayOutputWithContext 

func (i QueueTagArray) ToQueueTagArrayOutputWithContext(ctx context.Context) QueueTagArrayOutput

type QueueTagArrayInput 

type QueueTagArrayInput interface {
	pulumi.Input

	ToQueueTagArrayOutput() QueueTagArrayOutput
	ToQueueTagArrayOutputWithContext(context.Context) QueueTagArrayOutput
}

QueueTagArrayInput is an input type that accepts QueueTagArray and QueueTagArrayOutput values. You can construct a concrete instance of `QueueTagArrayInput` via: 

QueueTagArray{ QueueTagArgs{...} }

type QueueTagArrayOutput 

type QueueTagArrayOutput struct{ *pulumi.OutputState }

func (QueueTagArrayOutput) ElementType 

func (QueueTagArrayOutput) ElementType() reflect.Type

func (QueueTagArrayOutput) Index 

func (o QueueTagArrayOutput) Index(i pulumi.IntInput) QueueTagOutput

func (QueueTagArrayOutput) ToOutput added in v0.76.0 

func (o QueueTagArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]QueueTag]

func (QueueTagArrayOutput) ToQueueTagArrayOutput 

func (o QueueTagArrayOutput) ToQueueTagArrayOutput() QueueTagArrayOutput

func (QueueTagArrayOutput) ToQueueTagArrayOutputWithContext 

func (o QueueTagArrayOutput) ToQueueTagArrayOutputWithContext(ctx context.Context) QueueTagArrayOutput

type QueueTagInput 

type QueueTagInput interface {
	pulumi.Input

	ToQueueTagOutput() QueueTagOutput
	ToQueueTagOutputWithContext(context.Context) QueueTagOutput
}

QueueTagInput is an input type that accepts QueueTagArgs and QueueTagOutput values. You can construct a concrete instance of `QueueTagInput` via: 

QueueTagArgs{...}

type QueueTagOutput 

type QueueTagOutput struct{ *pulumi.OutputState }

func (QueueTagOutput) ElementType 

func (QueueTagOutput) ElementType() reflect.Type

func (QueueTagOutput) Key 

func (o QueueTagOutput) Key() pulumi.StringOutput

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 -.

func (QueueTagOutput) ToOutput added in v0.76.0 

func (o QueueTagOutput) ToOutput(ctx context.Context) pulumix.Output[QueueTag]

func (QueueTagOutput) ToQueueTagOutput 

func (o QueueTagOutput) ToQueueTagOutput() QueueTagOutput

func (QueueTagOutput) ToQueueTagOutputWithContext 

func (o QueueTagOutput) ToQueueTagOutputWithContext(ctx context.Context) QueueTagOutput

func (QueueTagOutput) Value 

func (o QueueTagOutput) Value() pulumi.StringOutput

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 -.

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.