`googleApigeeTargetServer` Submodule

Constructs

GoogleApigeeTargetServer

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

Initializers

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

new googleApigeeTargetServer.GoogleApigeeTargetServer(scope: Construct, id: string, config: GoogleApigeeTargetServerConfig)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: GoogleApigeeTargetServerConfig

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".
`putSSlInfo`	No description.
`putTimeouts`	No description.
`resetDescription`	No description.
`resetId`	No description.
`resetIsEnabled`	No description.
`resetProtocol`	No description.
`resetSSlInfo`	No description.
`resetTimeouts`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

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

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public resetOverrideLogicalId(): void

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

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

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

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

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

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

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

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

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

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

`id`^Required

Type: string

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

`moveTo`

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

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

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

`index`^Optional

Type: string | number

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

`moveToId`

public moveToId(id: string): void

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

`id`^Required

Type: string

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

`putSSlInfo`

public putSSlInfo(value: GoogleApigeeTargetServerSSlInfo): void

`value`^Required

Type: GoogleApigeeTargetServerSSlInfo

`putTimeouts`

public putTimeouts(value: GoogleApigeeTargetServerTimeouts): void

`value`^Required

Type: GoogleApigeeTargetServerTimeouts

`resetDescription`

public resetDescription(): void

`resetId`

public resetId(): void

`resetIsEnabled`

public resetIsEnabled(): void

`resetProtocol`

public resetProtocol(): void

`resetSSlInfo`

public resetSSlInfo(): void

`resetTimeouts`

public resetTimeouts(): void

Static Functions

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

`isConstruct`

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

googleApigeeTargetServer.GoogleApigeeTargetServer.isConstruct(x: any)

Checks if x is a construct.

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

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

`x`^Required

Type: any

Any object.

`isTerraformElement`

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

googleApigeeTargetServer.GoogleApigeeTargetServer.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

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

googleApigeeTargetServer.GoogleApigeeTargetServer.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

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

googleApigeeTargetServer.GoogleApigeeTargetServer.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

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

`importFromId`^Required

Type: string

The id of the existing GoogleApigeeTargetServer that should be imported.

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

`provider`^Optional

Type: cdktf.TerraformProvider

? Optional instance of the provider where the GoogleApigeeTargetServer 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.
`sSlInfo`	`GoogleApigeeTargetServerSSlInfoOutputReference`	No description.
`timeouts`	`GoogleApigeeTargetServerTimeoutsOutputReference`	No description.
`descriptionInput`	`string`	No description.
`envIdInput`	`string`	No description.
`hostInput`	`string`	No description.
`idInput`	`string`	No description.
`isEnabledInput`	`boolean \| cdktf.IResolvable`	No description.
`nameInput`	`string`	No description.
`portInput`	`number`	No description.
`protocolInput`	`string`	No description.
`sSlInfoInput`	`GoogleApigeeTargetServerSSlInfo`	No description.
`timeoutsInput`	`cdktf.IResolvable \| GoogleApigeeTargetServerTimeouts`	No description.
`description`	`string`	No description.
`envId`	`string`	No description.
`host`	`string`	No description.
`id`	`string`	No description.
`isEnabled`	`boolean \| cdktf.IResolvable`	No description.
`name`	`string`	No description.
`port`	`number`	No description.
`protocol`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

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

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

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

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

`sSlInfo`^Required

public readonly sSlInfo: GoogleApigeeTargetServerSSlInfoOutputReference;

Type: GoogleApigeeTargetServerSSlInfoOutputReference

`timeouts`^Required

public readonly timeouts: GoogleApigeeTargetServerTimeoutsOutputReference;

Type: GoogleApigeeTargetServerTimeoutsOutputReference

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`envIdInput`^Optional

public readonly envIdInput: string;

Type: string

`hostInput`^Optional

public readonly hostInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`isEnabledInput`^Optional

public readonly isEnabledInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`portInput`^Optional

public readonly portInput: number;

Type: number

`protocolInput`^Optional

public readonly protocolInput: string;

Type: string

`sSlInfoInput`^Optional

public readonly sSlInfoInput: GoogleApigeeTargetServerSSlInfo;

Type: GoogleApigeeTargetServerSSlInfo

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | GoogleApigeeTargetServerTimeouts;

