Skip to content

Files

Latest commit

 

History

History
11809 lines (7339 loc) · 624 KB
·

computeRegionBackendService.typescript.md

File metadata and controls

11809 lines (7339 loc) · 624 KB
·

computeRegionBackendService Submodule

Constructs

ComputeRegionBackendService

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service google_compute_region_backend_service}.

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendService(scope: Construct, id: string, config: ComputeRegionBackendServiceConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config ComputeRegionBackendServiceConfig 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".
putBackend No description.
putCdnPolicy No description.
putCircuitBreakers No description.
putConsistentHash No description.
putCustomMetrics No description.
putFailoverPolicy No description.
putIap No description.
putLogConfig No description.
putOutlierDetection No description.
putStrongSessionAffinityCookie No description.
putTimeouts No description.
resetAffinityCookieTtlSec No description.
resetBackend No description.
resetCdnPolicy No description.
resetCircuitBreakers No description.
resetConnectionDrainingTimeoutSec No description.
resetConsistentHash No description.
resetCustomMetrics No description.
resetDescription No description.
resetEnableCdn No description.
resetFailoverPolicy No description.
resetHealthChecks No description.
resetIap No description.
resetId No description.
resetIpAddressSelectionPolicy No description.
resetLoadBalancingScheme No description.
resetLocalityLbPolicy No description.
resetLogConfig No description.
resetNetwork No description.
resetOutlierDetection No description.
resetPortName No description.
resetProject No description.
resetProtocol No description.
resetRegion No description.
resetSessionAffinity No description.
resetStrongSessionAffinityCookie No description.
resetTimeouts No description.
resetTimeoutSec 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".

putBackend 
public putBackend(value: IResolvable | ComputeRegionBackendServiceBackend[]): void
valueRequired
putCdnPolicy 
public putCdnPolicy(value: ComputeRegionBackendServiceCdnPolicy): void
valueRequired
putCircuitBreakers 
public putCircuitBreakers(value: ComputeRegionBackendServiceCircuitBreakers): void
valueRequired
putConsistentHash 
public putConsistentHash(value: ComputeRegionBackendServiceConsistentHash): void
valueRequired
putCustomMetrics 
public putCustomMetrics(value: IResolvable | ComputeRegionBackendServiceCustomMetrics[]): void
valueRequired
putFailoverPolicy 
public putFailoverPolicy(value: ComputeRegionBackendServiceFailoverPolicy): void
valueRequired
putIap 
public putIap(value: ComputeRegionBackendServiceIap): void
valueRequired
putLogConfig 
public putLogConfig(value: ComputeRegionBackendServiceLogConfig): void
valueRequired
putOutlierDetection 
public putOutlierDetection(value: ComputeRegionBackendServiceOutlierDetection): void
valueRequired
putStrongSessionAffinityCookie 
public putStrongSessionAffinityCookie(value: ComputeRegionBackendServiceStrongSessionAffinityCookie): void
valueRequired
putTimeouts 
public putTimeouts(value: ComputeRegionBackendServiceTimeouts): void
valueRequired
resetAffinityCookieTtlSec 
public resetAffinityCookieTtlSec(): void
resetBackend 
public resetBackend(): void
resetCdnPolicy 
public resetCdnPolicy(): void
resetCircuitBreakers 
public resetCircuitBreakers(): void
resetConnectionDrainingTimeoutSec 
public resetConnectionDrainingTimeoutSec(): void
resetConsistentHash 
public resetConsistentHash(): void
resetCustomMetrics 
public resetCustomMetrics(): void
resetDescription 
public resetDescription(): void
resetEnableCdn 
public resetEnableCdn(): void
resetFailoverPolicy 
public resetFailoverPolicy(): void
resetHealthChecks 
public resetHealthChecks(): void
resetIap 
public resetIap(): void
resetId 
public resetId(): void
resetIpAddressSelectionPolicy 
public resetIpAddressSelectionPolicy(): void
resetLoadBalancingScheme 
public resetLoadBalancingScheme(): void
resetLocalityLbPolicy 
public resetLocalityLbPolicy(): void
resetLogConfig 
public resetLogConfig(): void
resetNetwork 
public resetNetwork(): void
resetOutlierDetection 
public resetOutlierDetection(): void
resetPortName 
public resetPortName(): void
resetProject 
public resetProject(): void
resetProtocol 
public resetProtocol(): void
resetRegion 
public resetRegion(): void
resetSessionAffinity 
public resetSessionAffinity(): void
resetStrongSessionAffinityCookie 
public resetStrongSessionAffinityCookie(): void
resetTimeouts 
public resetTimeouts(): void
resetTimeoutSec 
public resetTimeoutSec(): 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 ComputeRegionBackendService resource upon running "cdktf plan ".
isConstruct 
import { computeRegionBackendService } from '@cdktf/provider-google'

computeRegionBackendService.ComputeRegionBackendService.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 { computeRegionBackendService } from '@cdktf/provider-google'

computeRegionBackendService.ComputeRegionBackendService.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { computeRegionBackendService } from '@cdktf/provider-google'

computeRegionBackendService.ComputeRegionBackendService.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { computeRegionBackendService } from '@cdktf/provider-google'

computeRegionBackendService.ComputeRegionBackendService.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

importFromIdRequired
  • Type: string

The id of the existing ComputeRegionBackendService that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#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 ComputeRegionBackendService 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.
backend ComputeRegionBackendServiceBackendList No description.
cdnPolicy ComputeRegionBackendServiceCdnPolicyOutputReference No description.
circuitBreakers ComputeRegionBackendServiceCircuitBreakersOutputReference No description.
consistentHash ComputeRegionBackendServiceConsistentHashOutputReference No description.
creationTimestamp string No description.
customMetrics ComputeRegionBackendServiceCustomMetricsList No description.
failoverPolicy ComputeRegionBackendServiceFailoverPolicyOutputReference No description.
fingerprint string No description.
generatedId number No description.
iap ComputeRegionBackendServiceIapOutputReference No description.
logConfig ComputeRegionBackendServiceLogConfigOutputReference No description.
outlierDetection ComputeRegionBackendServiceOutlierDetectionOutputReference No description.
selfLink string No description.
strongSessionAffinityCookie ComputeRegionBackendServiceStrongSessionAffinityCookieOutputReference No description.
timeouts ComputeRegionBackendServiceTimeoutsOutputReference No description.
affinityCookieTtlSecInput number No description.
backendInput cdktf.IResolvable | ComputeRegionBackendServiceBackend[] No description.
cdnPolicyInput ComputeRegionBackendServiceCdnPolicy No description.
circuitBreakersInput ComputeRegionBackendServiceCircuitBreakers No description.
connectionDrainingTimeoutSecInput number No description.
consistentHashInput ComputeRegionBackendServiceConsistentHash No description.
customMetricsInput cdktf.IResolvable | ComputeRegionBackendServiceCustomMetrics[] No description.
descriptionInput string No description.
enableCdnInput boolean | cdktf.IResolvable No description.
failoverPolicyInput ComputeRegionBackendServiceFailoverPolicy No description.
healthChecksInput string[] No description.
iapInput ComputeRegionBackendServiceIap No description.
idInput string No description.
ipAddressSelectionPolicyInput string No description.
loadBalancingSchemeInput string No description.
localityLbPolicyInput string No description.
logConfigInput ComputeRegionBackendServiceLogConfig No description.
nameInput string No description.
networkInput string No description.
outlierDetectionInput ComputeRegionBackendServiceOutlierDetection No description.
portNameInput string No description.
projectInput string No description.
protocolInput string No description.
regionInput string No description.
sessionAffinityInput string No description.
strongSessionAffinityCookieInput ComputeRegionBackendServiceStrongSessionAffinityCookie No description.
timeoutSecInput number No description.
timeoutsInput cdktf.IResolvable | ComputeRegionBackendServiceTimeouts No description.
affinityCookieTtlSec number No description.
connectionDrainingTimeoutSec number No description.
description string No description.
enableCdn boolean | cdktf.IResolvable No description.
healthChecks string[] No description.
id string No description.
ipAddressSelectionPolicy string No description.
loadBalancingScheme string No description.
localityLbPolicy string No description.
name string No description.
network string No description.
portName string No description.
project string No description.
protocol string No description.
region string No description.
sessionAffinity string No description.
timeoutSec number 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[]
backendRequired 
public readonly backend: ComputeRegionBackendServiceBackendList;
cdnPolicyRequired 
public readonly cdnPolicy: ComputeRegionBackendServiceCdnPolicyOutputReference;
circuitBreakersRequired 
public readonly circuitBreakers: ComputeRegionBackendServiceCircuitBreakersOutputReference;
consistentHashRequired 
public readonly consistentHash: ComputeRegionBackendServiceConsistentHashOutputReference;
creationTimestampRequired 
public readonly creationTimestamp: string;
  • Type: string
customMetricsRequired 
public readonly customMetrics: ComputeRegionBackendServiceCustomMetricsList;
failoverPolicyRequired 
public readonly failoverPolicy: ComputeRegionBackendServiceFailoverPolicyOutputReference;
fingerprintRequired 
public readonly fingerprint: string;
  • Type: string
generatedIdRequired 
public readonly generatedId: number;
  • Type: number
iapRequired 
public readonly iap: ComputeRegionBackendServiceIapOutputReference;
logConfigRequired 
public readonly logConfig: ComputeRegionBackendServiceLogConfigOutputReference;
outlierDetectionRequired 
public readonly outlierDetection: ComputeRegionBackendServiceOutlierDetectionOutputReference;
selfLinkRequired 
public readonly selfLink: string;
  • Type: string
strongSessionAffinityCookieRequired 
public readonly strongSessionAffinityCookie: ComputeRegionBackendServiceStrongSessionAffinityCookieOutputReference;
timeoutsRequired 
public readonly timeouts: ComputeRegionBackendServiceTimeoutsOutputReference;
affinityCookieTtlSecInputOptional 
public readonly affinityCookieTtlSecInput: number;
  • Type: number
backendInputOptional 
public readonly backendInput: IResolvable | ComputeRegionBackendServiceBackend[];
cdnPolicyInputOptional 
public readonly cdnPolicyInput: ComputeRegionBackendServiceCdnPolicy;
circuitBreakersInputOptional 
public readonly circuitBreakersInput: ComputeRegionBackendServiceCircuitBreakers;
connectionDrainingTimeoutSecInputOptional 
public readonly connectionDrainingTimeoutSecInput: number;
  • Type: number
consistentHashInputOptional 
public readonly consistentHashInput: ComputeRegionBackendServiceConsistentHash;
customMetricsInputOptional 
public readonly customMetricsInput: IResolvable | ComputeRegionBackendServiceCustomMetrics[];
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
enableCdnInputOptional 
public readonly enableCdnInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
failoverPolicyInputOptional 
public readonly failoverPolicyInput: ComputeRegionBackendServiceFailoverPolicy;
healthChecksInputOptional 
public readonly healthChecksInput: string[];
  • Type: string[]
iapInputOptional 
public readonly iapInput: ComputeRegionBackendServiceIap;
idInputOptional 
public readonly idInput: string;
  • Type: string
ipAddressSelectionPolicyInputOptional 
public readonly ipAddressSelectionPolicyInput: string;
  • Type: string
loadBalancingSchemeInputOptional 
public readonly loadBalancingSchemeInput: string;
  • Type: string
localityLbPolicyInputOptional 
public readonly localityLbPolicyInput: string;
  • Type: string
logConfigInputOptional 
public readonly logConfigInput: ComputeRegionBackendServiceLogConfig;
nameInputOptional 
public readonly nameInput: string;
  • Type: string
networkInputOptional 
public readonly networkInput: string;
  • Type: string
outlierDetectionInputOptional 
public readonly outlierDetectionInput: ComputeRegionBackendServiceOutlierDetection;
portNameInputOptional 
public readonly portNameInput: string;
  • Type: string
projectInputOptional 
public readonly projectInput: string;
  • Type: string
protocolInputOptional 
public readonly protocolInput: string;
  • Type: string
regionInputOptional 
public readonly regionInput: string;
  • Type: string
sessionAffinityInputOptional 
public readonly sessionAffinityInput: string;
  • Type: string
strongSessionAffinityCookieInputOptional 
public readonly strongSessionAffinityCookieInput: ComputeRegionBackendServiceStrongSessionAffinityCookie;
timeoutSecInputOptional 
public readonly timeoutSecInput: number;
  • Type: number
timeoutsInputOptional 
public readonly timeoutsInput: IResolvable | ComputeRegionBackendServiceTimeouts;
affinityCookieTtlSecRequired 
public readonly affinityCookieTtlSec: number;
  • Type: number
connectionDrainingTimeoutSecRequired 
public readonly connectionDrainingTimeoutSec: number;
  • Type: number
descriptionRequired 
public readonly description: string;
  • Type: string
enableCdnRequired 
public readonly enableCdn: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
healthChecksRequired 
public readonly healthChecks: string[];
  • Type: string[]
idRequired 
public readonly id: string;
  • Type: string
ipAddressSelectionPolicyRequired 
public readonly ipAddressSelectionPolicy: string;
  • Type: string
loadBalancingSchemeRequired 
public readonly loadBalancingScheme: string;
  • Type: string
localityLbPolicyRequired 
public readonly localityLbPolicy: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
networkRequired 
public readonly network: string;
  • Type: string
portNameRequired 
public readonly portName: string;
  • Type: string
projectRequired 
public readonly project: string;
  • Type: string
protocolRequired 
public readonly protocol: string;
  • Type: string
regionRequired 
public readonly region: string;
  • Type: string
sessionAffinityRequired 
public readonly sessionAffinity: string;
  • Type: string
timeoutSecRequired 
public readonly timeoutSec: number;
  • Type: number

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

ComputeRegionBackendServiceBackend

Initializer 

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

const computeRegionBackendServiceBackend: computeRegionBackendService.ComputeRegionBackendServiceBackend = { ... }

Properties

Name Type Description
group string The fully-qualified URL of an Instance Group or Network Endpoint Group resource.
balancingMode string Specifies the balancing mode for this backend.
capacityScaler number A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).
customMetrics cdktf.IResolvable | ComputeRegionBackendServiceBackendCustomMetrics[] custom_metrics block.
description string An optional description of this resource. Provide this property when you create the resource.
failover boolean | cdktf.IResolvable This field designates whether this is a failover backend.
maxConnections number The max number of simultaneous connections for the group.
maxConnectionsPerEndpoint number The max number of simultaneous connections that a single backend network endpoint can handle. Cannot be set for INTERNAL backend services.
maxConnectionsPerInstance number The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services.
maxRate number The max requests per second (RPS) of the group. Cannot be set for INTERNAL backend services.
maxRatePerEndpoint number The max requests per second (RPS) that a single backend network endpoint can handle.
maxRatePerInstance number The max requests per second (RPS) that a single backend instance can handle.
maxUtilization number Used when balancingMode is UTILIZATION.
groupRequired 
public readonly group: string;
  • Type: string

