Skip to content

Latest commit

 

History

History
2183 lines (1340 loc) · 97 KB

loggingFolderSink.typescript.md

File metadata and controls

2183 lines (1340 loc) · 97 KB

loggingFolderSink Submodule

Constructs

LoggingFolderSink

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/logging_folder_sink google_logging_folder_sink}.

Initializers

import { loggingFolderSink } from '@cdktf/provider-google'

new loggingFolderSink.LoggingFolderSink(scope: Construct, id: string, config: LoggingFolderSinkConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config LoggingFolderSinkConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

Methods

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

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • 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.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


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

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktf.TerraformProvider

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • 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.

idRequired
  • 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.

moveTargetRequired
  • Type: string

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


indexOptional
  • 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".

idRequired
  • Type: string

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


putBigqueryOptions
public putBigqueryOptions(value: LoggingFolderSinkBigqueryOptions): void
valueRequired

putExclusions
public putExclusions(value: IResolvable | LoggingFolderSinkExclusions[]): void
valueRequired

resetBigqueryOptions
public resetBigqueryOptions(): void
resetDescription
public resetDescription(): void
resetDisabled
public resetDisabled(): void
resetExclusions
public resetExclusions(): void
resetFilter
public resetFilter(): void
resetId
public resetId(): void
resetIncludeChildren
public resetIncludeChildren(): void
resetInterceptChildren
public resetInterceptChildren(): void

Static Functions

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

isConstruct
import { loggingFolderSink } from '@cdktf/provider-google'

loggingFolderSink.LoggingFolderSink.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.

xRequired
  • Type: any

Any object.


isTerraformElement
import { loggingFolderSink } from '@cdktf/provider-google'

loggingFolderSink.LoggingFolderSink.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { loggingFolderSink } from '@cdktf/provider-google'

loggingFolderSink.LoggingFolderSink.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { loggingFolderSink } from '@cdktf/provider-google'

loggingFolderSink.LoggingFolderSink.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: string

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


importFromIdRequired
  • Type: string

The id of the existing LoggingFolderSink that should be imported.

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


providerOptional
  • Type: cdktf.TerraformProvider

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


Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
bigqueryOptions LoggingFolderSinkBigqueryOptionsOutputReference No description.
exclusions LoggingFolderSinkExclusionsList No description.
writerIdentity string No description.
bigqueryOptionsInput LoggingFolderSinkBigqueryOptions No description.
descriptionInput string No description.
destinationInput string No description.
disabledInput boolean | cdktf.IResolvable No description.
exclusionsInput cdktf.IResolvable | LoggingFolderSinkExclusions[] No description.
filterInput string No description.
folderInput string No description.
idInput string No description.
includeChildrenInput boolean | cdktf.IResolvable No description.
interceptChildrenInput boolean | cdktf.IResolvable No description.
nameInput string No description.
description string No description.
destination string No description.
disabled boolean | cdktf.IResolvable No description.
filter string No description.
folder string No description.
id string No description.
includeChildren boolean | cdktf.IResolvable No description.
interceptChildren boolean | cdktf.IResolvable No description.
name string No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

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

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

bigqueryOptionsRequired
public readonly bigqueryOptions: LoggingFolderSinkBigqueryOptionsOutputReference;

exclusionsRequired
public readonly exclusions: LoggingFolderSinkExclusionsList;

writerIdentityRequired
public readonly writerIdentity: string;
  • Type: string

bigqueryOptionsInputOptional
public readonly bigqueryOptionsInput: LoggingFolderSinkBigqueryOptions;

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

destinationInputOptional
public readonly destinationInput: string;
  • Type: string

disabledInputOptional
public readonly disabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

exclusionsInputOptional
public readonly exclusionsInput: IResolvable | LoggingFolderSinkExclusions[];

filterInputOptional
public readonly filterInput: string;
  • Type: string

folderInputOptional
public readonly folderInput: string;
  • Type: string

idInputOptional
public readonly idInput: string;
  • Type: string

includeChildrenInputOptional
public readonly includeChildrenInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

interceptChildrenInputOptional
public readonly interceptChildrenInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

nameInputOptional
public readonly nameInput: string;
  • Type: string

descriptionRequired
public readonly description: string;
  • Type: string

destinationRequired
public readonly destination: string;
  • Type: string

disabledRequired
public readonly disabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

filterRequired
public readonly filter: string;
  • Type: string

folderRequired
public readonly folder: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

includeChildrenRequired
public readonly includeChildren: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

interceptChildrenRequired
public readonly interceptChildren: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

nameRequired
public readonly name: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

LoggingFolderSinkBigqueryOptions

Initializer

import { loggingFolderSink } from '@cdktf/provider-google'

const loggingFolderSinkBigqueryOptions: loggingFolderSink.LoggingFolderSinkBigqueryOptions = { ... }

Properties

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

usePartitionedTablesRequired
public readonly usePartitionedTables: boolean | IResolvable;
  • Type: boolean | cdktf.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/6.15.0/docs/resources/logging_folder_sink#use_partitioned_tables LoggingFolderSink#use_partitioned_tables}


LoggingFolderSinkConfig

Initializer

import { loggingFolderSink } from '@cdktf/provider-google'

const loggingFolderSinkConfig: loggingFolderSink.LoggingFolderSinkConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
destination string The destination of the sink (or, in other words, where logs are written to).
folder string The folder to be exported to the sink. Note that either [FOLDER_ID] or "folders/[FOLDER_ID]" is accepted.
name string The name of the logging sink.
bigqueryOptions LoggingFolderSinkBigqueryOptions bigquery_options block.
description string A description of this sink. The maximum length of the description is 8000 characters.
disabled boolean | cdktf.IResolvable If set to True, then this sink is disabled and it does not export any log entries.
exclusions cdktf.IResolvable | LoggingFolderSinkExclusions[] 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/6.15.0/docs/resources/logging_folder_sink#id LoggingFolderSink#id}.
includeChildren boolean | cdktf.IResolvable Whether or not to include children folders in the sink export.
interceptChildren boolean | cdktf.IResolvable Whether or not to intercept logs from child projects.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

destinationRequired
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/6.15.0/docs/resources/logging_folder_sink#destination LoggingFolderSink#destination}


folderRequired
public readonly folder: string;
  • Type: string

The folder to be exported to the sink. Note that either [FOLDER_ID] or "folders/[FOLDER_ID]" is accepted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/logging_folder_sink#folder LoggingFolderSink#folder}


nameRequired
public readonly name: string;
  • Type: string

The name of the logging sink.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/logging_folder_sink#name LoggingFolderSink#name}


bigqueryOptionsOptional
public readonly bigqueryOptions: LoggingFolderSinkBigqueryOptions;

bigquery_options block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/logging_folder_sink#bigquery_options LoggingFolderSink#bigquery_options}


descriptionOptional
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/6.15.0/docs/resources/logging_folder_sink#description LoggingFolderSink#description}


disabledOptional
public readonly disabled: boolean | IResolvable;
  • Type: boolean | cdktf.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/6.15.0/docs/resources/logging_folder_sink#disabled LoggingFolderSink#disabled}


exclusionsOptional
public readonly exclusions: IResolvable | LoggingFolderSinkExclusions[];

exclusions block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/logging_folder_sink#exclusions LoggingFolderSink#exclusions}


filterOptional
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/6.15.0/docs/resources/logging_folder_sink#filter LoggingFolderSink#filter}


idOptional
public readonly id: string;
  • Type: string

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


includeChildrenOptional
public readonly includeChildren: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Whether or not to include children folders in the sink export.

If true, logs associated with child projects are also exported; otherwise only logs relating to the provided folder are included.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/logging_folder_sink#include_children LoggingFolderSink#include_children}


interceptChildrenOptional
public readonly interceptChildren: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Whether or not to intercept logs from child projects.

If true, matching logs will not match with sinks in child resources, except _Required sinks. This sink will be visible to child resources when listing sinks.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/logging_folder_sink#intercept_children LoggingFolderSink#intercept_children}


LoggingFolderSinkExclusions

Initializer

import { loggingFolderSink } from '@cdktf/provider-google'

const loggingFolderSinkExclusions: loggingFolderSink.LoggingFolderSinkExclusions = { ... }

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 | cdktf.IResolvable If set to True, then this exclusion is disabled and it does not exclude any log entries.

filterRequired
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/6.15.0/docs/resources/logging_folder_sink#filter LoggingFolderSink#filter}


nameRequired
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/6.15.0/docs/resources/logging_folder_sink#name LoggingFolderSink#name}


descriptionOptional
public readonly description: string;
  • Type: string

A description of this exclusion.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/logging_folder_sink#description LoggingFolderSink#description}


disabledOptional
public readonly disabled: boolean | IResolvable;
  • Type: boolean | cdktf.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/6.15.0/docs/resources/logging_folder_sink#disabled LoggingFolderSink#disabled}


Classes

LoggingFolderSinkBigqueryOptionsOutputReference

Initializers

import { loggingFolderSink } from '@cdktf/provider-google'

new loggingFolderSink.LoggingFolderSinkBigqueryOptionsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

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

creationStackRequired
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.


fqnRequired
public readonly fqn: string;
  • Type: string

usePartitionedTablesInputOptional
public readonly usePartitionedTablesInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

usePartitionedTablesRequired
public readonly usePartitionedTables: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

internalValueOptional
public readonly internalValue: LoggingFolderSinkBigqueryOptions;

LoggingFolderSinkExclusionsList

Initializers

import { loggingFolderSink } from '@cdktf/provider-google'

new loggingFolderSink.LoggingFolderSinkExclusionsList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


wrapsSetRequired
  • 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.

mapKeyAttributeNameRequired
  • Type: string

computeFqn
public computeFqn(): string
resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get
public get(index: number): LoggingFolderSinkExclusionsOutputReference
indexRequired
  • 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 cdktf.IResolvable | LoggingFolderSinkExclusions[] No description.

creationStackRequired
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.


fqnRequired
public readonly fqn: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | LoggingFolderSinkExclusions[];

LoggingFolderSinkExclusionsOutputReference

Initializers

import { loggingFolderSink } from '@cdktf/provider-google'

new loggingFolderSink.LoggingFolderSinkExclusionsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: number

the index of this item in the list.


complexObjectIsFromSetRequired
  • 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}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.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 | cdktf.IResolvable No description.
filterInput string No description.
nameInput string No description.
description string No description.
disabled boolean | cdktf.IResolvable No description.
filter string No description.
name string No description.
internalValue cdktf.IResolvable | LoggingFolderSinkExclusions No description.

creationStackRequired
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.


fqnRequired
public readonly fqn: string;
  • Type: string

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

disabledInputOptional
public readonly disabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

filterInputOptional
public readonly filterInput: string;
  • Type: string

nameInputOptional
public readonly nameInput: string;
  • Type: string

descriptionRequired
public readonly description: string;
  • Type: string

disabledRequired
public readonly disabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

filterRequired
public readonly filter: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | LoggingFolderSinkExclusions;