Skip to content

Latest commit

 

History

History
1923 lines (1200 loc) · 111 KB

File metadata and controls

1923 lines (1200 loc) · 111 KB

googleNetworkManagementOrganizationVpcFlowLogsConfig Submodule

Constructs

GoogleNetworkManagementOrganizationVpcFlowLogsConfig

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

Initializers

import { googleNetworkManagementOrganizationVpcFlowLogsConfig } from '@cdktn/provider-google-beta'

new googleNetworkManagementOrganizationVpcFlowLogsConfig.GoogleNetworkManagementOrganizationVpcFlowLogsConfig(scope: Construct, id: string, config: GoogleNetworkManagementOrganizationVpcFlowLogsConfigConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config GoogleNetworkManagementOrganizationVpcFlowLogsConfigConfig 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.
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".
putTimeouts No description.
resetAggregationInterval No description.
resetCrossProjectMetadata No description.
resetDeletionPolicy No description.
resetDescription No description.
resetFilterExpr No description.
resetFlowSampling No description.
resetId No description.
resetLabels No description.
resetMetadata No description.
resetMetadataFields No description.
resetState No description.
resetTimeouts 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.

mixinsRequired
  • Type: ...constructs.IMixin[]

The mixins to apply.


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: cdktn.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: GoogleNetworkManagementOrganizationVpcFlowLogsConfigTimeouts): void
valueRequired

resetAggregationInterval
public resetAggregationInterval(): void
resetCrossProjectMetadata
public resetCrossProjectMetadata(): void
resetDeletionPolicy
public resetDeletionPolicy(): void
resetDescription
public resetDescription(): void
resetFilterExpr
public resetFilterExpr(): void
resetFlowSampling
public resetFlowSampling(): void
resetId
public resetId(): void
resetLabels
public resetLabels(): void
resetMetadata
public resetMetadata(): void
resetMetadataFields
public resetMetadataFields(): void
resetState
public resetState(): void
resetTimeouts
public resetTimeouts(): 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 GoogleNetworkManagementOrganizationVpcFlowLogsConfig resource upon running "cdktn plan ".

isConstruct
import { googleNetworkManagementOrganizationVpcFlowLogsConfig } from '@cdktn/provider-google-beta'

googleNetworkManagementOrganizationVpcFlowLogsConfig.GoogleNetworkManagementOrganizationVpcFlowLogsConfig.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 { googleNetworkManagementOrganizationVpcFlowLogsConfig } from '@cdktn/provider-google-beta'

googleNetworkManagementOrganizationVpcFlowLogsConfig.GoogleNetworkManagementOrganizationVpcFlowLogsConfig.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { googleNetworkManagementOrganizationVpcFlowLogsConfig } from '@cdktn/provider-google-beta'

googleNetworkManagementOrganizationVpcFlowLogsConfig.GoogleNetworkManagementOrganizationVpcFlowLogsConfig.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { googleNetworkManagementOrganizationVpcFlowLogsConfig } from '@cdktn/provider-google-beta'

googleNetworkManagementOrganizationVpcFlowLogsConfig.GoogleNetworkManagementOrganizationVpcFlowLogsConfig.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTN code for importing a GoogleNetworkManagementOrganizationVpcFlowLogsConfig resource upon running "cdktn 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 GoogleNetworkManagementOrganizationVpcFlowLogsConfig to import.


importFromIdRequired
  • Type: string

The id of the existing GoogleNetworkManagementOrganizationVpcFlowLogsConfig that should be imported.

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


providerOptional
  • Type: cdktn.TerraformProvider

? Optional instance of the provider where the GoogleNetworkManagementOrganizationVpcFlowLogsConfig 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.
createTime string No description.
effectiveLabels cdktn.StringMap No description.
name string No description.
terraformLabels cdktn.StringMap No description.
timeouts GoogleNetworkManagementOrganizationVpcFlowLogsConfigTimeoutsOutputReference No description.
updateTime string No description.
aggregationIntervalInput string No description.
crossProjectMetadataInput string No description.
deletionPolicyInput string No description.
descriptionInput string No description.
filterExprInput string No description.
flowSamplingInput number No description.
idInput string No description.
labelsInput {[ key: string ]: string} No description.
locationInput string No description.
metadataFieldsInput string[] No description.
metadataInput string No description.
organizationInput string No description.
stateInput string No description.
timeoutsInput cdktn.IResolvable | GoogleNetworkManagementOrganizationVpcFlowLogsConfigTimeouts No description.
vpcFlowLogsConfigIdInput string No description.
aggregationInterval string No description.
crossProjectMetadata string No description.
deletionPolicy string No description.
description string No description.
filterExpr string No description.
flowSampling number No description.
id string No description.
labels {[ key: string ]: string} No description.
location string No description.
metadata string No description.
metadataFields string[] No description.
organization string No description.
state string No description.
vpcFlowLogsConfigId string No description.

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

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktn.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: cdktn.TerraformProviderGeneratorMetadata

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

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

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

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

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

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