The fully-qualified URL of an Instance Group or Network Endpoint Group resource.

In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.

For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group.

Backend services cannot mix Instance Group and Network Endpoint Group backends.

When the 'load_balancing_scheme' is INTERNAL, only instance groups are supported.

Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#group ComputeRegionBackendService#group}

balancingModeOptional 
public readonly balancingMode: string;
  • Type: string

Specifies the balancing mode for this backend.

See the Backend Services Overview for an explanation of load balancing modes. Default value: "UTILIZATION" Possible values: ["UTILIZATION", "RATE", "CONNECTION", "CUSTOM_METRICS"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#balancing_mode ComputeRegionBackendService#balancing_mode}

capacityScalerOptional 
public readonly capacityScaler: number;
  • Type: number

A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).

~>NOTE: This field cannot be set for INTERNAL region backend services (default loadBalancingScheme), but is required for non-INTERNAL backend service. The total capacity_scaler for all backends must be non-zero.

A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#capacity_scaler ComputeRegionBackendService#capacity_scaler}

customMetricsOptional 
public readonly customMetrics: IResolvable | ComputeRegionBackendServiceBackendCustomMetrics[];

custom_metrics block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#custom_metrics ComputeRegionBackendService#custom_metrics}

descriptionOptional 
public readonly description: string;
  • Type: string

An optional description of this resource. Provide this property when you create the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#description ComputeRegionBackendService#description}

failoverOptional 
public readonly failover: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

This field designates whether this is a failover backend.

More than one failover backend can be configured for a given RegionBackendService.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#failover ComputeRegionBackendService#failover}

maxConnectionsOptional 
public readonly maxConnections: number;
  • Type: number

The max number of simultaneous connections for the group.

Can be used with either CONNECTION or UTILIZATION balancing modes. Cannot be set for INTERNAL backend services.

For CONNECTION mode, either maxConnections or one of maxConnectionsPerInstance or maxConnectionsPerEndpoint, as appropriate for group type, must be set.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#max_connections ComputeRegionBackendService#max_connections}

maxConnectionsPerEndpointOptional 
public readonly maxConnectionsPerEndpoint: number;
  • Type: number

The max number of simultaneous connections that a single backend network endpoint can handle. Cannot be set for INTERNAL backend services.

This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#max_connections_per_endpoint ComputeRegionBackendService#max_connections_per_endpoint}

maxConnectionsPerInstanceOptional 
public readonly maxConnectionsPerInstance: number;
  • Type: number

The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services.

This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#max_connections_per_instance ComputeRegionBackendService#max_connections_per_instance}

maxRateOptional 
public readonly maxRate: number;
  • Type: number

The max requests per second (RPS) of the group. Cannot be set for INTERNAL backend services.

Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. Either maxRate or one of maxRatePerInstance or maxRatePerEndpoint, as appropriate for group type, must be set.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#max_rate ComputeRegionBackendService#max_rate}

maxRatePerEndpointOptional 
public readonly maxRatePerEndpoint: number;
  • Type: number

The max requests per second (RPS) that a single backend network endpoint can handle.

This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint must be set. Cannot be set for INTERNAL backend services.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#max_rate_per_endpoint ComputeRegionBackendService#max_rate_per_endpoint}

maxRatePerInstanceOptional 
public readonly maxRatePerInstance: number;
  • Type: number

The max requests per second (RPS) that a single backend instance can handle.

This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. Cannot be set for INTERNAL backend services.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#max_rate_per_instance ComputeRegionBackendService#max_rate_per_instance}

maxUtilizationOptional 
public readonly maxUtilization: number;
  • Type: number

Used when balancingMode is UTILIZATION.

This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0]. Cannot be set for INTERNAL backend services.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#max_utilization ComputeRegionBackendService#max_utilization}

ComputeRegionBackendServiceBackendCustomMetrics

Initializer 

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

const computeRegionBackendServiceBackendCustomMetrics: computeRegionBackendService.ComputeRegionBackendServiceBackendCustomMetrics = { ... }

Properties

Name Type Description
dryRun boolean | cdktf.IResolvable If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.
name string Name of a custom utilization signal.
maxUtilization number Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
dryRunRequired 
public readonly dryRun: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#dry_run ComputeRegionBackendService#dry_run}

nameRequired 
public readonly name: string;
  • Type: string

Name of a custom utilization signal.

The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#name ComputeRegionBackendService#name}

maxUtilizationOptional 
public readonly maxUtilization: number;
  • Type: number

Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#max_utilization ComputeRegionBackendService#max_utilization}

ComputeRegionBackendServiceCdnPolicy

Initializer 

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

const computeRegionBackendServiceCdnPolicy: computeRegionBackendService.ComputeRegionBackendServiceCdnPolicy = { ... }

Properties

Name Type Description
cacheKeyPolicy ComputeRegionBackendServiceCdnPolicyCacheKeyPolicy cache_key_policy block.
cacheMode string Specifies the cache setting for all responses from this backend.
clientTtl number Specifies the maximum allowed TTL for cached content served by this origin.
defaultTtl number Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age).
maxTtl number Specifies the maximum allowed TTL for cached content served by this origin.
negativeCaching boolean | cdktf.IResolvable Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.
negativeCachingPolicy cdktf.IResolvable | ComputeRegionBackendServiceCdnPolicyNegativeCachingPolicy[] negative_caching_policy block.
serveWhileStale number Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.
signedUrlCacheMaxAgeSec number Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s).
cacheKeyPolicyOptional 
public readonly cacheKeyPolicy: ComputeRegionBackendServiceCdnPolicyCacheKeyPolicy;

cache_key_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#cache_key_policy ComputeRegionBackendService#cache_key_policy}

cacheModeOptional 
public readonly cacheMode: string;
  • Type: string

Specifies the cache setting for all responses from this backend.

The possible values are: USE_ORIGIN_HEADERS, FORCE_CACHE_ALL and CACHE_ALL_STATIC Possible values: ["USE_ORIGIN_HEADERS", "FORCE_CACHE_ALL", "CACHE_ALL_STATIC"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#cache_mode ComputeRegionBackendService#cache_mode}

clientTtlOptional 
public readonly clientTtl: number;
  • Type: number

Specifies the maximum allowed TTL for cached content served by this origin.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#client_ttl ComputeRegionBackendService#client_ttl}

defaultTtlOptional 
public readonly defaultTtl: number;
  • Type: number

Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#default_ttl ComputeRegionBackendService#default_ttl}

maxTtlOptional 
public readonly maxTtl: number;
  • Type: number

Specifies the maximum allowed TTL for cached content served by this origin.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#max_ttl ComputeRegionBackendService#max_ttl}

negativeCachingOptional 
public readonly negativeCaching: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#negative_caching ComputeRegionBackendService#negative_caching}

negativeCachingPolicyOptional 
public readonly negativeCachingPolicy: IResolvable | ComputeRegionBackendServiceCdnPolicyNegativeCachingPolicy[];

negative_caching_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#negative_caching_policy ComputeRegionBackendService#negative_caching_policy}

serveWhileStaleOptional 
public readonly serveWhileStale: number;
  • Type: number

Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#serve_while_stale ComputeRegionBackendService#serve_while_stale}

signedUrlCacheMaxAgeSecOptional 
public readonly signedUrlCacheMaxAgeSec: number;
  • Type: number

Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s).

