Functions that represent AWS CDK enums and builders in the software.amazon.awscdk.services.sqs package.
Functions that represent AWS CDK enums and builders in the software.amazon.awscdk.services.sqs package.
(build-cfn-queue-builder builder id config)
The build-cfn-queue-builder function updates a CfnQueue$Builder instance using the provided configuration. The function takes the CfnQueue$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
contentBasedDeduplication | java.lang.Boolean | cdk.support/lookup-entry | :content-based-deduplication |
deduplicationScope | java.lang.String | cdk.support/lookup-entry | :deduplication-scope |
delaySeconds | java.lang.Number | cdk.support/lookup-entry | :delay-seconds |
fifoQueue | java.lang.Boolean | cdk.support/lookup-entry | :fifo-queue |
fifoThroughputLimit | java.lang.String | cdk.support/lookup-entry | :fifo-throughput-limit |
kmsDataKeyReusePeriodSeconds | java.lang.Number | cdk.support/lookup-entry | :kms-data-key-reuse-period-seconds |
kmsMasterKeyId | java.lang.String | cdk.support/lookup-entry | :kms-master-key-id |
maximumMessageSize | java.lang.Number | cdk.support/lookup-entry | :maximum-message-size |
messageRetentionPeriod | java.lang.Number | cdk.support/lookup-entry | :message-retention-period |
queueName | java.lang.String | cdk.support/lookup-entry | :queue-name |
receiveMessageWaitTimeSeconds | java.lang.Number | cdk.support/lookup-entry | :receive-message-wait-time-seconds |
redriveAllowPolicy | java.lang.Object | cdk.support/lookup-entry | :redrive-allow-policy |
redrivePolicy | java.lang.Object | cdk.support/lookup-entry | :redrive-policy |
sqsManagedSseEnabled | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :sqs-managed-sse-enabled |
tags | java.util.List | cdk.support/lookup-entry | :tags |
visibilityTimeout | java.lang.Number | cdk.support/lookup-entry | :visibility-timeout |
The build-cfn-queue-builder function updates a CfnQueue$Builder instance using the provided configuration. The function takes the CfnQueue$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `contentBasedDeduplication` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:content-based-deduplication` | | `deduplicationScope` | java.lang.String | [[cdk.support/lookup-entry]] | `:deduplication-scope` | | `delaySeconds` | java.lang.Number | [[cdk.support/lookup-entry]] | `:delay-seconds` | | `fifoQueue` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:fifo-queue` | | `fifoThroughputLimit` | java.lang.String | [[cdk.support/lookup-entry]] | `:fifo-throughput-limit` | | `kmsDataKeyReusePeriodSeconds` | java.lang.Number | [[cdk.support/lookup-entry]] | `:kms-data-key-reuse-period-seconds` | | `kmsMasterKeyId` | java.lang.String | [[cdk.support/lookup-entry]] | `:kms-master-key-id` | | `maximumMessageSize` | java.lang.Number | [[cdk.support/lookup-entry]] | `:maximum-message-size` | | `messageRetentionPeriod` | java.lang.Number | [[cdk.support/lookup-entry]] | `:message-retention-period` | | `queueName` | java.lang.String | [[cdk.support/lookup-entry]] | `:queue-name` | | `receiveMessageWaitTimeSeconds` | java.lang.Number | [[cdk.support/lookup-entry]] | `:receive-message-wait-time-seconds` | | `redriveAllowPolicy` | java.lang.Object | [[cdk.support/lookup-entry]] | `:redrive-allow-policy` | | `redrivePolicy` | java.lang.Object | [[cdk.support/lookup-entry]] | `:redrive-policy` | | `sqsManagedSseEnabled` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:sqs-managed-sse-enabled` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` | | `visibilityTimeout` | java.lang.Number | [[cdk.support/lookup-entry]] | `:visibility-timeout` |
(build-cfn-queue-inline-policy-builder builder id config)
The build-cfn-queue-inline-policy-builder function updates a CfnQueueInlinePolicy$Builder instance using the provided configuration. The function takes the CfnQueueInlinePolicy$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
policyDocument | java.lang.Object | cdk.support/lookup-entry | :policy-document |
queue | java.lang.String | cdk.support/lookup-entry | :queue |
The build-cfn-queue-inline-policy-builder function updates a CfnQueueInlinePolicy$Builder instance using the provided configuration. The function takes the CfnQueueInlinePolicy$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `policyDocument` | java.lang.Object | [[cdk.support/lookup-entry]] | `:policy-document` | | `queue` | java.lang.String | [[cdk.support/lookup-entry]] | `:queue` |
(build-cfn-queue-inline-policy-props-builder builder id config)
The build-cfn-queue-inline-policy-props-builder function updates a CfnQueueInlinePolicyProps$Builder instance using the provided configuration. The function takes the CfnQueueInlinePolicyProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
policyDocument | java.lang.Object | cdk.support/lookup-entry | :policy-document |
queue | java.lang.String | cdk.support/lookup-entry | :queue |
The build-cfn-queue-inline-policy-props-builder function updates a CfnQueueInlinePolicyProps$Builder instance using the provided configuration. The function takes the CfnQueueInlinePolicyProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `policyDocument` | java.lang.Object | [[cdk.support/lookup-entry]] | `:policy-document` | | `queue` | java.lang.String | [[cdk.support/lookup-entry]] | `:queue` |
(build-cfn-queue-policy-builder builder id config)
The build-cfn-queue-policy-builder function updates a CfnQueuePolicy$Builder instance using the provided configuration. The function takes the CfnQueuePolicy$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
policyDocument | java.lang.Object | cdk.support/lookup-entry | :policy-document |
queues | java.util.List | cdk.support/lookup-entry | :queues |
The build-cfn-queue-policy-builder function updates a CfnQueuePolicy$Builder instance using the provided configuration. The function takes the CfnQueuePolicy$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `policyDocument` | java.lang.Object | [[cdk.support/lookup-entry]] | `:policy-document` | | `queues` | java.util.List | [[cdk.support/lookup-entry]] | `:queues` |
(build-cfn-queue-policy-props-builder builder id config)
The build-cfn-queue-policy-props-builder function updates a CfnQueuePolicyProps$Builder instance using the provided configuration. The function takes the CfnQueuePolicyProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
policyDocument | java.lang.Object | cdk.support/lookup-entry | :policy-document |
queues | java.util.List | cdk.support/lookup-entry | :queues |
The build-cfn-queue-policy-props-builder function updates a CfnQueuePolicyProps$Builder instance using the provided configuration. The function takes the CfnQueuePolicyProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `policyDocument` | java.lang.Object | [[cdk.support/lookup-entry]] | `:policy-document` | | `queues` | java.util.List | [[cdk.support/lookup-entry]] | `:queues` |
(build-cfn-queue-props-builder builder id config)
The build-cfn-queue-props-builder function updates a CfnQueueProps$Builder instance using the provided configuration. The function takes the CfnQueueProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
contentBasedDeduplication | java.lang.Boolean | cdk.support/lookup-entry | :content-based-deduplication |
deduplicationScope | java.lang.String | cdk.support/lookup-entry | :deduplication-scope |
delaySeconds | java.lang.Number | cdk.support/lookup-entry | :delay-seconds |
fifoQueue | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :fifo-queue |
fifoThroughputLimit | java.lang.String | cdk.support/lookup-entry | :fifo-throughput-limit |
kmsDataKeyReusePeriodSeconds | java.lang.Number | cdk.support/lookup-entry | :kms-data-key-reuse-period-seconds |
kmsMasterKeyId | java.lang.String | cdk.support/lookup-entry | :kms-master-key-id |
maximumMessageSize | java.lang.Number | cdk.support/lookup-entry | :maximum-message-size |
messageRetentionPeriod | java.lang.Number | cdk.support/lookup-entry | :message-retention-period |
queueName | java.lang.String | cdk.support/lookup-entry | :queue-name |
receiveMessageWaitTimeSeconds | java.lang.Number | cdk.support/lookup-entry | :receive-message-wait-time-seconds |
redriveAllowPolicy | java.lang.Object | cdk.support/lookup-entry | :redrive-allow-policy |
redrivePolicy | java.lang.Object | cdk.support/lookup-entry | :redrive-policy |
sqsManagedSseEnabled | java.lang.Boolean | cdk.support/lookup-entry | :sqs-managed-sse-enabled |
tags | java.util.List | cdk.support/lookup-entry | :tags |
visibilityTimeout | java.lang.Number | cdk.support/lookup-entry | :visibility-timeout |
The build-cfn-queue-props-builder function updates a CfnQueueProps$Builder instance using the provided configuration. The function takes the CfnQueueProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `contentBasedDeduplication` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:content-based-deduplication` | | `deduplicationScope` | java.lang.String | [[cdk.support/lookup-entry]] | `:deduplication-scope` | | `delaySeconds` | java.lang.Number | [[cdk.support/lookup-entry]] | `:delay-seconds` | | `fifoQueue` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:fifo-queue` | | `fifoThroughputLimit` | java.lang.String | [[cdk.support/lookup-entry]] | `:fifo-throughput-limit` | | `kmsDataKeyReusePeriodSeconds` | java.lang.Number | [[cdk.support/lookup-entry]] | `:kms-data-key-reuse-period-seconds` | | `kmsMasterKeyId` | java.lang.String | [[cdk.support/lookup-entry]] | `:kms-master-key-id` | | `maximumMessageSize` | java.lang.Number | [[cdk.support/lookup-entry]] | `:maximum-message-size` | | `messageRetentionPeriod` | java.lang.Number | [[cdk.support/lookup-entry]] | `:message-retention-period` | | `queueName` | java.lang.String | [[cdk.support/lookup-entry]] | `:queue-name` | | `receiveMessageWaitTimeSeconds` | java.lang.Number | [[cdk.support/lookup-entry]] | `:receive-message-wait-time-seconds` | | `redriveAllowPolicy` | java.lang.Object | [[cdk.support/lookup-entry]] | `:redrive-allow-policy` | | `redrivePolicy` | java.lang.Object | [[cdk.support/lookup-entry]] | `:redrive-policy` | | `sqsManagedSseEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:sqs-managed-sse-enabled` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` | | `visibilityTimeout` | java.lang.Number | [[cdk.support/lookup-entry]] | `:visibility-timeout` |
(build-dead-letter-queue-builder builder id config)
The build-dead-letter-queue-builder function updates a DeadLetterQueue$Builder instance using the provided configuration. The function takes the DeadLetterQueue$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
maxReceiveCount | java.lang.Number | cdk.support/lookup-entry | :max-receive-count |
queue | software.amazon.awscdk.services.sqs.IQueue | cdk.support/lookup-entry | :queue |
The build-dead-letter-queue-builder function updates a DeadLetterQueue$Builder instance using the provided configuration. The function takes the DeadLetterQueue$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `maxReceiveCount` | java.lang.Number | [[cdk.support/lookup-entry]] | `:max-receive-count` | | `queue` | software.amazon.awscdk.services.sqs.IQueue | [[cdk.support/lookup-entry]] | `:queue` |
(build-queue-attributes-builder builder id config)
The build-queue-attributes-builder function updates a QueueAttributes$Builder instance using the provided configuration. The function takes the QueueAttributes$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
fifo | java.lang.Boolean | cdk.support/lookup-entry | :fifo |
keyArn | java.lang.String | cdk.support/lookup-entry | :key-arn |
queueArn | java.lang.String | cdk.support/lookup-entry | :queue-arn |
queueName | java.lang.String | cdk.support/lookup-entry | :queue-name |
queueUrl | java.lang.String | cdk.support/lookup-entry | :queue-url |
The build-queue-attributes-builder function updates a QueueAttributes$Builder instance using the provided configuration. The function takes the QueueAttributes$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `fifo` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:fifo` | | `keyArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:key-arn` | | `queueArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:queue-arn` | | `queueName` | java.lang.String | [[cdk.support/lookup-entry]] | `:queue-name` | | `queueUrl` | java.lang.String | [[cdk.support/lookup-entry]] | `:queue-url` |
(build-queue-builder builder id config)
The build-queue-builder function updates a Queue$Builder instance using the provided configuration. The function takes the Queue$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
contentBasedDeduplication | java.lang.Boolean | cdk.support/lookup-entry | :content-based-deduplication |
dataKeyReuse | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :data-key-reuse |
deadLetterQueue | software.amazon.awscdk.services.sqs.DeadLetterQueue | cdk.support/lookup-entry | :dead-letter-queue |
deduplicationScope | software.amazon.awscdk.services.sqs.DeduplicationScope | cdk.api.services.sqs/deduplication-scope | :deduplication-scope |
deliveryDelay | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :delivery-delay |
encryption | software.amazon.awscdk.services.sqs.QueueEncryption | cdk.api.services.sqs/queue-encryption | :encryption |
encryptionMasterKey | software.amazon.awscdk.services.kms.IKey | cdk.support/lookup-entry | :encryption-master-key |
enforceSsl | java.lang.Boolean | cdk.support/lookup-entry | :enforce-ssl |
fifo | java.lang.Boolean | cdk.support/lookup-entry | :fifo |
fifoThroughputLimit | software.amazon.awscdk.services.sqs.FifoThroughputLimit | cdk.api.services.sqs/fifo-throughput-limit | :fifo-throughput-limit |
maxMessageSizeBytes | java.lang.Number | cdk.support/lookup-entry | :max-message-size-bytes |
queueName | java.lang.String | cdk.support/lookup-entry | :queue-name |
receiveMessageWaitTime | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :receive-message-wait-time |
redriveAllowPolicy | software.amazon.awscdk.services.sqs.RedriveAllowPolicy | cdk.support/lookup-entry | :redrive-allow-policy |
removalPolicy | software.amazon.awscdk.RemovalPolicy | cdk.api/removal-policy | :removal-policy |
retentionPeriod | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :retention-period |
visibilityTimeout | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :visibility-timeout |
The build-queue-builder function updates a Queue$Builder instance using the provided configuration. The function takes the Queue$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `contentBasedDeduplication` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:content-based-deduplication` | | `dataKeyReuse` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:data-key-reuse` | | `deadLetterQueue` | software.amazon.awscdk.services.sqs.DeadLetterQueue | [[cdk.support/lookup-entry]] | `:dead-letter-queue` | | `deduplicationScope` | software.amazon.awscdk.services.sqs.DeduplicationScope | [[cdk.api.services.sqs/deduplication-scope]] | `:deduplication-scope` | | `deliveryDelay` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:delivery-delay` | | `encryption` | software.amazon.awscdk.services.sqs.QueueEncryption | [[cdk.api.services.sqs/queue-encryption]] | `:encryption` | | `encryptionMasterKey` | software.amazon.awscdk.services.kms.IKey | [[cdk.support/lookup-entry]] | `:encryption-master-key` | | `enforceSsl` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:enforce-ssl` | | `fifo` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:fifo` | | `fifoThroughputLimit` | software.amazon.awscdk.services.sqs.FifoThroughputLimit | [[cdk.api.services.sqs/fifo-throughput-limit]] | `:fifo-throughput-limit` | | `maxMessageSizeBytes` | java.lang.Number | [[cdk.support/lookup-entry]] | `:max-message-size-bytes` | | `queueName` | java.lang.String | [[cdk.support/lookup-entry]] | `:queue-name` | | `receiveMessageWaitTime` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:receive-message-wait-time` | | `redriveAllowPolicy` | software.amazon.awscdk.services.sqs.RedriveAllowPolicy | [[cdk.support/lookup-entry]] | `:redrive-allow-policy` | | `removalPolicy` | software.amazon.awscdk.RemovalPolicy | [[cdk.api/removal-policy]] | `:removal-policy` | | `retentionPeriod` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:retention-period` | | `visibilityTimeout` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:visibility-timeout` |
(build-queue-policy-builder builder id config)
The build-queue-policy-builder function updates a QueuePolicy$Builder instance using the provided configuration. The function takes the QueuePolicy$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
queues | java.util.List | cdk.support/lookup-entry | :queues |
The build-queue-policy-builder function updates a QueuePolicy$Builder instance using the provided configuration. The function takes the QueuePolicy$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `queues` | java.util.List | [[cdk.support/lookup-entry]] | `:queues` |
(build-queue-policy-props-builder builder id config)
The build-queue-policy-props-builder function updates a QueuePolicyProps$Builder instance using the provided configuration. The function takes the QueuePolicyProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
queues | java.util.List | cdk.support/lookup-entry | :queues |
The build-queue-policy-props-builder function updates a QueuePolicyProps$Builder instance using the provided configuration. The function takes the QueuePolicyProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `queues` | java.util.List | [[cdk.support/lookup-entry]] | `:queues` |
(build-queue-props-builder builder id config)
The build-queue-props-builder function updates a QueueProps$Builder instance using the provided configuration. The function takes the QueueProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
contentBasedDeduplication | java.lang.Boolean | cdk.support/lookup-entry | :content-based-deduplication |
dataKeyReuse | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :data-key-reuse |
deadLetterQueue | software.amazon.awscdk.services.sqs.DeadLetterQueue | cdk.support/lookup-entry | :dead-letter-queue |
deduplicationScope | software.amazon.awscdk.services.sqs.DeduplicationScope | cdk.api.services.sqs/deduplication-scope | :deduplication-scope |
deliveryDelay | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :delivery-delay |
encryption | software.amazon.awscdk.services.sqs.QueueEncryption | cdk.api.services.sqs/queue-encryption | :encryption |
encryptionMasterKey | software.amazon.awscdk.services.kms.IKey | cdk.support/lookup-entry | :encryption-master-key |
enforceSsl | java.lang.Boolean | cdk.support/lookup-entry | :enforce-ssl |
fifo | java.lang.Boolean | cdk.support/lookup-entry | :fifo |
fifoThroughputLimit | software.amazon.awscdk.services.sqs.FifoThroughputLimit | cdk.api.services.sqs/fifo-throughput-limit | :fifo-throughput-limit |
maxMessageSizeBytes | java.lang.Number | cdk.support/lookup-entry | :max-message-size-bytes |
queueName | java.lang.String | cdk.support/lookup-entry | :queue-name |
receiveMessageWaitTime | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :receive-message-wait-time |
redriveAllowPolicy | software.amazon.awscdk.services.sqs.RedriveAllowPolicy | cdk.support/lookup-entry | :redrive-allow-policy |
removalPolicy | software.amazon.awscdk.RemovalPolicy | cdk.api/removal-policy | :removal-policy |
retentionPeriod | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :retention-period |
visibilityTimeout | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :visibility-timeout |
The build-queue-props-builder function updates a QueueProps$Builder instance using the provided configuration. The function takes the QueueProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `contentBasedDeduplication` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:content-based-deduplication` | | `dataKeyReuse` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:data-key-reuse` | | `deadLetterQueue` | software.amazon.awscdk.services.sqs.DeadLetterQueue | [[cdk.support/lookup-entry]] | `:dead-letter-queue` | | `deduplicationScope` | software.amazon.awscdk.services.sqs.DeduplicationScope | [[cdk.api.services.sqs/deduplication-scope]] | `:deduplication-scope` | | `deliveryDelay` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:delivery-delay` | | `encryption` | software.amazon.awscdk.services.sqs.QueueEncryption | [[cdk.api.services.sqs/queue-encryption]] | `:encryption` | | `encryptionMasterKey` | software.amazon.awscdk.services.kms.IKey | [[cdk.support/lookup-entry]] | `:encryption-master-key` | | `enforceSsl` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:enforce-ssl` | | `fifo` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:fifo` | | `fifoThroughputLimit` | software.amazon.awscdk.services.sqs.FifoThroughputLimit | [[cdk.api.services.sqs/fifo-throughput-limit]] | `:fifo-throughput-limit` | | `maxMessageSizeBytes` | java.lang.Number | [[cdk.support/lookup-entry]] | `:max-message-size-bytes` | | `queueName` | java.lang.String | [[cdk.support/lookup-entry]] | `:queue-name` | | `receiveMessageWaitTime` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:receive-message-wait-time` | | `redriveAllowPolicy` | software.amazon.awscdk.services.sqs.RedriveAllowPolicy | [[cdk.support/lookup-entry]] | `:redrive-allow-policy` | | `removalPolicy` | software.amazon.awscdk.RemovalPolicy | [[cdk.api/removal-policy]] | `:removal-policy` | | `retentionPeriod` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:retention-period` | | `visibilityTimeout` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:visibility-timeout` |
(build-redrive-allow-policy-builder builder id config)
The build-redrive-allow-policy-builder function updates a RedriveAllowPolicy$Builder instance using the provided configuration. The function takes the RedriveAllowPolicy$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
redrivePermission | software.amazon.awscdk.services.sqs.RedrivePermission | cdk.api.services.sqs/redrive-permission | :redrive-permission |
sourceQueues | java.util.List | cdk.support/lookup-entry | :source-queues |
The build-redrive-allow-policy-builder function updates a RedriveAllowPolicy$Builder instance using the provided configuration. The function takes the RedriveAllowPolicy$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `redrivePermission` | software.amazon.awscdk.services.sqs.RedrivePermission | [[cdk.api.services.sqs/redrive-permission]] | `:redrive-permission` | | `sourceQueues` | java.util.List | [[cdk.support/lookup-entry]] | `:source-queues` |
(cfn-queue-builder scope id config)
Creates a CfnQueue$Builder
instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments:
| Argument | DataType | Description |
|---|---|---|
| scope | software.constructs.Construct | The parent scope construct of the object being built. |
| id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. |
| config | map | Data configuration |
Creates a `CfnQueue$Builder` instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | scope | software.constructs.Construct | The parent scope construct of the object being built. | | id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. | | config | map | Data configuration |
(cfn-queue-inline-policy-builder scope id config)
Creates a CfnQueueInlinePolicy$Builder
instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments:
| Argument | DataType | Description |
|---|---|---|
| scope | software.constructs.Construct | The parent scope construct of the object being built. |
| id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. |
| config | map | Data configuration |
Creates a `CfnQueueInlinePolicy$Builder` instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | scope | software.constructs.Construct | The parent scope construct of the object being built. | | id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. | | config | map | Data configuration |
(cfn-queue-inline-policy-props-builder id config)
Creates a CfnQueueInlinePolicyProps$Builder
instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments:
Argument | DataType | Description |
---|---|---|
id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. |
config | map | Data configuration |
Creates a `CfnQueueInlinePolicyProps$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
(cfn-queue-policy-builder scope id config)
Creates a CfnQueuePolicy$Builder
instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments:
| Argument | DataType | Description |
|---|---|---|
| scope | software.constructs.Construct | The parent scope construct of the object being built. |
| id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. |
| config | map | Data configuration |
Creates a `CfnQueuePolicy$Builder` instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | scope | software.constructs.Construct | The parent scope construct of the object being built. | | id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. | | config | map | Data configuration |
(cfn-queue-policy-props-builder id config)
Creates a CfnQueuePolicyProps$Builder
instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments:
Argument | DataType | Description |
---|---|---|
id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. |
config | map | Data configuration |
Creates a `CfnQueuePolicyProps$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
(cfn-queue-props-builder id config)
Creates a CfnQueueProps$Builder
instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments:
Argument | DataType | Description |
---|---|---|
id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. |
config | map | Data configuration |
Creates a `CfnQueueProps$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
(dead-letter-queue-builder id config)
Creates a DeadLetterQueue$Builder
instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments:
Argument | DataType | Description |
---|---|---|
id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. |
config | map | Data configuration |
Creates a `DeadLetterQueue$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
(deduplication-scope config id item-key)
The deduplication-scope
function data interprets values in the provided config data into a
DeduplicationScope
instance. This simplifies the use of keywords in place of actual enum values in
the configuration provided to builders. The value is found using the cdk.support/lookup-entry
function on the data with the provided namespace id and item-key. The found value is interpretted as follows:
DeduplicationScope
- the value is returned.:message-group
- DeduplicationScope/MESSAGE_GROUP
is returned:queue
- DeduplicationScope/QUEUE
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `deduplication-scope` function data interprets values in the provided config data into a `DeduplicationScope` instance. This simplifies the use of keywords in place of actual enum values in the configuration provided to builders. The value is found using the `cdk.support/lookup-entry` function on the data with the provided namespace id and item-key. The found value is interpretted as follows: * instance of `DeduplicationScope` - the value is returned. * is `:message-group` - `DeduplicationScope/MESSAGE_GROUP` is returned * is `:queue` - `DeduplicationScope/QUEUE` is returned If a value is not found or matches the above criteria, nil is returned.
(fifo-throughput-limit config id item-key)
The fifo-throughput-limit
function data interprets values in the provided config data into a
FifoThroughputLimit
instance. This simplifies the use of keywords in place of actual enum values in
the configuration provided to builders. The value is found using the cdk.support/lookup-entry
function on the data with the provided namespace id and item-key. The found value is interpretted as follows:
FifoThroughputLimit
- the value is returned.:per-queue
- FifoThroughputLimit/PER_QUEUE
is returned:per-message-group-id
- FifoThroughputLimit/PER_MESSAGE_GROUP_ID
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `fifo-throughput-limit` function data interprets values in the provided config data into a `FifoThroughputLimit` instance. This simplifies the use of keywords in place of actual enum values in the configuration provided to builders. The value is found using the `cdk.support/lookup-entry` function on the data with the provided namespace id and item-key. The found value is interpretted as follows: * instance of `FifoThroughputLimit` - the value is returned. * is `:per-queue` - `FifoThroughputLimit/PER_QUEUE` is returned * is `:per-message-group-id` - `FifoThroughputLimit/PER_MESSAGE_GROUP_ID` is returned If a value is not found or matches the above criteria, nil is returned.
(queue-attributes-builder id config)
Creates a QueueAttributes$Builder
instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments:
Argument | DataType | Description |
---|---|---|
id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. |
config | map | Data configuration |
Creates a `QueueAttributes$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
(queue-builder scope id config)
Creates a Queue$Builder
instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments:
| Argument | DataType | Description |
|---|---|---|
| scope | software.constructs.Construct | The parent scope construct of the object being built. |
| id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. |
| config | map | Data configuration |
Creates a `Queue$Builder` instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | scope | software.constructs.Construct | The parent scope construct of the object being built. | | id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. | | config | map | Data configuration |
(queue-encryption config id item-key)
The queue-encryption
function data interprets values in the provided config data into a
QueueEncryption
instance. This simplifies the use of keywords in place of actual enum values in
the configuration provided to builders. The value is found using the cdk.support/lookup-entry
function on the data with the provided namespace id and item-key. The found value is interpretted as follows:
QueueEncryption
- the value is returned.:unencrypted
- QueueEncryption/UNENCRYPTED
is returned:kms
- QueueEncryption/KMS
is returned:sqs-managed
- QueueEncryption/SQS_MANAGED
is returned:kms-managed
- QueueEncryption/KMS_MANAGED
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `queue-encryption` function data interprets values in the provided config data into a `QueueEncryption` instance. This simplifies the use of keywords in place of actual enum values in the configuration provided to builders. The value is found using the `cdk.support/lookup-entry` function on the data with the provided namespace id and item-key. The found value is interpretted as follows: * instance of `QueueEncryption` - the value is returned. * is `:unencrypted` - `QueueEncryption/UNENCRYPTED` is returned * is `:kms` - `QueueEncryption/KMS` is returned * is `:sqs-managed` - `QueueEncryption/SQS_MANAGED` is returned * is `:kms-managed` - `QueueEncryption/KMS_MANAGED` is returned If a value is not found or matches the above criteria, nil is returned.
(queue-policy-builder scope id config)
Creates a QueuePolicy$Builder
instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments:
| Argument | DataType | Description |
|---|---|---|
| scope | software.constructs.Construct | The parent scope construct of the object being built. |
| id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. |
| config | map | Data configuration |
Creates a `QueuePolicy$Builder` instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | scope | software.constructs.Construct | The parent scope construct of the object being built. | | id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. | | config | map | Data configuration |
(queue-policy-props-builder id config)
Creates a QueuePolicyProps$Builder
instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments:
Argument | DataType | Description |
---|---|---|
id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. |
config | map | Data configuration |
Creates a `QueuePolicyProps$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
(queue-props-builder id config)
Creates a QueueProps$Builder
instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments:
Argument | DataType | Description |
---|---|---|
id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. |
config | map | Data configuration |
Creates a `QueueProps$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
(redrive-allow-policy-builder id config)
Creates a RedriveAllowPolicy$Builder
instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments:
Argument | DataType | Description |
---|---|---|
id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. |
config | map | Data configuration |
Creates a `RedriveAllowPolicy$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
(redrive-permission config id item-key)
The redrive-permission
function data interprets values in the provided config data into a
RedrivePermission
instance. This simplifies the use of keywords in place of actual enum values in
the configuration provided to builders. The value is found using the cdk.support/lookup-entry
function on the data with the provided namespace id and item-key. The found value is interpretted as follows:
RedrivePermission
- the value is returned.:by-queue
- RedrivePermission/BY_QUEUE
is returned:allow-all
- RedrivePermission/ALLOW_ALL
is returned:deny-all
- RedrivePermission/DENY_ALL
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `redrive-permission` function data interprets values in the provided config data into a `RedrivePermission` instance. This simplifies the use of keywords in place of actual enum values in the configuration provided to builders. The value is found using the `cdk.support/lookup-entry` function on the data with the provided namespace id and item-key. The found value is interpretted as follows: * instance of `RedrivePermission` - the value is returned. * is `:by-queue` - `RedrivePermission/BY_QUEUE` is returned * is `:allow-all` - `RedrivePermission/ALLOW_ALL` is returned * is `:deny-all` - `RedrivePermission/DENY_ALL` is returned If a value is not found or matches the above criteria, nil is returned.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close