`loggingProjectSink` Submodule

Constructs

LoggingProjectSink

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/logging_project_sink google_logging_project_sink}.

Initializers

import { loggingProjectSink } from '@cdktn/provider-google'

new loggingProjectSink.LoggingProjectSink(scope: Construct, id: string, config: LoggingProjectSinkConfig)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: LoggingProjectSinkConfig

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`addOverride`	No description.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`resetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`toHclTerraform`	No description.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`addMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`hasResourceMove`	No description.
`importFrom`	No description.
`interpolationForAttribute`	No description.
`moveFromId`	Move the resource corresponding to "id" to this resource.
`moveTo`	Moves this resource to the target resource given by moveTarget.
`moveToId`	Moves this resource to the resource corresponding to "id".
`putBigqueryOptions`	No description.
`putExclusions`	No description.
`resetBigqueryOptions`	No description.
`resetCustomWriterIdentity`	No description.
`resetDeletionPolicy`	No description.
`resetDescription`	No description.
`resetDisabled`	No description.
`resetExclusions`	No description.
`resetFilter`	No description.
`resetId`	No description.
`resetProject`	No description.
`resetUniqueWriterIdentity`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`with`

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

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

`mixins`^Required

Type: ...constructs.IMixin[]

The mixins to apply.

`addOverride`

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

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public resetOverrideLogicalId(): void

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

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

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

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

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

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

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

`id`^Required

Type: string

`provider`^Optional

Type: cdktn.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

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

Note that the resource being moved from must be marked as moved using it's instance function.

`id`^Required

Type: string

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

`moveTo`

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

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

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

`index`^Optional

Type: string | number

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

`moveToId`

public moveToId(id: string): void

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

`id`^Required

Type: string

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

`putBigqueryOptions`

public putBigqueryOptions(value: LoggingProjectSinkBigqueryOptions): void

`value`^Required

Type: LoggingProjectSinkBigqueryOptions

`putExclusions`

public putExclusions(value: IResolvable | LoggingProjectSinkExclusions[]): void

`value`^Required

Type: cdktn.IResolvable | LoggingProjectSinkExclusions[]

`resetBigqueryOptions`

public resetBigqueryOptions(): void

`resetCustomWriterIdentity`

public resetCustomWriterIdentity(): void

`resetDeletionPolicy`

public resetDeletionPolicy(): void

`resetDescription`

public resetDescription(): void

`resetDisabled`

public resetDisabled(): void

`resetExclusions`

public resetExclusions(): void

`resetFilter`

public resetFilter(): void

`resetId`

public resetId(): void

`resetProject`

public resetProject(): void

`resetUniqueWriterIdentity`

public resetUniqueWriterIdentity(): void

Static Functions

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

`isConstruct`

import { loggingProjectSink } from '@cdktn/provider-google'

loggingProjectSink.LoggingProjectSink.isConstruct(x: any)

Checks if x is a construct.

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

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

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { loggingProjectSink } from '@cdktn/provider-google'

loggingProjectSink.LoggingProjectSink.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { loggingProjectSink } from '@cdktn/provider-google'

loggingProjectSink.LoggingProjectSink.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { loggingProjectSink } from '@cdktn/provider-google'

loggingProjectSink.LoggingProjectSink.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

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

`importFromId`^Required

Type: string

The id of the existing LoggingProjectSink that should be imported.

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

`provider`^Optional

