software.amazon.awscdk.services.sqs

Class CfnQueue

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.sqs.CfnQueue

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:19.318Z")
 @Stability(value=Stable)
public class CfnQueue
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SQS::Queue`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sqs.*;
 Object redriveAllowPolicy;
 Object redrivePolicy;
 CfnQueue cfnQueue = CfnQueue.Builder.create(this, "MyCfnQueue")
         .contentBasedDeduplication(false)
         .deduplicationScope("deduplicationScope")
         .delaySeconds(123)
         .fifoQueue(false)
         .fifoThroughputLimit("fifoThroughputLimit")
         .kmsDataKeyReusePeriodSeconds(123)
         .kmsMasterKeyId("kmsMasterKeyId")
         .maximumMessageSize(123)
         .messageRetentionPeriod(123)
         .queueName("queueName")
         .receiveMessageWaitTimeSeconds(123)
         .redriveAllowPolicy(redriveAllowPolicy)
         .redrivePolicy(redrivePolicy)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .visibilityTimeout(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnQueue.Builder A fluent builder for CfnQueue.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnQueue(software.constructs.Construct scope, String id) Create a new `AWS::SQS::Queue`.
	CfnQueue(software.constructs.Construct scope, String id, CfnQueueProps props) Create a new `AWS::SQS::Queue`.
protected	CfnQueue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnQueue(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
String	getAttrQueueName()
protected Map<String,Object>	getCfnProperties()
Object	getContentBasedDeduplication() `AWS::SQS::Queue.ContentBasedDeduplication`.
String	getDeduplicationScope() `AWS::SQS::Queue.DeduplicationScope`.
Number	getDelaySeconds() `AWS::SQS::Queue.DelaySeconds`.
Object	getFifoQueue() `AWS::SQS::Queue.FifoQueue`.
String	getFifoThroughputLimit() `AWS::SQS::Queue.FifoThroughputLimit`.
Number	getKmsDataKeyReusePeriodSeconds() `AWS::SQS::Queue.KmsDataKeyReusePeriodSeconds`.
String	getKmsMasterKeyId() `AWS::SQS::Queue.KmsMasterKeyId`.
Number	getMaximumMessageSize() `AWS::SQS::Queue.MaximumMessageSize`.
Number	getMessageRetentionPeriod() `AWS::SQS::Queue.MessageRetentionPeriod`.
String	getQueueName() `AWS::SQS::Queue.QueueName`.
Number	getReceiveMessageWaitTimeSeconds() `AWS::SQS::Queue.ReceiveMessageWaitTimeSeconds`.
Object	getRedriveAllowPolicy() `AWS::SQS::Queue.RedriveAllowPolicy`.
Object	getRedrivePolicy() `AWS::SQS::Queue.RedrivePolicy`.
TagManager	getTags() `AWS::SQS::Queue.Tags`.
Number	getVisibilityTimeout() `AWS::SQS::Queue.VisibilityTimeout`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setContentBasedDeduplication(Boolean value) `AWS::SQS::Queue.ContentBasedDeduplication`.
void	setContentBasedDeduplication(IResolvable value) `AWS::SQS::Queue.ContentBasedDeduplication`.
void	setDeduplicationScope(String value) `AWS::SQS::Queue.DeduplicationScope`.
void	setDelaySeconds(Number value) `AWS::SQS::Queue.DelaySeconds`.
void	setFifoQueue(Boolean value) `AWS::SQS::Queue.FifoQueue`.
void	setFifoQueue(IResolvable value) `AWS::SQS::Queue.FifoQueue`.
void	setFifoThroughputLimit(String value) `AWS::SQS::Queue.FifoThroughputLimit`.
void	setKmsDataKeyReusePeriodSeconds(Number value) `AWS::SQS::Queue.KmsDataKeyReusePeriodSeconds`.
void	setKmsMasterKeyId(String value) `AWS::SQS::Queue.KmsMasterKeyId`.
void	setMaximumMessageSize(Number value) `AWS::SQS::Queue.MaximumMessageSize`.
void	setMessageRetentionPeriod(Number value) `AWS::SQS::Queue.MessageRetentionPeriod`.
void	setQueueName(String value) `AWS::SQS::Queue.QueueName`.
void	setReceiveMessageWaitTimeSeconds(Number value) `AWS::SQS::Queue.ReceiveMessageWaitTimeSeconds`.
void	setRedriveAllowPolicy(Object value) `AWS::SQS::Queue.RedriveAllowPolicy`.
void	setRedrivePolicy(Object value) `AWS::SQS::Queue.RedrivePolicy`.
void	setVisibilityTimeout(Number value) `AWS::SQS::Queue.VisibilityTimeout`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnQueue

protected CfnQueue(software.amazon.jsii.JsiiObjectRef objRef)

CfnQueue

protected CfnQueue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnQueue

@Stability(value=Stable)
public CfnQueue(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @Nullable
                                         CfnQueueProps props)

Create a new `AWS::SQS::Queue`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnQueue

@Stability(value=Stable)
public CfnQueue(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id)

Create a new `AWS::SQS::Queue`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getAttrQueueName

@Stability(value=Stable)
 @NotNull
public String getAttrQueueName()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getContentBasedDeduplication

@Stability(value=Stable)
 @Nullable
public Object getContentBasedDeduplication()

`AWS::SQS::Queue.ContentBasedDeduplication`.

setContentBasedDeduplication

@Stability(value=Stable)
public void setContentBasedDeduplication(@Nullable
                                                                  Boolean value)

`AWS::SQS::Queue.ContentBasedDeduplication`.

setContentBasedDeduplication

@Stability(value=Stable)
public void setContentBasedDeduplication(@Nullable
                                                                  IResolvable value)

`AWS::SQS::Queue.ContentBasedDeduplication`.

getDeduplicationScope

@Stability(value=Stable)
 @Nullable
public String getDeduplicationScope()

`AWS::SQS::Queue.DeduplicationScope`.

setDeduplicationScope

@Stability(value=Stable)
public void setDeduplicationScope(@Nullable
                                                           String value)

`AWS::SQS::Queue.DeduplicationScope`.

getDelaySeconds

@Stability(value=Stable)
 @Nullable
public Number getDelaySeconds()

`AWS::SQS::Queue.DelaySeconds`.

setDelaySeconds

@Stability(value=Stable)
public void setDelaySeconds(@Nullable
                                                     Number value)

`AWS::SQS::Queue.DelaySeconds`.

getFifoQueue

@Stability(value=Stable)
 @Nullable
public Object getFifoQueue()

`AWS::SQS::Queue.FifoQueue`.

setFifoQueue

@Stability(value=Stable)
public void setFifoQueue(@Nullable
                                                  Boolean value)

`AWS::SQS::Queue.FifoQueue`.

setFifoQueue

@Stability(value=Stable)
public void setFifoQueue(@Nullable
                                                  IResolvable value)

`AWS::SQS::Queue.FifoQueue`.

getFifoThroughputLimit

@Stability(value=Stable)
 @Nullable
public String getFifoThroughputLimit()

`AWS::SQS::Queue.FifoThroughputLimit`.

setFifoThroughputLimit

@Stability(value=Stable)
public void setFifoThroughputLimit(@Nullable
                                                            String value)

`AWS::SQS::Queue.FifoThroughputLimit`.

getKmsDataKeyReusePeriodSeconds

@Stability(value=Stable)
 @Nullable
public Number getKmsDataKeyReusePeriodSeconds()

`AWS::SQS::Queue.KmsDataKeyReusePeriodSeconds`.

setKmsDataKeyReusePeriodSeconds

@Stability(value=Stable)
public void setKmsDataKeyReusePeriodSeconds(@Nullable
                                                                     Number value)

`AWS::SQS::Queue.KmsDataKeyReusePeriodSeconds`.

getKmsMasterKeyId

@Stability(value=Stable)
 @Nullable
public String getKmsMasterKeyId()

`AWS::SQS::Queue.KmsMasterKeyId`.

setKmsMasterKeyId

@Stability(value=Stable)
public void setKmsMasterKeyId(@Nullable
                                                       String value)

`AWS::SQS::Queue.KmsMasterKeyId`.

getMaximumMessageSize

@Stability(value=Stable)
 @Nullable
public Number getMaximumMessageSize()

`AWS::SQS::Queue.MaximumMessageSize`.

setMaximumMessageSize

@Stability(value=Stable)
public void setMaximumMessageSize(@Nullable
                                                           Number value)

`AWS::SQS::Queue.MaximumMessageSize`.

getMessageRetentionPeriod

@Stability(value=Stable)
 @Nullable
public Number getMessageRetentionPeriod()

`AWS::SQS::Queue.MessageRetentionPeriod`.

setMessageRetentionPeriod

@Stability(value=Stable)
public void setMessageRetentionPeriod(@Nullable
                                                               Number value)

`AWS::SQS::Queue.MessageRetentionPeriod`.

getQueueName

@Stability(value=Stable)
 @Nullable
public String getQueueName()

`AWS::SQS::Queue.QueueName`.

setQueueName

@Stability(value=Stable)
public void setQueueName(@Nullable
                                                  String value)

`AWS::SQS::Queue.QueueName`.

getReceiveMessageWaitTimeSeconds

@Stability(value=Stable)
 @Nullable
public Number getReceiveMessageWaitTimeSeconds()

`AWS::SQS::Queue.ReceiveMessageWaitTimeSeconds`.

setReceiveMessageWaitTimeSeconds

@Stability(value=Stable)
public void setReceiveMessageWaitTimeSeconds(@Nullable
                                                                      Number value)

`AWS::SQS::Queue.ReceiveMessageWaitTimeSeconds`.

getRedriveAllowPolicy

@Stability(value=Stable)
 @NotNull
public Object getRedriveAllowPolicy()

`AWS::SQS::Queue.RedriveAllowPolicy`.

setRedriveAllowPolicy

@Stability(value=Stable)
public void setRedriveAllowPolicy(@NotNull
                                                           Object value)

`AWS::SQS::Queue.RedriveAllowPolicy`.

getRedrivePolicy

@Stability(value=Stable)
 @NotNull
public Object getRedrivePolicy()

`AWS::SQS::Queue.RedrivePolicy`.

setRedrivePolicy

@Stability(value=Stable)
public void setRedrivePolicy(@NotNull
                                                      Object value)

`AWS::SQS::Queue.RedrivePolicy`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::SQS::Queue.Tags`.

getVisibilityTimeout

@Stability(value=Stable)
 @Nullable
public Number getVisibilityTimeout()

`AWS::SQS::Queue.VisibilityTimeout`.

setVisibilityTimeout

@Stability(value=Stable)
public void setVisibilityTimeout(@Nullable
                                                          Number value)

`AWS::SQS::Queue.VisibilityTimeout`.