pubsubTopic.python.md

pubsubTopic Submodule

Constructs

PubsubTopic

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic google_pubsub_topic}.

Initializers

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopic(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[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[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  id: str = None,
  ingestion_data_source_settings: PubsubTopicIngestionDataSourceSettings = None,
  kms_key_name: str = None,
  labels: typing.Mapping[str] = None,
  message_retention_duration: str = None,
  message_storage_policy: PubsubTopicMessageStoragePolicy = None,
  project: str = None,
  schema_settings: PubsubTopicSchemaSettings = None,
  timeouts: PubsubTopicTimeouts = None
)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	str	The scoped construct ID.
connection	typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]	No description.
count	typing.Union[typing.Union[int, float], cdktf.TerraformCount]	No description.
depends_on	typing.List[cdktf.ITerraformDependable]	No description.
for_each	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]	No description.
name	str	Name of the topic.
id	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#id PubsubTopic#id}.
ingestion_data_source_settings	PubsubTopicIngestionDataSourceSettings	ingestion_data_source_settings block.
kms_key_name	str	The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.
labels	typing.Mapping[str]	A set of key/value label pairs to assign to this Topic.
message_retention_duration	str	Indicates the minimum duration to retain a message after it is published to the topic.
message_storage_policy	PubsubTopicMessageStoragePolicy	message_storage_policy block.
project	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#project PubsubTopic#project}.
schema_settings	PubsubTopicSchemaSettings	schema_settings block.
timeouts	PubsubTopicTimeouts	timeouts block.

---

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: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

---

count^Optional

• Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

---

depends_on^Optional

• Type: typing.List[cdktf.ITerraformDependable]

---

for_each^Optional

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

• Type: cdktf.TerraformProvider

---

provisioners^Optional

• Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

---

name^Required

• Type: str

Name of the topic.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#name PubsubTopic#name}

---

id^Optional

• Type: str

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

---

ingestion_data_source_settings^Optional

• Type: PubsubTopicIngestionDataSourceSettings

ingestion_data_source_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#ingestion_data_source_settings PubsubTopic#ingestion_data_source_settings}

---

kms_key_name^Optional

• Type: str

The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.

