Skip to content

Latest commit

 

History

History
1858 lines (1156 loc) · 82.8 KB

apigwGatewayV2.typescript.md

File metadata and controls

1858 lines (1156 loc) · 82.8 KB
Raw

apigwGatewayV2 Submodule

Constructs

ApigwGatewayV2

Represents a {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2 opentelekomcloud_apigw_gateway_v2}.

Initializers 

import { apigwGatewayV2 } from '@cdktf/provider-opentelekomcloud'

new apigwGatewayV2.ApigwGatewayV2(scope: Construct, id: string, config: ApigwGatewayV2Config)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config ApigwGatewayV2Config No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putTimeouts No description.
resetBandwidthChargingMode No description.
resetBandwidthSize No description.
resetDescription No description.
resetId No description.
resetIngressBandwidthChargingMode No description.
resetIngressBandwidthSize No description.
resetLoadbalancerProvider No description.
resetMaintainBegin No description.
resetTimeouts No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

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

toHclTerraform 
public toHclTerraform(): any
toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget 
public addMoveTarget(moveTarget: string): void

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

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
moveFromId 
public moveFromId(id: string): void

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

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

idRequired
  • Type: string

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

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

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

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

indexOptional
  • Type: string | number

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

moveToId 
public moveToId(id: string): void

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

idRequired
  • Type: string

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

putTimeouts 
public putTimeouts(value: ApigwGatewayV2Timeouts): void
valueRequired
resetBandwidthChargingMode 
public resetBandwidthChargingMode(): void
resetBandwidthSize 
public resetBandwidthSize(): void
resetDescription 
public resetDescription(): void
resetId 
public resetId(): void
resetIngressBandwidthChargingMode 
public resetIngressBandwidthChargingMode(): void
resetIngressBandwidthSize 
public resetIngressBandwidthSize(): void
resetLoadbalancerProvider 
public resetLoadbalancerProvider(): void
resetMaintainBegin 
public resetMaintainBegin(): 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 ApigwGatewayV2 resource upon running "cdktf plan ".
isConstruct 
import { apigwGatewayV2 } from '@cdktf/provider-opentelekomcloud'

apigwGatewayV2.ApigwGatewayV2.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 { apigwGatewayV2 } from '@cdktf/provider-opentelekomcloud'

apigwGatewayV2.ApigwGatewayV2.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { apigwGatewayV2 } from '@cdktf/provider-opentelekomcloud'

apigwGatewayV2.ApigwGatewayV2.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { apigwGatewayV2 } from '@cdktf/provider-opentelekomcloud'

apigwGatewayV2.ApigwGatewayV2.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

importFromIdRequired
  • Type: string

The id of the existing ApigwGatewayV2 that should be imported.