After this time period, the response will be revalidated before being served.

When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#signed_url_cache_max_age_sec ComputeRegionBackendService#signed_url_cache_max_age_sec}

ComputeRegionBackendServiceCdnPolicyCacheKeyPolicy

Initializer 

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

const computeRegionBackendServiceCdnPolicyCacheKeyPolicy: computeRegionBackendService.ComputeRegionBackendServiceCdnPolicyCacheKeyPolicy = { ... }

Properties

Name Type Description
includeHost boolean | cdktf.IResolvable If true requests to different hosts will be cached separately.
includeNamedCookies string[] Names of cookies to include in cache keys.
includeProtocol boolean | cdktf.IResolvable If true, http and https requests will be cached separately.
includeQueryString boolean | cdktf.IResolvable If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist.
queryStringBlacklist string[] Names of query string parameters to exclude in cache keys.
queryStringWhitelist string[] Names of query string parameters to include in cache keys.
includeHostOptional 
public readonly includeHost: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

If true requests to different hosts will be cached separately.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#include_host ComputeRegionBackendService#include_host}

includeNamedCookiesOptional 
public readonly includeNamedCookies: string[];
  • Type: string[]

Names of cookies to include in cache keys.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#include_named_cookies ComputeRegionBackendService#include_named_cookies}

includeProtocolOptional 
public readonly includeProtocol: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

If true, http and https requests will be cached separately.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#include_protocol ComputeRegionBackendService#include_protocol}

includeQueryStringOptional 
public readonly includeQueryString: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist.

If neither is set, the entire query string will be included.

If false, the query string will be excluded from the cache key entirely.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#include_query_string ComputeRegionBackendService#include_query_string}

queryStringBlacklistOptional 
public readonly queryStringBlacklist: string[];
  • Type: string[]

Names of query string parameters to exclude in cache keys.

All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#query_string_blacklist ComputeRegionBackendService#query_string_blacklist}

queryStringWhitelistOptional 
public readonly queryStringWhitelist: string[];
  • Type: string[]

Names of query string parameters to include in cache keys.

All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#query_string_whitelist ComputeRegionBackendService#query_string_whitelist}

ComputeRegionBackendServiceCdnPolicyNegativeCachingPolicy

Initializer 

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

const computeRegionBackendServiceCdnPolicyNegativeCachingPolicy: computeRegionBackendService.ComputeRegionBackendServiceCdnPolicyNegativeCachingPolicy = { ... }

Properties

Name Type Description
code number The HTTP status code to define a TTL against.
codeOptional 
public readonly code: number;
  • Type: number

The HTTP status code to define a TTL against.

Only HTTP status codes 300, 301, 308, 404, 405, 410, 421, 451 and 501 can be specified as values, and you cannot specify a status code more than once.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#code ComputeRegionBackendService#code}

ComputeRegionBackendServiceCircuitBreakers

Initializer 

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

const computeRegionBackendServiceCircuitBreakers: computeRegionBackendService.ComputeRegionBackendServiceCircuitBreakers = { ... }

Properties

Name Type Description
maxConnections number The maximum number of connections to the backend cluster. Defaults to 1024.
maxPendingRequests number The maximum number of pending requests to the backend cluster. Defaults to 1024.
maxRequests number The maximum number of parallel requests to the backend cluster. Defaults to 1024.
maxRequestsPerConnection number Maximum requests for a single backend connection.
maxRetries number The maximum number of parallel retries to the backend cluster. Defaults to 3.
maxConnectionsOptional 
public readonly maxConnections: number;
  • Type: number

The maximum number of connections to the backend cluster. Defaults to 1024.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#max_connections ComputeRegionBackendService#max_connections}

maxPendingRequestsOptional 
public readonly maxPendingRequests: number;
  • Type: number

The maximum number of pending requests to the backend cluster. Defaults to 1024.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#max_pending_requests ComputeRegionBackendService#max_pending_requests}

maxRequestsOptional 
public readonly maxRequests: number;
  • Type: number

The maximum number of parallel requests to the backend cluster. Defaults to 1024.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#max_requests ComputeRegionBackendService#max_requests}

maxRequestsPerConnectionOptional 
public readonly maxRequestsPerConnection: number;
  • Type: number

Maximum requests for a single backend connection.

This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#max_requests_per_connection ComputeRegionBackendService#max_requests_per_connection}

maxRetriesOptional 
public readonly maxRetries: number;
  • Type: number

The maximum number of parallel retries to the backend cluster. Defaults to 3.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#max_retries ComputeRegionBackendService#max_retries}

ComputeRegionBackendServiceConfig

Initializer 

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

const computeRegionBackendServiceConfig: computeRegionBackendService.ComputeRegionBackendServiceConfig = { ... }

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.
name string Name of the resource.
affinityCookieTtlSec number Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE.
backend cdktf.IResolvable | ComputeRegionBackendServiceBackend[] backend block.
cdnPolicy ComputeRegionBackendServiceCdnPolicy cdn_policy block.
circuitBreakers ComputeRegionBackendServiceCircuitBreakers circuit_breakers block.
connectionDrainingTimeoutSec number Time for which instance will be drained (not accept new connections, but still work to finish started).
consistentHash ComputeRegionBackendServiceConsistentHash consistent_hash block.
customMetrics cdktf.IResolvable | ComputeRegionBackendServiceCustomMetrics[] custom_metrics block.
description string An optional description of this resource.
enableCdn boolean | cdktf.IResolvable If true, enable Cloud CDN for this RegionBackendService.
failoverPolicy ComputeRegionBackendServiceFailoverPolicy failover_policy block.
healthChecks string[] The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified.
iap ComputeRegionBackendServiceIap iap block.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#id ComputeRegionBackendService#id}.
ipAddressSelectionPolicy string Specifies preference of traffic to the backend (from the proxy and from the client for proxyless gRPC).
loadBalancingScheme string Indicates what kind of load balancing this regional backend service will be used for.
localityLbPolicy string The load balancing algorithm used within the scope of the locality. The possible values are:.
logConfig ComputeRegionBackendServiceLogConfig log_config block.
network string The URL of the network to which this backend service belongs.
outlierDetection ComputeRegionBackendServiceOutlierDetection outlier_detection block.
portName string A named port on a backend instance group representing the port for communication to the backend VMs in that group.
project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#project ComputeRegionBackendService#project}.
protocol string The protocol this BackendService uses to communicate with backends.
region string The Region in which the created backend service should reside. If it is not provided, the provider region is used.
sessionAffinity string Type of session affinity to use.
strongSessionAffinityCookie ComputeRegionBackendServiceStrongSessionAffinityCookie strong_session_affinity_cookie block.
timeouts ComputeRegionBackendServiceTimeouts timeouts block.
timeoutSec number The backend service timeout has a different meaning depending on the type of load balancer.
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[]
nameRequired 
public readonly name: string;
  • Type: string

Name of the resource.

Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression 'a-z?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#name ComputeRegionBackendService#name}

affinityCookieTtlSecOptional 
public readonly affinityCookieTtlSec: number;
  • Type: number

Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE.

If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.

When the load balancing scheme is INTERNAL, this field is not used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#affinity_cookie_ttl_sec ComputeRegionBackendService#affinity_cookie_ttl_sec}

backendOptional 
public readonly backend: IResolvable | ComputeRegionBackendServiceBackend[];

backend block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#backend ComputeRegionBackendService#backend}

cdnPolicyOptional 
public readonly cdnPolicy: ComputeRegionBackendServiceCdnPolicy;

cdn_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#cdn_policy ComputeRegionBackendService#cdn_policy}

circuitBreakersOptional 
public readonly circuitBreakers: ComputeRegionBackendServiceCircuitBreakers;

circuit_breakers block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#circuit_breakers ComputeRegionBackendService#circuit_breakers}

connectionDrainingTimeoutSecOptional 
public readonly connectionDrainingTimeoutSec: number;
  • Type: number

Time for which instance will be drained (not accept new connections, but still work to finish started).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#connection_draining_timeout_sec ComputeRegionBackendService#connection_draining_timeout_sec}

consistentHashOptional 
public readonly consistentHash: ComputeRegionBackendServiceConsistentHash;

consistent_hash block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#consistent_hash ComputeRegionBackendService#consistent_hash}

customMetricsOptional 
public readonly customMetrics: IResolvable | ComputeRegionBackendServiceCustomMetrics[];

custom_metrics block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#custom_metrics ComputeRegionBackendService#custom_metrics}

descriptionOptional 
public readonly description: string;
  • Type: string

An optional description of this resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#description ComputeRegionBackendService#description}

enableCdnOptional 
public readonly enableCdn: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

If true, enable Cloud CDN for this RegionBackendService.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#enable_cdn ComputeRegionBackendService#enable_cdn}

failoverPolicyOptional 
public readonly failoverPolicy: ComputeRegionBackendServiceFailoverPolicy;

failover_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#failover_policy ComputeRegionBackendService#failover_policy}

healthChecksOptional 
public readonly healthChecks: string[];
  • Type: string[]

The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified.

A health check must be specified unless the backend service uses an internet or serverless NEG as a backend.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#health_checks ComputeRegionBackendService#health_checks}

iapOptional 
public readonly iap: ComputeRegionBackendServiceIap;

iap block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#iap ComputeRegionBackendService#iap}

idOptional 
public readonly id: string;
  • Type: string

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

ipAddressSelectionPolicyOptional 
public readonly ipAddressSelectionPolicy: string;
  • Type: string

Specifies preference of traffic to the backend (from the proxy and from the client for proxyless gRPC).

