`queueConsumer` Submodule

Constructs

QueueConsumer

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer cloudflare_queue_consumer}.

Initializers

from cdktn_provider_cloudflare import queue_consumer

queueConsumer.QueueConsumer(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  queue_id: str,
  type: str,
  account_id: str = None,
  dead_letter_queue: str = None,
  script_name: str = None,
  settings: QueueConsumerSettings = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[cdktn.ITerraformDependable]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`queue_id`	`str`	A Resource identifier.
`type`	`str`	Available values: "worker", "http_pull".
`account_id`	`str`	A Resource identifier.
`dead_letter_queue`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#dead_letter_queue QueueConsumer#dead_letter_queue}.
`script_name`	`str`	Name of a Worker.
`settings`	`QueueConsumerSettings`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#settings QueueConsumer#settings}.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

Type: typing.List[cdktn.ITerraformDependable]

`for_each`^Optional

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

Type: cdktn.TerraformProvider

`provisioners`^Optional

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`queue_id`^Required

Type: str

A Resource identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#queue_id QueueConsumer#queue_id}

`type`^Required

Type: str

Available values: "worker", "http_pull".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#type QueueConsumer#type}

`account_id`^Optional

Type: str

A Resource identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#account_id QueueConsumer#account_id}

`dead_letter_queue`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#dead_letter_queue QueueConsumer#dead_letter_queue}.

`script_name`^Optional

Type: str

Name of a Worker.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#script_name QueueConsumer#script_name}

`settings`^Optional

Type: QueueConsumerSettings

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#settings QueueConsumer#settings}.

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	No description.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`add_move_target`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`has_resource_move`	No description.
`import_from`	No description.
`interpolation_for_attribute`	No description.
`move_from_id`	Move the resource corresponding to "id" to this resource.
`move_to`	Moves this resource to the target resource given by moveTarget.
`move_to_id`	Moves this resource to the resource corresponding to "id".
`put_settings`	No description.
`reset_account_id`	No description.
`reset_dead_letter_queue`	No description.
`reset_script_name`	No description.
`reset_settings`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`with`

def with(
  mixins: *IMixin
) -> IConstruct

Applies one or more mixins to this construct.

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

`mixins`^Required

Type: *constructs.IMixin

The mixins to apply.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

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

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`add_move_target`

def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`move_target`^Required

Type: str

The string move target that will correspond to this resource.

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`has_resource_move`

def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById

`import_from`

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

`id`^Required

Type: str

`provider`^Optional

Type: cdktn.TerraformProvider

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`move_from_id`

def move_from_id(
  id: str
) -> None

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.

`id`^Required

Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`move_to`

def move_to(
  move_target: str,
  index: str | typing.Union[int, float] = None
) -> None

Moves this resource to the target resource given by moveTarget.

`move_target`^Required

Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`index`^Optional

Type: str | typing.Union[int, float]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`move_to_id`

def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

`id`^Required

Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

`put_settings`

def put_settings(
  batch_size: typing.Union[int, float] = None,
  max_concurrency: typing.Union[int, float] = None,
  max_retries: typing.Union[int, float] = None,
  max_wait_time_ms: typing.Union[int, float] = None,
  retry_delay: typing.Union[int, float] = None,
  visibility_timeout_ms: typing.Union[int, float] = None
) -> None

`batch_size`^Optional

Type: typing.Union[int, float]

The maximum number of messages to include in a batch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#batch_size QueueConsumer#batch_size}

`max_concurrency`^Optional

Type: typing.Union[int, float]

Maximum number of concurrent consumers that may consume from this Queue.

Set to null to automatically opt in to the platform's maximum (recommended).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#max_concurrency QueueConsumer#max_concurrency}

`max_retries`^Optional

Type: typing.Union[int, float]

The maximum number of retries.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#max_retries QueueConsumer#max_retries}

`max_wait_time_ms`^Optional

Type: typing.Union[int, float]

The number of milliseconds to wait for a batch to fill up before attempting to deliver it.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#max_wait_time_ms QueueConsumer#max_wait_time_ms}

`retry_delay`^Optional

Type: typing.Union[int, float]

The number of seconds to delay before making the message available for another attempt.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#retry_delay QueueConsumer#retry_delay}

`visibility_timeout_ms`^Optional

Type: typing.Union[int, float]

The number of milliseconds that a message is exclusively leased.

After the timeout, the message becomes available for another attempt.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#visibility_timeout_ms QueueConsumer#visibility_timeout_ms}

`reset_account_id`

def reset_account_id() -> None

`reset_dead_letter_queue`

def reset_dead_letter_queue() -> None

`reset_script_name`

def reset_script_name() -> None

`reset_settings`

def reset_settings() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_resource`	No description.
`generate_config_for_import`	Generates CDKTN code for importing a QueueConsumer resource upon running "cdktn plan ".

`is_construct`

from cdktn_provider_cloudflare import queue_consumer

queueConsumer.QueueConsumer.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

from cdktn_provider_cloudflare import queue_consumer

queueConsumer.QueueConsumer.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_resource`

from cdktn_provider_cloudflare import queue_consumer

queueConsumer.QueueConsumer.is_terraform_resource(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktn_provider_cloudflare import queue_consumer

queueConsumer.QueueConsumer.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTN code for importing a QueueConsumer resource upon running "cdktn plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`import_to_id`^Required

Type: str

The construct id used in the generated config for the QueueConsumer to import.

`import_from_id`^Required

Type: str

The id of the existing QueueConsumer that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: cdktn.TerraformProvider

? Optional instance of the provider where the QueueConsumer to import is found.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`cdktn.TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.
`terraform_meta_arguments`	`typing.Mapping[typing.Any]`	No description.
`terraform_resource_type`	`str`	No description.
`terraform_generator_metadata`	`cdktn.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`consumer_id`	`str`	No description.
`created_on`	`str`	No description.
`queue_name`	`str`	No description.
`settings`	`QueueConsumerSettingsOutputReference`	No description.
`account_id_input`	`str`	No description.
`dead_letter_queue_input`	`str`	No description.
`queue_id_input`	`str`	No description.
`script_name_input`	`str`	No description.
`settings_input`	`cdktn.IResolvable \| QueueConsumerSettings`	No description.
`type_input`	`str`	No description.
`account_id`	`str`	No description.
`dead_letter_queue`	`str`	No description.
`queue_id`	`str`	No description.
`script_name`	`str`	No description.
`type`	`str`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktn.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktn.TerraformProviderGeneratorMetadata

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktn.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`consumer_id`^Required

consumer_id: str

Type: str

`created_on`^Required

created_on: str

Type: str

`queue_name`^Required

queue_name: str

Type: str

`settings`^Required

settings: QueueConsumerSettingsOutputReference

Type: QueueConsumerSettingsOutputReference

`account_id_input`^Optional

account_id_input: str

Type: str

`dead_letter_queue_input`^Optional

dead_letter_queue_input: str

Type: str

`queue_id_input`^Optional

queue_id_input: str

Type: str

`script_name_input`^Optional

script_name_input: str

Type: str

`settings_input`^Optional

settings_input: IResolvable | QueueConsumerSettings

Type: cdktn.IResolvable | QueueConsumerSettings

`type_input`^Optional

type_input: str

Type: str

`account_id`^Required

account_id: str

Type: str

`dead_letter_queue`^Required

dead_letter_queue: str

Type: str

`queue_id`^Required

queue_id: str

Type: str

`script_name`^Required

script_name: str

Type: str

`type`^Required

type: str

Type: str

Constants

Name	Type	Description
`tfResourceType`	`str`	No description.

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

QueueConsumerConfig

Initializer

from cdktn_provider_cloudflare import queue_consumer

queueConsumer.QueueConsumerConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  queue_id: str,
  type: str,
  account_id: str = None,
  dead_letter_queue: str = None,
  script_name: str = None,
  settings: QueueConsumerSettings = None
)

Properties

Name	Type	Description
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[cdktn.ITerraformDependable]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`queue_id`	`str`	A Resource identifier.
`type`	`str`	Available values: "worker", "http_pull".
`account_id`	`str`	A Resource identifier.
`dead_letter_queue`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#dead_letter_queue QueueConsumer#dead_letter_queue}.
`script_name`	`str`	Name of a Worker.
`settings`	`QueueConsumerSettings`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#settings QueueConsumer#settings}.

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktn.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktn.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`queue_id`^Required

queue_id: str

Type: str

A Resource identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#queue_id QueueConsumer#queue_id}

`type`^Required

type: str

Type: str

Available values: "worker", "http_pull".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#type QueueConsumer#type}

`account_id`^Optional

account_id: str

Type: str

A Resource identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#account_id QueueConsumer#account_id}

`dead_letter_queue`^Optional

dead_letter_queue: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#dead_letter_queue QueueConsumer#dead_letter_queue}.

`script_name`^Optional

script_name: str

Type: str

Name of a Worker.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#script_name QueueConsumer#script_name}

`settings`^Optional

settings: QueueConsumerSettings

Type: QueueConsumerSettings

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#settings QueueConsumer#settings}.

QueueConsumerSettings

Initializer

from cdktn_provider_cloudflare import queue_consumer

queueConsumer.QueueConsumerSettings(
  batch_size: typing.Union[int, float] = None,
  max_concurrency: typing.Union[int, float] = None,
  max_retries: typing.Union[int, float] = None,
  max_wait_time_ms: typing.Union[int, float] = None,
  retry_delay: typing.Union[int, float] = None,
  visibility_timeout_ms: typing.Union[int, float] = None
)

Properties

Name	Type	Description
`batch_size`	`typing.Union[int, float]`	The maximum number of messages to include in a batch.
`max_concurrency`	`typing.Union[int, float]`	Maximum number of concurrent consumers that may consume from this Queue.
`max_retries`	`typing.Union[int, float]`	The maximum number of retries.
`max_wait_time_ms`	`typing.Union[int, float]`	The number of milliseconds to wait for a batch to fill up before attempting to deliver it.
`retry_delay`	`typing.Union[int, float]`	The number of seconds to delay before making the message available for another attempt.
`visibility_timeout_ms`	`typing.Union[int, float]`	The number of milliseconds that a message is exclusively leased.

`batch_size`^Optional

batch_size: typing.Union[int, float]

Type: typing.Union[int, float]

The maximum number of messages to include in a batch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#batch_size QueueConsumer#batch_size}

`max_concurrency`^Optional

max_concurrency: typing.Union[int, float]

Type: typing.Union[int, float]

Maximum number of concurrent consumers that may consume from this Queue.

Set to null to automatically opt in to the platform's maximum (recommended).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#max_concurrency QueueConsumer#max_concurrency}

`max_retries`^Optional

max_retries: typing.Union[int, float]

Type: typing.Union[int, float]

The maximum number of retries.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#max_retries QueueConsumer#max_retries}

`max_wait_time_ms`^Optional

max_wait_time_ms: typing.Union[int, float]

Type: typing.Union[int, float]

The number of milliseconds to wait for a batch to fill up before attempting to deliver it.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#max_wait_time_ms QueueConsumer#max_wait_time_ms}

`retry_delay`^Optional

retry_delay: typing.Union[int, float]

Type: typing.Union[int, float]

The number of seconds to delay before making the message available for another attempt.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#retry_delay QueueConsumer#retry_delay}

`visibility_timeout_ms`^Optional

visibility_timeout_ms: typing.Union[int, float]

Type: typing.Union[int, float]

The number of milliseconds that a message is exclusively leased.

After the timeout, the message becomes available for another attempt.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/queue_consumer#visibility_timeout_ms QueueConsumer#visibility_timeout_ms}

Classes

QueueConsumerSettingsOutputReference

Initializers

from cdktn_provider_cloudflare import queue_consumer

queueConsumer.QueueConsumerSettingsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
`terraform_resource`	`cdktn.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.

`terraform_resource`^Required

Type: cdktn.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`compute_fqn`	No description.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`interpolation_for_attribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`to_string`	Return a string representation of this resolvable object.
`reset_batch_size`	No description.
`reset_max_concurrency`	No description.
`reset_max_retries`	No description.
`reset_max_wait_time_ms`	No description.
`reset_retry_delay`	No description.
`reset_visibility_timeout_ms`	No description.

`compute_fqn`

def compute_fqn() -> str

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktn.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

`reset_batch_size`

def reset_batch_size() -> None

`reset_max_concurrency`

def reset_max_concurrency() -> None

`reset_max_retries`

def reset_max_retries() -> None

`reset_max_wait_time_ms`

def reset_max_wait_time_ms() -> None

`reset_retry_delay`

def reset_retry_delay() -> None

`reset_visibility_timeout_ms`

def reset_visibility_timeout_ms() -> None

Properties

Name	Type	Description
`creation_stack`	`typing.List[str]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`str`	No description.
`batch_size_input`	`typing.Union[int, float]`	No description.
`max_concurrency_input`	`typing.Union[int, float]`	No description.
`max_retries_input`	`typing.Union[int, float]`	No description.
`max_wait_time_ms_input`	`typing.Union[int, float]`	No description.
`retry_delay_input`	`typing.Union[int, float]`	No description.
`visibility_timeout_ms_input`	`typing.Union[int, float]`	No description.
`batch_size`	`typing.Union[int, float]`	No description.
`max_concurrency`	`typing.Union[int, float]`	No description.
`max_retries`	`typing.Union[int, float]`	No description.
`max_wait_time_ms`	`typing.Union[int, float]`	No description.
`retry_delay`	`typing.Union[int, float]`	No description.
`visibility_timeout_ms`	`typing.Union[int, float]`	No description.
`internal_value`	`cdktn.IResolvable \| QueueConsumerSettings`	No description.

`creation_stack`^Required

creation_stack: typing.List[str]

Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

fqn: str

Type: str

`batch_size_input`^Optional

batch_size_input: typing.Union[int, float]

Type: typing.Union[int, float]

`max_concurrency_input`^Optional

max_concurrency_input: typing.Union[int, float]

Type: typing.Union[int, float]

`max_retries_input`^Optional

max_retries_input: typing.Union[int, float]

Type: typing.Union[int, float]

`max_wait_time_ms_input`^Optional

max_wait_time_ms_input: typing.Union[int, float]

Type: typing.Union[int, float]

`retry_delay_input`^Optional

retry_delay_input: typing.Union[int, float]

Type: typing.Union[int, float]

`visibility_timeout_ms_input`^Optional

visibility_timeout_ms_input: typing.Union[int, float]

Type: typing.Union[int, float]

`batch_size`^Required

batch_size: typing.Union[int, float]

Type: typing.Union[int, float]

`max_concurrency`^Required

max_concurrency: typing.Union[int, float]

Type: typing.Union[int, float]

`max_retries`^Required

max_retries: typing.Union[int, float]

Type: typing.Union[int, float]

`max_wait_time_ms`^Required

max_wait_time_ms: typing.Union[int, float]

Type: typing.Union[int, float]

`retry_delay`^Required

retry_delay: typing.Union[int, float]

Type: typing.Union[int, float]

`visibility_timeout_ms`^Required

visibility_timeout_ms: typing.Union[int, float]

Type: typing.Union[int, float]

`internal_value`^Optional

internal_value: IResolvable | QueueConsumerSettings

Type: cdktn.IResolvable | QueueConsumerSettings

FilesExpand file tree

queueConsumer.python.md

Latest commit

History

queueConsumer.python.md

File metadata and controls

queueConsumer Submodule

Constructs

QueueConsumer

Initializers

scopeRequired

idRequired

connectionOptional

countOptional

depends_onOptional

for_eachOptional

lifecycleOptional

providerOptional

provisionersOptional

queue_idRequired

typeRequired

account_idOptional

dead_letter_queueOptional

script_nameOptional

settingsOptional

Methods

to_string

with

mixinsRequired

add_override

pathRequired

valueRequired

override_logical_id

new_logical_idRequired

reset_override_logical_id

to_hcl_terraform

to_metadata

to_terraform

add_move_target

move_targetRequired

get_any_map_attribute

terraform_attributeRequired

get_boolean_attribute

terraform_attributeRequired

get_boolean_map_attribute

terraform_attributeRequired

get_list_attribute

terraform_attributeRequired

get_number_attribute

terraform_attributeRequired

get_number_list_attribute

terraform_attributeRequired

get_number_map_attribute

terraform_attributeRequired

get_string_attribute

terraform_attributeRequired

get_string_map_attribute

terraform_attributeRequired

has_resource_move

import_from

idRequired

providerOptional

interpolation_for_attribute

terraform_attributeRequired

move_from_id

idRequired

move_to

move_targetRequired

indexOptional

move_to_id

idRequired

put_settings

batch_sizeOptional

max_concurrencyOptional

max_retriesOptional

max_wait_time_msOptional

retry_delayOptional

visibility_timeout_msOptional

reset_account_id

reset_dead_letter_queue

`queueConsumer` Submodule

`scope`^Required

`id`^Required

`connection`^Optional

`count`^Optional

`depends_on`^Optional

`for_each`^Optional

`lifecycle`^Optional

`provider`^Optional

`provisioners`^Optional

`queue_id`^Required

`type`^Required

`account_id`^Optional

`dead_letter_queue`^Optional

`script_name`^Optional

`settings`^Optional

`to_string`

`with`

`mixins`^Required

`add_override`

`path`^Required

`value`^Required

`override_logical_id`

`new_logical_id`^Required

`reset_override_logical_id`

`to_hcl_terraform`

`to_metadata`

`to_terraform`

`add_move_target`

`move_target`^Required

`get_any_map_attribute`

`terraform_attribute`^Required

`get_boolean_attribute`

`terraform_attribute`^Required

`get_boolean_map_attribute`

`terraform_attribute`^Required

`get_list_attribute`

`terraform_attribute`^Required

`get_number_attribute`

`terraform_attribute`^Required

`get_number_list_attribute`

`terraform_attribute`^Required

`get_number_map_attribute`

`terraform_attribute`^Required

`get_string_attribute`

`terraform_attribute`^Required

`get_string_map_attribute`

`terraform_attribute`^Required

`has_resource_move`

`import_from`

`id`^Required

`provider`^Optional

`interpolation_for_attribute`

`terraform_attribute`^Required

`move_from_id`

`id`^Required

`move_to`

`move_target`^Required

`index`^Optional

`move_to_id`

`id`^Required

`put_settings`

`batch_size`^Optional

`max_concurrency`^Optional

`max_retries`^Optional

`max_wait_time_ms`^Optional

`retry_delay`^Optional

`visibility_timeout_ms`^Optional

`reset_account_id`

`reset_dead_letter_queue`

`reset_script_name`

`reset_settings`

`is_construct`

`x`^Required

`is_terraform_element`

`x`^Required

`is_terraform_resource`

`x`^Required

`generate_config_for_import`

`scope`^Required