< Back
Add-CfnSQS_QueueResource
Post
NAME Add-CfnSQS_QueueResource
SYNOPSIS
The AWS::SQS::Queue type creates an Amazon SQS queue.
SYNTAX
Add-CfnSQS_QueueResource [-ResourceName] <String> [-DelaySeconds <Int32>] [-MaximumMessageSize <Int32>]
[-MessageRetentionPeriod <Int32>] [-QueueName <String>] [-ReceiveMessageWaitTimeSeconds <Int32>] [-RedrivePolicy
<IDictionary>] [-VisibilityTimeout <Int32>] [-DeletionPolicy <String>] [-Metadata <Hashtable>] [-DependsOn
<Array>] [[-PropertiesBlock] <ScriptBlock>] [-Condition <Object>] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-ResourceName <String>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DelaySeconds <Int32>
The time in seconds that the delivery of all messages in the queue will be delayed. You can specify an integer
value of 0 to 900 (15 minutes). The default value is 0.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-MaximumMessageSize <Int32>
The limit of how many bytes a message can contain before Amazon SQS rejects it.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-MessageRetentionPeriod <Int32>
The number of seconds Amazon SQS retains a message.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-QueueName <String>
A name for the queue. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses
that ID for the queue name.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ReceiveMessageWaitTimeSeconds <Int32>
Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue
to include in the response, as opposed to returning an empty response if a message is not yet available to
return.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-RedrivePolicy <IDictionary>
Specifies an existing dead letter queue to receive messages after the source queue (this queue) fails to
process a message a specified number of times.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-VisibilityTimeout <Int32>
The length of time during which the queue will be unavailable once 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 43200 seconds (12 hours). If no value is
specified, the default value of 30 seconds will be used.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-DeletionPolicy <String>
With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is
deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has
no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default.
To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any
resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to
use or modify those resources after you delete their stacks.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Metadata <Hashtable>
The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata
attribute to a resource, you can add data in JSON format to the resource declaration. In addition, you can use
intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute
to add those interpreted values.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DependsOn <Array>
With the DependsOn attribute you can specify that the creation of a specific resource follows another. When
you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource
specified in the DependsOn attribute. You can use the DependsOn attribute with any resource.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PropertiesBlock <ScriptBlock>
Allows you to declare a block of one or more Property statements.
A Properties block allows you to side-step the rigid, type-enforced literal properties of a typed resource,
and specify Property assignments that may include CloudFormation function calls or references, or computed
values.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Condition <Object>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS
http://docs.aws.amazon.com/AWSCloudForm ... olicy.html
http://docs.aws.amazon.com/AWSCloudForm ... adata.html
http://docs.aws.amazon.com/AWSCloudForm ... ndson.html
http://docs.aws.amazon.com/AWSCloudForm ... e-ref.html
http://docs.aws.amazon.com/search/doc-s ... SQS::Queue
SYNOPSIS
The AWS::SQS::Queue type creates an Amazon SQS queue.
SYNTAX
Add-CfnSQS_QueueResource [-ResourceName] <String> [-DelaySeconds <Int32>] [-MaximumMessageSize <Int32>]
[-MessageRetentionPeriod <Int32>] [-QueueName <String>] [-ReceiveMessageWaitTimeSeconds <Int32>] [-RedrivePolicy
<IDictionary>] [-VisibilityTimeout <Int32>] [-DeletionPolicy <String>] [-Metadata <Hashtable>] [-DependsOn
<Array>] [[-PropertiesBlock] <ScriptBlock>] [-Condition <Object>] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-ResourceName <String>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DelaySeconds <Int32>
The time in seconds that the delivery of all messages in the queue will be delayed. You can specify an integer
value of 0 to 900 (15 minutes). The default value is 0.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-MaximumMessageSize <Int32>
The limit of how many bytes a message can contain before Amazon SQS rejects it.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-MessageRetentionPeriod <Int32>
The number of seconds Amazon SQS retains a message.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-QueueName <String>
A name for the queue. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses
that ID for the queue name.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ReceiveMessageWaitTimeSeconds <Int32>
Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue
to include in the response, as opposed to returning an empty response if a message is not yet available to
return.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-RedrivePolicy <IDictionary>
Specifies an existing dead letter queue to receive messages after the source queue (this queue) fails to
process a message a specified number of times.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-VisibilityTimeout <Int32>
The length of time during which the queue will be unavailable once 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 43200 seconds (12 hours). If no value is
specified, the default value of 30 seconds will be used.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-DeletionPolicy <String>
With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is
deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has
no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default.
To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any
resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to
use or modify those resources after you delete their stacks.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Metadata <Hashtable>
The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata
attribute to a resource, you can add data in JSON format to the resource declaration. In addition, you can use
intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute
to add those interpreted values.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DependsOn <Array>
With the DependsOn attribute you can specify that the creation of a specific resource follows another. When
you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource
specified in the DependsOn attribute. You can use the DependsOn attribute with any resource.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PropertiesBlock <ScriptBlock>
Allows you to declare a block of one or more Property statements.
A Properties block allows you to side-step the rigid, type-enforced literal properties of a typed resource,
and specify Property assignments that may include CloudFormation function calls or references, or computed
values.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Condition <Object>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS
http://docs.aws.amazon.com/AWSCloudForm ... olicy.html
http://docs.aws.amazon.com/AWSCloudForm ... adata.html
http://docs.aws.amazon.com/AWSCloudForm ... ndson.html
http://docs.aws.amazon.com/AWSCloudForm ... e-ref.html
http://docs.aws.amazon.com/search/doc-s ... SQS::Queue