`computeOrganizationSecurityPolicy` Submodule

Constructs

ComputeOrganizationSecurityPolicy

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

Initializers

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

new computeOrganizationSecurityPolicy.ComputeOrganizationSecurityPolicy(scope: Construct, id: string, config: ComputeOrganizationSecurityPolicyConfig)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: ComputeOrganizationSecurityPolicyConfig

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".
`putAdvancedOptionsConfig`	No description.
`putTimeouts`	No description.
`resetAdvancedOptionsConfig`	No description.
`resetDeletionPolicy`	No description.
`resetDescription`	No description.
`resetDisplayName`	No description.
`resetId`	No description.
`resetShortName`	No description.
`resetTimeouts`	No description.
`resetType`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`with`

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

Applies one or more mixins to this construct.

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

`mixins`^Required

Type: ...constructs.IMixin[]

The mixins to apply.

`addOverride`

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

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public resetOverrideLogicalId(): void

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

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

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

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

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

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

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

`id`^Required

Type: string

`provider`^Optional

Type: cdktn.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

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

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

`id`^Required

Type: string

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

`moveTo`

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

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

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

`index`^Optional

Type: string | number

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

`moveToId`

public moveToId(id: string): void

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

`id`^Required

Type: string

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

`putAdvancedOptionsConfig`

public putAdvancedOptionsConfig(value: ComputeOrganizationSecurityPolicyAdvancedOptionsConfig): void

`value`^Required

Type: ComputeOrganizationSecurityPolicyAdvancedOptionsConfig

`putTimeouts`

public putTimeouts(value: ComputeOrganizationSecurityPolicyTimeouts): void

`value`^Required

Type: ComputeOrganizationSecurityPolicyTimeouts

`resetAdvancedOptionsConfig`

public resetAdvancedOptionsConfig(): void

`resetDeletionPolicy`

public resetDeletionPolicy(): void

`resetDescription`

public resetDescription(): void

`resetDisplayName`

public resetDisplayName(): void

`resetId`

public resetId(): void

`resetShortName`

public resetShortName(): void

`resetTimeouts`

public resetTimeouts(): void

`resetType`

public resetType(): 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 ComputeOrganizationSecurityPolicy resource upon running "cdktn plan ".

`isConstruct`

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

computeOrganizationSecurityPolicy.ComputeOrganizationSecurityPolicy.isConstruct(x: any)

Checks if x is a construct.

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

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

`x`^Required

Type: any

Any object.

`isTerraformElement`

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

computeOrganizationSecurityPolicy.ComputeOrganizationSecurityPolicy.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

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

computeOrganizationSecurityPolicy.ComputeOrganizationSecurityPolicy.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

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

computeOrganizationSecurityPolicy.ComputeOrganizationSecurityPolicy.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

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

`importFromId`^Required

Type: string

The id of the existing ComputeOrganizationSecurityPolicy that should be imported.

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

`provider`^Optional

Type: cdktn.TerraformProvider

? Optional instance of the provider where the ComputeOrganizationSecurityPolicy 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.
`advancedOptionsConfig`	`ComputeOrganizationSecurityPolicyAdvancedOptionsConfigOutputReference`	No description.
`fingerprint`	`string`	No description.
`policyId`	`string`	No description.
`timeouts`	`ComputeOrganizationSecurityPolicyTimeoutsOutputReference`	No description.
`advancedOptionsConfigInput`	`ComputeOrganizationSecurityPolicyAdvancedOptionsConfig`	No description.
`deletionPolicyInput`	`string`	No description.
`descriptionInput`	`string`	No description.
`displayNameInput`	`string`	No description.
`idInput`	`string`	No description.
`parentInput`	`string`	No description.
`shortNameInput`	`string`	No description.
`timeoutsInput`	`cdktn.IResolvable \| ComputeOrganizationSecurityPolicyTimeouts`	No description.
`typeInput`	`string`	No description.
`deletionPolicy`	`string`	No description.
`description`	`string`	No description.
`displayName`	`string`	No description.
`id`	`string`	No description.
`parent`	`string`	No description.
`shortName`	`string`	No description.
`type`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktn.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

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

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktn.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktn.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktn.TerraformProvider