Refer to the {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#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 ApigwGatewayV2 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.
maintainEnd string No description.
privateEgressAddresses string[] No description.
projectId string No description.
publicEgressAddress string No description.
region string No description.
status string No description.
supportedFeatures string[] No description.
timeouts ApigwGatewayV2TimeoutsOutputReference No description.
vpcepServiceName string No description.
vpcIngressAddress string No description.
availabilityZonesInput string[] No description.
bandwidthChargingModeInput string No description.
bandwidthSizeInput number No description.
descriptionInput string No description.
idInput string No description.
ingressBandwidthChargingModeInput string No description.
ingressBandwidthSizeInput number No description.
loadbalancerProviderInput string No description.
maintainBeginInput string No description.
nameInput string No description.
securityGroupIdInput string No description.
specIdInput string No description.
subnetIdInput string No description.
timeoutsInput cdktf.IResolvable | ApigwGatewayV2Timeouts No description.
vpcIdInput string No description.
availabilityZones string[] No description.
bandwidthChargingMode string No description.
bandwidthSize number No description.
description string No description.
id string No description.
ingressBandwidthChargingMode string No description.
ingressBandwidthSize number No description.
loadbalancerProvider string No description.
maintainBegin string No description.
name string No description.
securityGroupId string No description.
specId string No description.
subnetId string No description.
vpcId string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
maintainEndRequired 
public readonly maintainEnd: string;
  • Type: string
privateEgressAddressesRequired 
public readonly privateEgressAddresses: string[];
  • Type: string[]
projectIdRequired 
public readonly projectId: string;
  • Type: string
publicEgressAddressRequired 
public readonly publicEgressAddress: string;
  • Type: string
regionRequired 
public readonly region: string;
  • Type: string
statusRequired 
public readonly status: string;
  • Type: string
supportedFeaturesRequired 
public readonly supportedFeatures: string[];
  • Type: string[]
timeoutsRequired 
public readonly timeouts: ApigwGatewayV2TimeoutsOutputReference;
vpcepServiceNameRequired 
public readonly vpcepServiceName: string;
  • Type: string
vpcIngressAddressRequired 
public readonly vpcIngressAddress: string;
  • Type: string
availabilityZonesInputOptional 
public readonly availabilityZonesInput: string[];
  • Type: string[]
bandwidthChargingModeInputOptional 
public readonly bandwidthChargingModeInput: string;
  • Type: string
bandwidthSizeInputOptional 
public readonly bandwidthSizeInput: number;
  • Type: number
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
ingressBandwidthChargingModeInputOptional 
public readonly ingressBandwidthChargingModeInput: string;
  • Type: string
ingressBandwidthSizeInputOptional 
public readonly ingressBandwidthSizeInput: number;
  • Type: number
loadbalancerProviderInputOptional 
public readonly loadbalancerProviderInput: string;
  • Type: string
maintainBeginInputOptional 
public readonly maintainBeginInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
securityGroupIdInputOptional 
public readonly securityGroupIdInput: string;
  • Type: string
specIdInputOptional 
public readonly specIdInput: string;
  • Type: string
subnetIdInputOptional 
public readonly subnetIdInput: string;
  • Type: string
timeoutsInputOptional 
public readonly timeoutsInput: IResolvable | ApigwGatewayV2Timeouts;
vpcIdInputOptional 
public readonly vpcIdInput: string;
  • Type: string
availabilityZonesRequired 
public readonly availabilityZones: string[];
  • Type: string[]
bandwidthChargingModeRequired 
public readonly bandwidthChargingMode: string;
  • Type: string
bandwidthSizeRequired 
public readonly bandwidthSize: number;
  • Type: number
descriptionRequired 
public readonly description: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
ingressBandwidthChargingModeRequired 
public readonly ingressBandwidthChargingMode: string;
  • Type: string
ingressBandwidthSizeRequired 
public readonly ingressBandwidthSize: number;
  • Type: number
loadbalancerProviderRequired 
public readonly loadbalancerProvider: string;
  • Type: string
maintainBeginRequired 
public readonly maintainBegin: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
securityGroupIdRequired 
public readonly securityGroupId: string;
  • Type: string
specIdRequired 
public readonly specId: string;
  • Type: string
subnetIdRequired 
public readonly subnetId: string;
  • Type: string
vpcIdRequired 
public readonly vpcId: string;
  • Type: string

Constants

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

Structs

ApigwGatewayV2Config

Initializer 

import { apigwGatewayV2 } from '@cdktf/provider-opentelekomcloud'

const apigwGatewayV2Config: apigwGatewayV2.ApigwGatewayV2Config = { ... }

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.
availabilityZones string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#availability_zones ApigwGatewayV2#availability_zones}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#name ApigwGatewayV2#name}.
securityGroupId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#security_group_id ApigwGatewayV2#security_group_id}.
specId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#spec_id ApigwGatewayV2#spec_id}.
subnetId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#subnet_id ApigwGatewayV2#subnet_id}.
vpcId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#vpc_id ApigwGatewayV2#vpc_id}.
bandwidthChargingMode string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#bandwidth_charging_mode ApigwGatewayV2#bandwidth_charging_mode}.
bandwidthSize number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#bandwidth_size ApigwGatewayV2#bandwidth_size}.
description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#description ApigwGatewayV2#description}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#id ApigwGatewayV2#id}.
ingressBandwidthChargingMode string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#ingress_bandwidth_charging_mode ApigwGatewayV2#ingress_bandwidth_charging_mode}.
ingressBandwidthSize number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#ingress_bandwidth_size ApigwGatewayV2#ingress_bandwidth_size}.
loadbalancerProvider string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#loadbalancer_provider ApigwGatewayV2#loadbalancer_provider}.
maintainBegin string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#maintain_begin ApigwGatewayV2#maintain_begin}.
timeouts ApigwGatewayV2Timeouts timeouts block.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
availabilityZonesRequired 
public readonly availabilityZones: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#availability_zones ApigwGatewayV2#availability_zones}.

nameRequired 
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#name ApigwGatewayV2#name}.

securityGroupIdRequired 
public readonly securityGroupId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#security_group_id ApigwGatewayV2#security_group_id}.

specIdRequired 
public readonly specId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#spec_id ApigwGatewayV2#spec_id}.

subnetIdRequired 
public readonly subnetId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#subnet_id ApigwGatewayV2#subnet_id}.

vpcIdRequired 
public readonly vpcId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#vpc_id ApigwGatewayV2#vpc_id}.

bandwidthChargingModeOptional 
public readonly bandwidthChargingMode: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#bandwidth_charging_mode ApigwGatewayV2#bandwidth_charging_mode}.

bandwidthSizeOptional 
public readonly bandwidthSize: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#bandwidth_size ApigwGatewayV2#bandwidth_size}.

descriptionOptional 
public readonly description: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#description ApigwGatewayV2#description}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#id ApigwGatewayV2#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.

ingressBandwidthChargingModeOptional 
public readonly ingressBandwidthChargingMode: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#ingress_bandwidth_charging_mode ApigwGatewayV2#ingress_bandwidth_charging_mode}.

ingressBandwidthSizeOptional 
public readonly ingressBandwidthSize: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#ingress_bandwidth_size ApigwGatewayV2#ingress_bandwidth_size}.

loadbalancerProviderOptional 
public readonly loadbalancerProvider: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#loadbalancer_provider ApigwGatewayV2#loadbalancer_provider}.

maintainBeginOptional 
public readonly maintainBegin: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#maintain_begin ApigwGatewayV2#maintain_begin}.

timeoutsOptional 
public readonly timeouts: ApigwGatewayV2Timeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#timeouts ApigwGatewayV2#timeouts}

ApigwGatewayV2Timeouts

Initializer 

import { apigwGatewayV2 } from '@cdktf/provider-opentelekomcloud'

const apigwGatewayV2Timeouts: apigwGatewayV2.ApigwGatewayV2Timeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#create ApigwGatewayV2#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#delete ApigwGatewayV2#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#update ApigwGatewayV2#update}.
createOptional 
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#create ApigwGatewayV2#create}.

deleteOptional 
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#delete ApigwGatewayV2#delete}.

updateOptional 
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/apigw_gateway_v2#update ApigwGatewayV2#update}.

Classes

ApigwGatewayV2TimeoutsOutputReference

Initializers 

import { apigwGatewayV2 } from '@cdktf/provider-opentelekomcloud'

new apigwGatewayV2.ApigwGatewayV2TimeoutsOutputReference(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 | ApigwGatewayV2Timeouts 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 | ApigwGatewayV2Timeouts;