{ "fingerprint": "C2BPubDSJo3yTrtbPWipgbwrRb5eSMYj5Ed7NzS7/oA=", "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "dependencies": { "@aws-cdk/aws-kms": { "dependencies": { "@aws-cdk/aws-iam": { "dependencies": { "@aws-cdk/cdk": { "dependencies": { "@aws-cdk/cx-api": { "targets": { "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "cdk", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "@aws-cdk/cdk" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "iam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.iam" }, "js": { "npm": "@aws-cdk/aws-iam" } }, "version": "0.8.2" }, "@aws-cdk/cdk": { "dependencies": { "@aws-cdk/cx-api": { "targets": { "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "cdk", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "@aws-cdk/cdk" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "kms", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.kms" }, "js": { "npm": "@aws-cdk/aws-kms" } }, "version": "0.8.2" }, "@aws-cdk/aws-s3-notifications": { "dependencies": { "@aws-cdk/cdk": { "dependencies": { "@aws-cdk/cx-api": { "targets": { "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "cdk", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "@aws-cdk/cdk" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "s3-notifications", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3.notifications" }, "js": { "npm": "@aws-cdk/aws-s3-notifications" } }, "version": "0.8.2" }, "@aws-cdk/cdk": { "dependencies": { "@aws-cdk/cx-api": { "targets": { "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "cdk", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "@aws-cdk/cdk" } }, "version": "0.8.2" } }, "description": "CDK Constructs for AWS SQS", "homepage": "https://github.com/awslabs/aws-cdk", "license": "Apache-2.0", "name": "@aws-cdk/aws-sqs", "readme": { "markdown": "## AWS SQS Construct Library\n\nHere's how to add a basic queue to your application:\n\n```ts\nnew Queue(this, 'Queue');\n```\n\n### Encryption\n\nIf you want to encrypt the queue contents, set the `encryption` property. You can have\nthe messages encrypted with a key that SQS manages for you, or a key that you\ncan manage yourself.\n\n```ts\n// Use managed key\nnew Queue(this, 'Queue', {\n encryption: QueueEncryption.Managed,\n});\n\n// Use custom key\nconst myKey = new EncryptionKey(this, 'Key');\n\nnew Queue(this, 'Queue', {\n encryption: QueueEncryption.Kms,\n encryptionMasterKey: myKey\n});\n```\n\n### First-In-First-Out (FIFO) queues\n\nFIFO queues give guarantees on the order in which messages are dequeued, and have additional\nfeatures in order to help guarantee exactly-once processing. For more information, see\nthe SQS manual. Note that FIFO queues are not available in all AWS regions.\n\nA queue can be made a FIFO queue by either setting `fifo: true`, giving it a name which ends\nin `\".fifo\"`, or enabling content-based deduplication (which requires FIFO queues).\n" }, "repository": { "type": "git", "url": "https://github.com/awslabs/aws-cdk.git" }, "schema": "jsii/1.0", "targets": { "java": { "maven": { "artifactId": "sqs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.sqs" }, "js": { "npm": "@aws-cdk/aws-sqs" } }, "types": { "@aws-cdk/aws-sqs.DeadLetterQueue": { "assembly": "@aws-cdk/aws-sqs", "datatype": true, "docs": { "comment": "Dead letter queue settings" }, "fqn": "@aws-cdk/aws-sqs.DeadLetterQueue", "kind": "interface", "name": "DeadLetterQueue", "namespace": "@aws-cdk/aws-sqs", "properties": [ { "docs": { "comment": "The dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded." }, "name": "queue", "type": { "fqn": "@aws-cdk/aws-sqs.QueueRef" } }, { "docs": { "comment": "The number of times a message can be unsuccesfully dequeued before being moved to the dead-letter queue." }, "name": "maxReceiveCount", "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-sqs.Queue": { "assembly": "@aws-cdk/aws-sqs", "base": { "fqn": "@aws-cdk/aws-sqs.QueueRef" }, "docs": { "comment": "A new Amazon SQS queue" }, "fqn": "@aws-cdk/aws-sqs.Queue", "initializer": { "initializer": true, "parameters": [ { "name": "parent", "type": { "fqn": "@aws-cdk/cdk.Construct" } }, { "name": "name", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-sqs.QueueProps", "optional": true } } ] }, "kind": "class", "name": "Queue", "namespace": "@aws-cdk/aws-sqs", "properties": [ { "docs": { "comment": "The ARN of this queue" }, "immutable": true, "name": "queueArn", "type": { "fqn": "@aws-cdk/aws-sqs.QueueArn" } }, { "docs": { "comment": "The name of this queue" }, "immutable": true, "name": "queueName", "type": { "fqn": "@aws-cdk/aws-sqs.QueueName" } }, { "docs": { "comment": "The URL of this queue" }, "immutable": true, "name": "queueUrl", "type": { "fqn": "@aws-cdk/aws-sqs.QueueUrl" } }, { "docs": { "comment": "If this queue is encrypted, this is the KMS key." }, "name": "encryptionMasterKey", "type": { "fqn": "@aws-cdk/aws-kms.EncryptionKeyRef", "optional": true } }, { "docs": { "comment": "Controls automatic creation of policy objects.\n\nSet by subclasses." }, "immutable": true, "name": "autoCreatePolicy", "protected": true, "type": { "primitive": "boolean" } } ] }, "@aws-cdk/aws-sqs.QueueArn": { "assembly": "@aws-cdk/aws-sqs", "base": { "fqn": "@aws-cdk/cdk.Arn" }, "fqn": "@aws-cdk/aws-sqs.QueueArn", "initializer": { "docs": { "comment": "Creates a token that resolves to `value`.\n\nIf value is a function, the function is evaluated upon resolution and\nthe value it returns will be used as the token's value.\n\ndisplayName is used to represent the Token when it's embedded into a string; it\nwill look something like this:\n\n \"embedded in a larger string is ${Token[DISPLAY_NAME.123]}\"\n\nThis value is used as a hint to humans what the meaning of the Token is,\nand does not have any effect on the evaluation.\n\nMust contain only alphanumeric and simple separator characters (_.:-)." }, "initializer": true, "parameters": [ { "docs": { "comment": "What this token will evaluate to, literal or function." }, "name": "valueOrFunction", "type": { "optional": true, "primitive": "any" } }, { "docs": { "comment": "A human-readable display hint for this Token" }, "name": "displayName", "type": { "optional": true, "primitive": "string" } } ] }, "kind": "class", "name": "QueueArn", "namespace": "@aws-cdk/aws-sqs" }, "@aws-cdk/aws-sqs.QueueEncryption": { "assembly": "@aws-cdk/aws-sqs", "docs": { "comment": "What kind of encryption to apply to this queue" }, "fqn": "@aws-cdk/aws-sqs.QueueEncryption", "kind": "enum", "members": [ { "name": "Unencrypted" }, { "name": "KmsManaged" }, { "name": "Kms" } ], "name": "QueueEncryption", "namespace": "@aws-cdk/aws-sqs" }, "@aws-cdk/aws-sqs.QueueName": { "assembly": "@aws-cdk/aws-sqs", "base": { "fqn": "@aws-cdk/cdk.Token" }, "fqn": "@aws-cdk/aws-sqs.QueueName", "initializer": { "docs": { "comment": "Creates a token that resolves to `value`.\n\nIf value is a function, the function is evaluated upon resolution and\nthe value it returns will be used as the token's value.\n\ndisplayName is used to represent the Token when it's embedded into a string; it\nwill look something like this:\n\n \"embedded in a larger string is ${Token[DISPLAY_NAME.123]}\"\n\nThis value is used as a hint to humans what the meaning of the Token is,\nand does not have any effect on the evaluation.\n\nMust contain only alphanumeric and simple separator characters (_.:-)." }, "initializer": true, "parameters": [ { "docs": { "comment": "What this token will evaluate to, literal or function." }, "name": "valueOrFunction", "type": { "optional": true, "primitive": "any" } }, { "docs": { "comment": "A human-readable display hint for this Token" }, "name": "displayName", "type": { "optional": true, "primitive": "string" } } ] }, "kind": "class", "name": "QueueName", "namespace": "@aws-cdk/aws-sqs" }, "@aws-cdk/aws-sqs.QueuePolicy": { "assembly": "@aws-cdk/aws-sqs", "base": { "fqn": "@aws-cdk/cdk.Construct" }, "docs": { "comment": "Applies a policy to SQS queues." }, "fqn": "@aws-cdk/aws-sqs.QueuePolicy", "initializer": { "initializer": true, "parameters": [ { "name": "parent", "type": { "fqn": "@aws-cdk/cdk.Construct" } }, { "name": "name", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-sqs.QueuePolicyProps" } } ] }, "kind": "class", "name": "QueuePolicy", "namespace": "@aws-cdk/aws-sqs", "properties": [ { "docs": { "comment": "The IAM policy document for this policy." }, "immutable": true, "name": "document", "type": { "fqn": "@aws-cdk/cdk.PolicyDocument" } } ] }, "@aws-cdk/aws-sqs.QueuePolicyProps": { "assembly": "@aws-cdk/aws-sqs", "datatype": true, "fqn": "@aws-cdk/aws-sqs.QueuePolicyProps", "kind": "interface", "name": "QueuePolicyProps", "namespace": "@aws-cdk/aws-sqs", "properties": [ { "docs": { "comment": "The set of queues this policy applies to." }, "name": "queues", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-sqs.QueueRef" }, "kind": "array" } } } ] }, "@aws-cdk/aws-sqs.QueueProps": { "assembly": "@aws-cdk/aws-sqs", "datatype": true, "docs": { "comment": "Properties for creating a new Queue" }, "fqn": "@aws-cdk/aws-sqs.QueueProps", "kind": "interface", "name": "QueueProps", "namespace": "@aws-cdk/aws-sqs", "properties": [ { "docs": { "comment": "A name for the queue.\n\nIf specified and this is a FIFO queue, must end in the string '.fifo'.", "default": "CloudFormation-generated name" }, "name": "queueName", "type": { "optional": true, "primitive": "string" } }, { "docs": { "comment": "The number of seconds that Amazon SQS retains a message.\n\nYou can specify an integer value from 60 seconds (1 minute) to 1209600\nseconds (14 days). The default value is 345600 seconds (4 days).", "default": "345600 seconds (4 days)" }, "name": "retentionPeriodSec", "type": { "optional": true, "primitive": "number" } }, { "docs": { "comment": "The time in seconds that the delivery of all messages in the queue is delayed.\n\nYou can specify an integer value of 0 to 900 (15 minutes). The default\nvalue is 0.", "default": "0" }, "name": "deliveryDelaySec", "type": { "optional": true, "primitive": "number" } }, { "docs": { "comment": "The limit of how many bytes that a message can contain before Amazon SQS rejects it.\n\nYou can specify an integer value from 1024 bytes (1 KiB) to 262144 bytes\n(256 KiB). The default value is 262144 (256 KiB).", "default": "256KiB" }, "name": "maxMessageSizeBytes", "type": { "optional": true, "primitive": "number" } }, { "docs": { "comment": "Default wait time for ReceiveMessage calls.\n\nDoes not wait if set to 0, otherwise waits this amount of seconds\nby default for messages to arrive.\n\nFor more information, see Amazon SQS Long Poll.\n\n ", "default": "0" }, "name": "receiveMessageWaitTimeSec", "type": { "optional": true, "primitive": "number" } }, { "docs": { "comment": "Timeout of processing a single message.\n\nAfter dequeuing, the processor has this much time to handle the message\nand delete it from the queue before it becomes visible again for dequeueing\nby another processor.\n\nValues must be from 0 to 43200 seconds (12 hours). If you don't specify\na value, AWS CloudFormation uses the default value of 30 seconds.", "default": "30" }, "name": "visibilityTimeoutSec", "type": { "optional": true, "primitive": "number" } }, { "docs": { "comment": "Send messages to this queue if they were unsuccessfully dequeued a number of times.", "default": "no dead-letter queue" }, "name": "deadLetterQueue", "type": { "fqn": "@aws-cdk/aws-sqs.DeadLetterQueue", "optional": true } }, { "docs": { "comment": "Whether the contents of the queue are encrypted, and by what type of key.\n\nBe aware that encryption is not available in all regions, please see the docs\nfor current availability details.", "default": "Unencrypted" }, "name": "encryption", "type": { "fqn": "@aws-cdk/aws-sqs.QueueEncryption", "optional": true } }, { "docs": { "comment": "External KMS master key to use for queue encryption.\n\nIndividual messages will be encrypted using data keys. The data keys in\nturn will be encrypted using this key, and reused for a maximum of\n`dataKeyReuseSecs` seconds.\n\nThe 'encryption' property must be either not specified or set to \"Kms\".\nAn error will be emitted if encryption is set to \"Unencrypted\" or\n\"KmsManaged\".", "default": "If encryption is set to KMS and not specified, a key will be created." }, "name": "encryptionMasterKey", "type": { "fqn": "@aws-cdk/aws-kms.EncryptionKeyRef", "optional": true } }, { "docs": { "comment": "The length of time that Amazon SQS reuses a data key before calling KMS again.\n\nThe value must be an integer between 60 (1 minute) and 86,400 (24\nhours). The default is 300 (5 minutes).", "default": "300 (5 minutes)" }, "name": "dataKeyReuseSec", "type": { "optional": true, "primitive": "number" } }, { "docs": { "comment": "Whether this a first-in-first-out (FIFO) queue.", "default": "false, unless queueName ends in '.fifo' or 'contentBasedDeduplication' is true." }, "name": "fifo", "type": { "optional": true, "primitive": "boolean" } }, { "docs": { "comment": "Specifies whether to enable content-based deduplication.\n\nDuring the deduplication interval (5 minutes), Amazon SQS treats\nmessages that are sent with identical content (excluding attributes) as\nduplicates and delivers only one copy of the message.\n\nIf you don't enable content-based deduplication and you want to deduplicate\nmessages, provide an explicit deduplication ID in your SendMessage() call.\n\n(Only applies to FIFO queues.)", "default": "false" }, "name": "contentBasedDeduplication", "type": { "optional": true, "primitive": "boolean" } } ] }, "@aws-cdk/aws-sqs.QueueRef": { "abstract": true, "assembly": "@aws-cdk/aws-sqs", "base": { "fqn": "@aws-cdk/cdk.Construct" }, "docs": { "comment": "Reference to a new or existing Amazon SQS queue" }, "fqn": "@aws-cdk/aws-sqs.QueueRef", "initializer": { "docs": { "comment": "Creates a new construct node." }, "initializer": true, "parameters": [ { "docs": { "comment": "The parent construct" }, "name": "parent", "type": { "fqn": "@aws-cdk/cdk.Construct" } }, { "name": "id", "type": { "primitive": "string" } } ] }, "interfaces": [ { "fqn": "@aws-cdk/aws-s3-notifications.IBucketNotificationDestination" } ], "kind": "class", "methods": [ { "docs": { "comment": "Import an existing queue" }, "name": "import", "parameters": [ { "name": "parent", "type": { "fqn": "@aws-cdk/cdk.Construct" } }, { "name": "name", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-sqs.QueueRefProps" } } ], "static": true }, { "docs": { "comment": "Export a queue" }, "name": "export", "returns": { "fqn": "@aws-cdk/aws-sqs.QueueRefProps" } }, { "docs": { "comment": "Adds a statement to the IAM resource policy associated with this queue.\n\nIf this queue was created in this stack (`new Queue`), a queue policy\nwill be automatically created upon the first call to `addToPolicy`. If\nthe queue is improted (`Queue.import`), then this is a no-op." }, "name": "addToResourcePolicy", "parameters": [ { "name": "statement", "type": { "fqn": "@aws-cdk/cdk.PolicyStatement" } } ] }, { "docs": { "comment": "Allows using SQS queues as destinations for bucket notifications.\nUse `bucket.onEvent(event, queue)` to subscribe." }, "name": "asBucketNotificationDestination", "parameters": [ { "docs": { "comment": "The ARN of the notifying bucket." }, "name": "bucketArn", "type": { "fqn": "@aws-cdk/cdk.Arn" } }, { "docs": { "comment": "A unique ID for the notifying bucket." }, "name": "bucketId", "type": { "primitive": "string" } } ], "returns": { "fqn": "@aws-cdk/aws-s3-notifications.BucketNotificationDestinationProps" } } ], "name": "QueueRef", "namespace": "@aws-cdk/aws-sqs", "properties": [ { "abstract": true, "docs": { "comment": "The ARN of this queue" }, "immutable": true, "name": "queueArn", "type": { "fqn": "@aws-cdk/aws-sqs.QueueArn" } }, { "abstract": true, "docs": { "comment": "The URL of this queue" }, "immutable": true, "name": "queueUrl", "type": { "fqn": "@aws-cdk/aws-sqs.QueueUrl" } }, { "abstract": true, "docs": { "comment": "If this queue is server-side encrypted, this is the KMS encryption key." }, "immutable": true, "name": "encryptionMasterKey", "type": { "fqn": "@aws-cdk/aws-kms.EncryptionKeyRef", "optional": true } }, { "abstract": true, "docs": { "comment": "Controls automatic creation of policy objects.\n\nSet by subclasses." }, "immutable": true, "name": "autoCreatePolicy", "protected": true, "type": { "primitive": "boolean" } } ] }, "@aws-cdk/aws-sqs.QueueRefProps": { "assembly": "@aws-cdk/aws-sqs", "datatype": true, "docs": { "comment": "Reference to a queue" }, "fqn": "@aws-cdk/aws-sqs.QueueRefProps", "kind": "interface", "name": "QueueRefProps", "namespace": "@aws-cdk/aws-sqs", "properties": [ { "docs": { "comment": "The ARN of the queue." }, "name": "queueArn", "type": { "fqn": "@aws-cdk/aws-sqs.QueueArn" } }, { "docs": { "comment": "The URL of the queue." }, "name": "queueUrl", "type": { "fqn": "@aws-cdk/aws-sqs.QueueUrl" } }, { "docs": { "comment": "KMS encryption key, if this queue is server-side encrypted by a KMS key." }, "name": "keyArn", "type": { "fqn": "@aws-cdk/aws-kms.KeyArn", "optional": true } } ] }, "@aws-cdk/aws-sqs.QueueUrl": { "assembly": "@aws-cdk/aws-sqs", "base": { "fqn": "@aws-cdk/cdk.Token" }, "docs": { "comment": "URL of a queue" }, "fqn": "@aws-cdk/aws-sqs.QueueUrl", "initializer": { "docs": { "comment": "Creates a token that resolves to `value`.\n\nIf value is a function, the function is evaluated upon resolution and\nthe value it returns will be used as the token's value.\n\ndisplayName is used to represent the Token when it's embedded into a string; it\nwill look something like this:\n\n \"embedded in a larger string is ${Token[DISPLAY_NAME.123]}\"\n\nThis value is used as a hint to humans what the meaning of the Token is,\nand does not have any effect on the evaluation.\n\nMust contain only alphanumeric and simple separator characters (_.:-)." }, "initializer": true, "parameters": [ { "docs": { "comment": "What this token will evaluate to, literal or function." }, "name": "valueOrFunction", "type": { "optional": true, "primitive": "any" } }, { "docs": { "comment": "A human-readable display hint for this Token" }, "name": "displayName", "type": { "optional": true, "primitive": "string" } } ] }, "kind": "class", "name": "QueueUrl", "namespace": "@aws-cdk/aws-sqs" }, "@aws-cdk/aws-sqs.cloudformation.QueuePolicyResource": { "assembly": "@aws-cdk/aws-sqs", "base": { "fqn": "@aws-cdk/cdk.Resource" }, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html" }, "fqn": "@aws-cdk/aws-sqs.cloudformation.QueuePolicyResource", "initializer": { "docs": { "comment": "Creates a new ``AWS::SQS::QueuePolicy``." }, "initializer": true, "parameters": [ { "docs": { "comment": "the ``cdk.Construct`` this ``QueuePolicyResource`` is a part of" }, "name": "parent", "type": { "fqn": "@aws-cdk/cdk.Construct" } }, { "docs": { "comment": "the name of the resource in the ``cdk.Construct`` tree" }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "comment": "the properties of this ``QueuePolicyResource``" }, "name": "properties", "type": { "fqn": "@aws-cdk/aws-sqs.cloudformation.QueuePolicyResourceProps" } } ] }, "kind": "class", "methods": [ { "name": "renderProperties", "protected": true, "returns": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "name": "QueuePolicyResource", "namespace": "@aws-cdk/aws-sqs.cloudformation", "properties": [ { "const": true, "docs": { "comment": "The CloudFormation resource type name for this resource class." }, "immutable": true, "name": "resourceTypeName", "static": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-sqs.cloudformation.QueuePolicyResourceProps": { "assembly": "@aws-cdk/aws-sqs", "datatype": true, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html" }, "fqn": "@aws-cdk/aws-sqs.cloudformation.QueuePolicyResourceProps", "kind": "interface", "name": "QueuePolicyResourceProps", "namespace": "@aws-cdk/aws-sqs.cloudformation", "properties": [ { "docs": { "comment": "``AWS::SQS::QueuePolicy.PolicyDocument``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html#cfn-sqs-queuepolicy-policydoc" }, "name": "policyDocument", "type": { "union": { "types": [ { "primitive": "json" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``AWS::SQS::QueuePolicy.Queues``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html#cfn-sqs-queuepolicy-queues" }, "name": "queues", "type": { "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "collection": { "elementtype": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } }, "kind": "array" } } ] } } } ] }, "@aws-cdk/aws-sqs.cloudformation.QueueResource": { "assembly": "@aws-cdk/aws-sqs", "base": { "fqn": "@aws-cdk/cdk.Resource" }, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html" }, "fqn": "@aws-cdk/aws-sqs.cloudformation.QueueResource", "initializer": { "docs": { "comment": "Creates a new ``AWS::SQS::Queue``." }, "initializer": true, "parameters": [ { "docs": { "comment": "the ``cdk.Construct`` this ``QueueResource`` is a part of" }, "name": "parent", "type": { "fqn": "@aws-cdk/cdk.Construct" } }, { "docs": { "comment": "the name of the resource in the ``cdk.Construct`` tree" }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "comment": "the properties of this ``QueueResource``" }, "name": "properties", "type": { "fqn": "@aws-cdk/aws-sqs.cloudformation.QueueResourceProps", "optional": true } } ] }, "kind": "class", "methods": [ { "name": "renderProperties", "protected": true, "returns": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "name": "QueueResource", "namespace": "@aws-cdk/aws-sqs.cloudformation", "properties": [ { "const": true, "docs": { "comment": "The CloudFormation resource type name for this resource class." }, "immutable": true, "name": "resourceTypeName", "static": true, "type": { "primitive": "string" } }, { "docs": { "cloudformation_attribute": "Arn" }, "immutable": true, "name": "queueArn", "type": { "fqn": "@aws-cdk/aws-sqs.QueueArn" } }, { "docs": { "cloudformation_attribute": "QueueName" }, "immutable": true, "name": "queueName", "type": { "fqn": "@aws-cdk/aws-sqs.QueueName" } } ] }, "@aws-cdk/aws-sqs.cloudformation.QueueResourceProps": { "assembly": "@aws-cdk/aws-sqs", "datatype": true, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html" }, "fqn": "@aws-cdk/aws-sqs.cloudformation.QueueResourceProps", "kind": "interface", "name": "QueueResourceProps", "namespace": "@aws-cdk/aws-sqs.cloudformation", "properties": [ { "docs": { "comment": "``AWS::SQS::Queue.ContentBasedDeduplication``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-contentbaseddeduplication" }, "name": "contentBasedDeduplication", "type": { "optional": true, "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``AWS::SQS::Queue.DelaySeconds``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-delayseconds" }, "name": "delaySeconds", "type": { "optional": true, "union": { "types": [ { "primitive": "number" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``AWS::SQS::Queue.FifoQueue``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-fifoqueue" }, "name": "fifoQueue", "type": { "optional": true, "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``AWS::SQS::Queue.KmsDataKeyReusePeriodSeconds``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-kmsdatakeyreuseperiodseconds" }, "name": "kmsDataKeyReusePeriodSeconds", "type": { "optional": true, "union": { "types": [ { "primitive": "number" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``AWS::SQS::Queue.KmsMasterKeyId``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-kmsmasterkeyid" }, "name": "kmsMasterKeyId", "type": { "optional": true, "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``AWS::SQS::Queue.MaximumMessageSize``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-maxmesgsize" }, "name": "maximumMessageSize", "type": { "optional": true, "union": { "types": [ { "primitive": "number" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``AWS::SQS::Queue.MessageRetentionPeriod``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-msgretentionperiod" }, "name": "messageRetentionPeriod", "type": { "optional": true, "union": { "types": [ { "primitive": "number" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``AWS::SQS::Queue.QueueName``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-name" }, "name": "queueName", "type": { "optional": true, "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``AWS::SQS::Queue.ReceiveMessageWaitTimeSeconds``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-receivemsgwaittime" }, "name": "receiveMessageWaitTimeSeconds", "type": { "optional": true, "union": { "types": [ { "primitive": "number" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``AWS::SQS::Queue.RedrivePolicy``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-redrive" }, "name": "redrivePolicy", "type": { "optional": true, "union": { "types": [ { "primitive": "json" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``AWS::SQS::Queue.VisibilityTimeout``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-visiblitytimeout" }, "name": "visibilityTimeout", "type": { "optional": true, "union": { "types": [ { "primitive": "number" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } } ] } }, "version": "0.8.2" }