Type: cdktf.IResolvable | GoogleApigeeTargetServerTimeouts

`description`^Required

public readonly description: string;

Type: string

`envId`^Required

public readonly envId: string;

Type: string

`host`^Required

public readonly host: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`isEnabled`^Required

public readonly isEnabled: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`name`^Required

public readonly name: string;

Type: string

`port`^Required

public readonly port: number;

Type: number

`protocol`^Required

public readonly protocol: string;

Type: string

Constants

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

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

GoogleApigeeTargetServerConfig

Initializer

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

const googleApigeeTargetServerConfig: googleApigeeTargetServer.GoogleApigeeTargetServerConfig = { ... }

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.
`envId`	`string`	The Apigee environment group associated with the Apigee environment, in the format 'organizations/{{org_name}}/environments/{{env_name}}'.
`host`	`string`	The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
`name`	`string`	The resource id of this reference. Values must match the regular expression [\w\s-.]+.
`port`	`number`	The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.
`description`	`string`	A human-readable description of this TargetServer.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_apigee_target_server#id GoogleApigeeTargetServer#id}.
`isEnabled`	`boolean \| cdktf.IResolvable`	Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically.
`protocol`	`string`	Immutable. The protocol used by this TargetServer. Possible values: ["HTTP", "HTTP2", "GRPC_TARGET", "GRPC", "EXTERNAL_CALLOUT"].
`sSlInfo`	`GoogleApigeeTargetServerSSlInfo`	s_sl_info block.
`timeouts`	`GoogleApigeeTargetServerTimeouts`	timeouts block.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

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

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

`envId`^Required

public readonly envId: string;

Type: string

The Apigee environment group associated with the Apigee environment, in the format 'organizations/{{org_name}}/environments/{{env_name}}'.

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

`host`^Required

public readonly host: string;

Type: string

The host name this target connects to. Value must be a valid hostname as described by RFC-1123.

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

`name`^Required

public readonly name: string;

Type: string

The resource id of this reference. Values must match the regular expression [\w\s-.]+.

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

`port`^Required

public readonly port: number;

Type: number

The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.

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

`description`^Optional

public readonly description: string;

Type: string

A human-readable description of this TargetServer.

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

`id`^Optional

public readonly id: string;

Type: string

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

`isEnabled`^Optional

public readonly isEnabled: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically.

Defaults to true.

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

`protocol`^Optional

public readonly protocol: string;

Type: string

Immutable. The protocol used by this TargetServer. Possible values: ["HTTP", "HTTP2", "GRPC_TARGET", "GRPC", "EXTERNAL_CALLOUT"].

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

`sSlInfo`^Optional

public readonly sSlInfo: GoogleApigeeTargetServerSSlInfo;

Type: GoogleApigeeTargetServerSSlInfo

s_sl_info block.

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

`timeouts`^Optional

public readonly timeouts: GoogleApigeeTargetServerTimeouts;

Type: GoogleApigeeTargetServerTimeouts

timeouts block.

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

GoogleApigeeTargetServerSSlInfo

Initializer

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

const googleApigeeTargetServerSSlInfo: googleApigeeTargetServer.GoogleApigeeTargetServerSSlInfo = { ... }

Properties

Name	Type	Description
`enabled`	`boolean \| cdktf.IResolvable`	Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
`ciphers`	`string[]`	The SSL/TLS cipher suites to be used.
`clientAuthEnabled`	`boolean \| cdktf.IResolvable`	Enables two-way TLS.
`commonName`	`GoogleApigeeTargetServerSSlInfoCommonName`	common_name block.
`ignoreValidationErrors`	`boolean \| cdktf.IResolvable`	If true, Edge ignores TLS certificate errors.
`keyAlias`	`string`	Required if clientAuthEnabled is true. The resource ID for the alias containing the private key and cert.
`keyStore`	`string`	Required if clientAuthEnabled is true. The resource ID of the keystore.
`protocols`	`string[]`	The TLS versioins to be used.
`trustStore`	`string`	The resource ID of the truststore.

`enabled`^Required

public readonly enabled: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Enables TLS. If false, neither one-way nor two-way TLS will be enabled.

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

`ciphers`^Optional

public readonly ciphers: string[];

Type: string[]

The SSL/TLS cipher suites to be used.

