Skip to content

Latest commit

 

History

History
1337 lines (834 loc) · 54.5 KB

fwRuleV2.typescript.md

File metadata and controls

1337 lines (834 loc) · 54.5 KB

fwRuleV2 Submodule

Constructs

FwRuleV2

Represents a {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2 opentelekomcloud_fw_rule_v2}.

Initializers

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

new fwRuleV2.FwRuleV2(scope: Construct, id: string, config: FwRuleV2Config)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config FwRuleV2Config 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".
resetDescription No description.
resetDestinationIpAddress No description.
resetDestinationPort No description.
resetEnabled No description.
resetId No description.
resetIpVersion No description.
resetName No description.
resetRegion No description.
resetSourceIpAddress No description.
resetSourcePort No description.
resetTenantId No description.
resetValueSpecs 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".


resetDescription
public resetDescription(): void
resetDestinationIpAddress
public resetDestinationIpAddress(): void
resetDestinationPort
public resetDestinationPort(): void
resetEnabled
public resetEnabled(): void
resetId
public resetId(): void
resetIpVersion
public resetIpVersion(): void
resetName
public resetName(): void
resetRegion
public resetRegion(): void
resetSourceIpAddress
public resetSourceIpAddress(): void
resetSourcePort
public resetSourcePort(): void
resetTenantId
public resetTenantId(): void
resetValueSpecs
public resetValueSpecs(): 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 FwRuleV2 resource upon running "cdktf plan ".

isConstruct
import { fwRuleV2 } from '@cdktf/provider-opentelekomcloud'

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

fwRuleV2.FwRuleV2.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { fwRuleV2 } from '@cdktf/provider-opentelekomcloud'

fwRuleV2.FwRuleV2.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { fwRuleV2 } from '@cdktf/provider-opentelekomcloud'

fwRuleV2.FwRuleV2.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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


importFromIdRequired
  • Type: string

The id of the existing FwRuleV2 that should be imported.

Refer to the {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_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 FwRuleV2 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.
actionInput string No description.
descriptionInput string No description.
destinationIpAddressInput string No description.
destinationPortInput string No description.
enabledInput boolean | cdktf.IResolvable No description.
idInput string No description.
ipVersionInput number No description.
nameInput string No description.
protocolInput string No description.
regionInput string No description.
sourceIpAddressInput string No description.
sourcePortInput string No description.
tenantIdInput string No description.
valueSpecsInput {[ key: string ]: string} No description.
action string No description.
description string No description.
destinationIpAddress string No description.
destinationPort string No description.
enabled boolean | cdktf.IResolvable No description.
id string No description.
ipVersion number No description.
name string No description.
protocol string No description.
region string No description.
sourceIpAddress string No description.
sourcePort string No description.
tenantId string No description.
valueSpecs {[ key: string ]: 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[]

actionInputOptional
public readonly actionInput: string;
  • Type: string

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

destinationIpAddressInputOptional
public readonly destinationIpAddressInput: string;
  • Type: string

destinationPortInputOptional
public readonly destinationPortInput: string;
  • Type: string

enabledInputOptional
public readonly enabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

idInputOptional
public readonly idInput: string;
  • Type: string

ipVersionInputOptional
public readonly ipVersionInput: number;
  • Type: number

nameInputOptional
public readonly nameInput: string;
  • Type: string

protocolInputOptional
public readonly protocolInput: string;
  • Type: string

regionInputOptional
public readonly regionInput: string;
  • Type: string

sourceIpAddressInputOptional
public readonly sourceIpAddressInput: string;
  • Type: string

sourcePortInputOptional
public readonly sourcePortInput: string;
  • Type: string

tenantIdInputOptional
public readonly tenantIdInput: string;
  • Type: string

valueSpecsInputOptional
public readonly valueSpecsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

actionRequired
public readonly action: string;
  • Type: string

descriptionRequired
public readonly description: string;
  • Type: string

destinationIpAddressRequired
public readonly destinationIpAddress: string;
  • Type: string

destinationPortRequired
public readonly destinationPort: string;
  • Type: string

enabledRequired
public readonly enabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

idRequired
public readonly id: string;
  • Type: string

ipVersionRequired
public readonly ipVersion: number;
  • Type: number

nameRequired
public readonly name: string;
  • Type: string

protocolRequired
public readonly protocol: string;
  • Type: string

regionRequired
public readonly region: string;
  • Type: string

sourceIpAddressRequired
public readonly sourceIpAddress: string;
  • Type: string

sourcePortRequired
public readonly sourcePort: string;
  • Type: string

tenantIdRequired
public readonly tenantId: string;
  • Type: string

valueSpecsRequired
public readonly valueSpecs: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

FwRuleV2Config

Initializer

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

const fwRuleV2Config: fwRuleV2.FwRuleV2Config = { ... }

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.
action string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#action FwRuleV2#action}.
protocol string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#protocol FwRuleV2#protocol}.
description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#description FwRuleV2#description}.
destinationIpAddress string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#destination_ip_address FwRuleV2#destination_ip_address}.
destinationPort string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#destination_port FwRuleV2#destination_port}.
enabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#enabled FwRuleV2#enabled}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#id FwRuleV2#id}.
ipVersion number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#ip_version FwRuleV2#ip_version}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#name FwRuleV2#name}.
region string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#region FwRuleV2#region}.
sourceIpAddress string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#source_ip_address FwRuleV2#source_ip_address}.
sourcePort string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#source_port FwRuleV2#source_port}.
tenantId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#tenant_id FwRuleV2#tenant_id}.
valueSpecs {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#value_specs FwRuleV2#value_specs}.

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[]

actionRequired
public readonly action: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#action FwRuleV2#action}.


protocolRequired
public readonly protocol: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#protocol FwRuleV2#protocol}.


descriptionOptional
public readonly description: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#description FwRuleV2#description}.


destinationIpAddressOptional
public readonly destinationIpAddress: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#destination_ip_address FwRuleV2#destination_ip_address}.


destinationPortOptional
public readonly destinationPort: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#destination_port FwRuleV2#destination_port}.


enabledOptional
public readonly enabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#enabled FwRuleV2#enabled}.


idOptional
public readonly id: string;
  • Type: string

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


ipVersionOptional
public readonly ipVersion: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#ip_version FwRuleV2#ip_version}.


nameOptional
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#name FwRuleV2#name}.


regionOptional
public readonly region: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#region FwRuleV2#region}.


sourceIpAddressOptional
public readonly sourceIpAddress: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#source_ip_address FwRuleV2#source_ip_address}.


sourcePortOptional
public readonly sourcePort: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#source_port FwRuleV2#source_port}.


tenantIdOptional
public readonly tenantId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#tenant_id FwRuleV2#tenant_id}.


valueSpecsOptional
public readonly valueSpecs: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/fw_rule_v2#value_specs FwRuleV2#value_specs}.