Possible values: ["IPV4_ONLY", "PREFER_IPV6", "IPV6_ONLY"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#ip_address_selection_policy ComputeRegionBackendService#ip_address_selection_policy}

loadBalancingSchemeOptional 
public readonly loadBalancingScheme: string;
  • Type: string

Indicates what kind of load balancing this regional backend service will be used for.

A backend service created for one type of load balancing cannot be used with the other(s). For more information, refer to Choosing a load balancer. Default value: "INTERNAL" Possible values: ["EXTERNAL", "EXTERNAL_MANAGED", "INTERNAL", "INTERNAL_MANAGED"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#load_balancing_scheme ComputeRegionBackendService#load_balancing_scheme}

localityLbPolicyOptional 
public readonly localityLbPolicy: string;
  • Type: string

The load balancing algorithm used within the scope of the locality. The possible values are:.

  • 'ROUND_ROBIN': This is a simple policy in which each healthy backend is selected in round robin order.

  • 'LEAST_REQUEST': An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.

  • 'RING_HASH': The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.

  • 'RANDOM': The load balancer selects a random healthy host.

  • 'ORIGINAL_DESTINATION': Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.

  • 'MAGLEV': used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824

  • 'WEIGHTED_MAGLEV': Per-instance weighted Load Balancing via health check reported weights. Only applicable to loadBalancingScheme EXTERNAL. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weight based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight.

  • 'WEIGHTED_ROUND_ROBIN': Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields.

locality_lb_policy is applicable to either:

  • A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2 or H2C, and loadBalancingScheme set to INTERNAL_MANAGED.
  • A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
  • A regional backend service with loadBalancingScheme set to EXTERNAL (External Network Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External Network Load Balancing. The default is MAGLEV.

If session_affinity is not NONE, and locality_lb_policy is not set to MAGLEV, WEIGHTED_MAGLEV, or RING_HASH, session affinity settings will not take effect.

Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validate_for_proxyless field set to true. Possible values: ["ROUND_ROBIN", "LEAST_REQUEST", "RING_HASH", "RANDOM", "ORIGINAL_DESTINATION", "MAGLEV", "WEIGHTED_MAGLEV", "WEIGHTED_ROUND_ROBIN"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#locality_lb_policy ComputeRegionBackendService#locality_lb_policy}

logConfigOptional 
public readonly logConfig: ComputeRegionBackendServiceLogConfig;

log_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#log_config ComputeRegionBackendService#log_config}

networkOptional 
public readonly network: string;
  • Type: string

The URL of the network to which this backend service belongs.

This field can only be specified when the load balancing scheme is set to INTERNAL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#network ComputeRegionBackendService#network}

outlierDetectionOptional 
public readonly outlierDetection: ComputeRegionBackendServiceOutlierDetection;

outlier_detection block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#outlier_detection ComputeRegionBackendService#outlier_detection}

portNameOptional 
public readonly portName: string;
  • Type: string

A named port on a backend instance group representing the port for communication to the backend VMs in that group.

Required when the loadBalancingScheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. API sets a default of "http" if not given. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#port_name ComputeRegionBackendService#port_name}

projectOptional 
public readonly project: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#project ComputeRegionBackendService#project}.

protocolOptional 
public readonly protocol: string;
  • Type: string

The protocol this BackendService uses to communicate with backends.

The default is HTTP. Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC. Refer to the documentation for the load balancers or for Traffic Director for more information. Possible values: ["HTTP", "HTTPS", "HTTP2", "TCP", "SSL", "UDP", "GRPC", "UNSPECIFIED", "H2C"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#protocol ComputeRegionBackendService#protocol}

regionOptional 
public readonly region: string;
  • Type: string

The Region in which the created backend service should reside. If it is not provided, the provider region is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#region ComputeRegionBackendService#region}

sessionAffinityOptional 
public readonly sessionAffinity: string;
  • Type: string

Type of session affinity to use.

The default is NONE. Session affinity is not applicable if the protocol is UDP. Possible values: ["NONE", "CLIENT_IP", "CLIENT_IP_PORT_PROTO", "CLIENT_IP_PROTO", "GENERATED_COOKIE", "HEADER_FIELD", "HTTP_COOKIE", "CLIENT_IP_NO_DESTINATION", "STRONG_COOKIE_AFFINITY"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#session_affinity ComputeRegionBackendService#session_affinity}

strongSessionAffinityCookieOptional 
public readonly strongSessionAffinityCookie: ComputeRegionBackendServiceStrongSessionAffinityCookie;

strong_session_affinity_cookie block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#strong_session_affinity_cookie ComputeRegionBackendService#strong_session_affinity_cookie}

timeoutsOptional 
public readonly timeouts: ComputeRegionBackendServiceTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#timeouts ComputeRegionBackendService#timeouts}

timeoutSecOptional 
public readonly timeoutSec: number;
  • Type: number

The backend service timeout has a different meaning depending on the type of load balancer.

For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#timeout_sec ComputeRegionBackendService#timeout_sec}

ComputeRegionBackendServiceConsistentHash

Initializer 

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

const computeRegionBackendServiceConsistentHash: computeRegionBackendService.ComputeRegionBackendServiceConsistentHash = { ... }

Properties

Name Type Description
httpCookie ComputeRegionBackendServiceConsistentHashHttpCookie http_cookie block.
httpHeaderName string The hash based on the value of the specified header field.
minimumRingSize number The minimum number of virtual nodes to use for the hash ring.
httpCookieOptional 
public readonly httpCookie: ComputeRegionBackendServiceConsistentHashHttpCookie;

http_cookie block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#http_cookie ComputeRegionBackendService#http_cookie}

httpHeaderNameOptional 
public readonly httpHeaderName: string;
  • Type: string

The hash based on the value of the specified header field.

This field is applicable if the sessionAffinity is set to HEADER_FIELD.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#http_header_name ComputeRegionBackendService#http_header_name}

minimumRingSizeOptional 
public readonly minimumRingSize: number;
  • Type: number

The minimum number of virtual nodes to use for the hash ring.

Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#minimum_ring_size ComputeRegionBackendService#minimum_ring_size}

ComputeRegionBackendServiceConsistentHashHttpCookie

Initializer 

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

const computeRegionBackendServiceConsistentHashHttpCookie: computeRegionBackendService.ComputeRegionBackendServiceConsistentHashHttpCookie = { ... }

Properties

Name Type Description
name string Name of the cookie.
path string Path to set for the cookie.
ttl ComputeRegionBackendServiceConsistentHashHttpCookieTtl ttl block.
nameOptional 
public readonly name: string;
  • Type: string

Name of the cookie.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#name ComputeRegionBackendService#name}

pathOptional 
public readonly path: string;
  • Type: string

Path to set for the cookie.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#path ComputeRegionBackendService#path}

ttlOptional 
public readonly ttl: ComputeRegionBackendServiceConsistentHashHttpCookieTtl;

ttl block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#ttl ComputeRegionBackendService#ttl}

ComputeRegionBackendServiceConsistentHashHttpCookieTtl

Initializer 

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

const computeRegionBackendServiceConsistentHashHttpCookieTtl: computeRegionBackendService.ComputeRegionBackendServiceConsistentHashHttpCookieTtl = { ... }

Properties

Name Type Description
seconds number Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
nanos number Span of time that's a fraction of a second at nanosecond resolution.
secondsRequired 
public readonly seconds: number;
  • Type: number

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#seconds ComputeRegionBackendService#seconds}

nanosOptional 
public readonly nanos: number;
  • Type: number

Span of time that's a fraction of a second at nanosecond resolution.

Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#nanos ComputeRegionBackendService#nanos}

ComputeRegionBackendServiceCustomMetrics

Initializer 

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

const computeRegionBackendServiceCustomMetrics: computeRegionBackendService.ComputeRegionBackendServiceCustomMetrics = { ... }

Properties

Name Type Description
dryRun boolean | cdktf.IResolvable If true, the metric data is not used for load balancing.
name string Name of a custom utilization signal.
dryRunRequired 
public readonly dryRun: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

If true, the metric data is not used for load balancing.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#dry_run ComputeRegionBackendService#dry_run}

nameRequired 
public readonly name: string;
  • Type: string

Name of a custom utilization signal.

The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#name ComputeRegionBackendService#name}

ComputeRegionBackendServiceFailoverPolicy

Initializer 

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

const computeRegionBackendServiceFailoverPolicy: computeRegionBackendService.ComputeRegionBackendServiceFailoverPolicy = { ... }

Properties

Name Type Description
disableConnectionDrainOnFailover boolean | cdktf.IResolvable On failover or failback, this field indicates whether connection drain will be honored.
dropTrafficIfUnhealthy boolean | cdktf.IResolvable This option is used only when no healthy VMs are detected in the primary and backup instance groups.
failoverRatio number The value of the field must be in [0, 1].
disableConnectionDrainOnFailoverOptional 
public readonly disableConnectionDrainOnFailover: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

On failover or failback, this field indicates whether connection drain will be honored.

Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. This can be set to true only if the protocol is TCP. The default is false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#disable_connection_drain_on_failover ComputeRegionBackendService#disable_connection_drain_on_failover}

dropTrafficIfUnhealthyOptional 
public readonly dropTrafficIfUnhealthy: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

This option is used only when no healthy VMs are detected in the primary and backup instance groups.

When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#drop_traffic_if_unhealthy ComputeRegionBackendService#drop_traffic_if_unhealthy}

failoverRatioOptional 
public readonly failoverRatio: number;
  • Type: number

The value of the field must be in [0, 1].

If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#failover_ratio ComputeRegionBackendService#failover_ratio}

ComputeRegionBackendServiceIap

Initializer 

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

const computeRegionBackendServiceIap: computeRegionBackendService.ComputeRegionBackendServiceIap = { ... }

Properties

Name Type Description
enabled boolean | cdktf.IResolvable Whether the serving infrastructure will authenticate and authorize all incoming requests.
oauth2ClientId string OAuth2 Client ID for IAP.
oauth2ClientSecret string OAuth2 Client Secret for IAP.
enabledRequired 
public readonly enabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Whether the serving infrastructure will authenticate and authorize all incoming requests.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#enabled ComputeRegionBackendService#enabled}

oauth2ClientIdOptional 
public readonly oauth2ClientId: string;
  • Type: string

OAuth2 Client ID for IAP.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#oauth2_client_id ComputeRegionBackendService#oauth2_client_id}

oauth2ClientSecretOptional 
public readonly oauth2ClientSecret: string;
  • Type: string

OAuth2 Client Secret for IAP.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#oauth2_client_secret ComputeRegionBackendService#oauth2_client_secret}

ComputeRegionBackendServiceLogConfig

Initializer 

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

const computeRegionBackendServiceLogConfig: computeRegionBackendService.ComputeRegionBackendServiceLogConfig = { ... }

Properties

Name Type Description
enable boolean | cdktf.IResolvable Whether to enable logging for the load balancer traffic served by this backend service.
optionalFields string[] Specifies the fields to include in logging.
optionalMode string Specifies the optional logging mode for the load balancer traffic. Supported values: INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM. Possible values: ["INCLUDE_ALL_OPTIONAL", "EXCLUDE_ALL_OPTIONAL", "CUSTOM"].
sampleRate number This field can only be specified if logging is enabled for this backend service.
enableOptional 
public readonly enable: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Whether to enable logging for the load balancer traffic served by this backend service.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#enable ComputeRegionBackendService#enable}

optionalFieldsOptional 
public readonly optionalFields: string[];
  • Type: string[]

Specifies the fields to include in logging.

This field can only be specified if logging is enabled for this backend service.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#optional_fields ComputeRegionBackendService#optional_fields}

optionalModeOptional 
public readonly optionalMode: string;
  • Type: string

Specifies the optional logging mode for the load balancer traffic. Supported values: INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM. Possible values: ["INCLUDE_ALL_OPTIONAL", "EXCLUDE_ALL_OPTIONAL", "CUSTOM"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#optional_mode ComputeRegionBackendService#optional_mode}

sampleRateOptional 
public readonly sampleRate: number;
  • Type: number

This field can only be specified if logging is enabled for this backend service.

The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#sample_rate ComputeRegionBackendService#sample_rate}

ComputeRegionBackendServiceOutlierDetection

Initializer 

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

const computeRegionBackendServiceOutlierDetection: computeRegionBackendService.ComputeRegionBackendServiceOutlierDetection = { ... }

Properties

Name Type Description
baseEjectionTime ComputeRegionBackendServiceOutlierDetectionBaseEjectionTime base_ejection_time block.
consecutiveErrors number Number of errors before a host is ejected from the connection pool.
consecutiveGatewayFailure number The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs.
enforcingConsecutiveErrors number The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx.
enforcingConsecutiveGatewayFailure number The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures.
enforcingSuccessRate number The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics.
interval ComputeRegionBackendServiceOutlierDetectionInterval interval block.
maxEjectionPercent number Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
successRateMinimumHosts number The number of hosts in a cluster that must have enough request volume to detect success rate outliers.
successRateRequestVolume number The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection.
successRateStdevFactor number This factor is used to determine the ejection threshold for success rate outlier ejection.
baseEjectionTimeOptional 
public readonly baseEjectionTime: ComputeRegionBackendServiceOutlierDetectionBaseEjectionTime;

base_ejection_time block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#base_ejection_time ComputeRegionBackendService#base_ejection_time}

consecutiveErrorsOptional 
public readonly consecutiveErrors: number;
  • Type: number

Number of errors before a host is ejected from the connection pool.

When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#consecutive_errors ComputeRegionBackendService#consecutive_errors}

consecutiveGatewayFailureOptional 
public readonly consecutiveGatewayFailure: number;
  • Type: number

The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs.

Defaults to 5.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#consecutive_gateway_failure ComputeRegionBackendService#consecutive_gateway_failure}

enforcingConsecutiveErrorsOptional 
public readonly enforcingConsecutiveErrors: number;
  • Type: number

The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx.

This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#enforcing_consecutive_errors ComputeRegionBackendService#enforcing_consecutive_errors}

enforcingConsecutiveGatewayFailureOptional 
public readonly enforcingConsecutiveGatewayFailure: number;
  • Type: number

The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures.

This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#enforcing_consecutive_gateway_failure ComputeRegionBackendService#enforcing_consecutive_gateway_failure}

enforcingSuccessRateOptional 
public readonly enforcingSuccessRate: number;
  • Type: number

The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics.

This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#enforcing_success_rate ComputeRegionBackendService#enforcing_success_rate}

intervalOptional 
public readonly interval: ComputeRegionBackendServiceOutlierDetectionInterval;

interval block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#interval ComputeRegionBackendService#interval}

maxEjectionPercentOptional 
public readonly maxEjectionPercent: number;
  • Type: number

Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#max_ejection_percent ComputeRegionBackendService#max_ejection_percent}

successRateMinimumHostsOptional 
public readonly successRateMinimumHosts: number;
  • Type: number

The number of hosts in a cluster that must have enough request volume to detect success rate outliers.

If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#success_rate_minimum_hosts ComputeRegionBackendService#success_rate_minimum_hosts}

successRateRequestVolumeOptional 
public readonly successRateRequestVolume: number;
  • Type: number

The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection.

If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#success_rate_request_volume ComputeRegionBackendService#success_rate_request_volume}

successRateStdevFactorOptional 
public readonly successRateStdevFactor: number;
  • Type: number

This factor is used to determine the ejection threshold for success rate outlier ejection.

The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#success_rate_stdev_factor ComputeRegionBackendService#success_rate_stdev_factor}

ComputeRegionBackendServiceOutlierDetectionBaseEjectionTime

Initializer 

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

const computeRegionBackendServiceOutlierDetectionBaseEjectionTime: computeRegionBackendService.ComputeRegionBackendServiceOutlierDetectionBaseEjectionTime = { ... }

Properties

Name Type Description
seconds number Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
nanos number Span of time that's a fraction of a second at nanosecond resolution.
secondsRequired 
public readonly seconds: number;
  • Type: number

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#seconds ComputeRegionBackendService#seconds}

nanosOptional 
public readonly nanos: number;
  • Type: number

Span of time that's a fraction of a second at nanosecond resolution.

Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#nanos ComputeRegionBackendService#nanos}

ComputeRegionBackendServiceOutlierDetectionInterval

Initializer 

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

const computeRegionBackendServiceOutlierDetectionInterval: computeRegionBackendService.ComputeRegionBackendServiceOutlierDetectionInterval = { ... }

Properties

Name Type Description
seconds number Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
nanos number Span of time that's a fraction of a second at nanosecond resolution.
secondsRequired 
public readonly seconds: number;
  • Type: number

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#seconds ComputeRegionBackendService#seconds}

nanosOptional 
public readonly nanos: number;
  • Type: number

Span of time that's a fraction of a second at nanosecond resolution.

Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#nanos ComputeRegionBackendService#nanos}

ComputeRegionBackendServiceStrongSessionAffinityCookie

Initializer 

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

const computeRegionBackendServiceStrongSessionAffinityCookie: computeRegionBackendService.ComputeRegionBackendServiceStrongSessionAffinityCookie = { ... }

Properties

Name Type Description
name string Name of the cookie.
path string Path to set for the cookie.
ttl ComputeRegionBackendServiceStrongSessionAffinityCookieTtl ttl block.
nameOptional 
public readonly name: string;
  • Type: string

Name of the cookie.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#name ComputeRegionBackendService#name}

pathOptional 
public readonly path: string;
  • Type: string

Path to set for the cookie.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#path ComputeRegionBackendService#path}

ttlOptional 
public readonly ttl: ComputeRegionBackendServiceStrongSessionAffinityCookieTtl;

ttl block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#ttl ComputeRegionBackendService#ttl}

ComputeRegionBackendServiceStrongSessionAffinityCookieTtl

Initializer 

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

const computeRegionBackendServiceStrongSessionAffinityCookieTtl: computeRegionBackendService.ComputeRegionBackendServiceStrongSessionAffinityCookieTtl = { ... }

Properties

Name Type Description
seconds number Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
nanos number Span of time that's a fraction of a second at nanosecond resolution.
secondsRequired 
public readonly seconds: number;
  • Type: number

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#seconds ComputeRegionBackendService#seconds}

nanosOptional 
public readonly nanos: number;
  • Type: number

Span of time that's a fraction of a second at nanosecond resolution.

Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#nanos ComputeRegionBackendService#nanos}

ComputeRegionBackendServiceTimeouts

Initializer 

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

const computeRegionBackendServiceTimeouts: computeRegionBackendService.ComputeRegionBackendServiceTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#create ComputeRegionBackendService#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#delete ComputeRegionBackendService#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#update ComputeRegionBackendService#update}.
createOptional 
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#create ComputeRegionBackendService#create}.

deleteOptional 
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#delete ComputeRegionBackendService#delete}.

updateOptional 
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/compute_region_backend_service#update ComputeRegionBackendService#update}.

Classes

ComputeRegionBackendServiceBackendCustomMetricsList

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceBackendCustomMetricsList(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): ComputeRegionBackendServiceBackendCustomMetricsOutputReference
indexRequired
  • Type: number

the index of the item to return.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
internalValue cdktf.IResolvable | ComputeRegionBackendServiceBackendCustomMetrics[] No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

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

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

fqnRequired 
public readonly fqn: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | ComputeRegionBackendServiceBackendCustomMetrics[];

ComputeRegionBackendServiceBackendCustomMetricsOutputReference

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceBackendCustomMetricsOutputReference(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.
resetMaxUtilization 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.

resetMaxUtilization 
public resetMaxUtilization(): 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.
dryRunInput boolean | cdktf.IResolvable No description.
maxUtilizationInput number No description.
nameInput string No description.
dryRun boolean | cdktf.IResolvable No description.
maxUtilization number No description.
name string No description.
internalValue cdktf.IResolvable | ComputeRegionBackendServiceBackendCustomMetrics 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
dryRunInputOptional 
public readonly dryRunInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
maxUtilizationInputOptional 
public readonly maxUtilizationInput: number;
  • Type: number
nameInputOptional 
public readonly nameInput: string;
  • Type: string
dryRunRequired 
public readonly dryRun: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
maxUtilizationRequired 
public readonly maxUtilization: number;
  • Type: number
nameRequired 
public readonly name: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | ComputeRegionBackendServiceBackendCustomMetrics;

ComputeRegionBackendServiceBackendList

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceBackendList(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): ComputeRegionBackendServiceBackendOutputReference
indexRequired
  • Type: number

the index of the item to return.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
internalValue cdktf.IResolvable | ComputeRegionBackendServiceBackend[] No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

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

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

fqnRequired 
public readonly fqn: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | ComputeRegionBackendServiceBackend[];

ComputeRegionBackendServiceBackendOutputReference

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceBackendOutputReference(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.
putCustomMetrics No description.
resetBalancingMode No description.
resetCapacityScaler No description.
resetCustomMetrics No description.
resetDescription No description.
resetFailover No description.
resetMaxConnections No description.
resetMaxConnectionsPerEndpoint No description.
resetMaxConnectionsPerInstance No description.
resetMaxRate No description.
resetMaxRatePerEndpoint No description.
resetMaxRatePerInstance No description.
resetMaxUtilization 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.

putCustomMetrics 
public putCustomMetrics(value: IResolvable | ComputeRegionBackendServiceBackendCustomMetrics[]): void
valueRequired
resetBalancingMode 
public resetBalancingMode(): void
resetCapacityScaler 
public resetCapacityScaler(): void
resetCustomMetrics 
public resetCustomMetrics(): void
resetDescription 
public resetDescription(): void
resetFailover 
public resetFailover(): void
resetMaxConnections 
public resetMaxConnections(): void
resetMaxConnectionsPerEndpoint 
public resetMaxConnectionsPerEndpoint(): void
resetMaxConnectionsPerInstance 
public resetMaxConnectionsPerInstance(): void
resetMaxRate 
public resetMaxRate(): void
resetMaxRatePerEndpoint 
public resetMaxRatePerEndpoint(): void
resetMaxRatePerInstance 
public resetMaxRatePerInstance(): void
resetMaxUtilization 
public resetMaxUtilization(): 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.
customMetrics ComputeRegionBackendServiceBackendCustomMetricsList No description.
balancingModeInput string No description.
capacityScalerInput number No description.
customMetricsInput cdktf.IResolvable | ComputeRegionBackendServiceBackendCustomMetrics[] No description.
descriptionInput string No description.
failoverInput boolean | cdktf.IResolvable No description.
groupInput string No description.
maxConnectionsInput number No description.
maxConnectionsPerEndpointInput number No description.
maxConnectionsPerInstanceInput number No description.
maxRateInput number No description.
maxRatePerEndpointInput number No description.
maxRatePerInstanceInput number No description.
maxUtilizationInput number No description.
balancingMode string No description.
capacityScaler number No description.
description string No description.
failover boolean | cdktf.IResolvable No description.
group string No description.
maxConnections number No description.
maxConnectionsPerEndpoint number No description.
maxConnectionsPerInstance number No description.
maxRate number No description.
maxRatePerEndpoint number No description.
maxRatePerInstance number No description.
maxUtilization number No description.
internalValue cdktf.IResolvable | ComputeRegionBackendServiceBackend 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
customMetricsRequired 
public readonly customMetrics: ComputeRegionBackendServiceBackendCustomMetricsList;
balancingModeInputOptional 
public readonly balancingModeInput: string;
  • Type: string
capacityScalerInputOptional 
public readonly capacityScalerInput: number;
  • Type: number
customMetricsInputOptional 
public readonly customMetricsInput: IResolvable | ComputeRegionBackendServiceBackendCustomMetrics[];
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
failoverInputOptional 
public readonly failoverInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
groupInputOptional 
public readonly groupInput: string;
  • Type: string
maxConnectionsInputOptional 
public readonly maxConnectionsInput: number;
  • Type: number
maxConnectionsPerEndpointInputOptional 
public readonly maxConnectionsPerEndpointInput: number;
  • Type: number
maxConnectionsPerInstanceInputOptional 
public readonly maxConnectionsPerInstanceInput: number;
  • Type: number
maxRateInputOptional 
public readonly maxRateInput: number;
  • Type: number
maxRatePerEndpointInputOptional 
public readonly maxRatePerEndpointInput: number;
  • Type: number
maxRatePerInstanceInputOptional 
public readonly maxRatePerInstanceInput: number;
  • Type: number
maxUtilizationInputOptional 
public readonly maxUtilizationInput: number;
  • Type: number
balancingModeRequired 
public readonly balancingMode: string;
  • Type: string
capacityScalerRequired 
public readonly capacityScaler: number;
  • Type: number
descriptionRequired 
public readonly description: string;
  • Type: string
failoverRequired 
public readonly failover: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
groupRequired 
public readonly group: string;
  • Type: string
maxConnectionsRequired 
public readonly maxConnections: number;
  • Type: number
maxConnectionsPerEndpointRequired 
public readonly maxConnectionsPerEndpoint: number;
  • Type: number
maxConnectionsPerInstanceRequired 
public readonly maxConnectionsPerInstance: number;
  • Type: number
maxRateRequired 
public readonly maxRate: number;
  • Type: number
maxRatePerEndpointRequired 
public readonly maxRatePerEndpoint: number;
  • Type: number
maxRatePerInstanceRequired 
public readonly maxRatePerInstance: number;
  • Type: number
maxUtilizationRequired 
public readonly maxUtilization: number;
  • Type: number
internalValueOptional 
public readonly internalValue: IResolvable | ComputeRegionBackendServiceBackend;

ComputeRegionBackendServiceCdnPolicyCacheKeyPolicyOutputReference

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceCdnPolicyCacheKeyPolicyOutputReference(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.
resetIncludeHost No description.
resetIncludeNamedCookies No description.
resetIncludeProtocol No description.
resetIncludeQueryString No description.
resetQueryStringBlacklist No description.
resetQueryStringWhitelist 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.

resetIncludeHost 
public resetIncludeHost(): void
resetIncludeNamedCookies 
public resetIncludeNamedCookies(): void
resetIncludeProtocol 
public resetIncludeProtocol(): void
resetIncludeQueryString 
public resetIncludeQueryString(): void
resetQueryStringBlacklist 
public resetQueryStringBlacklist(): void
resetQueryStringWhitelist 
public resetQueryStringWhitelist(): 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.
includeHostInput boolean | cdktf.IResolvable No description.
includeNamedCookiesInput string[] No description.
includeProtocolInput boolean | cdktf.IResolvable No description.
includeQueryStringInput boolean | cdktf.IResolvable No description.
queryStringBlacklistInput string[] No description.
queryStringWhitelistInput string[] No description.
includeHost boolean | cdktf.IResolvable No description.
includeNamedCookies string[] No description.
includeProtocol boolean | cdktf.IResolvable No description.
includeQueryString boolean | cdktf.IResolvable No description.
queryStringBlacklist string[] No description.
queryStringWhitelist string[] No description.
internalValue ComputeRegionBackendServiceCdnPolicyCacheKeyPolicy 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
includeHostInputOptional 
public readonly includeHostInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
includeNamedCookiesInputOptional 
public readonly includeNamedCookiesInput: string[];
  • Type: string[]
includeProtocolInputOptional 
public readonly includeProtocolInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
includeQueryStringInputOptional 
public readonly includeQueryStringInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
queryStringBlacklistInputOptional 
public readonly queryStringBlacklistInput: string[];
  • Type: string[]
queryStringWhitelistInputOptional 
public readonly queryStringWhitelistInput: string[];
  • Type: string[]
includeHostRequired 
public readonly includeHost: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
includeNamedCookiesRequired 
public readonly includeNamedCookies: string[];
  • Type: string[]
includeProtocolRequired 
public readonly includeProtocol: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
includeQueryStringRequired 
public readonly includeQueryString: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
queryStringBlacklistRequired 
public readonly queryStringBlacklist: string[];
  • Type: string[]
queryStringWhitelistRequired 
public readonly queryStringWhitelist: string[];
  • Type: string[]
internalValueOptional 
public readonly internalValue: ComputeRegionBackendServiceCdnPolicyCacheKeyPolicy;

ComputeRegionBackendServiceCdnPolicyNegativeCachingPolicyList

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceCdnPolicyNegativeCachingPolicyList(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): ComputeRegionBackendServiceCdnPolicyNegativeCachingPolicyOutputReference
indexRequired
  • Type: number

the index of the item to return.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
internalValue cdktf.IResolvable | ComputeRegionBackendServiceCdnPolicyNegativeCachingPolicy[] No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

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

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

fqnRequired 
public readonly fqn: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | ComputeRegionBackendServiceCdnPolicyNegativeCachingPolicy[];

ComputeRegionBackendServiceCdnPolicyNegativeCachingPolicyOutputReference

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceCdnPolicyNegativeCachingPolicyOutputReference(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.
resetCode 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.

resetCode 
public resetCode(): 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.
codeInput number No description.
code number No description.
internalValue cdktf.IResolvable | ComputeRegionBackendServiceCdnPolicyNegativeCachingPolicy 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
codeInputOptional 
public readonly codeInput: number;
  • Type: number
codeRequired 
public readonly code: number;
  • Type: number
internalValueOptional 
public readonly internalValue: IResolvable | ComputeRegionBackendServiceCdnPolicyNegativeCachingPolicy;

ComputeRegionBackendServiceCdnPolicyOutputReference

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceCdnPolicyOutputReference(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.
putCacheKeyPolicy No description.
putNegativeCachingPolicy No description.
resetCacheKeyPolicy No description.
resetCacheMode No description.
resetClientTtl No description.
resetDefaultTtl No description.
resetMaxTtl No description.
resetNegativeCaching No description.
resetNegativeCachingPolicy No description.
resetServeWhileStale No description.
resetSignedUrlCacheMaxAgeSec 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.

putCacheKeyPolicy 
public putCacheKeyPolicy(value: ComputeRegionBackendServiceCdnPolicyCacheKeyPolicy): void
valueRequired
putNegativeCachingPolicy 
public putNegativeCachingPolicy(value: IResolvable | ComputeRegionBackendServiceCdnPolicyNegativeCachingPolicy[]): void
valueRequired
resetCacheKeyPolicy 
public resetCacheKeyPolicy(): void
resetCacheMode 
public resetCacheMode(): void
resetClientTtl 
public resetClientTtl(): void
resetDefaultTtl 
public resetDefaultTtl(): void
resetMaxTtl 
public resetMaxTtl(): void
resetNegativeCaching 
public resetNegativeCaching(): void
resetNegativeCachingPolicy 
public resetNegativeCachingPolicy(): void
resetServeWhileStale 
public resetServeWhileStale(): void
resetSignedUrlCacheMaxAgeSec 
public resetSignedUrlCacheMaxAgeSec(): 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.
cacheKeyPolicy ComputeRegionBackendServiceCdnPolicyCacheKeyPolicyOutputReference No description.
negativeCachingPolicy ComputeRegionBackendServiceCdnPolicyNegativeCachingPolicyList No description.
cacheKeyPolicyInput ComputeRegionBackendServiceCdnPolicyCacheKeyPolicy No description.
cacheModeInput string No description.
clientTtlInput number No description.
defaultTtlInput number No description.
maxTtlInput number No description.
negativeCachingInput boolean | cdktf.IResolvable No description.
negativeCachingPolicyInput cdktf.IResolvable | ComputeRegionBackendServiceCdnPolicyNegativeCachingPolicy[] No description.
serveWhileStaleInput number No description.
signedUrlCacheMaxAgeSecInput number No description.
cacheMode string No description.
clientTtl number No description.
defaultTtl number No description.
maxTtl number No description.
negativeCaching boolean | cdktf.IResolvable No description.
serveWhileStale number No description.
signedUrlCacheMaxAgeSec number No description.
internalValue ComputeRegionBackendServiceCdnPolicy 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
cacheKeyPolicyRequired 
public readonly cacheKeyPolicy: ComputeRegionBackendServiceCdnPolicyCacheKeyPolicyOutputReference;
negativeCachingPolicyRequired 
public readonly negativeCachingPolicy: ComputeRegionBackendServiceCdnPolicyNegativeCachingPolicyList;
cacheKeyPolicyInputOptional 
public readonly cacheKeyPolicyInput: ComputeRegionBackendServiceCdnPolicyCacheKeyPolicy;
cacheModeInputOptional 
public readonly cacheModeInput: string;
  • Type: string
clientTtlInputOptional 
public readonly clientTtlInput: number;
  • Type: number
defaultTtlInputOptional 
public readonly defaultTtlInput: number;
  • Type: number
maxTtlInputOptional 
public readonly maxTtlInput: number;
  • Type: number
negativeCachingInputOptional 
public readonly negativeCachingInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
negativeCachingPolicyInputOptional 
public readonly negativeCachingPolicyInput: IResolvable | ComputeRegionBackendServiceCdnPolicyNegativeCachingPolicy[];
serveWhileStaleInputOptional 
public readonly serveWhileStaleInput: number;
  • Type: number
signedUrlCacheMaxAgeSecInputOptional 
public readonly signedUrlCacheMaxAgeSecInput: number;
  • Type: number
cacheModeRequired 
public readonly cacheMode: string;
  • Type: string
clientTtlRequired 
public readonly clientTtl: number;
  • Type: number
defaultTtlRequired 
public readonly defaultTtl: number;
  • Type: number
maxTtlRequired 
public readonly maxTtl: number;
  • Type: number
negativeCachingRequired 
public readonly negativeCaching: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
serveWhileStaleRequired 
public readonly serveWhileStale: number;
  • Type: number
signedUrlCacheMaxAgeSecRequired 
public readonly signedUrlCacheMaxAgeSec: number;
  • Type: number
internalValueOptional 
public readonly internalValue: ComputeRegionBackendServiceCdnPolicy;

ComputeRegionBackendServiceCircuitBreakersOutputReference

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceCircuitBreakersOutputReference(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.
resetMaxConnections No description.
resetMaxPendingRequests No description.
resetMaxRequests No description.
resetMaxRequestsPerConnection No description.
resetMaxRetries 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.

resetMaxConnections 
public resetMaxConnections(): void
resetMaxPendingRequests 
public resetMaxPendingRequests(): void
resetMaxRequests 
public resetMaxRequests(): void
resetMaxRequestsPerConnection 
public resetMaxRequestsPerConnection(): void
resetMaxRetries 
public resetMaxRetries(): 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.
maxConnectionsInput number No description.
maxPendingRequestsInput number No description.
maxRequestsInput number No description.
maxRequestsPerConnectionInput number No description.
maxRetriesInput number No description.
maxConnections number No description.
maxPendingRequests number No description.
maxRequests number No description.
maxRequestsPerConnection number No description.
maxRetries number No description.
internalValue ComputeRegionBackendServiceCircuitBreakers 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
maxConnectionsInputOptional 
public readonly maxConnectionsInput: number;
  • Type: number
maxPendingRequestsInputOptional 
public readonly maxPendingRequestsInput: number;
  • Type: number
maxRequestsInputOptional 
public readonly maxRequestsInput: number;
  • Type: number
maxRequestsPerConnectionInputOptional 
public readonly maxRequestsPerConnectionInput: number;
  • Type: number
maxRetriesInputOptional 
public readonly maxRetriesInput: number;
  • Type: number
maxConnectionsRequired 
public readonly maxConnections: number;
  • Type: number
maxPendingRequestsRequired 
public readonly maxPendingRequests: number;
  • Type: number
maxRequestsRequired 
public readonly maxRequests: number;
  • Type: number
maxRequestsPerConnectionRequired 
public readonly maxRequestsPerConnection: number;
  • Type: number
maxRetriesRequired 
public readonly maxRetries: number;
  • Type: number
internalValueOptional 
public readonly internalValue: ComputeRegionBackendServiceCircuitBreakers;

ComputeRegionBackendServiceConsistentHashHttpCookieOutputReference

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceConsistentHashHttpCookieOutputReference(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.
putTtl No description.
resetName No description.
resetPath No description.
resetTtl 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.

putTtl 
public putTtl(value: ComputeRegionBackendServiceConsistentHashHttpCookieTtl): void
valueRequired
resetName 
public resetName(): void
resetPath 
public resetPath(): void
resetTtl 
public resetTtl(): 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.
ttl ComputeRegionBackendServiceConsistentHashHttpCookieTtlOutputReference No description.
nameInput string No description.
pathInput string No description.
ttlInput ComputeRegionBackendServiceConsistentHashHttpCookieTtl No description.
name string No description.
path string No description.
internalValue ComputeRegionBackendServiceConsistentHashHttpCookie 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
ttlRequired 
public readonly ttl: ComputeRegionBackendServiceConsistentHashHttpCookieTtlOutputReference;
nameInputOptional 
public readonly nameInput: string;
  • Type: string
pathInputOptional 
public readonly pathInput: string;
  • Type: string
ttlInputOptional 
public readonly ttlInput: ComputeRegionBackendServiceConsistentHashHttpCookieTtl;
nameRequired 
public readonly name: string;
  • Type: string
pathRequired 
public readonly path: string;
  • Type: string
internalValueOptional 
public readonly internalValue: ComputeRegionBackendServiceConsistentHashHttpCookie;

ComputeRegionBackendServiceConsistentHashHttpCookieTtlOutputReference

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceConsistentHashHttpCookieTtlOutputReference(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.
resetNanos 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.

resetNanos 
public resetNanos(): 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.
nanosInput number No description.
secondsInput number No description.
nanos number No description.
seconds number No description.
internalValue ComputeRegionBackendServiceConsistentHashHttpCookieTtl 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
nanosInputOptional 
public readonly nanosInput: number;
  • Type: number
secondsInputOptional 
public readonly secondsInput: number;
  • Type: number
nanosRequired 
public readonly nanos: number;
  • Type: number
secondsRequired 
public readonly seconds: number;
  • Type: number
internalValueOptional 
public readonly internalValue: ComputeRegionBackendServiceConsistentHashHttpCookieTtl;

ComputeRegionBackendServiceConsistentHashOutputReference

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceConsistentHashOutputReference(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.
putHttpCookie No description.
resetHttpCookie No description.
resetHttpHeaderName No description.
resetMinimumRingSize 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.

putHttpCookie 
public putHttpCookie(value: ComputeRegionBackendServiceConsistentHashHttpCookie): void
valueRequired
resetHttpCookie 
public resetHttpCookie(): void
resetHttpHeaderName 
public resetHttpHeaderName(): void
resetMinimumRingSize 
public resetMinimumRingSize(): 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.
httpCookie ComputeRegionBackendServiceConsistentHashHttpCookieOutputReference No description.
httpCookieInput ComputeRegionBackendServiceConsistentHashHttpCookie No description.
httpHeaderNameInput string No description.
minimumRingSizeInput number No description.
httpHeaderName string No description.
minimumRingSize number No description.
internalValue ComputeRegionBackendServiceConsistentHash 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
httpCookieRequired 
public readonly httpCookie: ComputeRegionBackendServiceConsistentHashHttpCookieOutputReference;
httpCookieInputOptional 
public readonly httpCookieInput: ComputeRegionBackendServiceConsistentHashHttpCookie;
httpHeaderNameInputOptional 
public readonly httpHeaderNameInput: string;
  • Type: string
minimumRingSizeInputOptional 
public readonly minimumRingSizeInput: number;
  • Type: number
httpHeaderNameRequired 
public readonly httpHeaderName: string;
  • Type: string
minimumRingSizeRequired 
public readonly minimumRingSize: number;
  • Type: number
internalValueOptional 
public readonly internalValue: ComputeRegionBackendServiceConsistentHash;

ComputeRegionBackendServiceCustomMetricsList

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceCustomMetricsList(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): ComputeRegionBackendServiceCustomMetricsOutputReference
indexRequired
  • Type: number

the index of the item to return.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
internalValue cdktf.IResolvable | ComputeRegionBackendServiceCustomMetrics[] No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

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

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

fqnRequired 
public readonly fqn: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | ComputeRegionBackendServiceCustomMetrics[];

ComputeRegionBackendServiceCustomMetricsOutputReference

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceCustomMetricsOutputReference(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.
dryRunInput boolean | cdktf.IResolvable No description.
nameInput string No description.
dryRun boolean | cdktf.IResolvable No description.
name string No description.
internalValue cdktf.IResolvable | ComputeRegionBackendServiceCustomMetrics 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
dryRunInputOptional 
public readonly dryRunInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
nameInputOptional 
public readonly nameInput: string;
  • Type: string
dryRunRequired 
public readonly dryRun: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
nameRequired 
public readonly name: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | ComputeRegionBackendServiceCustomMetrics;

ComputeRegionBackendServiceFailoverPolicyOutputReference

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceFailoverPolicyOutputReference(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.
resetDisableConnectionDrainOnFailover No description.
resetDropTrafficIfUnhealthy No description.
resetFailoverRatio 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.

resetDisableConnectionDrainOnFailover 
public resetDisableConnectionDrainOnFailover(): void
resetDropTrafficIfUnhealthy 
public resetDropTrafficIfUnhealthy(): void
resetFailoverRatio 
public resetFailoverRatio(): 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.
disableConnectionDrainOnFailoverInput boolean | cdktf.IResolvable No description.
dropTrafficIfUnhealthyInput boolean | cdktf.IResolvable No description.
failoverRatioInput number No description.
disableConnectionDrainOnFailover boolean | cdktf.IResolvable No description.
dropTrafficIfUnhealthy boolean | cdktf.IResolvable No description.
failoverRatio number No description.
internalValue ComputeRegionBackendServiceFailoverPolicy 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
disableConnectionDrainOnFailoverInputOptional 
public readonly disableConnectionDrainOnFailoverInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
dropTrafficIfUnhealthyInputOptional 
public readonly dropTrafficIfUnhealthyInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
failoverRatioInputOptional 
public readonly failoverRatioInput: number;
  • Type: number
disableConnectionDrainOnFailoverRequired 
public readonly disableConnectionDrainOnFailover: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
dropTrafficIfUnhealthyRequired 
public readonly dropTrafficIfUnhealthy: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
failoverRatioRequired 
public readonly failoverRatio: number;
  • Type: number
internalValueOptional 
public readonly internalValue: ComputeRegionBackendServiceFailoverPolicy;

ComputeRegionBackendServiceIapOutputReference

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceIapOutputReference(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.
resetOauth2ClientId No description.
resetOauth2ClientSecret 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.

resetOauth2ClientId 
public resetOauth2ClientId(): void
resetOauth2ClientSecret 
public resetOauth2ClientSecret(): 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.
oauth2ClientSecretSha256 string No description.
enabledInput boolean | cdktf.IResolvable No description.
oauth2ClientIdInput string No description.
oauth2ClientSecretInput string No description.
enabled boolean | cdktf.IResolvable No description.
oauth2ClientId string No description.
oauth2ClientSecret string No description.
internalValue ComputeRegionBackendServiceIap 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
oauth2ClientSecretSha256Required 
public readonly oauth2ClientSecretSha256: string;
  • Type: string
enabledInputOptional 
public readonly enabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
oauth2ClientIdInputOptional 
public readonly oauth2ClientIdInput: string;
  • Type: string
oauth2ClientSecretInputOptional 
public readonly oauth2ClientSecretInput: string;
  • Type: string
enabledRequired 
public readonly enabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
oauth2ClientIdRequired 
public readonly oauth2ClientId: string;
  • Type: string
oauth2ClientSecretRequired 
public readonly oauth2ClientSecret: string;
  • Type: string
internalValueOptional 
public readonly internalValue: ComputeRegionBackendServiceIap;

ComputeRegionBackendServiceLogConfigOutputReference

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceLogConfigOutputReference(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.
resetEnable No description.
resetOptionalFields No description.
resetOptionalMode No description.
resetSampleRate 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.

resetEnable 
public resetEnable(): void
resetOptionalFields 
public resetOptionalFields(): void
resetOptionalMode 
public resetOptionalMode(): void
resetSampleRate 
public resetSampleRate(): 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.
enableInput boolean | cdktf.IResolvable No description.
optionalFieldsInput string[] No description.
optionalModeInput string No description.
sampleRateInput number No description.
enable boolean | cdktf.IResolvable No description.
optionalFields string[] No description.
optionalMode string No description.
sampleRate number No description.
internalValue ComputeRegionBackendServiceLogConfig 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
enableInputOptional 
public readonly enableInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
optionalFieldsInputOptional 
public readonly optionalFieldsInput: string[];
  • Type: string[]
optionalModeInputOptional 
public readonly optionalModeInput: string;
  • Type: string
sampleRateInputOptional 
public readonly sampleRateInput: number;
  • Type: number
enableRequired 
public readonly enable: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
optionalFieldsRequired 
public readonly optionalFields: string[];
  • Type: string[]
optionalModeRequired 
public readonly optionalMode: string;
  • Type: string
sampleRateRequired 
public readonly sampleRate: number;
  • Type: number
internalValueOptional 
public readonly internalValue: ComputeRegionBackendServiceLogConfig;

ComputeRegionBackendServiceOutlierDetectionBaseEjectionTimeOutputReference

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceOutlierDetectionBaseEjectionTimeOutputReference(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.
resetNanos 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.

resetNanos 
public resetNanos(): 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.
nanosInput number No description.
secondsInput number No description.
nanos number No description.
seconds number No description.
internalValue ComputeRegionBackendServiceOutlierDetectionBaseEjectionTime 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
nanosInputOptional 
public readonly nanosInput: number;
  • Type: number
secondsInputOptional 
public readonly secondsInput: number;
  • Type: number
nanosRequired 
public readonly nanos: number;
  • Type: number
secondsRequired 
public readonly seconds: number;
  • Type: number
internalValueOptional 
public readonly internalValue: ComputeRegionBackendServiceOutlierDetectionBaseEjectionTime;

ComputeRegionBackendServiceOutlierDetectionIntervalOutputReference

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceOutlierDetectionIntervalOutputReference(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.
resetNanos 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.

resetNanos 
public resetNanos(): 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.
nanosInput number No description.
secondsInput number No description.
nanos number No description.
seconds number No description.
internalValue ComputeRegionBackendServiceOutlierDetectionInterval 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
nanosInputOptional 
public readonly nanosInput: number;
  • Type: number
secondsInputOptional 
public readonly secondsInput: number;
  • Type: number
nanosRequired 
public readonly nanos: number;
  • Type: number
secondsRequired 
public readonly seconds: number;
  • Type: number
internalValueOptional 
public readonly internalValue: ComputeRegionBackendServiceOutlierDetectionInterval;

ComputeRegionBackendServiceOutlierDetectionOutputReference

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceOutlierDetectionOutputReference(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.
putBaseEjectionTime No description.
putInterval No description.
resetBaseEjectionTime No description.
resetConsecutiveErrors No description.
resetConsecutiveGatewayFailure No description.
resetEnforcingConsecutiveErrors No description.
resetEnforcingConsecutiveGatewayFailure No description.
resetEnforcingSuccessRate No description.
resetInterval No description.
resetMaxEjectionPercent No description.
resetSuccessRateMinimumHosts No description.
resetSuccessRateRequestVolume No description.
resetSuccessRateStdevFactor 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.

putBaseEjectionTime 
public putBaseEjectionTime(value: ComputeRegionBackendServiceOutlierDetectionBaseEjectionTime): void
valueRequired
putInterval 
public putInterval(value: ComputeRegionBackendServiceOutlierDetectionInterval): void
valueRequired
resetBaseEjectionTime 
public resetBaseEjectionTime(): void
resetConsecutiveErrors 
public resetConsecutiveErrors(): void
resetConsecutiveGatewayFailure 
public resetConsecutiveGatewayFailure(): void
resetEnforcingConsecutiveErrors 
public resetEnforcingConsecutiveErrors(): void
resetEnforcingConsecutiveGatewayFailure 
public resetEnforcingConsecutiveGatewayFailure(): void
resetEnforcingSuccessRate 
public resetEnforcingSuccessRate(): void
resetInterval 
public resetInterval(): void
resetMaxEjectionPercent 
public resetMaxEjectionPercent(): void
resetSuccessRateMinimumHosts 
public resetSuccessRateMinimumHosts(): void
resetSuccessRateRequestVolume 
public resetSuccessRateRequestVolume(): void
resetSuccessRateStdevFactor 
public resetSuccessRateStdevFactor(): 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.
baseEjectionTime ComputeRegionBackendServiceOutlierDetectionBaseEjectionTimeOutputReference No description.
interval ComputeRegionBackendServiceOutlierDetectionIntervalOutputReference No description.
baseEjectionTimeInput ComputeRegionBackendServiceOutlierDetectionBaseEjectionTime No description.
consecutiveErrorsInput number No description.
consecutiveGatewayFailureInput number No description.
enforcingConsecutiveErrorsInput number No description.
enforcingConsecutiveGatewayFailureInput number No description.
enforcingSuccessRateInput number No description.
intervalInput ComputeRegionBackendServiceOutlierDetectionInterval No description.
maxEjectionPercentInput number No description.
successRateMinimumHostsInput number No description.
successRateRequestVolumeInput number No description.
successRateStdevFactorInput number No description.
consecutiveErrors number No description.
consecutiveGatewayFailure number No description.
enforcingConsecutiveErrors number No description.
enforcingConsecutiveGatewayFailure number No description.
enforcingSuccessRate number No description.
maxEjectionPercent number No description.
successRateMinimumHosts number No description.
successRateRequestVolume number No description.
successRateStdevFactor number No description.
internalValue ComputeRegionBackendServiceOutlierDetection 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
baseEjectionTimeRequired 
public readonly baseEjectionTime: ComputeRegionBackendServiceOutlierDetectionBaseEjectionTimeOutputReference;
intervalRequired 
public readonly interval: ComputeRegionBackendServiceOutlierDetectionIntervalOutputReference;
baseEjectionTimeInputOptional 
public readonly baseEjectionTimeInput: ComputeRegionBackendServiceOutlierDetectionBaseEjectionTime;
consecutiveErrorsInputOptional 
public readonly consecutiveErrorsInput: number;
  • Type: number
consecutiveGatewayFailureInputOptional 
public readonly consecutiveGatewayFailureInput: number;
  • Type: number
enforcingConsecutiveErrorsInputOptional 
public readonly enforcingConsecutiveErrorsInput: number;
  • Type: number
enforcingConsecutiveGatewayFailureInputOptional 
public readonly enforcingConsecutiveGatewayFailureInput: number;
  • Type: number
enforcingSuccessRateInputOptional 
public readonly enforcingSuccessRateInput: number;
  • Type: number
intervalInputOptional 
public readonly intervalInput: ComputeRegionBackendServiceOutlierDetectionInterval;
maxEjectionPercentInputOptional 
public readonly maxEjectionPercentInput: number;
  • Type: number
successRateMinimumHostsInputOptional 
public readonly successRateMinimumHostsInput: number;
  • Type: number
successRateRequestVolumeInputOptional 
public readonly successRateRequestVolumeInput: number;
  • Type: number
successRateStdevFactorInputOptional 
public readonly successRateStdevFactorInput: number;
  • Type: number
consecutiveErrorsRequired 
public readonly consecutiveErrors: number;
  • Type: number
consecutiveGatewayFailureRequired 
public readonly consecutiveGatewayFailure: number;
  • Type: number
enforcingConsecutiveErrorsRequired 
public readonly enforcingConsecutiveErrors: number;
  • Type: number
enforcingConsecutiveGatewayFailureRequired 
public readonly enforcingConsecutiveGatewayFailure: number;
  • Type: number
enforcingSuccessRateRequired 
public readonly enforcingSuccessRate: number;
  • Type: number
maxEjectionPercentRequired 
public readonly maxEjectionPercent: number;
  • Type: number
successRateMinimumHostsRequired 
public readonly successRateMinimumHosts: number;
  • Type: number
successRateRequestVolumeRequired 
public readonly successRateRequestVolume: number;
  • Type: number
successRateStdevFactorRequired 
public readonly successRateStdevFactor: number;
  • Type: number
internalValueOptional 
public readonly internalValue: ComputeRegionBackendServiceOutlierDetection;

ComputeRegionBackendServiceStrongSessionAffinityCookieOutputReference

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceStrongSessionAffinityCookieOutputReference(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.
putTtl No description.
resetName No description.
resetPath No description.
resetTtl 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.

putTtl 
public putTtl(value: ComputeRegionBackendServiceStrongSessionAffinityCookieTtl): void
valueRequired
resetName 
public resetName(): void
resetPath 
public resetPath(): void
resetTtl 
public resetTtl(): 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.
ttl ComputeRegionBackendServiceStrongSessionAffinityCookieTtlOutputReference No description.
nameInput string No description.
pathInput string No description.
ttlInput ComputeRegionBackendServiceStrongSessionAffinityCookieTtl No description.
name string No description.
path string No description.
internalValue ComputeRegionBackendServiceStrongSessionAffinityCookie 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
ttlRequired 
public readonly ttl: ComputeRegionBackendServiceStrongSessionAffinityCookieTtlOutputReference;
nameInputOptional 
public readonly nameInput: string;
  • Type: string
pathInputOptional 
public readonly pathInput: string;
  • Type: string
ttlInputOptional 
public readonly ttlInput: ComputeRegionBackendServiceStrongSessionAffinityCookieTtl;
nameRequired 
public readonly name: string;
  • Type: string
pathRequired 
public readonly path: string;
  • Type: string
internalValueOptional 
public readonly internalValue: ComputeRegionBackendServiceStrongSessionAffinityCookie;

ComputeRegionBackendServiceStrongSessionAffinityCookieTtlOutputReference

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceStrongSessionAffinityCookieTtlOutputReference(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.
resetNanos 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.

resetNanos 
public resetNanos(): 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.
nanosInput number No description.
secondsInput number No description.
nanos number No description.
seconds number No description.
internalValue ComputeRegionBackendServiceStrongSessionAffinityCookieTtl 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
nanosInputOptional 
public readonly nanosInput: number;
  • Type: number
secondsInputOptional 
public readonly secondsInput: number;
  • Type: number
nanosRequired 
public readonly nanos: number;
  • Type: number
secondsRequired 
public readonly seconds: number;
  • Type: number
internalValueOptional 
public readonly internalValue: ComputeRegionBackendServiceStrongSessionAffinityCookieTtl;

ComputeRegionBackendServiceTimeoutsOutputReference

Initializers 

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

new computeRegionBackendService.ComputeRegionBackendServiceTimeoutsOutputReference(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 | ComputeRegionBackendServiceTimeouts 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 | ComputeRegionBackendServiceTimeouts;