For programmable proxies, it must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. For configurable proxies, it must follow the configuration specified in: https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. This setting has no effect for configurable proxies when negotiating TLS 1.3.

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

`clientAuthEnabled`^Optional

public readonly clientAuthEnabled: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Enables two-way TLS.

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

`commonName`^Optional

public readonly commonName: GoogleApigeeTargetServerSSlInfoCommonName;

Type: GoogleApigeeTargetServerSSlInfoCommonName

common_name block.

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

`ignoreValidationErrors`^Optional

public readonly ignoreValidationErrors: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

If true, Edge ignores TLS certificate errors.

Valid when configuring TLS for target servers and target endpoints, and when configuring virtual hosts that use 2-way TLS. When used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails.

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

`keyAlias`^Optional

public readonly keyAlias: string;

Type: string

Required if clientAuthEnabled is true. The resource ID for the alias containing the private key and cert.

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

`keyStore`^Optional

public readonly keyStore: string;

Type: string

Required if clientAuthEnabled is true. The resource ID of the keystore.

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

`protocols`^Optional

public readonly protocols: string[];

Type: string[]

The TLS versioins to be used.

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

`trustStore`^Optional

public readonly trustStore: string;

Type: string

The resource ID of the truststore.

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

GoogleApigeeTargetServerSSlInfoCommonName

Initializer

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

const googleApigeeTargetServerSSlInfoCommonName: googleApigeeTargetServer.GoogleApigeeTargetServerSSlInfoCommonName = { ... }

Properties

Name	Type	Description
`value`	`string`	The TLS Common Name string of the certificate.
`wildcardMatch`	`boolean \| cdktf.IResolvable`	Indicates whether the cert should be matched against as a wildcard cert.

`value`^Optional

public readonly value: string;

Type: string

The TLS Common Name string of the certificate.

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

`wildcardMatch`^Optional

public readonly wildcardMatch: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Indicates whether the cert should be matched against as a wildcard cert.

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

GoogleApigeeTargetServerTimeouts

Initializer

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

const googleApigeeTargetServerTimeouts: googleApigeeTargetServer.GoogleApigeeTargetServerTimeouts = { ... }

Properties

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

`create`^Optional

public readonly create: string;

Type: string

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

`delete`^Optional

public readonly delete: string;

Type: string

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

`update`^Optional

public readonly update: string;

Type: string

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

Classes

GoogleApigeeTargetServerSSlInfoCommonNameOutputReference

Initializers

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

