`googlePubsubLiteTopic` Submodule

Constructs

GooglePubsubLiteTopic

Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic google_pubsub_lite_topic}.

Initializers

import { googlePubsubLiteTopic } from '@cdktf/provider-google-beta'

new googlePubsubLiteTopic.GooglePubsubLiteTopic(scope: Construct, id: string, config: GooglePubsubLiteTopicConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`GooglePubsubLiteTopicConfig`	No description.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: GooglePubsubLiteTopicConfig

Methods

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".
`putPartitionConfig`	No description.
`putReservationConfig`	No description.
`putRetentionConfig`	No description.
`putTimeouts`	No description.
`resetId`	No description.
`resetPartitionConfig`	No description.
`resetProject`	No description.
`resetRegion`	No description.
`resetReservationConfig`	No description.
`resetRetentionConfig`	No description.
`resetTimeouts`	No description.
`resetZone`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public resetOverrideLogicalId(): void

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

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

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.

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

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.

`id`^Required

Type: string

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

`moveTo`

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

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

`index`^Optional

Type: string | number

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

`moveToId`

public moveToId(id: string): void

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

`id`^Required

Type: string

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

`putPartitionConfig`

public putPartitionConfig(value: GooglePubsubLiteTopicPartitionConfig): void

`value`^Required

Type: GooglePubsubLiteTopicPartitionConfig

`putReservationConfig`

public putReservationConfig(value: GooglePubsubLiteTopicReservationConfig): void

`value`^Required

Type: GooglePubsubLiteTopicReservationConfig

`putRetentionConfig`

public putRetentionConfig(value: GooglePubsubLiteTopicRetentionConfig): void

`value`^Required

Type: GooglePubsubLiteTopicRetentionConfig

`putTimeouts`

public putTimeouts(value: GooglePubsubLiteTopicTimeouts): void

`value`^Required

Type: GooglePubsubLiteTopicTimeouts

`resetId`

public resetId(): void

`resetPartitionConfig`

public resetPartitionConfig(): void

`resetProject`

public resetProject(): void

`resetRegion`

public resetRegion(): void

`resetReservationConfig`

public resetReservationConfig(): void

`resetRetentionConfig`

public resetRetentionConfig(): void

`resetTimeouts`

public resetTimeouts(): void

`resetZone`

public resetZone(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.
`generateConfigForImport`	Generates CDKTF code for importing a GooglePubsubLiteTopic resource upon running "cdktf plan ".

`isConstruct`

import { googlePubsubLiteTopic } from '@cdktf/provider-google-beta'

googlePubsubLiteTopic.GooglePubsubLiteTopic.isConstruct(x: 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: any

Any object.

`isTerraformElement`

import { googlePubsubLiteTopic } from '@cdktf/provider-google-beta'

googlePubsubLiteTopic.GooglePubsubLiteTopic.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { googlePubsubLiteTopic } from '@cdktf/provider-google-beta'

googlePubsubLiteTopic.GooglePubsubLiteTopic.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { googlePubsubLiteTopic } from '@cdktf/provider-google-beta'

googlePubsubLiteTopic.GooglePubsubLiteTopic.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a GooglePubsubLiteTopic resource upon running "cdktf plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

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

`importFromId`^Required

Type: string

The id of the existing GooglePubsubLiteTopic that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: cdktf.TerraformProvider

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

Properties

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.
`partitionConfig`	`GooglePubsubLiteTopicPartitionConfigOutputReference`	No description.
`reservationConfig`	`GooglePubsubLiteTopicReservationConfigOutputReference`	No description.
`retentionConfig`	`GooglePubsubLiteTopicRetentionConfigOutputReference`	No description.
`timeouts`	`GooglePubsubLiteTopicTimeoutsOutputReference`	No description.
`idInput`	`string`	No description.
`nameInput`	`string`	No description.
`partitionConfigInput`	`GooglePubsubLiteTopicPartitionConfig`	No description.
`projectInput`	`string`	No description.
`regionInput`	`string`	No description.
`reservationConfigInput`	`GooglePubsubLiteTopicReservationConfig`	No description.
`retentionConfigInput`	`GooglePubsubLiteTopicRetentionConfig`	No description.
`timeoutsInput`	`cdktf.IResolvable \| GooglePubsubLiteTopicTimeouts`	No description.
`zoneInput`	`string`	No description.
`id`	`string`	No description.
`name`	`string`	No description.
`project`	`string`	No description.
`region`	`string`	No description.
`zone`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`partitionConfig`^Required

public readonly partitionConfig: GooglePubsubLiteTopicPartitionConfigOutputReference;

Type: GooglePubsubLiteTopicPartitionConfigOutputReference

`reservationConfig`^Required

public readonly reservationConfig: GooglePubsubLiteTopicReservationConfigOutputReference;

Type: GooglePubsubLiteTopicReservationConfigOutputReference

`retentionConfig`^Required

public readonly retentionConfig: GooglePubsubLiteTopicRetentionConfigOutputReference;

Type: GooglePubsubLiteTopicRetentionConfigOutputReference

`timeouts`^Required

public readonly timeouts: GooglePubsubLiteTopicTimeoutsOutputReference;

Type: GooglePubsubLiteTopicTimeoutsOutputReference

`idInput`^Optional

public readonly idInput: string;

Type: string

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`partitionConfigInput`^Optional

public readonly partitionConfigInput: GooglePubsubLiteTopicPartitionConfig;

Type: GooglePubsubLiteTopicPartitionConfig

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`regionInput`^Optional

public readonly regionInput: string;

Type: string

`reservationConfigInput`^Optional

public readonly reservationConfigInput: GooglePubsubLiteTopicReservationConfig;

Type: GooglePubsubLiteTopicReservationConfig

`retentionConfigInput`^Optional

public readonly retentionConfigInput: GooglePubsubLiteTopicRetentionConfig;

Type: GooglePubsubLiteTopicRetentionConfig

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | GooglePubsubLiteTopicTimeouts;

Type: cdktf.IResolvable | GooglePubsubLiteTopicTimeouts

`zoneInput`^Optional

public readonly zoneInput: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`project`^Required

public readonly project: string;

Type: string

`region`^Required

public readonly region: string;

Type: string

`zone`^Required

public readonly zone: string;

Type: string

Constants

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

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

GooglePubsubLiteTopicConfig

Initializer

import { googlePubsubLiteTopic } from '@cdktf/provider-google-beta'

const googlePubsubLiteTopicConfig: googlePubsubLiteTopic.GooglePubsubLiteTopicConfig = { ... }

Properties

Name	Type	Description
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`cdktf.ITerraformDependable[]`	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.
`name`	`string`	Name of the topic.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#id GooglePubsubLiteTopic#id}.
`partitionConfig`	`GooglePubsubLiteTopicPartitionConfig`	partition_config block.
`project`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#project GooglePubsubLiteTopic#project}.
`region`	`string`	The region of the pubsub lite topic.
`reservationConfig`	`GooglePubsubLiteTopicReservationConfig`	reservation_config block.
`retentionConfig`	`GooglePubsubLiteTopicRetentionConfig`	retention_config block.
`timeouts`	`GooglePubsubLiteTopicTimeouts`	timeouts block.
`zone`	`string`	The zone of the pubsub lite topic.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`name`^Required

public readonly name: string;

Type: string

Name of the topic.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#name GooglePubsubLiteTopic#name}

`id`^Optional

public readonly id: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#id GooglePubsubLiteTopic#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.

`partitionConfig`^Optional

public readonly partitionConfig: GooglePubsubLiteTopicPartitionConfig;

Type: GooglePubsubLiteTopicPartitionConfig

partition_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#partition_config GooglePubsubLiteTopic#partition_config}

`project`^Optional

public readonly project: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#project GooglePubsubLiteTopic#project}.

`region`^Optional

public readonly region: string;

Type: string

The region of the pubsub lite topic.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#region GooglePubsubLiteTopic#region}

`reservationConfig`^Optional

public readonly reservationConfig: GooglePubsubLiteTopicReservationConfig;

Type: GooglePubsubLiteTopicReservationConfig

reservation_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#reservation_config GooglePubsubLiteTopic#reservation_config}

`retentionConfig`^Optional

public readonly retentionConfig: GooglePubsubLiteTopicRetentionConfig;

Type: GooglePubsubLiteTopicRetentionConfig

retention_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#retention_config GooglePubsubLiteTopic#retention_config}

`timeouts`^Optional

public readonly timeouts: GooglePubsubLiteTopicTimeouts;

Type: GooglePubsubLiteTopicTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#timeouts GooglePubsubLiteTopic#timeouts}

`zone`^Optional

public readonly zone: string;

Type: string

The zone of the pubsub lite topic.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#zone GooglePubsubLiteTopic#zone}

GooglePubsubLiteTopicPartitionConfig

Initializer

import { googlePubsubLiteTopic } from '@cdktf/provider-google-beta'

const googlePubsubLiteTopicPartitionConfig: googlePubsubLiteTopic.GooglePubsubLiteTopicPartitionConfig = { ... }

Properties

Name	Type	Description
`count`	`number`	The number of partitions in the topic. Must be at least 1.
`capacity`	`GooglePubsubLiteTopicPartitionConfigCapacity`	capacity block.

`count`^Required

public readonly count: number;

Type: number

The number of partitions in the topic. Must be at least 1.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#count GooglePubsubLiteTopic#count}

`capacity`^Optional

public readonly capacity: GooglePubsubLiteTopicPartitionConfigCapacity;

Type: GooglePubsubLiteTopicPartitionConfigCapacity

capacity block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#capacity GooglePubsubLiteTopic#capacity}

GooglePubsubLiteTopicPartitionConfigCapacity

Initializer

import { googlePubsubLiteTopic } from '@cdktf/provider-google-beta'

const googlePubsubLiteTopicPartitionConfigCapacity: googlePubsubLiteTopic.GooglePubsubLiteTopicPartitionConfigCapacity = { ... }

Properties

Name	Type	Description
`publishMibPerSec`	`number`	Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
`subscribeMibPerSec`	`number`	Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.

`publishMibPerSec`^Required

public readonly publishMibPerSec: number;

Type: number

Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#publish_mib_per_sec GooglePubsubLiteTopic#publish_mib_per_sec}

`subscribeMibPerSec`^Required

public readonly subscribeMibPerSec: number;

Type: number

Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#subscribe_mib_per_sec GooglePubsubLiteTopic#subscribe_mib_per_sec}

GooglePubsubLiteTopicReservationConfig

Initializer

import { googlePubsubLiteTopic } from '@cdktf/provider-google-beta'

const googlePubsubLiteTopicReservationConfig: googlePubsubLiteTopic.GooglePubsubLiteTopicReservationConfig = { ... }

Properties

Name	Type	Description
`throughputReservation`	`string`	The Reservation to use for this topic's throughput capacity.

`throughputReservation`^Optional

public readonly throughputReservation: string;

Type: string

The Reservation to use for this topic's throughput capacity.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#throughput_reservation GooglePubsubLiteTopic#throughput_reservation}

GooglePubsubLiteTopicRetentionConfig

Initializer

import { googlePubsubLiteTopic } from '@cdktf/provider-google-beta'

const googlePubsubLiteTopicRetentionConfig: googlePubsubLiteTopic.GooglePubsubLiteTopicRetentionConfig = { ... }

Properties

Name	Type	Description
`perPartitionBytes`	`string`	The provisioned storage, in bytes, per partition.
`period`	`string`	How long a published message is retained.

`perPartitionBytes`^Required

public readonly perPartitionBytes: string;

Type: string

The provisioned storage, in bytes, per partition.

If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of period.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#per_partition_bytes GooglePubsubLiteTopic#per_partition_bytes}

`period`^Optional

public readonly period: string;

Type: string

How long a published message is retained.

If unset, messages will be retained as long as the bytes retained for each partition is below perPartitionBytes. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#period GooglePubsubLiteTopic#period}

GooglePubsubLiteTopicTimeouts

Initializer

import { googlePubsubLiteTopic } from '@cdktf/provider-google-beta'

const googlePubsubLiteTopicTimeouts: googlePubsubLiteTopic.GooglePubsubLiteTopicTimeouts = { ... }

Properties

Name	Type	Description
`create`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#create GooglePubsubLiteTopic#create}.
`delete`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#delete GooglePubsubLiteTopic#delete}.
`update`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#update GooglePubsubLiteTopic#update}.

`create`^Optional

public readonly create: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#create GooglePubsubLiteTopic#create}.

`delete`^Optional

public readonly delete: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#delete GooglePubsubLiteTopic#delete}.

`update`^Optional

public readonly update: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_pubsub_lite_topic#update GooglePubsubLiteTopic#update}.

Classes

GooglePubsubLiteTopicPartitionConfigCapacityOutputReference

Initializers

import { googlePubsubLiteTopic } from '@cdktf/provider-google-beta'

new googlePubsubLiteTopic.GooglePubsubLiteTopicPartitionConfigCapacityOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`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.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`publishMibPerSecInput`	`number`	No description.
`subscribeMibPerSecInput`	`number`	No description.
`publishMibPerSec`	`number`	No description.
`subscribeMibPerSec`	`number`	No description.
`internalValue`	`GooglePubsubLiteTopicPartitionConfigCapacity`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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

public readonly fqn: string;

Type: string

`publishMibPerSecInput`^Optional

public readonly publishMibPerSecInput: number;

Type: number

`subscribeMibPerSecInput`^Optional

public readonly subscribeMibPerSecInput: number;

Type: number

`publishMibPerSec`^Required

public readonly publishMibPerSec: number;

Type: number

`subscribeMibPerSec`^Required

public readonly subscribeMibPerSec: number;

Type: number

`internalValue`^Optional

public readonly internalValue: GooglePubsubLiteTopicPartitionConfigCapacity;

Type: GooglePubsubLiteTopicPartitionConfigCapacity

GooglePubsubLiteTopicPartitionConfigOutputReference

Initializers

import { googlePubsubLiteTopic } from '@cdktf/provider-google-beta'

new googlePubsubLiteTopic.GooglePubsubLiteTopicPartitionConfigOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`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.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`putCapacity`	No description.
`resetCapacity`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`putCapacity`

public putCapacity(value: GooglePubsubLiteTopicPartitionConfigCapacity): void

`value`^Required

Type: GooglePubsubLiteTopicPartitionConfigCapacity

`resetCapacity`

public resetCapacity(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`capacity`	`GooglePubsubLiteTopicPartitionConfigCapacityOutputReference`	No description.
`capacityInput`	`GooglePubsubLiteTopicPartitionConfigCapacity`	No description.
`countInput`	`number`	No description.
`count`	`number`	No description.
`internalValue`	`GooglePubsubLiteTopicPartitionConfig`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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

public readonly fqn: string;

Type: string

`capacity`^Required

public readonly capacity: GooglePubsubLiteTopicPartitionConfigCapacityOutputReference;

Type: GooglePubsubLiteTopicPartitionConfigCapacityOutputReference

`capacityInput`^Optional

public readonly capacityInput: GooglePubsubLiteTopicPartitionConfigCapacity;

Type: GooglePubsubLiteTopicPartitionConfigCapacity

`countInput`^Optional

public readonly countInput: number;

Type: number

`count`^Required

public readonly count: number;

Type: number

`internalValue`^Optional

public readonly internalValue: GooglePubsubLiteTopicPartitionConfig;

Type: GooglePubsubLiteTopicPartitionConfig

GooglePubsubLiteTopicReservationConfigOutputReference

Initializers

import { googlePubsubLiteTopic } from '@cdktf/provider-google-beta'

new googlePubsubLiteTopic.GooglePubsubLiteTopicReservationConfigOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`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.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`resetThroughputReservation`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetThroughputReservation`

public resetThroughputReservation(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`throughputReservationInput`	`string`	No description.
`throughputReservation`	`string`	No description.
`internalValue`	`GooglePubsubLiteTopicReservationConfig`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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

public readonly fqn: string;

Type: string

`throughputReservationInput`^Optional

public readonly throughputReservationInput: string;

Type: string

`throughputReservation`^Required

public readonly throughputReservation: string;

Type: string

`internalValue`^Optional

public readonly internalValue: GooglePubsubLiteTopicReservationConfig;

Type: GooglePubsubLiteTopicReservationConfig

GooglePubsubLiteTopicRetentionConfigOutputReference

Initializers

import { googlePubsubLiteTopic } from '@cdktf/provider-google-beta'

new googlePubsubLiteTopic.GooglePubsubLiteTopicRetentionConfigOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`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.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`resetPeriod`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetPeriod`

public resetPeriod(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`periodInput`	`string`	No description.
`perPartitionBytesInput`	`string`	No description.
`period`	`string`	No description.
`perPartitionBytes`	`string`	No description.
`internalValue`	`GooglePubsubLiteTopicRetentionConfig`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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

public readonly fqn: string;

Type: string

`periodInput`^Optional

public readonly periodInput: string;

Type: string

`perPartitionBytesInput`^Optional

public readonly perPartitionBytesInput: string;

Type: string

`period`^Required

public readonly period: string;

Type: string

`perPartitionBytes`^Required

public readonly perPartitionBytes: string;

Type: string

`internalValue`^Optional

public readonly internalValue: GooglePubsubLiteTopicRetentionConfig;

Type: GooglePubsubLiteTopicRetentionConfig

GooglePubsubLiteTopicTimeoutsOutputReference

Initializers

import { googlePubsubLiteTopic } from '@cdktf/provider-google-beta'

new googlePubsubLiteTopic.GooglePubsubLiteTopicTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`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.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`resetCreate`	No description.
`resetDelete`	No description.
`resetUpdate`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetCreate`

public resetCreate(): void

`resetDelete`

public resetDelete(): void

`resetUpdate`

public resetUpdate(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`createInput`	`string`	No description.
`deleteInput`	`string`	No description.
`updateInput`	`string`	No description.
`create`	`string`	No description.
`delete`	`string`	No description.
`update`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| GooglePubsubLiteTopicTimeouts`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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

public readonly fqn: string;

Type: string

`createInput`^Optional

public readonly createInput: string;

Type: string

`deleteInput`^Optional

public readonly deleteInput: string;

Type: string

`updateInput`^Optional

public readonly updateInput: string;

Type: string

`create`^Required

public readonly create: string;

Type: string

`delete`^Required

public readonly delete: string;

Type: string

`update`^Required

public readonly update: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GooglePubsubLiteTopicTimeouts;

Type: cdktf.IResolvable | GooglePubsubLiteTopicTimeouts

Files

googlePubsubLiteTopic.typescript.md

Latest commit

History

googlePubsubLiteTopic.typescript.md

File metadata and controls

googlePubsubLiteTopic Submodule

Constructs