Skip to content

Latest commit

 

History

History
3157 lines (1935 loc) · 146 KB

googleChronicleRule.typescript.md

File metadata and controls

3157 lines (1935 loc) · 146 KB

googleChronicleRule Submodule

Constructs

GoogleChronicleRule

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

Initializers

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

new googleChronicleRule.GoogleChronicleRule(scope: Construct, id: string, config: GoogleChronicleRuleConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config GoogleChronicleRuleConfig 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".
putTimeouts No description.
resetDeletionPolicy No description.
resetEtag No description.
resetId No description.
resetProject No description.
resetRuleId No description.
resetScope No description.
resetText No description.
resetTimeouts 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".


putTimeouts
public putTimeouts(value: GoogleChronicleRuleTimeouts): void
valueRequired

resetDeletionPolicy
public resetDeletionPolicy(): void
resetEtag
public resetEtag(): void
resetId
public resetId(): void
resetProject
public resetProject(): void
resetRuleId
public resetRuleId(): void
resetScope
public resetScope(): void
resetText
public resetText(): void
resetTimeouts
public resetTimeouts(): 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 GoogleChronicleRule resource upon running "cdktf plan ".

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

googleChronicleRule.GoogleChronicleRule.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 { googleChronicleRule } from '@cdktf/provider-google-beta'

googleChronicleRule.GoogleChronicleRule.isTerraformElement(x: any)
xRequired
  • Type: any

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

googleChronicleRule.GoogleChronicleRule.isTerraformResource(x: any)
xRequired
  • Type: any

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

googleChronicleRule.GoogleChronicleRule.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a GoogleChronicleRule 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 GoogleChronicleRule to import.


importFromIdRequired
  • Type: string

The id of the existing GoogleChronicleRule that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_chronicle_rule#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 GoogleChronicleRule 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.
allowedRunFrequencies string[] No description.
author string No description.
compilationDiagnostics GoogleChronicleRuleCompilationDiagnosticsList No description.
compilationState string No description.
createTime string No description.
dataTables string[] No description.
displayName string No description.
metadata cdktf.StringMap No description.
name string No description.
nearRealTimeLiveRuleEligible cdktf.IResolvable No description.
referenceLists string[] No description.
revisionCreateTime string No description.
revisionId string No description.
severity GoogleChronicleRuleSeverityList No description.
timeouts GoogleChronicleRuleTimeoutsOutputReference No description.
type string No description.
deletionPolicyInput string No description.
etagInput string No description.
idInput string No description.
instanceInput string No description.
locationInput string No description.
projectInput string No description.
ruleIdInput string No description.
scopeInput string No description.
textInput string No description.
timeoutsInput cdktf.IResolvable | GoogleChronicleRuleTimeouts No description.
deletionPolicy string No description.
etag string No description.
id string No description.
instance string No description.
location string No description.
project string No description.
ruleId string No description.
scope string No description.
text 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[]

allowedRunFrequenciesRequired
public readonly allowedRunFrequencies: string[];
  • Type: string[]

authorRequired
public readonly author: string;
  • Type: string

compilationDiagnosticsRequired
public readonly compilationDiagnostics: GoogleChronicleRuleCompilationDiagnosticsList;

compilationStateRequired
public readonly compilationState: string;
  • Type: string

createTimeRequired
public readonly createTime: string;
  • Type: string

dataTablesRequired
public readonly dataTables: string[];
  • Type: string[]

displayNameRequired
public readonly displayName: string;
  • Type: string

metadataRequired
public readonly metadata: StringMap;
  • Type: cdktf.StringMap

nameRequired
public readonly name: string;
  • Type: string

nearRealTimeLiveRuleEligibleRequired
public readonly nearRealTimeLiveRuleEligible: IResolvable;
  • Type: cdktf.IResolvable

referenceListsRequired
public readonly referenceLists: string[];
  • Type: string[]

revisionCreateTimeRequired
public readonly revisionCreateTime: string;
  • Type: string

revisionIdRequired
public readonly revisionId: string;
  • Type: string

severityRequired
public readonly severity: GoogleChronicleRuleSeverityList;

timeoutsRequired
public readonly timeouts: GoogleChronicleRuleTimeoutsOutputReference;

typeRequired
public readonly type: string;
  • Type: string

deletionPolicyInputOptional
public readonly deletionPolicyInput: string;
  • Type: string

etagInputOptional
public readonly etagInput: string;
  • Type: string

idInputOptional
public readonly idInput: string;
  • Type: string

instanceInputOptional
public readonly instanceInput: string;
  • Type: string

locationInputOptional
public readonly locationInput: string;
  • Type: string

projectInputOptional
public readonly projectInput: string;
  • Type: string

ruleIdInputOptional
public readonly ruleIdInput: string;
  • Type: string

scopeInputOptional
public readonly scopeInput: string;
  • Type: string

textInputOptional
public readonly textInput: string;
  • Type: string

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | GoogleChronicleRuleTimeouts;

deletionPolicyRequired
public readonly deletionPolicy: string;
  • Type: string

etagRequired
public readonly etag: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

instanceRequired
public readonly instance: string;
  • Type: string

locationRequired
public readonly location: string;
  • Type: string

projectRequired
public readonly project: string;
  • Type: string

ruleIdRequired
public readonly ruleId: string;
  • Type: string

scopeRequired
public readonly scope: string;
  • Type: string

textRequired
public readonly text: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

GoogleChronicleRuleCompilationDiagnostics

Initializer

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

const googleChronicleRuleCompilationDiagnostics: googleChronicleRule.GoogleChronicleRuleCompilationDiagnostics = { ... }

GoogleChronicleRuleCompilationDiagnosticsPosition

Initializer

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

const googleChronicleRuleCompilationDiagnosticsPosition: googleChronicleRule.GoogleChronicleRuleCompilationDiagnosticsPosition = { ... }

GoogleChronicleRuleConfig

Initializer

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

const googleChronicleRuleConfig: googleChronicleRule.GoogleChronicleRuleConfig = { ... }

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.
instance string The unique identifier for the Chronicle instance, which is the same as the customer ID.
location string The location of the resource.
deletionPolicy string Policy to determine if the rule should be deleted forcefully.
etag string The etag for this rule.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_chronicle_rule#id GoogleChronicleRule#id}.
project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_chronicle_rule#project GoogleChronicleRule#project}.
ruleId string Rule Id is the ID of the Rule.
scope string Resource name of the DataAccessScope bound to this rule.
text string The YARA-L content of the rule. Populated in FULL view.
timeouts GoogleChronicleRuleTimeouts timeouts block.

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[]

instanceRequired
public readonly instance: string;
  • Type: string

The unique identifier for the Chronicle instance, which is the same as the customer ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_chronicle_rule#instance GoogleChronicleRule#instance}


locationRequired
public readonly location: string;
  • Type: string

The location of the resource.

This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_chronicle_rule#location GoogleChronicleRule#location}


deletionPolicyOptional
public readonly deletionPolicy: string;
  • Type: string

Policy to determine if the rule should be deleted forcefully.

If deletion_policy = "FORCE", any retrohunts and any detections associated with the rule will also be deleted. If deletion_policy = "DEFAULT", the call will only succeed if the rule has no associated retrohunts, including completed retrohunts, and no associated detections. Regardless of this field's value, the rule deployment associated with this rule will also be deleted. Possible values: DEFAULT, FORCE

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_chronicle_rule#deletion_policy GoogleChronicleRule#deletion_policy}


etagOptional
public readonly etag: string;
  • Type: string

The etag for this rule.

If this is provided on update, the request will succeed if and only if it matches the server-computed value, and will fail with an ABORTED error otherwise. Populated in BASIC view and FULL view.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_chronicle_rule#etag GoogleChronicleRule#etag}


idOptional
public readonly id: string;
  • Type: string

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


projectOptional
public readonly project: string;
  • Type: string

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


ruleIdOptional
public readonly ruleId: string;
  • Type: string

Rule Id is the ID of the Rule.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_chronicle_rule#rule_id GoogleChronicleRule#rule_id}


scopeOptional
public readonly scope: string;
  • Type: string

Resource name of the DataAccessScope bound to this rule.

Populated in BASIC view and FULL view. If reference lists are used in the rule, validations will be performed against this scope to ensure that the reference lists are compatible with both the user's and the rule's scopes. The scope should be in the format: "projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{scope}".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_chronicle_rule#scope GoogleChronicleRule#scope}


textOptional
public readonly text: string;
  • Type: string

The YARA-L content of the rule. Populated in FULL view.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_chronicle_rule#text GoogleChronicleRule#text}


timeoutsOptional
public readonly timeouts: GoogleChronicleRuleTimeouts;

timeouts block.

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


GoogleChronicleRuleSeverity

Initializer

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

const googleChronicleRuleSeverity: googleChronicleRule.GoogleChronicleRuleSeverity = { ... }

GoogleChronicleRuleTimeouts

Initializer

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

const googleChronicleRuleTimeouts: googleChronicleRule.GoogleChronicleRuleTimeouts = { ... }

Properties

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

createOptional
public readonly create: string;
  • Type: string

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


deleteOptional
public readonly delete: string;
  • Type: string

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


updateOptional
public readonly update: string;
  • Type: string

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


Classes

GoogleChronicleRuleCompilationDiagnosticsList

Initializers

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

new googleChronicleRule.GoogleChronicleRuleCompilationDiagnosticsList(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): GoogleChronicleRuleCompilationDiagnosticsOutputReference
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.

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

GoogleChronicleRuleCompilationDiagnosticsOutputReference

Initializers

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

new googleChronicleRule.GoogleChronicleRuleCompilationDiagnosticsOutputReference(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.

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.
message string No description.
position GoogleChronicleRuleCompilationDiagnosticsPositionList No description.
severity string No description.
uri string No description.
internalValue GoogleChronicleRuleCompilationDiagnostics 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

messageRequired
public readonly message: string;
  • Type: string

positionRequired
public readonly position: GoogleChronicleRuleCompilationDiagnosticsPositionList;

severityRequired
public readonly severity: string;
  • Type: string

uriRequired
public readonly uri: string;
  • Type: string

internalValueOptional
public readonly internalValue: GoogleChronicleRuleCompilationDiagnostics;

GoogleChronicleRuleCompilationDiagnosticsPositionList

Initializers

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

new googleChronicleRule.GoogleChronicleRuleCompilationDiagnosticsPositionList(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): GoogleChronicleRuleCompilationDiagnosticsPositionOutputReference
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.

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

GoogleChronicleRuleCompilationDiagnosticsPositionOutputReference

Initializers

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

new googleChronicleRule.GoogleChronicleRuleCompilationDiagnosticsPositionOutputReference(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.

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.
endColumn number No description.
endLine number No description.
startColumn number No description.
startLine number No description.
internalValue GoogleChronicleRuleCompilationDiagnosticsPosition 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

endColumnRequired
public readonly endColumn: number;
  • Type: number

endLineRequired
public readonly endLine: number;
  • Type: number

startColumnRequired
public readonly startColumn: number;
  • Type: number

startLineRequired
public readonly startLine: number;
  • Type: number

internalValueOptional
public readonly internalValue: GoogleChronicleRuleCompilationDiagnosticsPosition;

GoogleChronicleRuleSeverityList

Initializers

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

new googleChronicleRule.GoogleChronicleRuleSeverityList(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): GoogleChronicleRuleSeverityOutputReference
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.

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

GoogleChronicleRuleSeverityOutputReference

Initializers

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

new googleChronicleRule.GoogleChronicleRuleSeverityOutputReference(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.

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.
displayName string No description.
internalValue GoogleChronicleRuleSeverity 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

displayNameRequired
public readonly displayName: string;
  • Type: string

internalValueOptional
public readonly internalValue: GoogleChronicleRuleSeverity;

GoogleChronicleRuleTimeoutsOutputReference

Initializers

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

new googleChronicleRule.GoogleChronicleRuleTimeoutsOutputReference(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.
resetCreate No description.
resetDelete No description.
resetUpdate 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.

resetCreate
public resetCreate(): void
resetDelete
public resetDelete(): void
resetUpdate
public resetUpdate(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
createInput string No description.
deleteInput string No description.
updateInput string No description.
create string No description.
delete string No description.
update string No description.
internalValue cdktf.IResolvable | GoogleChronicleRuleTimeouts 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

createInputOptional
public readonly createInput: string;
  • Type: string

deleteInputOptional
public readonly deleteInput: string;
  • Type: string

updateInputOptional
public readonly updateInput: string;
  • Type: string

createRequired
public readonly create: string;
  • Type: string

deleteRequired
public readonly delete: string;
  • Type: string

updateRequired
public readonly update: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | GoogleChronicleRuleTimeouts;