`provisioners`^Optional

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

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

`advancedOptionsConfig`^Required

public readonly advancedOptionsConfig: ComputeOrganizationSecurityPolicyAdvancedOptionsConfigOutputReference;

Type: ComputeOrganizationSecurityPolicyAdvancedOptionsConfigOutputReference

`fingerprint`^Required

public readonly fingerprint: string;

Type: string

`policyId`^Required

public readonly policyId: string;

Type: string

`timeouts`^Required

public readonly timeouts: ComputeOrganizationSecurityPolicyTimeoutsOutputReference;

Type: ComputeOrganizationSecurityPolicyTimeoutsOutputReference

`advancedOptionsConfigInput`^Optional

public readonly advancedOptionsConfigInput: ComputeOrganizationSecurityPolicyAdvancedOptionsConfig;

Type: ComputeOrganizationSecurityPolicyAdvancedOptionsConfig

`deletionPolicyInput`^Optional

public readonly deletionPolicyInput: string;

Type: string

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`displayNameInput`^Optional

public readonly displayNameInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`parentInput`^Optional

public readonly parentInput: string;

Type: string

`shortNameInput`^Optional

public readonly shortNameInput: string;

Type: string

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | ComputeOrganizationSecurityPolicyTimeouts;

Type: cdktn.IResolvable | ComputeOrganizationSecurityPolicyTimeouts

`typeInput`^Optional

public readonly typeInput: string;

Type: string

`deletionPolicy`^Required

public readonly deletionPolicy: string;

Type: string

`description`^Required

public readonly description: string;

Type: string

`displayName`^Required

public readonly displayName: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`parent`^Required

public readonly parent: string;

Type: string

`shortName`^Required

public readonly shortName: string;

Type: string

`type`^Required

public readonly type: string;

Type: string

Constants

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

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

ComputeOrganizationSecurityPolicyAdvancedOptionsConfig

Initializer

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

const computeOrganizationSecurityPolicyAdvancedOptionsConfig: computeOrganizationSecurityPolicy.ComputeOrganizationSecurityPolicyAdvancedOptionsConfig = { ... }

Properties

Name	Type	Description
`jsonCustomConfig`	`ComputeOrganizationSecurityPolicyAdvancedOptionsConfigJsonCustomConfig`	json_custom_config block.
`jsonParsing`	`string`	JSON body parsing. Supported values include: "DISABLED", "STANDARD", "STANDARD_WITH_GRAPHQL". Possible values: ["DISABLED", "STANDARD", "STANDARD_WITH_GRAPHQL"].
`logLevel`	`string`	Logging level. Supported values include: "NORMAL", "VERBOSE". Possible values: ["NORMAL", "VERBOSE"].
`requestBodyInspectionSize`	`string`	The maximum request size chosen by the customer with Waf enabled.
`userIpRequestHeaders`	`string[]`	An optional list of case-insensitive request header names to use for resolving the client source IP address.

`jsonCustomConfig`^Optional

public readonly jsonCustomConfig: ComputeOrganizationSecurityPolicyAdvancedOptionsConfigJsonCustomConfig;

Type: ComputeOrganizationSecurityPolicyAdvancedOptionsConfigJsonCustomConfig

json_custom_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/compute_organization_security_policy#json_custom_config ComputeOrganizationSecurityPolicy#json_custom_config}

`jsonParsing`^Optional

public readonly jsonParsing: string;

Type: string