provisionersOptional
public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];
  • Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]

createTimeRequired
public readonly createTime: string;
  • Type: string

effectiveLabelsRequired
public readonly effectiveLabels: StringMap;
  • Type: cdktn.StringMap

nameRequired
public readonly name: string;
  • Type: string

terraformLabelsRequired
public readonly terraformLabels: StringMap;
  • Type: cdktn.StringMap

timeoutsRequired
public readonly timeouts: GoogleNetworkManagementOrganizationVpcFlowLogsConfigTimeoutsOutputReference;

updateTimeRequired
public readonly updateTime: string;
  • Type: string

aggregationIntervalInputOptional
public readonly aggregationIntervalInput: string;
  • Type: string

crossProjectMetadataInputOptional
public readonly crossProjectMetadataInput: string;
  • Type: string

deletionPolicyInputOptional
public readonly deletionPolicyInput: string;
  • Type: string

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

filterExprInputOptional
public readonly filterExprInput: string;
  • Type: string

flowSamplingInputOptional
public readonly flowSamplingInput: number;
  • Type: number

idInputOptional
public readonly idInput: string;
  • Type: string

labelsInputOptional
public readonly labelsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

locationInputOptional
public readonly locationInput: string;
  • Type: string

metadataFieldsInputOptional
public readonly metadataFieldsInput: string[];
  • Type: string[]

metadataInputOptional
public readonly metadataInput: string;
  • Type: string

organizationInputOptional
public readonly organizationInput: string;
  • Type: string

stateInputOptional
public readonly stateInput: string;
  • Type: string

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | GoogleNetworkManagementOrganizationVpcFlowLogsConfigTimeouts;

vpcFlowLogsConfigIdInputOptional
public readonly vpcFlowLogsConfigIdInput: string;
  • Type: string

aggregationIntervalRequired
public readonly aggregationInterval: string;
  • Type: string

crossProjectMetadataRequired
public readonly crossProjectMetadata: string;
  • Type: string

deletionPolicyRequired
public readonly deletionPolicy: string;
  • Type: string

descriptionRequired
public readonly description: string;
  • Type: string

filterExprRequired
public readonly filterExpr: string;
  • Type: string

flowSamplingRequired
public readonly flowSampling: number;
  • Type: number

idRequired
public readonly id: string;
  • Type: string

labelsRequired
public readonly labels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

locationRequired
public readonly location: string;
  • Type: string

metadataRequired
public readonly metadata: string;
  • Type: string

metadataFieldsRequired
public readonly metadataFields: string[];
  • Type: string[]

organizationRequired
public readonly organization: string;
  • Type: string

stateRequired
public readonly state: string;
  • Type: string

vpcFlowLogsConfigIdRequired
public readonly vpcFlowLogsConfigId: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

GoogleNetworkManagementOrganizationVpcFlowLogsConfigConfig

Initializer

import { googleNetworkManagementOrganizationVpcFlowLogsConfig } from '@cdktn/provider-google-beta'

const googleNetworkManagementOrganizationVpcFlowLogsConfigConfig: googleNetworkManagementOrganizationVpcFlowLogsConfig.GoogleNetworkManagementOrganizationVpcFlowLogsConfigConfig = { ... }

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.
location string Resource ID segment making up resource 'name'.
organization string Resource ID segment making up resource 'name'. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
vpcFlowLogsConfigId string Required. ID of the 'VpcFlowLogsConfig'.
aggregationInterval string Optional.
crossProjectMetadata string Determines whether to include cross project annotations in the logs.
deletionPolicy string Whether Terraform will be prevented from destroying the instance.
description string Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
filterExpr string Optional. Export filter used to define which VPC Flow Logs should be logged.
flowSampling number Optional.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_network_management_organization_vpc_flow_logs_config#id GoogleNetworkManagementOrganizationVpcFlowLogsConfig#id}.
labels {[ key: string ]: string} Optional. Resource labels to represent the user-provided metadata.
metadata string Optional.
metadataFields string[] Optional.
state string Optional.
timeouts GoogleNetworkManagementOrganizationVpcFlowLogsConfigTimeouts timeouts block.

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

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

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

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

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

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

provisionersOptional
public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];
  • Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]

locationRequired
public readonly location: string;
  • Type: string

Resource ID segment making up resource 'name'.

It identifies the resource within its parent collection as described in https://google.aip.dev/122. See documentation for resource type 'networkmanagement.googleapis.com/VpcFlowLogsConfig'.

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


organizationRequired
public readonly organization: string;
  • Type: string

Resource ID segment making up resource 'name'. It identifies the resource within its parent collection as described in https://google.aip.dev/122.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_network_management_organization_vpc_flow_logs_config#organization GoogleNetworkManagementOrganizationVpcFlowLogsConfig#organization}


vpcFlowLogsConfigIdRequired
public readonly vpcFlowLogsConfigId: string;
  • Type: string