Type: cdktn.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktfStack`	`cdktn.TerraformStack`	No description.
`fqn`	`string`	No description.
`friendlyUniqueId`	`string`	No description.
`terraformMetaArguments`	`{[ key: string ]: any}`	No description.
`terraformResourceType`	`string`	No description.
`terraformGeneratorMetadata`	`cdktn.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktn.TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner[]`	No description.
`bigqueryOptions`	`LoggingProjectSinkBigqueryOptionsOutputReference`	No description.
`exclusions`	`LoggingProjectSinkExclusionsList`	No description.
`writerIdentity`	`string`	No description.
`bigqueryOptionsInput`	`LoggingProjectSinkBigqueryOptions`	No description.
`customWriterIdentityInput`	`string`	No description.
`deletionPolicyInput`	`string`	No description.
`descriptionInput`	`string`	No description.
`destinationInput`	`string`	No description.
`disabledInput`	`boolean \| cdktn.IResolvable`	No description.
`exclusionsInput`	`cdktn.IResolvable \| LoggingProjectSinkExclusions[]`	No description.
`filterInput`	`string`	No description.
`idInput`	`string`	No description.
`nameInput`	`string`	No description.
`projectInput`	`string`	No description.
`uniqueWriterIdentityInput`	`boolean \| cdktn.IResolvable`	No description.
`customWriterIdentity`	`string`	No description.
`deletionPolicy`	`string`	No description.
`description`	`string`	No description.
`destination`	`string`	No description.
`disabled`	`boolean \| cdktn.IResolvable`	No description.
`filter`	`string`	No description.
`id`	`string`	No description.
`name`	`string`	No description.
`project`	`string`	No description.
`uniqueWriterIdentity`	`boolean \| cdktn.IResolvable`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktn.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

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

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktn.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktn.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktn.TerraformProvider

`provisioners`^Optional

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

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

`bigqueryOptions`^Required

public readonly bigqueryOptions: LoggingProjectSinkBigqueryOptionsOutputReference;

Type: LoggingProjectSinkBigqueryOptionsOutputReference

`exclusions`^Required

public readonly exclusions: LoggingProjectSinkExclusionsList;

Type: LoggingProjectSinkExclusionsList

`writerIdentity`^Required

public readonly writerIdentity: string;

Type: string

`bigqueryOptionsInput`^Optional

public readonly bigqueryOptionsInput: LoggingProjectSinkBigqueryOptions;

Type: LoggingProjectSinkBigqueryOptions

`customWriterIdentityInput`^Optional

public readonly customWriterIdentityInput: string;

Type: string

`deletionPolicyInput`^Optional

public readonly deletionPolicyInput: string;

Type: string

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`destinationInput`^Optional

public readonly destinationInput: string;

Type: string

`disabledInput`^Optional

public readonly disabledInput: boolean | IResolvable;

Type: boolean | cdktn.IResolvable

`exclusionsInput`^Optional

public readonly exclusionsInput: IResolvable | LoggingProjectSinkExclusions[];

Type: cdktn.IResolvable | LoggingProjectSinkExclusions[]

`filterInput`^Optional

public readonly filterInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`uniqueWriterIdentityInput`^Optional

public readonly uniqueWriterIdentityInput: boolean | IResolvable;

Type: boolean | cdktn.IResolvable

`customWriterIdentity`^Required

public readonly customWriterIdentity: string;

Type: string

`deletionPolicy`^Required

public readonly deletionPolicy: string;

Type: string

`description`^Required

public readonly description: string;

Type: string

`destination`^Required

public readonly destination: string;

Type: string

`disabled`^Required

public readonly disabled: boolean | IResolvable;

Type: boolean | cdktn.IResolvable

`filter`^Required

public readonly filter: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`project`^Required

public readonly project: string;

Type: string

`uniqueWriterIdentity`^Required

public readonly uniqueWriterIdentity: boolean | IResolvable;

Type: boolean | cdktn.IResolvable

Constants

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

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

LoggingProjectSinkBigqueryOptions

Initializer

import { loggingProjectSink } from '@cdktn/provider-google'

const loggingProjectSinkBigqueryOptions: loggingProjectSink.LoggingProjectSinkBigqueryOptions = { ... }

Properties

Name	Type	Description
`usePartitionedTables`	`boolean \| cdktn.IResolvable`	Whether to use BigQuery's partition tables.

`usePartitionedTables`^Required

public readonly usePartitionedTables: boolean | IResolvable;

Type: boolean | cdktn.IResolvable

Whether to use BigQuery's partition tables.

By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/logging_project_sink#use_partitioned_tables LoggingProjectSink#use_partitioned_tables}

LoggingProjectSinkConfig

Initializer

import { loggingProjectSink } from '@cdktn/provider-google'

const loggingProjectSinkConfig: loggingProjectSink.LoggingProjectSinkConfig = { ... }

Properties

Name	Type	Description
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktn.TerraformCount`	No description.
`dependsOn`	`cdktn.ITerraformDependable[]`	No description.
`forEach`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner[]`	No description.
`destination`	`string`	The destination of the sink (or, in other words, where logs are written to).
`name`	`string`	The name of the logging sink.
`bigqueryOptions`	`LoggingProjectSinkBigqueryOptions`	bigquery_options block.
`customWriterIdentity`	`string`	A service account provided by the caller that will be used to write the log entries.
`deletionPolicy`	`string`	Whether Terraform will be prevented from destroying the instance.
`description`	`string`	A description of this sink. The maximum length of the description is 8000 characters.
`disabled`	`boolean \| cdktn.IResolvable`	If set to True, then this sink is disabled and it does not export any log entries.
`exclusions`	`cdktn.IResolvable \| LoggingProjectSinkExclusions[]`	exclusions block.
`filter`	`string`	The filter to apply when exporting logs. Only log entries that match the filter are exported.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/logging_project_sink#id LoggingProjectSink#id}.
`project`	`string`	The ID of the project to create the sink in.
`uniqueWriterIdentity`	`boolean \| cdktn.IResolvable`	Whether or not to create a unique identity associated with this sink.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktn.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktn.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktn.TerraformProvider

`provisioners`^Optional

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

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

`destination`^Required

public readonly destination: string;

Type: string

The destination of the sink (or, in other words, where logs are written to).

Can be a Cloud Storage bucket, a PubSub topic, or a BigQuery dataset. Examples: "storage.googleapis.com/[GCS_BUCKET]" "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]" The writer associated with the sink must have access to write to the above resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/logging_project_sink#destination LoggingProjectSink#destination}

`name`^Required

public readonly name: string;

Type: string

The name of the logging sink.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/logging_project_sink#name LoggingProjectSink#name}

`bigqueryOptions`^Optional

public readonly bigqueryOptions: LoggingProjectSinkBigqueryOptions;

Type: LoggingProjectSinkBigqueryOptions

bigquery_options block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/logging_project_sink#bigquery_options LoggingProjectSink#bigquery_options}

`customWriterIdentity`^Optional

public readonly customWriterIdentity: string;

Type: string

A service account provided by the caller that will be used to write the log entries.

The format must be serviceAccount:some@email. This field can only be specified if you are routing logs to a destination outside this sink's project. If not specified, a Logging service account will automatically be generated.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/logging_project_sink#custom_writer_identity LoggingProjectSink#custom_writer_identity}

`deletionPolicy`^Optional

public readonly deletionPolicy: string;

Type: string

Whether Terraform will be prevented from destroying the instance.

Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/logging_project_sink#deletion_policy LoggingProjectSink#deletion_policy}

`description`^Optional

public readonly description: string;

Type: string

A description of this sink. The maximum length of the description is 8000 characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/logging_project_sink#description LoggingProjectSink#description}

`disabled`^Optional

public readonly disabled: boolean | IResolvable;

Type: boolean | cdktn.IResolvable

If set to True, then this sink is disabled and it does not export any log entries.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/logging_project_sink#disabled LoggingProjectSink#disabled}

`exclusions`^Optional

public readonly exclusions: IResolvable | LoggingProjectSinkExclusions[];

Type: cdktn.IResolvable | LoggingProjectSinkExclusions[]

exclusions block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/logging_project_sink#exclusions LoggingProjectSink#exclusions}

`filter`^Optional

public readonly filter: string;

Type: string

The filter to apply when exporting logs. Only log entries that match the filter are exported.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/logging_project_sink#filter LoggingProjectSink#filter}

`id`^Optional

public readonly id: string;

Type: string

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

`project`^Optional

public readonly project: string;

Type: string

The ID of the project to create the sink in.

If omitted, the project associated with the provider is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/logging_project_sink#project LoggingProjectSink#project}

`uniqueWriterIdentity`^Optional

public readonly uniqueWriterIdentity: boolean | IResolvable;

Type: boolean | cdktn.IResolvable

Whether or not to create a unique identity associated with this sink.

If false (the legacy behavior), then the writer_identity used is serviceAccount:cloud-logs@system.gserviceaccount.com. If true (default), then a unique service account is created and used for this sink. If you wish to publish logs across projects, you must set unique_writer_identity to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/logging_project_sink#unique_writer_identity LoggingProjectSink#unique_writer_identity}

LoggingProjectSinkExclusions

Initializer

import { loggingProjectSink } from '@cdktn/provider-google'

const loggingProjectSinkExclusions: loggingProjectSink.LoggingProjectSinkExclusions = { ... }

Properties

Name	Type	Description
`filter`	`string`	An advanced logs filter that matches the log entries to be excluded.
`name`	`string`	A client-assigned identifier, such as "load-balancer-exclusion".
`description`	`string`	A description of this exclusion.
`disabled`	`boolean \| cdktn.IResolvable`	If set to True, then this exclusion is disabled and it does not exclude any log entries.

`filter`^Required

public readonly filter: string;

Type: string

An advanced logs filter that matches the log entries to be excluded.

By using the sample function, you can exclude less than 100% of the matching log entries

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/logging_project_sink#filter LoggingProjectSink#filter}

`name`^Required

public readonly name: string;

Type: string

A client-assigned identifier, such as "load-balancer-exclusion".

Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/logging_project_sink#name LoggingProjectSink#name}

`description`^Optional

public readonly description: string;

Type: string

A description of this exclusion.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/logging_project_sink#description LoggingProjectSink#description}

`disabled`^Optional

public readonly disabled: boolean | IResolvable;

Type: boolean | cdktn.IResolvable

If set to True, then this exclusion is disabled and it does not exclude any log entries.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/logging_project_sink#disabled LoggingProjectSink#disabled}

Classes

LoggingProjectSinkBigqueryOptionsOutputReference

Initializers

import { loggingProjectSink } from '@cdktn/provider-google'

new loggingProjectSink.LoggingProjectSinkBigqueryOptionsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

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

`terraformResource`^Required

Type: cdktn.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

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

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktn.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`usePartitionedTablesInput`	`boolean \| cdktn.IResolvable`	No description.
`usePartitionedTables`	`boolean \| cdktn.IResolvable`	No description.
`internalValue`	`LoggingProjectSinkBigqueryOptions`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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

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

`fqn`^Required

public readonly fqn: string;

Type: string

`usePartitionedTablesInput`^Optional

public readonly usePartitionedTablesInput: boolean | IResolvable;

Type: boolean | cdktn.IResolvable

`usePartitionedTables`^Required

public readonly usePartitionedTables: boolean | IResolvable;

Type: boolean | cdktn.IResolvable

`internalValue`^Optional

public readonly internalValue: LoggingProjectSinkBigqueryOptions;

Type: LoggingProjectSinkBigqueryOptions

LoggingProjectSinkExclusionsList

Initializers

import { loggingProjectSink } from '@cdktn/provider-google'

new loggingProjectSink.LoggingProjectSinkExclusionsList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
`terraformResource`	`cdktn.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`wrapsSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktn.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`allWithMapKey`	Creating an iterator for this complex list.
`computeFqn`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`get`	No description.

`allWithMapKey`

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`mapKeyAttributeName`^Required

Type: string

`computeFqn`

public computeFqn(): string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktn.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`get`

public get(index: number): LoggingProjectSinkExclusionsOutputReference

`index`^Required

Type: number

the index of the item to return.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`internalValue`	`cdktn.IResolvable \| LoggingProjectSinkExclusions[]`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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

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

`fqn`^Required

public readonly fqn: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | LoggingProjectSinkExclusions[];

Type: cdktn.IResolvable | LoggingProjectSinkExclusions[]

LoggingProjectSinkExclusionsOutputReference

Initializers

import { loggingProjectSink } from '@cdktn/provider-google'

new loggingProjectSink.LoggingProjectSinkExclusionsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
`terraformResource`	`cdktn.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`complexObjectIndex`	`number`	the index of this item in the list.
`complexObjectIsFromSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktn.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: number

the index of this item in the list.

`complexObjectIsFromSet`^Required

Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`resetDescription`	No description.
`resetDisabled`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

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

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktn.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetDescription`