JSON body parsing. Supported values include: "DISABLED", "STANDARD", "STANDARD_WITH_GRAPHQL". Possible values: ["DISABLED", "STANDARD", "STANDARD_WITH_GRAPHQL"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/compute_organization_security_policy#json_parsing ComputeOrganizationSecurityPolicy#json_parsing}

`logLevel`^Optional

public readonly logLevel: string;

Type: string

Logging level. Supported values include: "NORMAL", "VERBOSE". Possible values: ["NORMAL", "VERBOSE"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/compute_organization_security_policy#log_level ComputeOrganizationSecurityPolicy#log_level}

`requestBodyInspectionSize`^Optional

public readonly requestBodyInspectionSize: string;

Type: string

The maximum request size chosen by the customer with Waf enabled.

Values supported are "8KB", "16KB", "32KB", "48KB" and "64KB". Values are case insensitive. Possible values: ["8KB", "16KB", "32KB", "48KB", "64KB"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/compute_organization_security_policy#request_body_inspection_size ComputeOrganizationSecurityPolicy#request_body_inspection_size}

`userIpRequestHeaders`^Optional

public readonly userIpRequestHeaders: string[];

Type: string[]

An optional list of case-insensitive request header names to use for resolving the client source IP address.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/compute_organization_security_policy#user_ip_request_headers ComputeOrganizationSecurityPolicy#user_ip_request_headers}

ComputeOrganizationSecurityPolicyAdvancedOptionsConfigJsonCustomConfig

Initializer

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

const computeOrganizationSecurityPolicyAdvancedOptionsConfigJsonCustomConfig: computeOrganizationSecurityPolicy.ComputeOrganizationSecurityPolicyAdvancedOptionsConfigJsonCustomConfig = { ... }

Properties

Name	Type	Description
`contentTypes`	`string[]`	A list of content types to be parsed as JSON.

`contentTypes`^Required

public readonly contentTypes: string[];

Type: string[]

A list of content types to be parsed as JSON.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/compute_organization_security_policy#content_types ComputeOrganizationSecurityPolicy#content_types}

ComputeOrganizationSecurityPolicyConfig

Initializer

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

const computeOrganizationSecurityPolicyConfig: computeOrganizationSecurityPolicy.ComputeOrganizationSecurityPolicyConfig = { ... }

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.
`parent`	`string`	The parent of this OrganizationSecurityPolicy in the Cloud Resource Hierarchy. Format: organizations/{organization_id} or folders/{folder_id}.
`advancedOptionsConfig`	`ComputeOrganizationSecurityPolicyAdvancedOptionsConfig`	advanced_options_config block.
`deletionPolicy`	`string`	Whether Terraform will be prevented from destroying the instance.
`description`	`string`	A textual description for the organization security policy.
`displayName`	`string`	User-provided name of the organization security policy.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/compute_organization_security_policy#id ComputeOrganizationSecurityPolicy#id}.
`shortName`	`string`	User-provided name of the organization security policy.
`timeouts`	`ComputeOrganizationSecurityPolicyTimeouts`	timeouts block.
`type`	`string`	The type indicates the intended use of the security policy.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktn.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktn.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktn.TerraformProvider

`provisioners`^Optional

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

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

`parent`^Required

public readonly parent: string;

Type: string

The parent of this OrganizationSecurityPolicy in the Cloud Resource Hierarchy. Format: organizations/{organization_id} or folders/{folder_id}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/compute_organization_security_policy#parent ComputeOrganizationSecurityPolicy#parent}

`advancedOptionsConfig`^Optional

public readonly advancedOptionsConfig: ComputeOrganizationSecurityPolicyAdvancedOptionsConfig;

Type: ComputeOrganizationSecurityPolicyAdvancedOptionsConfig

advanced_options_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/compute_organization_security_policy#advanced_options_config ComputeOrganizationSecurityPolicy#advanced_options_config}

`deletionPolicy`^Optional

public readonly deletionPolicy: string;

Type: string

Whether Terraform will be prevented from destroying the instance.

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

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

`description`^Optional

public readonly description: string;

Type: string

A textual description for the organization security policy.

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

`displayName`^Optional

public readonly displayName: string;

Type: string

User-provided name of the organization security policy.

The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is FIREWALL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/compute_organization_security_policy#display_name ComputeOrganizationSecurityPolicy#display_name}

`id`^Optional

public readonly id: string;

Type: string

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

`shortName`^Optional

public readonly shortName: string;

Type: string

User-provided name of the organization security policy.

The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/compute_organization_security_policy#short_name ComputeOrganizationSecurityPolicy#short_name}

`timeouts`^Optional

public readonly timeouts: ComputeOrganizationSecurityPolicyTimeouts;

Type: ComputeOrganizationSecurityPolicyTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/compute_organization_security_policy#timeouts ComputeOrganizationSecurityPolicy#timeouts}

`type`^Optional

public readonly type: string;

Type: string

The type indicates the intended use of the security policy.

This field can be set only at resource creation time.

NOTE : 'FIREWALL' type is deprecated and will be removed in a future major release. Please use 'google_compute_firewall_policy' instead." Possible values: ["FIREWALL", "CLOUD_ARMOR", "CLOUD_ARMOR_EDGE", "CLOUD_ARMOR_INTERNAL_SERVICE", "CLOUD_ARMOR_NETWORK"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/compute_organization_security_policy#type ComputeOrganizationSecurityPolicy#type}

ComputeOrganizationSecurityPolicyTimeouts

Initializer

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

const computeOrganizationSecurityPolicyTimeouts: computeOrganizationSecurityPolicy.ComputeOrganizationSecurityPolicyTimeouts = { ... }

Properties

Name	Type	Description
`create`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/compute_organization_security_policy#create ComputeOrganizationSecurityPolicy#create}.
`delete`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/compute_organization_security_policy#delete ComputeOrganizationSecurityPolicy#delete}.
`update`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/compute_organization_security_policy#update ComputeOrganizationSecurityPolicy#update}.

`create`^Optional

public readonly create: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/compute_organization_security_policy#create ComputeOrganizationSecurityPolicy#create}.

`delete`^Optional

public readonly delete: string;

Type: string

`update`^Optional

public readonly update: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/compute_organization_security_policy#update ComputeOrganizationSecurityPolicy#update}.

Classes

ComputeOrganizationSecurityPolicyAdvancedOptionsConfigJsonCustomConfigOutputReference

Initializers

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

new computeOrganizationSecurityPolicy.ComputeOrganizationSecurityPolicyAdvancedOptionsConfigJsonCustomConfigOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

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

`terraformResource`^Required

Type: cdktn.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

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

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

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

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktn.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`contentTypesInput`	`string[]`	No description.
`contentTypes`	`string[]`	No description.
`internalValue`	`ComputeOrganizationSecurityPolicyAdvancedOptionsConfigJsonCustomConfig`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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

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

`fqn`^Required

public readonly fqn: string;

Type: string

`contentTypesInput`^Optional

public readonly contentTypesInput: string[];

Type: string[]

`contentTypes`^Required

public readonly contentTypes: string[];

Type: string[]

`internalValue`^Optional

public readonly internalValue: ComputeOrganizationSecurityPolicyAdvancedOptionsConfigJsonCustomConfig;

Type: ComputeOrganizationSecurityPolicyAdvancedOptionsConfigJsonCustomConfig

ComputeOrganizationSecurityPolicyAdvancedOptionsConfigOutputReference

Initializers

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

new computeOrganizationSecurityPolicy.ComputeOrganizationSecurityPolicyAdvancedOptionsConfigOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

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

`terraformResource`^Required

Type: cdktn.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

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

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

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

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktn.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`putJsonCustomConfig`

public putJsonCustomConfig(value: ComputeOrganizationSecurityPolicyAdvancedOptionsConfigJsonCustomConfig): void

`value`^Required

Type: ComputeOrganizationSecurityPolicyAdvancedOptionsConfigJsonCustomConfig

`resetJsonCustomConfig`

public resetJsonCustomConfig(): void

`resetJsonParsing`

public resetJsonParsing(): void

`resetLogLevel`

public resetLogLevel(): void

`resetRequestBodyInspectionSize`

public resetRequestBodyInspectionSize(): void

`resetUserIpRequestHeaders`

public resetUserIpRequestHeaders(): 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.
`jsonCustomConfig`	`ComputeOrganizationSecurityPolicyAdvancedOptionsConfigJsonCustomConfigOutputReference`	No description.
`jsonCustomConfigInput`	`ComputeOrganizationSecurityPolicyAdvancedOptionsConfigJsonCustomConfig`	No description.
`jsonParsingInput`	`string`	No description.
`logLevelInput`	`string`	No description.
`requestBodyInspectionSizeInput`	`string`	No description.
`userIpRequestHeadersInput`	`string[]`	No description.
`jsonParsing`	`string`	No description.
`logLevel`	`string`	No description.
`requestBodyInspectionSize`	`string`	No description.
`userIpRequestHeaders`	`string[]`	No description.
`internalValue`	`ComputeOrganizationSecurityPolicyAdvancedOptionsConfig`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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

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

`fqn`^Required

public readonly fqn: string;

Type: string

`jsonCustomConfig`^Required

public readonly jsonCustomConfig: ComputeOrganizationSecurityPolicyAdvancedOptionsConfigJsonCustomConfigOutputReference;

Type: ComputeOrganizationSecurityPolicyAdvancedOptionsConfigJsonCustomConfigOutputReference

`jsonCustomConfigInput`^Optional

public readonly jsonCustomConfigInput: ComputeOrganizationSecurityPolicyAdvancedOptionsConfigJsonCustomConfig;

Type: ComputeOrganizationSecurityPolicyAdvancedOptionsConfigJsonCustomConfig

`jsonParsingInput`^Optional

public readonly jsonParsingInput: string;

Type: string

`logLevelInput`^Optional

public readonly logLevelInput: string;

Type: string

`requestBodyInspectionSizeInput`^Optional

public readonly requestBodyInspectionSizeInput: string;

Type: string

`userIpRequestHeadersInput`^Optional

public readonly userIpRequestHeadersInput: string[];

Type: string[]

`jsonParsing`^Required

public readonly jsonParsing: string;

Type: string

`logLevel`^Required

public readonly logLevel: string;

Type: string

`requestBodyInspectionSize`^Required

public readonly requestBodyInspectionSize: string;

Type: string

`userIpRequestHeaders`^Required

public readonly userIpRequestHeaders: string[];

Type: string[]

`internalValue`^Optional

public readonly internalValue: ComputeOrganizationSecurityPolicyAdvancedOptionsConfig;

Type: ComputeOrganizationSecurityPolicyAdvancedOptionsConfig

ComputeOrganizationSecurityPolicyTimeoutsOutputReference

Initializers

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

new computeOrganizationSecurityPolicy.ComputeOrganizationSecurityPolicyTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

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

`terraformResource`^Required

Type: cdktn.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

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

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

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

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktn.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`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 \| ComputeOrganizationSecurityPolicyTimeouts`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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

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

`fqn`^Required

public readonly fqn: string;

Type: string

`createInput`^Optional

public readonly createInput: string;

Type: string

`deleteInput`^Optional

public readonly deleteInput: string;

Type: string

`updateInput`^Optional

public readonly updateInput: string;

Type: string

`create`^Required

public readonly create: string;

Type: string

`delete`^Required

public readonly delete: string;

Type: string

`update`^Required

public readonly update: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | ComputeOrganizationSecurityPolicyTimeouts;

Type: cdktn.IResolvable | ComputeOrganizationSecurityPolicyTimeouts

Uh oh!

FilesExpand file tree

computeOrganizationSecurityPolicy.typescript.md

Latest commit

History

computeOrganizationSecurityPolicy.typescript.md

File metadata and controls

computeOrganizationSecurityPolicy Submodule

Constructs