new googleApigeeTargetServer.GoogleApigeeTargetServerSSlInfoCommonNameOutputReference(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.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

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

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

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

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetValue`

public resetValue(): void

`resetWildcardMatch`

public resetWildcardMatch(): 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.
`valueInput`	`string`	No description.
`wildcardMatchInput`	`boolean \| cdktf.IResolvable`	No description.
`value`	`string`	No description.
`wildcardMatch`	`boolean \| cdktf.IResolvable`	No description.
`internalValue`	`GoogleApigeeTargetServerSSlInfoCommonName`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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

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

`fqn`^Required

public readonly fqn: string;

Type: string

`valueInput`^Optional

public readonly valueInput: string;

Type: string

`wildcardMatchInput`^Optional

public readonly wildcardMatchInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`value`^Required

public readonly value: string;

Type: string

`wildcardMatch`^Required

public readonly wildcardMatch: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`internalValue`^Optional

public readonly internalValue: GoogleApigeeTargetServerSSlInfoCommonName;

Type: GoogleApigeeTargetServerSSlInfoCommonName

GoogleApigeeTargetServerSSlInfoOutputReference

Initializers

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

new googleApigeeTargetServer.GoogleApigeeTargetServerSSlInfoOutputReference(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.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

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

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

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

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`putCommonName`

public putCommonName(value: GoogleApigeeTargetServerSSlInfoCommonName): void

`value`^Required

Type: GoogleApigeeTargetServerSSlInfoCommonName

`resetCiphers`

public resetCiphers(): void

`resetClientAuthEnabled`

public resetClientAuthEnabled(): void

`resetCommonName`

public resetCommonName(): void

`resetIgnoreValidationErrors`

public resetIgnoreValidationErrors(): void

`resetKeyAlias`

public resetKeyAlias(): void

`resetKeyStore`

public resetKeyStore(): void

`resetProtocols`

public resetProtocols(): void

`resetTrustStore`

public resetTrustStore(): 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.
`commonName`	`GoogleApigeeTargetServerSSlInfoCommonNameOutputReference`	No description.
`ciphersInput`	`string[]`	No description.
`clientAuthEnabledInput`	`boolean \| cdktf.IResolvable`	No description.
`commonNameInput`	`GoogleApigeeTargetServerSSlInfoCommonName`	No description.
`enabledInput`	`boolean \| cdktf.IResolvable`	No description.
`ignoreValidationErrorsInput`	`boolean \| cdktf.IResolvable`	No description.
`keyAliasInput`	`string`	No description.
`keyStoreInput`	`string`	No description.
`protocolsInput`	`string[]`	No description.
`trustStoreInput`	`string`	No description.
`ciphers`	`string[]`	No description.
`clientAuthEnabled`	`boolean \| cdktf.IResolvable`	No description.
`enabled`	`boolean \| cdktf.IResolvable`	No description.
`ignoreValidationErrors`	`boolean \| cdktf.IResolvable`	No description.
`keyAlias`	`string`	No description.
`keyStore`	`string`	No description.
`protocols`	`string[]`	No description.
`trustStore`	`string`	No description.
`internalValue`	`GoogleApigeeTargetServerSSlInfo`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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

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

`fqn`^Required

public readonly fqn: string;

Type: string

`commonName`^Required

public readonly commonName: GoogleApigeeTargetServerSSlInfoCommonNameOutputReference;

Type: GoogleApigeeTargetServerSSlInfoCommonNameOutputReference

`ciphersInput`^Optional

public readonly ciphersInput: string[];

Type: string[]

`clientAuthEnabledInput`^Optional

public readonly clientAuthEnabledInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`commonNameInput`^Optional

public readonly commonNameInput: GoogleApigeeTargetServerSSlInfoCommonName;

Type: GoogleApigeeTargetServerSSlInfoCommonName

`enabledInput`^Optional

public readonly enabledInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`ignoreValidationErrorsInput`^Optional

public readonly ignoreValidationErrorsInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`keyAliasInput`^Optional

public readonly keyAliasInput: string;

Type: string

`keyStoreInput`^Optional

public readonly keyStoreInput: string;

Type: string

`protocolsInput`^Optional

public readonly protocolsInput: string[];

Type: string[]

`trustStoreInput`^Optional

public readonly trustStoreInput: string;

Type: string

`ciphers`^Required

public readonly ciphers: string[];

Type: string[]

`clientAuthEnabled`^Required

public readonly clientAuthEnabled: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`enabled`^Required

public readonly enabled: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`ignoreValidationErrors`^Required

public readonly ignoreValidationErrors: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`keyAlias`^Required

public readonly keyAlias: string;

Type: string

`keyStore`^Required

public readonly keyStore: string;

Type: string

`protocols`^Required

public readonly protocols: string[];

Type: string[]

`trustStore`^Required

public readonly trustStore: string;

Type: string

`internalValue`^Optional

public readonly internalValue: GoogleApigeeTargetServerSSlInfo;

Type: GoogleApigeeTargetServerSSlInfo

GoogleApigeeTargetServerTimeoutsOutputReference

Initializers

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

new googleApigeeTargetServer.GoogleApigeeTargetServerTimeoutsOutputReference(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.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

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

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

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

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: 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 \| GoogleApigeeTargetServerTimeouts`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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

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

`fqn`^Required

public readonly fqn: string;

Type: string

`createInput`^Optional

public readonly createInput: string;

Type: string

`deleteInput`^Optional

public readonly deleteInput: string;

Type: string

`updateInput`^Optional

public readonly updateInput: string;

Type: string

`create`^Required

public readonly create: string;

Type: string

`delete`^Required

public readonly delete: string;

Type: string

`update`^Required

public readonly update: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleApigeeTargetServerTimeouts;

Type: cdktf.IResolvable | GoogleApigeeTargetServerTimeouts

Files

googleApigeeTargetServer.typescript.md

Latest commit

History

googleApigeeTargetServer.typescript.md

File metadata and controls

googleApigeeTargetServer Submodule

Constructs