Required. ID of the 'VpcFlowLogsConfig'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_network_management_organization_vpc_flow_logs_config#vpc_flow_logs_config_id GoogleNetworkManagementOrganizationVpcFlowLogsConfig#vpc_flow_logs_config_id}


aggregationIntervalOptional
public readonly aggregationInterval: string;
  • Type: string

Optional.

The aggregation interval for the logs. Default value is INTERVAL_5_SEC. Possible values: INTERVAL_5_SEC INTERVAL_30_SEC INTERVAL_1_MIN INTERVAL_5_MIN INTERVAL_10_MIN INTERVAL_15_MIN

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_network_management_organization_vpc_flow_logs_config#aggregation_interval GoogleNetworkManagementOrganizationVpcFlowLogsConfig#aggregation_interval}


crossProjectMetadataOptional
public readonly crossProjectMetadata: string;
  • Type: string

Determines whether to include cross project annotations in the logs.

This field is available only for organization configurations. If not specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED. Possible values: CROSS_PROJECT_METADATA_ENABLED CROSS_PROJECT_METADATA_DISABLED Possible values: ["CROSS_PROJECT_METADATA_ENABLED", "CROSS_PROJECT_METADATA_DISABLED"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_network_management_organization_vpc_flow_logs_config#cross_project_metadata GoogleNetworkManagementOrganizationVpcFlowLogsConfig#cross_project_metadata}


deletionPolicyOptional
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-beta/7.36.0/docs/resources/google_network_management_organization_vpc_flow_logs_config#deletion_policy GoogleNetworkManagementOrganizationVpcFlowLogsConfig#deletion_policy}


descriptionOptional
public readonly description: string;
  • Type: string

Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_network_management_organization_vpc_flow_logs_config#description GoogleNetworkManagementOrganizationVpcFlowLogsConfig#description}


filterExprOptional
public readonly filterExpr: string;
  • Type: string

Optional. Export filter used to define which VPC Flow Logs should be logged.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_network_management_organization_vpc_flow_logs_config#filter_expr GoogleNetworkManagementOrganizationVpcFlowLogsConfig#filter_expr}


flowSamplingOptional
public readonly flowSampling: number;
  • Type: number

Optional.

The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_network_management_organization_vpc_flow_logs_config#flow_sampling GoogleNetworkManagementOrganizationVpcFlowLogsConfig#flow_sampling}


idOptional
public readonly id: string;
  • Type: string

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


labelsOptional
public readonly labels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Optional. Resource labels to represent the user-provided metadata.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_network_management_organization_vpc_flow_logs_config#labels GoogleNetworkManagementOrganizationVpcFlowLogsConfig#labels}


metadataOptional
public readonly metadata: string;
  • Type: string

Optional.

Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA. Possible values: METADATA_UNSPECIFIED INCLUDE_ALL_METADATA EXCLUDE_ALL_METADATA CUSTOM_METADATA

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_network_management_organization_vpc_flow_logs_config#metadata GoogleNetworkManagementOrganizationVpcFlowLogsConfig#metadata}


metadataFieldsOptional
public readonly metadataFields: string[];
  • Type: string[]

Optional.

Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_network_management_organization_vpc_flow_logs_config#metadata_fields GoogleNetworkManagementOrganizationVpcFlowLogsConfig#metadata_fields}


stateOptional
public readonly state: string;
  • Type: string

Optional.

The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Possible values: ENABLED DISABLED

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_network_management_organization_vpc_flow_logs_config#state GoogleNetworkManagementOrganizationVpcFlowLogsConfig#state}


timeoutsOptional
public readonly timeouts: GoogleNetworkManagementOrganizationVpcFlowLogsConfigTimeouts;

timeouts block.

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


GoogleNetworkManagementOrganizationVpcFlowLogsConfigTimeouts

Initializer

import { googleNetworkManagementOrganizationVpcFlowLogsConfig } from '@cdktn/provider-google-beta'

const googleNetworkManagementOrganizationVpcFlowLogsConfigTimeouts: googleNetworkManagementOrganizationVpcFlowLogsConfig.GoogleNetworkManagementOrganizationVpcFlowLogsConfigTimeouts = { ... }

Properties

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

createOptional
public readonly create: string;
  • Type: string

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


deleteOptional
public readonly delete: string;
  • Type: string

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


updateOptional
public readonly update: string;
  • Type: string

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


Classes

GoogleNetworkManagementOrganizationVpcFlowLogsConfigTimeoutsOutputReference

Initializers

import { googleNetworkManagementOrganizationVpcFlowLogsConfig } from '@cdktn/provider-google-beta'

new googleNetworkManagementOrganizationVpcFlowLogsConfig.GoogleNetworkManagementOrganizationVpcFlowLogsConfigTimeoutsOutputReference(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.

terraformResourceRequired
  • Type: cdktn.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: cdktn.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 cdktn.IResolvable | GoogleNetworkManagementOrganizationVpcFlowLogsConfigTimeouts 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 | GoogleNetworkManagementOrganizationVpcFlowLogsConfigTimeouts;