Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue aws_sqs_queue}.
import { sqsQueue } from '@cdktf/aws-cdk'
new sqsQueue.SqsQueue(scope: Construct, id: string, config?: SqsQueueConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
SqsQueueConfig |
No description. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: SqsQueueConfig
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
addOverride |
No description. |
overrideLogicalId |
Overrides the auto-generated logical ID with a specific ID. |
resetOverrideLogicalId |
Resets a previously passed logical Id to use the auto-generated logical id again. |
toHclTerraform |
No description. |
toMetadata |
No description. |
toTerraform |
Adds this resource to the terraform JSON output. |
addMoveTarget |
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. |
getAnyMapAttribute |
No description. |
getBooleanAttribute |
No description. |
getBooleanMapAttribute |
No description. |
getListAttribute |
No description. |
getNumberAttribute |
No description. |
getNumberListAttribute |
No description. |
getNumberMapAttribute |
No description. |
getStringAttribute |
No description. |
getStringMapAttribute |
No description. |
hasResourceMove |
No description. |
importFrom |
No description. |
interpolationForAttribute |
No description. |
moveFromId |
Move the resource corresponding to "id" to this resource. |
moveTo |
Moves this resource to the target resource given by moveTarget. |
moveToId |
Moves this resource to the resource corresponding to "id". |
resetContentBasedDeduplication |
No description. |
resetDeduplicationScope |
No description. |
resetDelaySeconds |
No description. |
resetFifoQueue |
No description. |
resetFifoThroughputLimit |
No description. |
resetId |
No description. |
resetKmsDataKeyReusePeriodSeconds |
No description. |
resetKmsMasterKeyId |
No description. |
resetMaxMessageSize |
No description. |
resetMessageRetentionSeconds |
No description. |
resetName |
No description. |
resetNamePrefix |
No description. |
resetPolicy |
No description. |
resetReceiveWaitTimeSeconds |
No description. |
resetRedriveAllowPolicy |
No description. |
resetRedrivePolicy |
No description. |
resetSqsManagedSseEnabled |
No description. |
resetTags |
No description. |
resetTagsAll |
No description. |
resetVisibilityTimeoutSeconds |
No description. |
public toString(): string
Returns a string representation of this construct.
public addOverride(path: string, value: any): void
- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
public toHclTerraform(): any
public toMetadata(): any
public toTerraform(): any
Adds this resource to the terraform JSON output.
public addMoveTarget(moveTarget: string): void
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
- Type: string
The string move target that will correspond to this resource.
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
public importFrom(id: string, provider?: TerraformProvider): void
- Type: string
- Type: cdktf.TerraformProvider
public interpolationForAttribute(terraformAttribute: string): IResolvable
- Type: string
public moveFromId(id: string): void
Move the resource corresponding to "id" to this resource.
Note that the resource being moved from must be marked as moved using it's instance function.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
public moveTo(moveTarget: string, index?: string | number): void
Moves this resource to the target resource given by moveTarget.
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: string | number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
public moveToId(id: string): void
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public resetContentBasedDeduplication(): void
public resetDeduplicationScope(): void
public resetDelaySeconds(): void
public resetFifoQueue(): void
public resetFifoThroughputLimit(): void
public resetId(): void
public resetKmsDataKeyReusePeriodSeconds(): void
public resetKmsMasterKeyId(): void
public resetMaxMessageSize(): void
public resetMessageRetentionSeconds(): void
public resetName(): void
public resetNamePrefix(): void
public resetPolicy(): void
public resetReceiveWaitTimeSeconds(): void
public resetRedriveAllowPolicy(): void
public resetRedrivePolicy(): void
public resetSqsManagedSseEnabled(): void
public resetTags(): void
public resetTagsAll(): void
public resetVisibilityTimeoutSeconds(): void
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a SqsQueue resource upon running "cdktf plan ". |
import { sqsQueue } from '@cdktf/aws-cdk'
sqsQueue.SqsQueue.isConstruct(x: any)
Checks if x
is a construct.
- Type: any
Any object.
import { sqsQueue } from '@cdktf/aws-cdk'
sqsQueue.SqsQueue.isTerraformElement(x: any)
- Type: any
import { sqsQueue } from '@cdktf/aws-cdk'
sqsQueue.SqsQueue.isTerraformResource(x: any)
- Type: any
import { sqsQueue } from '@cdktf/aws-cdk'
sqsQueue.SqsQueue.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)
Generates CDKTF code for importing a SqsQueue resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the SqsQueue to import.
- Type: string
The id of the existing SqsQueue that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the SqsQueue to import is found.
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
cdktfStack |
cdktf.TerraformStack |
No description. |
fqn |
string |
No description. |
friendlyUniqueId |
string |
No description. |
terraformMetaArguments |
{[ key: string ]: any} |
No description. |
terraformResourceType |
string |
No description. |
terraformGeneratorMetadata |
cdktf.TerraformProviderGeneratorMetadata |
No description. |
connection |
cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection |
No description. |
count |
number | cdktf.TerraformCount |
No description. |
dependsOn |
string[] |
No description. |
forEach |
cdktf.ITerraformIterator |
No description. |
lifecycle |
cdktf.TerraformResourceLifecycle |
No description. |
provider |
cdktf.TerraformProvider |
No description. |
provisioners |
cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] |
No description. |
arn |
string |
No description. |
url |
string |
No description. |
contentBasedDeduplicationInput |
boolean | cdktf.IResolvable |
No description. |
deduplicationScopeInput |
string |
No description. |
delaySecondsInput |
number |
No description. |
fifoQueueInput |
boolean | cdktf.IResolvable |
No description. |
fifoThroughputLimitInput |
string |
No description. |
idInput |
string |
No description. |
kmsDataKeyReusePeriodSecondsInput |
number |
No description. |
kmsMasterKeyIdInput |
string |
No description. |
maxMessageSizeInput |
number |
No description. |
messageRetentionSecondsInput |
number |
No description. |
nameInput |
string |
No description. |
namePrefixInput |
string |
No description. |
policyInput |
string |
No description. |
receiveWaitTimeSecondsInput |
number |
No description. |
redriveAllowPolicyInput |
string |
No description. |
redrivePolicyInput |
string |
No description. |
sqsManagedSseEnabledInput |
boolean | cdktf.IResolvable |
No description. |
tagsAllInput |
{[ key: string ]: string} |
No description. |
tagsInput |
{[ key: string ]: string} |
No description. |
visibilityTimeoutSecondsInput |
number |
No description. |
contentBasedDeduplication |
boolean | cdktf.IResolvable |
No description. |
deduplicationScope |
string |
No description. |
delaySeconds |
number |
No description. |
fifoQueue |
boolean | cdktf.IResolvable |
No description. |
fifoThroughputLimit |
string |
No description. |
id |
string |
No description. |
kmsDataKeyReusePeriodSeconds |
number |
No description. |
kmsMasterKeyId |
string |
No description. |
maxMessageSize |
number |
No description. |
messageRetentionSeconds |
number |
No description. |
name |
string |
No description. |
namePrefix |
string |
No description. |
policy |
string |
No description. |
receiveWaitTimeSeconds |
number |
No description. |
redriveAllowPolicy |
string |
No description. |
redrivePolicy |
string |
No description. |
sqsManagedSseEnabled |
boolean | cdktf.IResolvable |
No description. |
tags |
{[ key: string ]: string} |
No description. |
tagsAll |
{[ key: string ]: string} |
No description. |
visibilityTimeoutSeconds |
number |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;
- Type: cdktf.TerraformStack
public readonly fqn: string;
- Type: string
public readonly friendlyUniqueId: string;
- Type: string
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;
- Type: string
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
- Type: cdktf.TerraformProviderGeneratorMetadata
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: string[];
- Type: string[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly arn: string;
- Type: string
public readonly url: string;
- Type: string
public readonly contentBasedDeduplicationInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly deduplicationScopeInput: string;
- Type: string
public readonly delaySecondsInput: number;
- Type: number
public readonly fifoQueueInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly fifoThroughputLimitInput: string;
- Type: string
public readonly idInput: string;
- Type: string
public readonly kmsDataKeyReusePeriodSecondsInput: number;
- Type: number
public readonly kmsMasterKeyIdInput: string;
- Type: string
public readonly maxMessageSizeInput: number;
- Type: number
public readonly messageRetentionSecondsInput: number;
- Type: number
public readonly nameInput: string;
- Type: string
public readonly namePrefixInput: string;
- Type: string
public readonly policyInput: string;
- Type: string
public readonly receiveWaitTimeSecondsInput: number;
- Type: number
public readonly redriveAllowPolicyInput: string;
- Type: string
public readonly redrivePolicyInput: string;
- Type: string
public readonly sqsManagedSseEnabledInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly tagsAllInput: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly tagsInput: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly visibilityTimeoutSecondsInput: number;
- Type: number
public readonly contentBasedDeduplication: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly deduplicationScope: string;
- Type: string
public readonly delaySeconds: number;
- Type: number
public readonly fifoQueue: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly fifoThroughputLimit: string;
- Type: string
public readonly id: string;
- Type: string
public readonly kmsDataKeyReusePeriodSeconds: number;
- Type: number
public readonly kmsMasterKeyId: string;
- Type: string
public readonly maxMessageSize: number;
- Type: number
public readonly messageRetentionSeconds: number;
- Type: number
public readonly name: string;
- Type: string
public readonly namePrefix: string;
- Type: string
public readonly policy: string;
- Type: string
public readonly receiveWaitTimeSeconds: number;
- Type: number
public readonly redriveAllowPolicy: string;
- Type: string
public readonly redrivePolicy: string;
- Type: string
public readonly sqsManagedSseEnabled: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly tags: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly tagsAll: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly visibilityTimeoutSeconds: number;
- Type: number
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { sqsQueue } from '@cdktf/aws-cdk'
const sqsQueueConfig: sqsQueue.SqsQueueConfig = { ... }
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: ITerraformDependable[];
- Type: cdktf.ITerraformDependable[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly contentBasedDeduplication: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#content_based_deduplication SqsQueue#content_based_deduplication}.
public readonly deduplicationScope: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#deduplication_scope SqsQueue#deduplication_scope}.
public readonly delaySeconds: number;
- Type: number
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#delay_seconds SqsQueue#delay_seconds}.
public readonly fifoQueue: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#fifo_queue SqsQueue#fifo_queue}.
public readonly fifoThroughputLimit: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#fifo_throughput_limit SqsQueue#fifo_throughput_limit}.
public readonly id: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#id SqsQueue#id}.
Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
public readonly kmsDataKeyReusePeriodSeconds: number;
- Type: number
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#kms_data_key_reuse_period_seconds SqsQueue#kms_data_key_reuse_period_seconds}.
public readonly kmsMasterKeyId: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#kms_master_key_id SqsQueue#kms_master_key_id}.
public readonly maxMessageSize: number;
- Type: number
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#max_message_size SqsQueue#max_message_size}.
public readonly messageRetentionSeconds: number;
- Type: number
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#message_retention_seconds SqsQueue#message_retention_seconds}.
public readonly name: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#name SqsQueue#name}.
public readonly namePrefix: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#name_prefix SqsQueue#name_prefix}.
public readonly policy: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#policy SqsQueue#policy}.
public readonly receiveWaitTimeSeconds: number;
- Type: number
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#receive_wait_time_seconds SqsQueue#receive_wait_time_seconds}.
public readonly redriveAllowPolicy: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#redrive_allow_policy SqsQueue#redrive_allow_policy}.
public readonly redrivePolicy: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#redrive_policy SqsQueue#redrive_policy}.
public readonly sqsManagedSseEnabled: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#sqs_managed_sse_enabled SqsQueue#sqs_managed_sse_enabled}.
public readonly tags: {[ key: string ]: string};
- Type: {[ key: string ]: string}
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#tags SqsQueue#tags}.
public readonly tagsAll: {[ key: string ]: string};
- Type: {[ key: string ]: string}
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#tags_all SqsQueue#tags_all}.
public readonly visibilityTimeoutSeconds: number;
- Type: number
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sqs_queue#visibility_timeout_seconds SqsQueue#visibility_timeout_seconds}.