public resetDescription(): void

`resetDisabled`

public resetDisabled(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`descriptionInput`	`string`	No description.
`disabledInput`	`boolean \| cdktn.IResolvable`	No description.
`filterInput`	`string`	No description.
`nameInput`	`string`	No description.
`description`	`string`	No description.
`disabled`	`boolean \| cdktn.IResolvable`	No description.
`filter`	`string`	No description.
`name`	`string`	No description.
`internalValue`	`cdktn.IResolvable \| LoggingProjectSinkExclusions`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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

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

`fqn`^Required

public readonly fqn: string;

Type: string

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`disabledInput`^Optional

public readonly disabledInput: boolean | IResolvable;

Type: boolean | cdktn.IResolvable

`filterInput`^Optional

public readonly filterInput: string;

Type: string

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`description`^Required

public readonly description: string;

Type: string

`disabled`^Required

public readonly disabled: boolean | IResolvable;

Type: boolean | cdktn.IResolvable

`filter`^Required

public readonly filter: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | LoggingProjectSinkExclusions;

Type: cdktn.IResolvable | LoggingProjectSinkExclusions

Uh oh!

FilesExpand file tree

loggingProjectSink.typescript.md

Latest commit

History

loggingProjectSink.typescript.md

File metadata and controls

loggingProjectSink Submodule

Constructs