Class: AWSCDK::SQS::CfnQueue

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSSQS::IQueueRef
Defined in:
sqs/cfn_queue.rb

Overview

The AWS::SQS::Queue resource creates an Amazon SQS standard or FIFO queue.

Keep the following caveats in mind:

  • If you don't specify the FifoQueue property, Amazon SQS creates a standard queue.

You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving from a standard queue to a FIFO queue in the Amazon SQS Developer Guide .

  • If you don't provide a value for a property, the queue is created with the default value for the property.
  • If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
  • To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.

For more information about creating FIFO (first-in-first-out) queues, see Creating an Amazon SQS queue ( CloudFormation ) in the Amazon SQS Developer Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnQueue

Create a new AWS::SQS::Queue.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::SQS::CfnQueueProps, nil) (defaults to: nil) —

    Resource properties.



30
31
32
33
34
35
36
 
# File 'sqs/cfn_queue.rb', line 30

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::SQS::CfnQueueProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3FzLkNmblF1ZXVlUHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_queue(resource) ⇒ String

Parameters:

Returns:

  • (String) 


101
102
103
104
 
# File 'sqs/cfn_queue.rb', line 101

def self.arn_for_queue(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zcXMuSVF1ZXVlUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sqs.CfnQueue", "arnForQueue", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


208
209
210
 
# File 'sqs/cfn_queue.rb', line 208

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_sqs.CfnQueue", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_queue(x) ⇒ Boolean

Checks whether the given object is a CfnQueue.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


110
111
112
113
 
# File 'sqs/cfn_queue.rb', line 110

def self.is_cfn_queue(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sqs.CfnQueue", "isCfnQueue", [x])
end

.jsii_overridable_methods ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'sqs/cfn_queue.rb', line 38

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_queue_name => { kind: :property, name: "attrQueueName", is_optional: false },
    :attr_queue_url => { kind: :property, name: "attrQueueUrl", is_optional: false },
    :queue_ref => { kind: :property, name: "queueRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :redrive_allow_policy => { kind: :property, name: "redriveAllowPolicy", is_optional: false },
    :redrive_policy => { kind: :property, name: "redrivePolicy", is_optional: false },
    :content_based_deduplication => { kind: :property, name: "contentBasedDeduplication", is_optional: true },
    :deduplication_scope => { kind: :property, name: "deduplicationScope", is_optional: true },
    :delay_seconds => { kind: :property, name: "delaySeconds", is_optional: true },
    :fifo_queue => { kind: :property, name: "fifoQueue", is_optional: true },
    :fifo_throughput_limit => { kind: :property, name: "fifoThroughputLimit", is_optional: true },
    :kms_data_key_reuse_period_seconds => { kind: :property, name: "kmsDataKeyReusePeriodSeconds", is_optional: true },
    :kms_master_key_id => { kind: :property, name: "kmsMasterKeyId", is_optional: true },
    :maximum_message_size => { kind: :property, name: "maximumMessageSize", is_optional: true },
    :message_retention_period => { kind: :property, name: "messageRetentionPeriod", is_optional: true },
    :queue_name => { kind: :property, name: "queueName", is_optional: true },
    :receive_message_wait_time_seconds => { kind: :property, name: "receiveMessageWaitTimeSeconds", is_optional: true },
    :sqs_managed_sse_enabled => { kind: :property, name: "sqsManagedSseEnabled", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :visibility_timeout => { kind: :property, name: "visibilityTimeout", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



480
481
482
483
 
# File 'sqs/cfn_queue.rb', line 480

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



492
493
494
495
 
# File 'sqs/cfn_queue.rb', line 492

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



502
503
504
505
 
# File 'sqs/cfn_queue.rb', line 502

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



513
514
515
516
517
 
# File 'sqs/cfn_queue.rb', line 513

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


570
571
572
573
574
 
# File 'sqs/cfn_queue.rb', line 570

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



580
581
582
583
 
# File 'sqs/cfn_queue.rb', line 580

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



592
593
594
595
596
 
# File 'sqs/cfn_queue.rb', line 592

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



605
606
607
608
 
# File 'sqs/cfn_queue.rb', line 605

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



627
628
629
630
631
632
 
# File 'sqs/cfn_queue.rb', line 627

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

Returns the Amazon Resource Name (ARN) of the queue.

For example: arn:aws:sqs:us-east-2:123456789012:mystack-myqueue-15PG5C2FC1CW8 .

Returns:

  • (String) 


217
218
219
 
# File 'sqs/cfn_queue.rb', line 217

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_queue_name ⇒ String

Returns the queue name.

For example: mystack-myqueue-1VF9BKQH5BJVI .

Returns:

  • (String) 


226
227
228
 
# File 'sqs/cfn_queue.rb', line 226

def attr_queue_name()
  jsii_get_property("attrQueueName")
end

#attr_queue_url ⇒ String

Returns the URLs of the queues from the policy.

Returns:

  • (String) 


233
234
235
 
# File 'sqs/cfn_queue.rb', line 233

def attr_queue_url()
  jsii_get_property("attrQueueUrl")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



161
162
163
 
# File 'sqs/cfn_queue.rb', line 161

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


166
167
168
 
# File 'sqs/cfn_queue.rb', line 166

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


636
637
638
639
 
# File 'sqs/cfn_queue.rb', line 636

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


171
172
173
 
# File 'sqs/cfn_queue.rb', line 171

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


178
179
180
 
# File 'sqs/cfn_queue.rb', line 178

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#content_based_deduplication ⇒ Boolean, ...

For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication.

Returns:



278
279
280
 
# File 'sqs/cfn_queue.rb', line 278

def content_based_deduplication()
  jsii_get_property("contentBasedDeduplication")
end

#content_based_deduplication=(value) ⇒ Object 



282
283
284
285
 
# File 'sqs/cfn_queue.rb', line 282

def content_based_deduplication=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "contentBasedDeduplication") unless value.nil?
  jsii_set_property("contentBasedDeduplication", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


123
124
125
 
# File 'sqs/cfn_queue.rb', line 123

def creation_stack()
  jsii_get_property("creationStack")
end

#deduplication_scope ⇒ String?

For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level.

Returns:

  • (String, nil) 


290
291
292
 
# File 'sqs/cfn_queue.rb', line 290

def deduplication_scope()
  jsii_get_property("deduplicationScope")
end

#deduplication_scope=(value) ⇒ Object 



294
295
296
297
 
# File 'sqs/cfn_queue.rb', line 294

def deduplication_scope=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deduplicationScope") unless value.nil?
  jsii_set_property("deduplicationScope", value)
end

#delay_seconds ⇒ Numeric?

The time in seconds for which the delivery of all messages in the queue is delayed.

Returns:

  • (Numeric, nil) 


302
303
304
 
# File 'sqs/cfn_queue.rb', line 302

def delay_seconds()
  jsii_get_property("delaySeconds")
end

#delay_seconds=(value) ⇒ Object 



306
307
308
309
 
# File 'sqs/cfn_queue.rb', line 306

def delay_seconds=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "delaySeconds") unless value.nil?
  jsii_set_property("delaySeconds", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



183
184
185
 
# File 'sqs/cfn_queue.rb', line 183

def env()
  jsii_get_property("env")
end

#fifo_queue ⇒ Boolean, ...

If set to true, creates a FIFO queue.

Returns:



314
315
316
 
# File 'sqs/cfn_queue.rb', line 314

def fifo_queue()
  jsii_get_property("fifoQueue")
end

#fifo_queue=(value) ⇒ Object 



318
319
320
321
 
# File 'sqs/cfn_queue.rb', line 318

def fifo_queue=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "fifoQueue") unless value.nil?
  jsii_set_property("fifoQueue", value)
end

#fifo_throughput_limit ⇒ String?

For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group.

Returns:

  • (String, nil) 


326
327
328
 
# File 'sqs/cfn_queue.rb', line 326

def fifo_throughput_limit()
  jsii_get_property("fifoThroughputLimit")
end

#fifo_throughput_limit=(value) ⇒ Object 



330
331
332
333
 
# File 'sqs/cfn_queue.rb', line 330

def fifo_throughput_limit=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fifoThroughputLimit") unless value.nil?
  jsii_set_property("fifoThroughputLimit", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



649
650
651
652
653
 
# File 'sqs/cfn_queue.rb', line 649

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



660
661
662
663
 
# File 'sqs/cfn_queue.rb', line 660

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



730
731
732
733
 
# File 'sqs/cfn_queue.rb', line 730

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#kms_data_key_reuse_period_seconds ⇒ Numeric?

The length of time in seconds for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS again.

Returns:

  • (Numeric, nil) 


338
339
340
 
# File 'sqs/cfn_queue.rb', line 338

def kms_data_key_reuse_period_seconds()
  jsii_get_property("kmsDataKeyReusePeriodSeconds")
end

#kms_data_key_reuse_period_seconds=(value) ⇒ Object 



342
343
344
345
 
# File 'sqs/cfn_queue.rb', line 342

def kms_data_key_reuse_period_seconds=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "kmsDataKeyReusePeriodSeconds") unless value.nil?
  jsii_set_property("kmsDataKeyReusePeriodSeconds", value)
end

#kms_master_key_id ⇒ String?

The ID of an AWS Key Management Service (KMS) for Amazon SQS , or a custom KMS.

Returns:

  • (String, nil) 


350
351
352
 
# File 'sqs/cfn_queue.rb', line 350

def kms_master_key_id()
  jsii_get_property("kmsMasterKeyId")
end

#kms_master_key_id=(value) ⇒ Object 



354
355
356
357
 
# File 'sqs/cfn_queue.rb', line 354

def kms_master_key_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsMasterKeyId") unless value.nil?
  jsii_set_property("kmsMasterKeyId", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


135
136
137
 
# File 'sqs/cfn_queue.rb', line 135

def logical_id()
  jsii_get_property("logicalId")
end

#maximum_message_size ⇒ Numeric?

The limit of how many bytes that a message can contain before Amazon SQS rejects it.

Returns:

  • (Numeric, nil) 


362
363
364
 
# File 'sqs/cfn_queue.rb', line 362

def maximum_message_size()
  jsii_get_property("maximumMessageSize")
end

#maximum_message_size=(value) ⇒ Object 



366
367
368
369
 
# File 'sqs/cfn_queue.rb', line 366

def maximum_message_size=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maximumMessageSize") unless value.nil?
  jsii_set_property("maximumMessageSize", value)
end

#message_retention_period ⇒ Numeric?

The number of seconds that Amazon SQS retains a message.

Returns:

  • (Numeric, nil) 


374
375
376
 
# File 'sqs/cfn_queue.rb', line 374

def message_retention_period()
  jsii_get_property("messageRetentionPeriod")
end

#message_retention_period=(value) ⇒ Object 



378
379
380
381
 
# File 'sqs/cfn_queue.rb', line 378

def message_retention_period=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "messageRetentionPeriod") unless value.nil?
  jsii_set_property("messageRetentionPeriod", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


118
119
120
 
# File 'sqs/cfn_queue.rb', line 118

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



671
672
673
 
# File 'sqs/cfn_queue.rb', line 671

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



678
679
680
 
# File 'sqs/cfn_queue.rb', line 678

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



471
472
473
474
 
# File 'sqs/cfn_queue.rb', line 471

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#queue_name ⇒ String?

A name for the queue.

Returns:

  • (String, nil) 


386
387
388
 
# File 'sqs/cfn_queue.rb', line 386

def queue_name()
  jsii_get_property("queueName")
end

#queue_name=(value) ⇒ Object 



390
391
392
393
 
# File 'sqs/cfn_queue.rb', line 390

def queue_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "queueName") unless value.nil?
  jsii_set_property("queueName", value)
end

#queue_ref ⇒ AWSCDK::Interfaces::AWSSQS::QueueReference

A reference to a Queue resource.

Returns:



240
241
242
 
# File 'sqs/cfn_queue.rb', line 240

def queue_ref()
  jsii_get_property("queueRef")
end

#receive_message_wait_time_seconds ⇒ Numeric?

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.

Returns:

  • (Numeric, nil) 


398
399
400
 
# File 'sqs/cfn_queue.rb', line 398

def receive_message_wait_time_seconds()
  jsii_get_property("receiveMessageWaitTimeSeconds")
end

#receive_message_wait_time_seconds=(value) ⇒ Object 



402
403
404
405
 
# File 'sqs/cfn_queue.rb', line 402

def receive_message_wait_time_seconds=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "receiveMessageWaitTimeSeconds") unless value.nil?
  jsii_set_property("receiveMessageWaitTimeSeconds", value)
end

#redrive_allow_policy ⇒ Object

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.

Returns:

  • (Object) 


254
255
256
 
# File 'sqs/cfn_queue.rb', line 254

def redrive_allow_policy()
  jsii_get_property("redriveAllowPolicy")
end

#redrive_allow_policy=(value) ⇒ Object 



258
259
260
261
 
# File 'sqs/cfn_queue.rb', line 258

def redrive_allow_policy=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "redriveAllowPolicy")
  jsii_set_property("redriveAllowPolicy", value)
end

#redrive_policy ⇒ Object

The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object.

Returns:

  • (Object) 


266
267
268
 
# File 'sqs/cfn_queue.rb', line 266

def redrive_policy()
  jsii_get_property("redrivePolicy")
end

#redrive_policy=(value) ⇒ Object 



270
271
272
273
 
# File 'sqs/cfn_queue.rb', line 270

def redrive_policy=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "redrivePolicy")
  jsii_set_property("redrivePolicy", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


154
155
156
 
# File 'sqs/cfn_queue.rb', line 154

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



689
690
691
692
 
# File 'sqs/cfn_queue.rb', line 689

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


696
697
698
699
 
# File 'sqs/cfn_queue.rb', line 696

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



706
707
708
709
710
 
# File 'sqs/cfn_queue.rb', line 706

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



715
716
717
 
# File 'sqs/cfn_queue.rb', line 715

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#sqs_managed_sse_enabled ⇒ Boolean, ...

Enables server-side queue encryption using SQS owned encryption keys.

Returns:



410
411
412
 
# File 'sqs/cfn_queue.rb', line 410

def sqs_managed_sse_enabled()
  jsii_get_property("sqsManagedSseEnabled")
end

#sqs_managed_sse_enabled=(value) ⇒ Object 



414
415
416
417
 
# File 'sqs/cfn_queue.rb', line 414

def sqs_managed_sse_enabled=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "sqsManagedSseEnabled") unless value.nil?
  jsii_set_property("sqsManagedSseEnabled", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



144
145
146
 
# File 'sqs/cfn_queue.rb', line 144

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



247
248
249
 
# File 'sqs/cfn_queue.rb', line 247

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags that you attach to this queue.

Returns:



422
423
424
 
# File 'sqs/cfn_queue.rb', line 422

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



426
427
428
429
430
 
# File 'sqs/cfn_queue.rb', line 426

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



447
448
449
 
# File 'sqs/cfn_queue.rb', line 447

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


191
192
193
 
# File 'sqs/cfn_queue.rb', line 191

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


201
202
203
 
# File 'sqs/cfn_queue.rb', line 201

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


721
722
723
724
 
# File 'sqs/cfn_queue.rb', line 721

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#visibility_timeout ⇒ Numeric?

The length of time during which a message will be unavailable after a message is delivered from the queue.

Returns:

  • (Numeric, nil) 


435
436
437
 
# File 'sqs/cfn_queue.rb', line 435

def visibility_timeout()
  jsii_get_property("visibilityTimeout")
end

#visibility_timeout=(value) ⇒ Object 



439
440
441
442
 
# File 'sqs/cfn_queue.rb', line 439

def visibility_timeout=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "visibilityTimeout") unless value.nil?
  jsii_set_property("visibilityTimeout", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


460
461
462
463
464
465
 
# File 'sqs/cfn_queue.rb', line 460

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end