Your project's PubSub service account ('service-{{PROJECT_NUMBER}}@gcp-sa-pubsub.iam.gserviceaccount.com') must have 'roles/cloudkms.cryptoKeyEncrypterDecrypter' to use this feature. The expected format is 'projects/* /locations/* /keyRings/* /cryptoKeys/*'

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#kms_key_name PubsubTopic#kms_key_name}

Note: The above comment contained a comment block ending sequence (* followed by /). We have introduced a space between to prevent syntax errors. Please ignore the space.

---

labels^Optional

• Type: typing.Mapping[str]

A set of key/value label pairs to assign to this Topic.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#labels PubsubTopic#labels}

---

message_retention_duration^Optional

• Type: str

Indicates the minimum duration to retain a message after it is published to the topic.

If this field is set, messages published to the topic in the last messageRetentionDuration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to messageRetentionDuration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. The rotation period has the format of a decimal number, followed by the letter 's' (seconds). Cannot be more than 31 days or less than 10 minutes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#message_retention_duration PubsubTopic#message_retention_duration}

---

message_storage_policy^Optional

• Type: PubsubTopicMessageStoragePolicy

message_storage_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#message_storage_policy PubsubTopic#message_storage_policy}

---

project^Optional

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#project PubsubTopic#project}.

---

schema_settings^Optional

• Type: PubsubTopicSchemaSettings

schema_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#schema_settings PubsubTopic#schema_settings}

---

timeouts^Optional

• Type: PubsubTopicTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#timeouts PubsubTopic#timeouts}

---

Methods

Name	Description
to_string	Returns a string representation of 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_ingestion_data_source_settings	No description.
put_message_storage_policy	No description.
put_schema_settings	No description.
put_timeouts	No description.
reset_id	No description.
reset_ingestion_data_source_settings	No description.
reset_kms_key_name	No description.
reset_labels	No description.
reset_message_retention_duration	No description.
reset_message_storage_policy	No description.
reset_project	No description.
reset_schema_settings	No description.
reset_timeouts	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

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() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]

import_from

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

id^Required

• Type: str

---

provider^Optional

• Type: cdktf.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: typing.Union[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: typing.Union[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_ingestion_data_source_settings

def put_ingestion_data_source_settings(
  aws_kinesis: PubsubTopicIngestionDataSourceSettingsAwsKinesis = None,
  aws_msk: PubsubTopicIngestionDataSourceSettingsAwsMsk = None,
  azure_event_hubs: PubsubTopicIngestionDataSourceSettingsAzureEventHubs = None,
  cloud_storage: PubsubTopicIngestionDataSourceSettingsCloudStorage = None,
  confluent_cloud: PubsubTopicIngestionDataSourceSettingsConfluentCloud = None,
  platform_logs_settings: PubsubTopicIngestionDataSourceSettingsPlatformLogsSettings = None
) -> None

aws_kinesis^Optional

• Type: PubsubTopicIngestionDataSourceSettingsAwsKinesis

aws_kinesis block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#aws_kinesis PubsubTopic#aws_kinesis}

---

aws_msk^Optional

• Type: PubsubTopicIngestionDataSourceSettingsAwsMsk

aws_msk block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#aws_msk PubsubTopic#aws_msk}

---

azure_event_hubs^Optional

• Type: PubsubTopicIngestionDataSourceSettingsAzureEventHubs

azure_event_hubs block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#azure_event_hubs PubsubTopic#azure_event_hubs}

---

cloud_storage^Optional

• Type: PubsubTopicIngestionDataSourceSettingsCloudStorage

cloud_storage block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#cloud_storage PubsubTopic#cloud_storage}

---

confluent_cloud^Optional

• Type: PubsubTopicIngestionDataSourceSettingsConfluentCloud

confluent_cloud block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#confluent_cloud PubsubTopic#confluent_cloud}

---

platform_logs_settings^Optional

• Type: PubsubTopicIngestionDataSourceSettingsPlatformLogsSettings

platform_logs_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#platform_logs_settings PubsubTopic#platform_logs_settings}

---

put_message_storage_policy

def put_message_storage_policy(
  allowed_persistence_regions: typing.List[str],
  enforce_in_transit: typing.Union[bool, IResolvable] = None
) -> None

allowed_persistence_regions^Required

• Type: typing.List[str]

A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage.

Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#allowed_persistence_regions PubsubTopic#allowed_persistence_regions}

---

enforce_in_transit^Optional

• Type: typing.Union[bool, cdktf.IResolvable]

If true, 'allowedPersistenceRegions' is also used to enforce in-transit guarantees for messages.

That is, Pub/Sub will fail topics.publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in 'allowedPersistenceRegions'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#enforce_in_transit PubsubTopic#enforce_in_transit}

---

put_schema_settings

def put_schema_settings(
  schema: str,
  encoding: str = None
) -> None

schema^Required

• Type: str

The name of the schema that messages published should be validated against.

Format is projects/{project}/schemas/{schema}. The value of this field will be deleted-schema if the schema has been deleted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#schema PubsubTopic#schema}

---

encoding^Optional

• Type: str

The encoding of messages validated against schema. Default value: "ENCODING_UNSPECIFIED" Possible values: ["ENCODING_UNSPECIFIED", "JSON", "BINARY"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#encoding PubsubTopic#encoding}

---

put_timeouts

def put_timeouts(
  create: str = None,
  delete: str = None,
  update: str = None
) -> None

create^Optional

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#create PubsubTopic#create}.

---

delete^Optional

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#delete PubsubTopic#delete}.

---

update^Optional

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#update PubsubTopic#update}.

---

reset_id

def reset_id() -> None

reset_ingestion_data_source_settings

def reset_ingestion_data_source_settings() -> None

reset_kms_key_name

def reset_kms_key_name() -> None

reset_labels

def reset_labels() -> None

reset_message_retention_duration

def reset_message_retention_duration() -> None

reset_message_storage_policy

def reset_message_storage_policy() -> None

reset_project

def reset_project() -> None

reset_schema_settings

def reset_schema_settings() -> None

reset_timeouts

def reset_timeouts() -> 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 CDKTF code for importing a PubsubTopic resource upon running "cdktf plan ".

---

is_construct

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopic.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 cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopic.is_terraform_element(
  x: typing.Any
)

x^Required

• Type: typing.Any

---

is_terraform_resource

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopic.is_terraform_resource(
  x: typing.Any
)

x^Required

• Type: typing.Any

---

generate_config_for_import

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopic.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a PubsubTopic resource upon running "cdktf 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 PubsubTopic to import.

---

import_from_id^Required

• Type: str

The id of the existing PubsubTopic that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_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 PubsubTopic to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktf_stack	cdktf.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	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]	No description.
count	typing.Union[typing.Union[int, float], cdktf.TerraformCount]	No description.
depends_on	typing.List[str]	No description.
for_each	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]	No description.
effective_labels	cdktf.StringMap	No description.
ingestion_data_source_settings	PubsubTopicIngestionDataSourceSettingsOutputReference	No description.
message_storage_policy	PubsubTopicMessageStoragePolicyOutputReference	No description.
schema_settings	PubsubTopicSchemaSettingsOutputReference	No description.
terraform_labels	cdktf.StringMap	No description.
timeouts	PubsubTopicTimeoutsOutputReference	No description.
id_input	str	No description.
ingestion_data_source_settings_input	PubsubTopicIngestionDataSourceSettings	No description.
kms_key_name_input	str	No description.
labels_input	typing.Mapping[str]	No description.
message_retention_duration_input	str	No description.
message_storage_policy_input	PubsubTopicMessageStoragePolicy	No description.
name_input	str	No description.
project_input	str	No description.
schema_settings_input	PubsubTopicSchemaSettings	No description.
timeouts_input	typing.Union[cdktf.IResolvable, PubsubTopicTimeouts]	No description.
id	str	No description.
kms_key_name	str	No description.
labels	typing.Mapping[str]	No description.
message_retention_duration	str	No description.
name	str	No description.
project	str	No description.

---

node^Required

node: Node

• Type: constructs.Node

The tree node.

---

cdktf_stack^Required

cdktf_stack: TerraformStack

• Type: cdktf.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: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

• Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

---

count^Optional

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

• Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

---

depends_on^Optional

depends_on: typing.List[str]

• Type: typing.List[str]

---

for_each^Optional

for_each: ITerraformIterator

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

lifecycle: TerraformResourceLifecycle

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

provider: TerraformProvider

• Type: cdktf.TerraformProvider

---

provisioners^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

• Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

---

effective_labels^Required

effective_labels: StringMap

• Type: cdktf.StringMap

---

ingestion_data_source_settings^Required

ingestion_data_source_settings: PubsubTopicIngestionDataSourceSettingsOutputReference

• Type: PubsubTopicIngestionDataSourceSettingsOutputReference

---

message_storage_policy^Required

message_storage_policy: PubsubTopicMessageStoragePolicyOutputReference

• Type: PubsubTopicMessageStoragePolicyOutputReference

---

schema_settings^Required

schema_settings: PubsubTopicSchemaSettingsOutputReference

• Type: PubsubTopicSchemaSettingsOutputReference

---

terraform_labels^Required

terraform_labels: StringMap

• Type: cdktf.StringMap

---

timeouts^Required

timeouts: PubsubTopicTimeoutsOutputReference

• Type: PubsubTopicTimeoutsOutputReference

---

id_input^Optional

id_input: str

• Type: str

---

ingestion_data_source_settings_input^Optional

ingestion_data_source_settings_input: PubsubTopicIngestionDataSourceSettings

• Type: PubsubTopicIngestionDataSourceSettings

---

kms_key_name_input^Optional

kms_key_name_input: str

• Type: str

---

labels_input^Optional

labels_input: typing.Mapping[str]

• Type: typing.Mapping[str]

---

message_retention_duration_input^Optional

message_retention_duration_input: str

• Type: str

---

message_storage_policy_input^Optional

message_storage_policy_input: PubsubTopicMessageStoragePolicy

• Type: PubsubTopicMessageStoragePolicy

---

name_input^Optional

name_input: str

• Type: str

---

project_input^Optional

project_input: str

• Type: str

---

schema_settings_input^Optional

schema_settings_input: PubsubTopicSchemaSettings

• Type: PubsubTopicSchemaSettings

---

timeouts_input^Optional

timeouts_input: typing.Union[IResolvable, PubsubTopicTimeouts]

• Type: typing.Union[cdktf.IResolvable, PubsubTopicTimeouts]

---

id^Required

id: str

• Type: str

---

kms_key_name^Required

kms_key_name: str

• Type: str

---

labels^Required

labels: typing.Mapping[str]

• Type: typing.Mapping[str]

---

message_retention_duration^Required

message_retention_duration: str

• Type: str

---

name^Required

name: str

• Type: str

---

project^Required

project: str

• Type: str

---

Constants

Name	Type	Description
tfResourceType	str	No description.

---

tfResourceType^Required

tfResourceType: str

• Type: str

---

Structs

PubsubTopicConfig

Initializer

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[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[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  id: str = None,
  ingestion_data_source_settings: PubsubTopicIngestionDataSourceSettings = None,
  kms_key_name: str = None,
  labels: typing.Mapping[str] = None,
  message_retention_duration: str = None,
  message_storage_policy: PubsubTopicMessageStoragePolicy = None,
  project: str = None,
  schema_settings: PubsubTopicSchemaSettings = None,
  timeouts: PubsubTopicTimeouts = None
)

Properties

Name	Type	Description
connection	typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]	No description.
count	typing.Union[typing.Union[int, float], cdktf.TerraformCount]	No description.
depends_on	typing.List[cdktf.ITerraformDependable]	No description.
for_each	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]	No description.
name	str	Name of the topic.
id	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#id PubsubTopic#id}.
ingestion_data_source_settings	PubsubTopicIngestionDataSourceSettings	ingestion_data_source_settings block.
kms_key_name	str	The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.
labels	typing.Mapping[str]	A set of key/value label pairs to assign to this Topic.
message_retention_duration	str	Indicates the minimum duration to retain a message after it is published to the topic.
message_storage_policy	PubsubTopicMessageStoragePolicy	message_storage_policy block.
project	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#project PubsubTopic#project}.
schema_settings	PubsubTopicSchemaSettings	schema_settings block.
timeouts	PubsubTopicTimeouts	timeouts block.

---

connection^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

• Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

---

count^Optional

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

• Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

---

depends_on^Optional

depends_on: typing.List[ITerraformDependable]

• Type: typing.List[cdktf.ITerraformDependable]

---

for_each^Optional

for_each: ITerraformIterator

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

lifecycle: TerraformResourceLifecycle

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

provider: TerraformProvider

• Type: cdktf.TerraformProvider

---

provisioners^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

• Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

---

name^Required

name: str

• Type: str

Name of the topic.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#name PubsubTopic#name}

---

id^Optional

id: str

• Type: str

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

---

ingestion_data_source_settings^Optional

ingestion_data_source_settings: PubsubTopicIngestionDataSourceSettings

• Type: PubsubTopicIngestionDataSourceSettings

ingestion_data_source_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#ingestion_data_source_settings PubsubTopic#ingestion_data_source_settings}

---

kms_key_name^Optional

kms_key_name: str

• Type: str

The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.

Your project's PubSub service account ('service-{{PROJECT_NUMBER}}@gcp-sa-pubsub.iam.gserviceaccount.com') must have 'roles/cloudkms.cryptoKeyEncrypterDecrypter' to use this feature. The expected format is 'projects/* /locations/* /keyRings/* /cryptoKeys/*'

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#kms_key_name PubsubTopic#kms_key_name}

Note: The above comment contained a comment block ending sequence (* followed by /). We have introduced a space between to prevent syntax errors. Please ignore the space.

---

labels^Optional

labels: typing.Mapping[str]

• Type: typing.Mapping[str]

A set of key/value label pairs to assign to this Topic.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#labels PubsubTopic#labels}

---

message_retention_duration^Optional

message_retention_duration: str

• Type: str

Indicates the minimum duration to retain a message after it is published to the topic.

If this field is set, messages published to the topic in the last messageRetentionDuration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to messageRetentionDuration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. The rotation period has the format of a decimal number, followed by the letter 's' (seconds). Cannot be more than 31 days or less than 10 minutes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#message_retention_duration PubsubTopic#message_retention_duration}

---

message_storage_policy^Optional

message_storage_policy: PubsubTopicMessageStoragePolicy

• Type: PubsubTopicMessageStoragePolicy

message_storage_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#message_storage_policy PubsubTopic#message_storage_policy}

---

project^Optional

project: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#project PubsubTopic#project}.

---

schema_settings^Optional

schema_settings: PubsubTopicSchemaSettings

• Type: PubsubTopicSchemaSettings

schema_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#schema_settings PubsubTopic#schema_settings}

---

timeouts^Optional

timeouts: PubsubTopicTimeouts

• Type: PubsubTopicTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#timeouts PubsubTopic#timeouts}

---

PubsubTopicIngestionDataSourceSettings

Initializer

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettings(
  aws_kinesis: PubsubTopicIngestionDataSourceSettingsAwsKinesis = None,
  aws_msk: PubsubTopicIngestionDataSourceSettingsAwsMsk = None,
  azure_event_hubs: PubsubTopicIngestionDataSourceSettingsAzureEventHubs = None,
  cloud_storage: PubsubTopicIngestionDataSourceSettingsCloudStorage = None,
  confluent_cloud: PubsubTopicIngestionDataSourceSettingsConfluentCloud = None,
  platform_logs_settings: PubsubTopicIngestionDataSourceSettingsPlatformLogsSettings = None
)

Properties

Name	Type	Description
aws_kinesis	PubsubTopicIngestionDataSourceSettingsAwsKinesis	aws_kinesis block.
aws_msk	PubsubTopicIngestionDataSourceSettingsAwsMsk	aws_msk block.
azure_event_hubs	PubsubTopicIngestionDataSourceSettingsAzureEventHubs	azure_event_hubs block.
cloud_storage	PubsubTopicIngestionDataSourceSettingsCloudStorage	cloud_storage block.
confluent_cloud	PubsubTopicIngestionDataSourceSettingsConfluentCloud	confluent_cloud block.
platform_logs_settings	PubsubTopicIngestionDataSourceSettingsPlatformLogsSettings	platform_logs_settings block.

---

aws_kinesis^Optional

aws_kinesis: PubsubTopicIngestionDataSourceSettingsAwsKinesis

• Type: PubsubTopicIngestionDataSourceSettingsAwsKinesis

aws_kinesis block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#aws_kinesis PubsubTopic#aws_kinesis}

---

aws_msk^Optional

aws_msk: PubsubTopicIngestionDataSourceSettingsAwsMsk

• Type: PubsubTopicIngestionDataSourceSettingsAwsMsk

aws_msk block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#aws_msk PubsubTopic#aws_msk}

---

azure_event_hubs^Optional

azure_event_hubs: PubsubTopicIngestionDataSourceSettingsAzureEventHubs

• Type: PubsubTopicIngestionDataSourceSettingsAzureEventHubs

azure_event_hubs block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#azure_event_hubs PubsubTopic#azure_event_hubs}

---

cloud_storage^Optional

cloud_storage: PubsubTopicIngestionDataSourceSettingsCloudStorage

• Type: PubsubTopicIngestionDataSourceSettingsCloudStorage

cloud_storage block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#cloud_storage PubsubTopic#cloud_storage}

---

confluent_cloud^Optional

confluent_cloud: PubsubTopicIngestionDataSourceSettingsConfluentCloud

• Type: PubsubTopicIngestionDataSourceSettingsConfluentCloud

confluent_cloud block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#confluent_cloud PubsubTopic#confluent_cloud}

---

platform_logs_settings^Optional

platform_logs_settings: PubsubTopicIngestionDataSourceSettingsPlatformLogsSettings

• Type: PubsubTopicIngestionDataSourceSettingsPlatformLogsSettings

platform_logs_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#platform_logs_settings PubsubTopic#platform_logs_settings}

---

PubsubTopicIngestionDataSourceSettingsAwsKinesis

Initializer

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettingsAwsKinesis(
  aws_role_arn: str,
  consumer_arn: str,
  gcp_service_account: str,
  stream_arn: str
)

Properties

Name	Type	Description
aws_role_arn	str	AWS role ARN to be used for Federated Identity authentication with Kinesis.
consumer_arn	str	The Kinesis consumer ARN to used for ingestion in Enhanced Fan-Out mode.
gcp_service_account	str	The GCP service account to be used for Federated Identity authentication with Kinesis (via a 'AssumeRoleWithWebIdentity' call for the provided role).
stream_arn	str	The Kinesis stream ARN to ingest data from.

---

aws_role_arn^Required

aws_role_arn: str

• Type: str

AWS role ARN to be used for Federated Identity authentication with Kinesis.

Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#aws_role_arn PubsubTopic#aws_role_arn}

---

consumer_arn^Required

consumer_arn: str

• Type: str

The Kinesis consumer ARN to used for ingestion in Enhanced Fan-Out mode.

The consumer must be already created and ready to be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#consumer_arn PubsubTopic#consumer_arn}

---

gcp_service_account^Required

gcp_service_account: str

• Type: str

The GCP service account to be used for Federated Identity authentication with Kinesis (via a 'AssumeRoleWithWebIdentity' call for the provided role).

The 'awsRoleArn' must be set up with 'accounts.google.com:sub' equals to this service account number.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#gcp_service_account PubsubTopic#gcp_service_account}

---

stream_arn^Required

stream_arn: str

• Type: str

The Kinesis stream ARN to ingest data from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#stream_arn PubsubTopic#stream_arn}

---

PubsubTopicIngestionDataSourceSettingsAwsMsk

Initializer

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettingsAwsMsk(
  aws_role_arn: str,
  cluster_arn: str,
  gcp_service_account: str,
  topic: str
)

Properties

Name	Type	Description
aws_role_arn	str	AWS role ARN to be used for Federated Identity authentication with MSK.
cluster_arn	str	ARN that uniquely identifies the MSK cluster.
gcp_service_account	str	The GCP service account to be used for Federated Identity authentication with MSK (via a 'AssumeRoleWithWebIdentity' call for the provided role).
topic	str	The name of the MSK topic that Pub/Sub will import from.

---

aws_role_arn^Required

aws_role_arn: str

• Type: str

AWS role ARN to be used for Federated Identity authentication with MSK.

Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#aws_role_arn PubsubTopic#aws_role_arn}

---

cluster_arn^Required

cluster_arn: str

• Type: str

ARN that uniquely identifies the MSK cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#cluster_arn PubsubTopic#cluster_arn}

---

gcp_service_account^Required

gcp_service_account: str

• Type: str

The GCP service account to be used for Federated Identity authentication with MSK (via a 'AssumeRoleWithWebIdentity' call for the provided role).

The 'awsRoleArn' must be set up with 'accounts.google.com:sub' equals to this service account number.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#gcp_service_account PubsubTopic#gcp_service_account}

---

topic^Required

topic: str

• Type: str

The name of the MSK topic that Pub/Sub will import from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#topic PubsubTopic#topic}

---

PubsubTopicIngestionDataSourceSettingsAzureEventHubs

Initializer

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettingsAzureEventHubs(
  client_id: str = None,
  event_hub: str = None,
  gcp_service_account: str = None,
  namespace: str = None,
  resource_group: str = None,
  subscription_id: str = None,
  tenant_id: str = None
)

Properties

Name	Type	Description
client_id	str	The Azure event hub client ID to use for ingestion.
event_hub	str	The Azure event hub to ingest data from.
gcp_service_account	str	The GCP service account to be used for Federated Identity authentication with Azure (via a 'AssumeRoleWithWebIdentity' call for the provided role).
namespace	str	The Azure event hub namespace to ingest data from.
resource_group	str	The name of the resource group within an Azure subscription.
subscription_id	str	The Azure event hub subscription ID to use for ingestion.
tenant_id	str	The Azure event hub tenant ID to use for ingestion.

---

client_id^Optional

client_id: str

• Type: str

The Azure event hub client ID to use for ingestion.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#client_id PubsubTopic#client_id}

---

event_hub^Optional

event_hub: str

• Type: str

The Azure event hub to ingest data from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#event_hub PubsubTopic#event_hub}

---

gcp_service_account^Optional

gcp_service_account: str

• Type: str

The GCP service account to be used for Federated Identity authentication with Azure (via a 'AssumeRoleWithWebIdentity' call for the provided role).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#gcp_service_account PubsubTopic#gcp_service_account}

---

namespace^Optional

namespace: str

• Type: str

The Azure event hub namespace to ingest data from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#namespace PubsubTopic#namespace}

---

resource_group^Optional

resource_group: str

• Type: str

The name of the resource group within an Azure subscription.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#resource_group PubsubTopic#resource_group}

---

subscription_id^Optional

subscription_id: str

• Type: str

The Azure event hub subscription ID to use for ingestion.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#subscription_id PubsubTopic#subscription_id}

---

tenant_id^Optional

tenant_id: str

• Type: str

The Azure event hub tenant ID to use for ingestion.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#tenant_id PubsubTopic#tenant_id}

---

PubsubTopicIngestionDataSourceSettingsCloudStorage

Initializer

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettingsCloudStorage(
  bucket: str,
  avro_format: PubsubTopicIngestionDataSourceSettingsCloudStorageAvroFormat = None,
  match_glob: str = None,
  minimum_object_create_time: str = None,
  pubsub_avro_format: PubsubTopicIngestionDataSourceSettingsCloudStoragePubsubAvroFormat = None,
  text_format: PubsubTopicIngestionDataSourceSettingsCloudStorageTextFormat = None
)

Properties

Name	Type	Description
bucket	str	Cloud Storage bucket. The bucket name must be without any prefix like "gs://". See the bucket naming requirements: https://cloud.google.com/storage/docs/buckets#naming.
avro_format	PubsubTopicIngestionDataSourceSettingsCloudStorageAvroFormat	avro_format block.
match_glob	str	Glob pattern used to match objects that will be ingested.
minimum_object_create_time	str	The timestamp set in RFC3339 text format.
pubsub_avro_format	PubsubTopicIngestionDataSourceSettingsCloudStoragePubsubAvroFormat	pubsub_avro_format block.
text_format	PubsubTopicIngestionDataSourceSettingsCloudStorageTextFormat	text_format block.

---

bucket^Required

bucket: str

• Type: str

Cloud Storage bucket. The bucket name must be without any prefix like "gs://". See the bucket naming requirements: https://cloud.google.com/storage/docs/buckets#naming.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#bucket PubsubTopic#bucket}

---

avro_format^Optional

avro_format: PubsubTopicIngestionDataSourceSettingsCloudStorageAvroFormat

• Type: PubsubTopicIngestionDataSourceSettingsCloudStorageAvroFormat

avro_format block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#avro_format PubsubTopic#avro_format}

---

match_glob^Optional

match_glob: str

• Type: str

Glob pattern used to match objects that will be ingested.

If unset, all objects will be ingested. See the supported patterns: https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-prefixes-using-glob

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#match_glob PubsubTopic#match_glob}

---

minimum_object_create_time^Optional

minimum_object_create_time: str

• Type: str

The timestamp set in RFC3339 text format.

If set, only objects with a larger or equal timestamp will be ingested. Unset by default, meaning all objects will be ingested.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#minimum_object_create_time PubsubTopic#minimum_object_create_time}

---

pubsub_avro_format^Optional

pubsub_avro_format: PubsubTopicIngestionDataSourceSettingsCloudStoragePubsubAvroFormat

• Type: PubsubTopicIngestionDataSourceSettingsCloudStoragePubsubAvroFormat

pubsub_avro_format block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#pubsub_avro_format PubsubTopic#pubsub_avro_format}

---

text_format^Optional

text_format: PubsubTopicIngestionDataSourceSettingsCloudStorageTextFormat

• Type: PubsubTopicIngestionDataSourceSettingsCloudStorageTextFormat

text_format block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#text_format PubsubTopic#text_format}

---

PubsubTopicIngestionDataSourceSettingsCloudStorageAvroFormat

Initializer

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettingsCloudStorageAvroFormat()

PubsubTopicIngestionDataSourceSettingsCloudStoragePubsubAvroFormat

Initializer

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettingsCloudStoragePubsubAvroFormat()

PubsubTopicIngestionDataSourceSettingsCloudStorageTextFormat

Initializer

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettingsCloudStorageTextFormat(
  delimiter: str = None
)

Properties

Name	Type	Description
delimiter	str	The delimiter to use when using the 'text' format.

---

delimiter^Optional

delimiter: str

• Type: str

The delimiter to use when using the 'text' format.

Each line of text as specified by the delimiter will be set to the 'data' field of a Pub/Sub message. When unset, '\n' is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#delimiter PubsubTopic#delimiter}

---

PubsubTopicIngestionDataSourceSettingsConfluentCloud

Initializer

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettingsConfluentCloud(
  bootstrap_server: str,
  gcp_service_account: str,
  identity_pool_id: str,
  topic: str,
  cluster_id: str = None
)

Properties

Name	Type	Description
bootstrap_server	str	The Confluent Cloud bootstrap server. The format is url:port.
gcp_service_account	str	The GCP service account to be used for Federated Identity authentication with Confluent Cloud.
identity_pool_id	str	Identity pool ID to be used for Federated Identity authentication with Confluent Cloud.
topic	str	Name of the Confluent Cloud topic that Pub/Sub will import from.
cluster_id	str	The Confluent Cloud cluster ID.

---

bootstrap_server^Required

bootstrap_server: str

• Type: str

The Confluent Cloud bootstrap server. The format is url:port.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#bootstrap_server PubsubTopic#bootstrap_server}

---

gcp_service_account^Required

gcp_service_account: str

• Type: str

The GCP service account to be used for Federated Identity authentication with Confluent Cloud.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#gcp_service_account PubsubTopic#gcp_service_account}

---

identity_pool_id^Required

identity_pool_id: str

• Type: str

Identity pool ID to be used for Federated Identity authentication with Confluent Cloud.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#identity_pool_id PubsubTopic#identity_pool_id}

---

topic^Required

topic: str

• Type: str

Name of the Confluent Cloud topic that Pub/Sub will import from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#topic PubsubTopic#topic}

---

cluster_id^Optional

cluster_id: str

• Type: str

The Confluent Cloud cluster ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#cluster_id PubsubTopic#cluster_id}

---

PubsubTopicIngestionDataSourceSettingsPlatformLogsSettings

Initializer

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettingsPlatformLogsSettings(
  severity: str = None
)

Properties

Name	Type	Description
severity	str	The minimum severity level of Platform Logs that will be written.

---

severity^Optional

severity: str

• Type: str

The minimum severity level of Platform Logs that will be written.

If unspecified, no Platform Logs will be written. Default value: "SEVERITY_UNSPECIFIED" Possible values: ["SEVERITY_UNSPECIFIED", "DISABLED", "DEBUG", "INFO", "WARNING", "ERROR"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#severity PubsubTopic#severity}

---

PubsubTopicMessageStoragePolicy

Initializer

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicMessageStoragePolicy(
  allowed_persistence_regions: typing.List[str],
  enforce_in_transit: typing.Union[bool, IResolvable] = None
)

Properties

Name	Type	Description
allowed_persistence_regions	typing.List[str]	A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage.
enforce_in_transit	typing.Union[bool, cdktf.IResolvable]	If true, 'allowedPersistenceRegions' is also used to enforce in-transit guarantees for messages.

---

allowed_persistence_regions^Required

allowed_persistence_regions: typing.List[str]

• Type: typing.List[str]

A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage.

Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#allowed_persistence_regions PubsubTopic#allowed_persistence_regions}

---

enforce_in_transit^Optional

enforce_in_transit: typing.Union[bool, IResolvable]

• Type: typing.Union[bool, cdktf.IResolvable]

If true, 'allowedPersistenceRegions' is also used to enforce in-transit guarantees for messages.

That is, Pub/Sub will fail topics.publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in 'allowedPersistenceRegions'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#enforce_in_transit PubsubTopic#enforce_in_transit}

---

PubsubTopicSchemaSettings

Initializer

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicSchemaSettings(
  schema: str,
  encoding: str = None
)

Properties

Name	Type	Description
schema	str	The name of the schema that messages published should be validated against.
encoding	str	The encoding of messages validated against schema. Default value: "ENCODING_UNSPECIFIED" Possible values: ["ENCODING_UNSPECIFIED", "JSON", "BINARY"].

---

schema^Required

schema: str

• Type: str

The name of the schema that messages published should be validated against.

Format is projects/{project}/schemas/{schema}. The value of this field will be deleted-schema if the schema has been deleted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#schema PubsubTopic#schema}

---

encoding^Optional

encoding: str

• Type: str

The encoding of messages validated against schema. Default value: "ENCODING_UNSPECIFIED" Possible values: ["ENCODING_UNSPECIFIED", "JSON", "BINARY"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#encoding PubsubTopic#encoding}

---

PubsubTopicTimeouts

Initializer

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicTimeouts(
  create: str = None,
  delete: str = None,
  update: str = None
)

Properties

Name	Type	Description
create	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#create PubsubTopic#create}.
delete	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#delete PubsubTopic#delete}.
update	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#update PubsubTopic#update}.

---

create^Optional

create: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#create PubsubTopic#create}.

---

delete^Optional

delete: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#delete PubsubTopic#delete}.

---

update^Optional

update: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#update PubsubTopic#update}.

---

Classes

PubsubTopicIngestionDataSourceSettingsAwsKinesisOutputReference

Initializers

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettingsAwsKinesisOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

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

---

terraform_resource^Required

• Type: cdktf.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.

---

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: cdktf.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

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.
aws_role_arn_input	str	No description.
consumer_arn_input	str	No description.
gcp_service_account_input	str	No description.
stream_arn_input	str	No description.
aws_role_arn	str	No description.
consumer_arn	str	No description.
gcp_service_account	str	No description.
stream_arn	str	No description.
internal_value	PubsubTopicIngestionDataSourceSettingsAwsKinesis	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

---

aws_role_arn_input^Optional

aws_role_arn_input: str

• Type: str

---

consumer_arn_input^Optional

consumer_arn_input: str

• Type: str

---

gcp_service_account_input^Optional

gcp_service_account_input: str

• Type: str

---

stream_arn_input^Optional

stream_arn_input: str

• Type: str

---

aws_role_arn^Required

aws_role_arn: str

• Type: str

---

consumer_arn^Required

consumer_arn: str

• Type: str

---

gcp_service_account^Required

gcp_service_account: str

• Type: str

---

stream_arn^Required

stream_arn: str

• Type: str

---

internal_value^Optional

internal_value: PubsubTopicIngestionDataSourceSettingsAwsKinesis

• Type: PubsubTopicIngestionDataSourceSettingsAwsKinesis

---

PubsubTopicIngestionDataSourceSettingsAwsMskOutputReference

Initializers

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettingsAwsMskOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

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

---

terraform_resource^Required

• Type: cdktf.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.

---

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: cdktf.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

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.
aws_role_arn_input	str	No description.
cluster_arn_input	str	No description.
gcp_service_account_input	str	No description.
topic_input	str	No description.
aws_role_arn	str	No description.
cluster_arn	str	No description.
gcp_service_account	str	No description.
topic	str	No description.
internal_value	PubsubTopicIngestionDataSourceSettingsAwsMsk	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

---

aws_role_arn_input^Optional

aws_role_arn_input: str

• Type: str

---

cluster_arn_input^Optional

cluster_arn_input: str

• Type: str

---

gcp_service_account_input^Optional

gcp_service_account_input: str

• Type: str

---

topic_input^Optional

topic_input: str

• Type: str

---

aws_role_arn^Required

aws_role_arn: str

• Type: str

---

cluster_arn^Required

cluster_arn: str

• Type: str

---

gcp_service_account^Required

gcp_service_account: str

• Type: str

---

topic^Required

topic: str

• Type: str

---

internal_value^Optional

internal_value: PubsubTopicIngestionDataSourceSettingsAwsMsk

• Type: PubsubTopicIngestionDataSourceSettingsAwsMsk

---

PubsubTopicIngestionDataSourceSettingsAzureEventHubsOutputReference

Initializers

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettingsAzureEventHubsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

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

---

terraform_resource^Required

• Type: cdktf.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_client_id	No description.
reset_event_hub	No description.
reset_gcp_service_account	No description.
reset_namespace	No description.
reset_resource_group	No description.
reset_subscription_id	No description.
reset_tenant_id	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: cdktf.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_client_id

def reset_client_id() -> None

reset_event_hub

def reset_event_hub() -> None

reset_gcp_service_account

def reset_gcp_service_account() -> None

reset_namespace

def reset_namespace() -> None

reset_resource_group

def reset_resource_group() -> None

reset_subscription_id

def reset_subscription_id() -> None

reset_tenant_id

def reset_tenant_id() -> 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.
client_id_input	str	No description.
event_hub_input	str	No description.
gcp_service_account_input	str	No description.
namespace_input	str	No description.
resource_group_input	str	No description.
subscription_id_input	str	No description.
tenant_id_input	str	No description.
client_id	str	No description.
event_hub	str	No description.
gcp_service_account	str	No description.
namespace	str	No description.
resource_group	str	No description.
subscription_id	str	No description.
tenant_id	str	No description.
internal_value	PubsubTopicIngestionDataSourceSettingsAzureEventHubs	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

---

client_id_input^Optional

client_id_input: str

• Type: str

---

event_hub_input^Optional

event_hub_input: str

• Type: str

---

gcp_service_account_input^Optional

gcp_service_account_input: str

• Type: str

---

namespace_input^Optional

namespace_input: str

• Type: str

---

resource_group_input^Optional

resource_group_input: str

• Type: str

---

subscription_id_input^Optional

subscription_id_input: str

• Type: str

---

tenant_id_input^Optional

tenant_id_input: str

• Type: str

---

client_id^Required

client_id: str

• Type: str

---

event_hub^Required

event_hub: str

• Type: str

---

gcp_service_account^Required

gcp_service_account: str

• Type: str

---

namespace^Required

namespace: str

• Type: str

---

resource_group^Required

resource_group: str

• Type: str

---

subscription_id^Required

subscription_id: str

• Type: str

---

tenant_id^Required

tenant_id: str

• Type: str

---

internal_value^Optional

internal_value: PubsubTopicIngestionDataSourceSettingsAzureEventHubs

• Type: PubsubTopicIngestionDataSourceSettingsAzureEventHubs

---

PubsubTopicIngestionDataSourceSettingsCloudStorageAvroFormatOutputReference

Initializers

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettingsCloudStorageAvroFormatOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

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

---

terraform_resource^Required

• Type: cdktf.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.

---

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: cdktf.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

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.
internal_value	PubsubTopicIngestionDataSourceSettingsCloudStorageAvroFormat	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

---

internal_value^Optional

internal_value: PubsubTopicIngestionDataSourceSettingsCloudStorageAvroFormat

• Type: PubsubTopicIngestionDataSourceSettingsCloudStorageAvroFormat

---

PubsubTopicIngestionDataSourceSettingsCloudStorageOutputReference

Initializers

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettingsCloudStorageOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

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

---

terraform_resource^Required

• Type: cdktf.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.
put_avro_format	No description.
put_pubsub_avro_format	No description.
put_text_format	No description.
reset_avro_format	No description.
reset_match_glob	No description.
reset_minimum_object_create_time	No description.
reset_pubsub_avro_format	No description.
reset_text_format	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: cdktf.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

put_avro_format

def put_avro_format() -> None

put_pubsub_avro_format

def put_pubsub_avro_format() -> None

put_text_format

def put_text_format(
  delimiter: str = None
) -> None

delimiter^Optional

• Type: str

The delimiter to use when using the 'text' format.

Each line of text as specified by the delimiter will be set to the 'data' field of a Pub/Sub message. When unset, '\n' is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#delimiter PubsubTopic#delimiter}

---

reset_avro_format

def reset_avro_format() -> None

reset_match_glob

def reset_match_glob() -> None

reset_minimum_object_create_time

def reset_minimum_object_create_time() -> None

reset_pubsub_avro_format

def reset_pubsub_avro_format() -> None

reset_text_format

def reset_text_format() -> 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.
avro_format	PubsubTopicIngestionDataSourceSettingsCloudStorageAvroFormatOutputReference	No description.
pubsub_avro_format	PubsubTopicIngestionDataSourceSettingsCloudStoragePubsubAvroFormatOutputReference	No description.
text_format	PubsubTopicIngestionDataSourceSettingsCloudStorageTextFormatOutputReference	No description.
avro_format_input	PubsubTopicIngestionDataSourceSettingsCloudStorageAvroFormat	No description.
bucket_input	str	No description.
match_glob_input	str	No description.
minimum_object_create_time_input	str	No description.
pubsub_avro_format_input	PubsubTopicIngestionDataSourceSettingsCloudStoragePubsubAvroFormat	No description.
text_format_input	PubsubTopicIngestionDataSourceSettingsCloudStorageTextFormat	No description.
bucket	str	No description.
match_glob	str	No description.
minimum_object_create_time	str	No description.
internal_value	PubsubTopicIngestionDataSourceSettingsCloudStorage	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

---

avro_format^Required

avro_format: PubsubTopicIngestionDataSourceSettingsCloudStorageAvroFormatOutputReference

• Type: PubsubTopicIngestionDataSourceSettingsCloudStorageAvroFormatOutputReference

---

pubsub_avro_format^Required

pubsub_avro_format: PubsubTopicIngestionDataSourceSettingsCloudStoragePubsubAvroFormatOutputReference

• Type: PubsubTopicIngestionDataSourceSettingsCloudStoragePubsubAvroFormatOutputReference

---

text_format^Required

text_format: PubsubTopicIngestionDataSourceSettingsCloudStorageTextFormatOutputReference

• Type: PubsubTopicIngestionDataSourceSettingsCloudStorageTextFormatOutputReference

---

avro_format_input^Optional

avro_format_input: PubsubTopicIngestionDataSourceSettingsCloudStorageAvroFormat

• Type: PubsubTopicIngestionDataSourceSettingsCloudStorageAvroFormat

---

bucket_input^Optional

bucket_input: str

• Type: str

---

match_glob_input^Optional

match_glob_input: str

• Type: str

---

minimum_object_create_time_input^Optional

minimum_object_create_time_input: str

• Type: str

---

pubsub_avro_format_input^Optional

pubsub_avro_format_input: PubsubTopicIngestionDataSourceSettingsCloudStoragePubsubAvroFormat

• Type: PubsubTopicIngestionDataSourceSettingsCloudStoragePubsubAvroFormat

---

text_format_input^Optional

text_format_input: PubsubTopicIngestionDataSourceSettingsCloudStorageTextFormat

• Type: PubsubTopicIngestionDataSourceSettingsCloudStorageTextFormat

---

bucket^Required

bucket: str

• Type: str

---

match_glob^Required

match_glob: str

• Type: str

---

minimum_object_create_time^Required

minimum_object_create_time: str

• Type: str

---

internal_value^Optional

internal_value: PubsubTopicIngestionDataSourceSettingsCloudStorage

• Type: PubsubTopicIngestionDataSourceSettingsCloudStorage

---

PubsubTopicIngestionDataSourceSettingsCloudStoragePubsubAvroFormatOutputReference

Initializers

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettingsCloudStoragePubsubAvroFormatOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

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

---

terraform_resource^Required

• Type: cdktf.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.

---

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: cdktf.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

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.
internal_value	PubsubTopicIngestionDataSourceSettingsCloudStoragePubsubAvroFormat	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

---

internal_value^Optional

internal_value: PubsubTopicIngestionDataSourceSettingsCloudStoragePubsubAvroFormat

• Type: PubsubTopicIngestionDataSourceSettingsCloudStoragePubsubAvroFormat

---

PubsubTopicIngestionDataSourceSettingsCloudStorageTextFormatOutputReference

Initializers

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettingsCloudStorageTextFormatOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

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

---

terraform_resource^Required

• Type: cdktf.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_delimiter	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: cdktf.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_delimiter

def reset_delimiter() -> 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.
delimiter_input	str	No description.
delimiter	str	No description.
internal_value	PubsubTopicIngestionDataSourceSettingsCloudStorageTextFormat	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

---

delimiter_input^Optional

delimiter_input: str

• Type: str

---

delimiter^Required

delimiter: str

• Type: str

---

internal_value^Optional

internal_value: PubsubTopicIngestionDataSourceSettingsCloudStorageTextFormat

• Type: PubsubTopicIngestionDataSourceSettingsCloudStorageTextFormat

---

PubsubTopicIngestionDataSourceSettingsConfluentCloudOutputReference

Initializers

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettingsConfluentCloudOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

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

---

terraform_resource^Required

• Type: cdktf.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_cluster_id	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: cdktf.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_cluster_id

def reset_cluster_id() -> 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.
bootstrap_server_input	str	No description.
cluster_id_input	str	No description.
gcp_service_account_input	str	No description.
identity_pool_id_input	str	No description.
topic_input	str	No description.
bootstrap_server	str	No description.
cluster_id	str	No description.
gcp_service_account	str	No description.
identity_pool_id	str	No description.
topic	str	No description.
internal_value	PubsubTopicIngestionDataSourceSettingsConfluentCloud	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

---

bootstrap_server_input^Optional

bootstrap_server_input: str

• Type: str

---

cluster_id_input^Optional

cluster_id_input: str

• Type: str

---

gcp_service_account_input^Optional

gcp_service_account_input: str

• Type: str

---

identity_pool_id_input^Optional

identity_pool_id_input: str

• Type: str

---

topic_input^Optional

topic_input: str

• Type: str

---

bootstrap_server^Required

bootstrap_server: str

• Type: str

---

cluster_id^Required

cluster_id: str

• Type: str

---

gcp_service_account^Required

gcp_service_account: str

• Type: str

---

identity_pool_id^Required

identity_pool_id: str

• Type: str

---

topic^Required

topic: str

• Type: str

---

internal_value^Optional

internal_value: PubsubTopicIngestionDataSourceSettingsConfluentCloud

• Type: PubsubTopicIngestionDataSourceSettingsConfluentCloud

---

PubsubTopicIngestionDataSourceSettingsOutputReference

Initializers

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettingsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

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

---

terraform_resource^Required

• Type: cdktf.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.
put_aws_kinesis	No description.
put_aws_msk	No description.
put_azure_event_hubs	No description.
put_cloud_storage	No description.
put_confluent_cloud	No description.
put_platform_logs_settings	No description.
reset_aws_kinesis	No description.
reset_aws_msk	No description.
reset_azure_event_hubs	No description.
reset_cloud_storage	No description.
reset_confluent_cloud	No description.
reset_platform_logs_settings	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: cdktf.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

put_aws_kinesis

def put_aws_kinesis(
  aws_role_arn: str,
  consumer_arn: str,
  gcp_service_account: str,
  stream_arn: str
) -> None

aws_role_arn^Required

• Type: str

AWS role ARN to be used for Federated Identity authentication with Kinesis.

Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#aws_role_arn PubsubTopic#aws_role_arn}

---

consumer_arn^Required

• Type: str

The Kinesis consumer ARN to used for ingestion in Enhanced Fan-Out mode.

The consumer must be already created and ready to be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#consumer_arn PubsubTopic#consumer_arn}

---

gcp_service_account^Required

• Type: str

The GCP service account to be used for Federated Identity authentication with Kinesis (via a 'AssumeRoleWithWebIdentity' call for the provided role).

The 'awsRoleArn' must be set up with 'accounts.google.com:sub' equals to this service account number.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#gcp_service_account PubsubTopic#gcp_service_account}

---

stream_arn^Required

• Type: str

The Kinesis stream ARN to ingest data from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#stream_arn PubsubTopic#stream_arn}

---

put_aws_msk

def put_aws_msk(
  aws_role_arn: str,
  cluster_arn: str,
  gcp_service_account: str,
  topic: str
) -> None

aws_role_arn^Required

• Type: str

AWS role ARN to be used for Federated Identity authentication with MSK.

Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#aws_role_arn PubsubTopic#aws_role_arn}

---

cluster_arn^Required

• Type: str

ARN that uniquely identifies the MSK cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#cluster_arn PubsubTopic#cluster_arn}

---

gcp_service_account^Required

• Type: str

The GCP service account to be used for Federated Identity authentication with MSK (via a 'AssumeRoleWithWebIdentity' call for the provided role).

The 'awsRoleArn' must be set up with 'accounts.google.com:sub' equals to this service account number.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#gcp_service_account PubsubTopic#gcp_service_account}

---

topic^Required

• Type: str

The name of the MSK topic that Pub/Sub will import from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#topic PubsubTopic#topic}

---

put_azure_event_hubs

def put_azure_event_hubs(
  client_id: str = None,
  event_hub: str = None,
  gcp_service_account: str = None,
  namespace: str = None,
  resource_group: str = None,
  subscription_id: str = None,
  tenant_id: str = None
) -> None

client_id^Optional

• Type: str

The Azure event hub client ID to use for ingestion.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#client_id PubsubTopic#client_id}

---

event_hub^Optional

• Type: str

The Azure event hub to ingest data from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#event_hub PubsubTopic#event_hub}

---

gcp_service_account^Optional

• Type: str

The GCP service account to be used for Federated Identity authentication with Azure (via a 'AssumeRoleWithWebIdentity' call for the provided role).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#gcp_service_account PubsubTopic#gcp_service_account}

---

namespace^Optional

• Type: str

The Azure event hub namespace to ingest data from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#namespace PubsubTopic#namespace}

---

resource_group^Optional

• Type: str

The name of the resource group within an Azure subscription.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#resource_group PubsubTopic#resource_group}

---

subscription_id^Optional

• Type: str

The Azure event hub subscription ID to use for ingestion.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#subscription_id PubsubTopic#subscription_id}

---

tenant_id^Optional

• Type: str

The Azure event hub tenant ID to use for ingestion.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#tenant_id PubsubTopic#tenant_id}

---

put_cloud_storage

def put_cloud_storage(
  bucket: str,
  avro_format: PubsubTopicIngestionDataSourceSettingsCloudStorageAvroFormat = None,
  match_glob: str = None,
  minimum_object_create_time: str = None,
  pubsub_avro_format: PubsubTopicIngestionDataSourceSettingsCloudStoragePubsubAvroFormat = None,
  text_format: PubsubTopicIngestionDataSourceSettingsCloudStorageTextFormat = None
) -> None

bucket^Required

• Type: str

Cloud Storage bucket. The bucket name must be without any prefix like "gs://". See the bucket naming requirements: https://cloud.google.com/storage/docs/buckets#naming.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#bucket PubsubTopic#bucket}

---

avro_format^Optional

• Type: PubsubTopicIngestionDataSourceSettingsCloudStorageAvroFormat

avro_format block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#avro_format PubsubTopic#avro_format}

---

match_glob^Optional

• Type: str

Glob pattern used to match objects that will be ingested.

If unset, all objects will be ingested. See the supported patterns: https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-prefixes-using-glob

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#match_glob PubsubTopic#match_glob}

---

minimum_object_create_time^Optional

• Type: str

The timestamp set in RFC3339 text format.

If set, only objects with a larger or equal timestamp will be ingested. Unset by default, meaning all objects will be ingested.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#minimum_object_create_time PubsubTopic#minimum_object_create_time}

---

pubsub_avro_format^Optional

• Type: PubsubTopicIngestionDataSourceSettingsCloudStoragePubsubAvroFormat

pubsub_avro_format block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#pubsub_avro_format PubsubTopic#pubsub_avro_format}

---

text_format^Optional

• Type: PubsubTopicIngestionDataSourceSettingsCloudStorageTextFormat

text_format block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#text_format PubsubTopic#text_format}

---

put_confluent_cloud

def put_confluent_cloud(
  bootstrap_server: str,
  gcp_service_account: str,
  identity_pool_id: str,
  topic: str,
  cluster_id: str = None
) -> None

bootstrap_server^Required

• Type: str

The Confluent Cloud bootstrap server. The format is url:port.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#bootstrap_server PubsubTopic#bootstrap_server}

---

gcp_service_account^Required

• Type: str

The GCP service account to be used for Federated Identity authentication with Confluent Cloud.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#gcp_service_account PubsubTopic#gcp_service_account}

---

identity_pool_id^Required

• Type: str

Identity pool ID to be used for Federated Identity authentication with Confluent Cloud.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#identity_pool_id PubsubTopic#identity_pool_id}

---

topic^Required

• Type: str

Name of the Confluent Cloud topic that Pub/Sub will import from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#topic PubsubTopic#topic}

---

cluster_id^Optional

• Type: str

The Confluent Cloud cluster ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#cluster_id PubsubTopic#cluster_id}

---

put_platform_logs_settings

def put_platform_logs_settings(
  severity: str = None
) -> None

severity^Optional

• Type: str

The minimum severity level of Platform Logs that will be written.

If unspecified, no Platform Logs will be written. Default value: "SEVERITY_UNSPECIFIED" Possible values: ["SEVERITY_UNSPECIFIED", "DISABLED", "DEBUG", "INFO", "WARNING", "ERROR"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/pubsub_topic#severity PubsubTopic#severity}

---

reset_aws_kinesis

def reset_aws_kinesis() -> None

reset_aws_msk

def reset_aws_msk() -> None

reset_azure_event_hubs

def reset_azure_event_hubs() -> None

reset_cloud_storage

def reset_cloud_storage() -> None

reset_confluent_cloud

def reset_confluent_cloud() -> None

reset_platform_logs_settings

def reset_platform_logs_settings() -> 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.
aws_kinesis	PubsubTopicIngestionDataSourceSettingsAwsKinesisOutputReference	No description.
aws_msk	PubsubTopicIngestionDataSourceSettingsAwsMskOutputReference	No description.
azure_event_hubs	PubsubTopicIngestionDataSourceSettingsAzureEventHubsOutputReference	No description.
cloud_storage	PubsubTopicIngestionDataSourceSettingsCloudStorageOutputReference	No description.
confluent_cloud	PubsubTopicIngestionDataSourceSettingsConfluentCloudOutputReference	No description.
platform_logs_settings	PubsubTopicIngestionDataSourceSettingsPlatformLogsSettingsOutputReference	No description.
aws_kinesis_input	PubsubTopicIngestionDataSourceSettingsAwsKinesis	No description.
aws_msk_input	PubsubTopicIngestionDataSourceSettingsAwsMsk	No description.
azure_event_hubs_input	PubsubTopicIngestionDataSourceSettingsAzureEventHubs	No description.
cloud_storage_input	PubsubTopicIngestionDataSourceSettingsCloudStorage	No description.
confluent_cloud_input	PubsubTopicIngestionDataSourceSettingsConfluentCloud	No description.
platform_logs_settings_input	PubsubTopicIngestionDataSourceSettingsPlatformLogsSettings	No description.
internal_value	PubsubTopicIngestionDataSourceSettings	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

---

aws_kinesis^Required

aws_kinesis: PubsubTopicIngestionDataSourceSettingsAwsKinesisOutputReference

• Type: PubsubTopicIngestionDataSourceSettingsAwsKinesisOutputReference

---

aws_msk^Required

aws_msk: PubsubTopicIngestionDataSourceSettingsAwsMskOutputReference

• Type: PubsubTopicIngestionDataSourceSettingsAwsMskOutputReference

---

azure_event_hubs^Required

azure_event_hubs: PubsubTopicIngestionDataSourceSettingsAzureEventHubsOutputReference

• Type: PubsubTopicIngestionDataSourceSettingsAzureEventHubsOutputReference

---

cloud_storage^Required

cloud_storage: PubsubTopicIngestionDataSourceSettingsCloudStorageOutputReference

• Type: PubsubTopicIngestionDataSourceSettingsCloudStorageOutputReference

---

confluent_cloud^Required

confluent_cloud: PubsubTopicIngestionDataSourceSettingsConfluentCloudOutputReference

• Type: PubsubTopicIngestionDataSourceSettingsConfluentCloudOutputReference

---

platform_logs_settings^Required

platform_logs_settings: PubsubTopicIngestionDataSourceSettingsPlatformLogsSettingsOutputReference

• Type: PubsubTopicIngestionDataSourceSettingsPlatformLogsSettingsOutputReference

---

aws_kinesis_input^Optional

aws_kinesis_input: PubsubTopicIngestionDataSourceSettingsAwsKinesis

• Type: PubsubTopicIngestionDataSourceSettingsAwsKinesis

---

aws_msk_input^Optional

aws_msk_input: PubsubTopicIngestionDataSourceSettingsAwsMsk

• Type: PubsubTopicIngestionDataSourceSettingsAwsMsk

---

azure_event_hubs_input^Optional

azure_event_hubs_input: PubsubTopicIngestionDataSourceSettingsAzureEventHubs

• Type: PubsubTopicIngestionDataSourceSettingsAzureEventHubs

---

cloud_storage_input^Optional

cloud_storage_input: PubsubTopicIngestionDataSourceSettingsCloudStorage

• Type: PubsubTopicIngestionDataSourceSettingsCloudStorage

---

confluent_cloud_input^Optional

confluent_cloud_input: PubsubTopicIngestionDataSourceSettingsConfluentCloud

• Type: PubsubTopicIngestionDataSourceSettingsConfluentCloud

---

platform_logs_settings_input^Optional

platform_logs_settings_input: PubsubTopicIngestionDataSourceSettingsPlatformLogsSettings

• Type: PubsubTopicIngestionDataSourceSettingsPlatformLogsSettings

---

internal_value^Optional

internal_value: PubsubTopicIngestionDataSourceSettings

• Type: PubsubTopicIngestionDataSourceSettings

---

PubsubTopicIngestionDataSourceSettingsPlatformLogsSettingsOutputReference

Initializers

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicIngestionDataSourceSettingsPlatformLogsSettingsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

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

---

terraform_resource^Required

• Type: cdktf.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_severity	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: cdktf.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_severity

def reset_severity() -> 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.
severity_input	str	No description.
severity	str	No description.
internal_value	PubsubTopicIngestionDataSourceSettingsPlatformLogsSettings	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

---

severity_input^Optional

severity_input: str

• Type: str

---

severity^Required

severity: str

• Type: str

---

internal_value^Optional

internal_value: PubsubTopicIngestionDataSourceSettingsPlatformLogsSettings

• Type: PubsubTopicIngestionDataSourceSettingsPlatformLogsSettings

---

PubsubTopicMessageStoragePolicyOutputReference

Initializers

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicMessageStoragePolicyOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

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

---

terraform_resource^Required

• Type: cdktf.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_enforce_in_transit	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: cdktf.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_enforce_in_transit

def reset_enforce_in_transit() -> 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.
allowed_persistence_regions_input	typing.List[str]	No description.
enforce_in_transit_input	typing.Union[bool, cdktf.IResolvable]	No description.
allowed_persistence_regions	typing.List[str]	No description.
enforce_in_transit	typing.Union[bool, cdktf.IResolvable]	No description.
internal_value	PubsubTopicMessageStoragePolicy	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

---

allowed_persistence_regions_input^Optional

allowed_persistence_regions_input: typing.List[str]

• Type: typing.List[str]

---

enforce_in_transit_input^Optional

enforce_in_transit_input: typing.Union[bool, IResolvable]

• Type: typing.Union[bool, cdktf.IResolvable]

---

allowed_persistence_regions^Required

allowed_persistence_regions: typing.List[str]

• Type: typing.List[str]

---

enforce_in_transit^Required

enforce_in_transit: typing.Union[bool, IResolvable]

• Type: typing.Union[bool, cdktf.IResolvable]

---

internal_value^Optional

internal_value: PubsubTopicMessageStoragePolicy

• Type: PubsubTopicMessageStoragePolicy

---

PubsubTopicSchemaSettingsOutputReference

Initializers

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicSchemaSettingsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

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

---

terraform_resource^Required

• Type: cdktf.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_encoding	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: cdktf.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_encoding

def reset_encoding() -> 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.
encoding_input	str	No description.
schema_input	str	No description.
encoding	str	No description.
schema	str	No description.
internal_value	PubsubTopicSchemaSettings	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

---

encoding_input^Optional

encoding_input: str

• Type: str

---

schema_input^Optional

schema_input: str

• Type: str

---

encoding^Required

encoding: str

• Type: str

---

schema^Required

schema: str

• Type: str

---

internal_value^Optional

internal_value: PubsubTopicSchemaSettings

• Type: PubsubTopicSchemaSettings

---

PubsubTopicTimeoutsOutputReference

Initializers

from cdktf_cdktf_provider_google import pubsub_topic

pubsubTopic.PubsubTopicTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

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

---

terraform_resource^Required

• Type: cdktf.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_create	No description.
reset_delete	No description.
reset_update	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: cdktf.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_create

def reset_create() -> None

reset_delete

def reset_delete() -> None

reset_update

def reset_update() -> 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.
create_input	str	No description.
delete_input	str	No description.
update_input	str	No description.
create	str	No description.
delete	str	No description.
update	str	No description.
internal_value	typing.Union[cdktf.IResolvable, PubsubTopicTimeouts]	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

---

create_input^Optional

create_input: str

• Type: str

---

delete_input^Optional

delete_input: str

• Type: str

---

update_input^Optional

update_input: str

• Type: str

---

create^Required

create: str

• Type: str

---

delete^Required

delete: str

• Type: str

---

update^Required

update: str

• Type: str

---

internal_value^Optional

internal_value: typing.Union[IResolvable, PubsubTopicTimeouts]

• Type: typing.Union[cdktf.IResolvable, PubsubTopicTimeouts]

---