Skip to content

Latest commit

 

History

History
2994 lines (1839 loc) · 130 KB

firewall.typescript.md

File metadata and controls

2994 lines (1839 loc) · 130 KB
Raw

firewall Submodule

Constructs

Firewall

Represents a {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall digitalocean_firewall}.

Initializers 

import { firewall } from '@cdktf/provider-digitalocean'

new firewall.Firewall(scope: Construct, id: string, config: FirewallConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config FirewallConfig 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".
putInboundRule No description.
putOutboundRule No description.
resetDropletIds No description.
resetId No description.
resetInboundRule No description.
resetOutboundRule No description.
resetTags 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".

putInboundRule 
public putInboundRule(value: IResolvable | FirewallInboundRule[]): void
valueRequired
putOutboundRule 
public putOutboundRule(value: IResolvable | FirewallOutboundRule[]): void
valueRequired
resetDropletIds 
public resetDropletIds(): void
resetId 
public resetId(): void
resetInboundRule 
public resetInboundRule(): void
resetOutboundRule 
public resetOutboundRule(): void
resetTags 
public resetTags(): 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 Firewall resource upon running "cdktf plan ".
isConstruct 
import { firewall } from '@cdktf/provider-digitalocean'

firewall.Firewall.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 { firewall } from '@cdktf/provider-digitalocean'

firewall.Firewall.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { firewall } from '@cdktf/provider-digitalocean'

firewall.Firewall.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { firewall } from '@cdktf/provider-digitalocean'

firewall.Firewall.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

importFromIdRequired
  • Type: string

The id of the existing Firewall that should be imported.

Refer to the {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#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 Firewall 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.
createdAt string No description.
inboundRule FirewallInboundRuleList No description.
outboundRule FirewallOutboundRuleList No description.
pendingChanges FirewallPendingChangesList No description.
status string No description.
dropletIdsInput number[] No description.
idInput string No description.
inboundRuleInput cdktf.IResolvable | FirewallInboundRule[] No description.
nameInput string No description.
outboundRuleInput cdktf.IResolvable | FirewallOutboundRule[] No description.
tagsInput string[] No description.
dropletIds number[] No description.
id string No description.
name string No description.
tags 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[]
createdAtRequired 
public readonly createdAt: string;
  • Type: string
inboundRuleRequired 
public readonly inboundRule: FirewallInboundRuleList;
outboundRuleRequired 
public readonly outboundRule: FirewallOutboundRuleList;
pendingChangesRequired 
public readonly pendingChanges: FirewallPendingChangesList;
statusRequired 
public readonly status: string;
  • Type: string
dropletIdsInputOptional 
public readonly dropletIdsInput: number[];
  • Type: number[]
idInputOptional 
public readonly idInput: string;
  • Type: string
inboundRuleInputOptional 
public readonly inboundRuleInput: IResolvable | FirewallInboundRule[];
nameInputOptional 
public readonly nameInput: string;
  • Type: string
outboundRuleInputOptional 
public readonly outboundRuleInput: IResolvable | FirewallOutboundRule[];
tagsInputOptional 
public readonly tagsInput: string[];
  • Type: string[]
dropletIdsRequired 
public readonly dropletIds: number[];
  • Type: number[]
idRequired 
public readonly id: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
tagsRequired 
public readonly tags: string[];
  • Type: string[]

Constants

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

Structs

FirewallConfig

Initializer 

import { firewall } from '@cdktf/provider-digitalocean'

const firewallConfig: firewall.FirewallConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#name Firewall#name}.
dropletIds number[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#droplet_ids Firewall#droplet_ids}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#id Firewall#id}.
inboundRule cdktf.IResolvable | FirewallInboundRule[] inbound_rule block.
outboundRule cdktf.IResolvable | FirewallOutboundRule[] outbound_rule block.
tags string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#tags Firewall#tags}.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
nameRequired 
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#name Firewall#name}.

dropletIdsOptional 
public readonly dropletIds: number[];
  • Type: number[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#droplet_ids Firewall#droplet_ids}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#id Firewall#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.

inboundRuleOptional 
public readonly inboundRule: IResolvable | FirewallInboundRule[];

inbound_rule block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#inbound_rule Firewall#inbound_rule}

outboundRuleOptional 
public readonly outboundRule: IResolvable | FirewallOutboundRule[];

outbound_rule block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#outbound_rule Firewall#outbound_rule}

tagsOptional 
public readonly tags: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#tags Firewall#tags}.

FirewallInboundRule

Initializer 

import { firewall } from '@cdktf/provider-digitalocean'

const firewallInboundRule: firewall.FirewallInboundRule = { ... }

Properties

Name Type Description
protocol string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#protocol Firewall#protocol}.
portRange string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#port_range Firewall#port_range}.
sourceAddresses string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#source_addresses Firewall#source_addresses}.
sourceDropletIds number[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#source_droplet_ids Firewall#source_droplet_ids}.
sourceKubernetesIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#source_kubernetes_ids Firewall#source_kubernetes_ids}.
sourceLoadBalancerUids string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#source_load_balancer_uids Firewall#source_load_balancer_uids}.
sourceTags string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#source_tags Firewall#source_tags}.
protocolRequired 
public readonly protocol: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#protocol Firewall#protocol}.

portRangeOptional 
public readonly portRange: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#port_range Firewall#port_range}.

sourceAddressesOptional 
public readonly sourceAddresses: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#source_addresses Firewall#source_addresses}.

sourceDropletIdsOptional 
public readonly sourceDropletIds: number[];
  • Type: number[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#source_droplet_ids Firewall#source_droplet_ids}.

sourceKubernetesIdsOptional 
public readonly sourceKubernetesIds: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#source_kubernetes_ids Firewall#source_kubernetes_ids}.

sourceLoadBalancerUidsOptional 
public readonly sourceLoadBalancerUids: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#source_load_balancer_uids Firewall#source_load_balancer_uids}.

sourceTagsOptional 
public readonly sourceTags: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#source_tags Firewall#source_tags}.

FirewallOutboundRule

Initializer 

import { firewall } from '@cdktf/provider-digitalocean'

const firewallOutboundRule: firewall.FirewallOutboundRule = { ... }

Properties

Name Type Description
protocol string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#protocol Firewall#protocol}.
destinationAddresses string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#destination_addresses Firewall#destination_addresses}.
destinationDropletIds number[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#destination_droplet_ids Firewall#destination_droplet_ids}.
destinationKubernetesIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#destination_kubernetes_ids Firewall#destination_kubernetes_ids}.
destinationLoadBalancerUids string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#destination_load_balancer_uids Firewall#destination_load_balancer_uids}.
destinationTags string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#destination_tags Firewall#destination_tags}.
portRange string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#port_range Firewall#port_range}.
protocolRequired 
public readonly protocol: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#protocol Firewall#protocol}.

destinationAddressesOptional 
public readonly destinationAddresses: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#destination_addresses Firewall#destination_addresses}.

destinationDropletIdsOptional 
public readonly destinationDropletIds: number[];
  • Type: number[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#destination_droplet_ids Firewall#destination_droplet_ids}.

destinationKubernetesIdsOptional 
public readonly destinationKubernetesIds: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#destination_kubernetes_ids Firewall#destination_kubernetes_ids}.

destinationLoadBalancerUidsOptional 
public readonly destinationLoadBalancerUids: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#destination_load_balancer_uids Firewall#destination_load_balancer_uids}.

destinationTagsOptional 
public readonly destinationTags: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#destination_tags Firewall#destination_tags}.

portRangeOptional 
public readonly portRange: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/firewall#port_range Firewall#port_range}.

FirewallPendingChanges

Initializer 

import { firewall } from '@cdktf/provider-digitalocean'

const firewallPendingChanges: firewall.FirewallPendingChanges = { ... }

Classes

FirewallInboundRuleList

Initializers 

import { firewall } from '@cdktf/provider-digitalocean'

new firewall.FirewallInboundRuleList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
wrapsSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.
allWithMapKey 
public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: string
computeFqn 
public computeFqn(): string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
public get(index: number): FirewallInboundRuleOutputReference
indexRequired
  • Type: number

the index of the item to return.

Properties

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

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

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

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

FirewallInboundRuleOutputReference

Initializers 

import { firewall } from '@cdktf/provider-digitalocean'

new firewall.FirewallInboundRuleOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
complexObjectIndex number the index of this item in the list.
complexObjectIsFromSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetPortRange No description.
resetSourceAddresses No description.
resetSourceDropletIds No description.
resetSourceKubernetesIds No description.
resetSourceLoadBalancerUids No description.
resetSourceTags 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.

resetPortRange 
public resetPortRange(): void
resetSourceAddresses 
public resetSourceAddresses(): void
resetSourceDropletIds 
public resetSourceDropletIds(): void
resetSourceKubernetesIds 
public resetSourceKubernetesIds(): void
resetSourceLoadBalancerUids 
public resetSourceLoadBalancerUids(): void
resetSourceTags 
public resetSourceTags(): 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.
portRangeInput string No description.
protocolInput string No description.
sourceAddressesInput string[] No description.
sourceDropletIdsInput number[] No description.
sourceKubernetesIdsInput string[] No description.
sourceLoadBalancerUidsInput string[] No description.
sourceTagsInput string[] No description.
portRange string No description.
protocol string No description.
sourceAddresses string[] No description.
sourceDropletIds number[] No description.
sourceKubernetesIds string[] No description.
sourceLoadBalancerUids string[] No description.
sourceTags string[] No description.
internalValue cdktf.IResolvable | FirewallInboundRule 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
portRangeInputOptional 
public readonly portRangeInput: string;
  • Type: string
protocolInputOptional 
public readonly protocolInput: string;
  • Type: string
sourceAddressesInputOptional 
public readonly sourceAddressesInput: string[];
  • Type: string[]
sourceDropletIdsInputOptional 
public readonly sourceDropletIdsInput: number[];
  • Type: number[]
sourceKubernetesIdsInputOptional 
public readonly sourceKubernetesIdsInput: string[];
  • Type: string[]
sourceLoadBalancerUidsInputOptional 
public readonly sourceLoadBalancerUidsInput: string[];
  • Type: string[]
sourceTagsInputOptional 
public readonly sourceTagsInput: string[];
  • Type: string[]
portRangeRequired 
public readonly portRange: string;
  • Type: string
protocolRequired 
public readonly protocol: string;
  • Type: string
sourceAddressesRequired 
public readonly sourceAddresses: string[];
  • Type: string[]
sourceDropletIdsRequired 
public readonly sourceDropletIds: number[];
  • Type: number[]
sourceKubernetesIdsRequired 
public readonly sourceKubernetesIds: string[];
  • Type: string[]
sourceLoadBalancerUidsRequired 
public readonly sourceLoadBalancerUids: string[];
  • Type: string[]
sourceTagsRequired 
public readonly sourceTags: string[];
  • Type: string[]
internalValueOptional 
public readonly internalValue: IResolvable | FirewallInboundRule;

FirewallOutboundRuleList

Initializers 

import { firewall } from '@cdktf/provider-digitalocean'

new firewall.FirewallOutboundRuleList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
wrapsSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.
allWithMapKey 
public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: string
computeFqn 
public computeFqn(): string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
public get(index: number): FirewallOutboundRuleOutputReference
indexRequired
  • Type: number

the index of the item to return.

Properties

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

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

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

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

FirewallOutboundRuleOutputReference

Initializers 

import { firewall } from '@cdktf/provider-digitalocean'

new firewall.FirewallOutboundRuleOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
complexObjectIndex number the index of this item in the list.
complexObjectIsFromSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetDestinationAddresses No description.
resetDestinationDropletIds No description.
resetDestinationKubernetesIds No description.
resetDestinationLoadBalancerUids No description.
resetDestinationTags No description.
resetPortRange 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.

resetDestinationAddresses 
public resetDestinationAddresses(): void
resetDestinationDropletIds 
public resetDestinationDropletIds(): void
resetDestinationKubernetesIds 
public resetDestinationKubernetesIds(): void
resetDestinationLoadBalancerUids 
public resetDestinationLoadBalancerUids(): void
resetDestinationTags 
public resetDestinationTags(): void
resetPortRange 
public resetPortRange(): 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.
destinationAddressesInput string[] No description.
destinationDropletIdsInput number[] No description.
destinationKubernetesIdsInput string[] No description.
destinationLoadBalancerUidsInput string[] No description.
destinationTagsInput string[] No description.
portRangeInput string No description.
protocolInput string No description.
destinationAddresses string[] No description.
destinationDropletIds number[] No description.
destinationKubernetesIds string[] No description.
destinationLoadBalancerUids string[] No description.
destinationTags string[] No description.
portRange string No description.
protocol string No description.
internalValue cdktf.IResolvable | FirewallOutboundRule 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
destinationAddressesInputOptional 
public readonly destinationAddressesInput: string[];
  • Type: string[]
destinationDropletIdsInputOptional 
public readonly destinationDropletIdsInput: number[];
  • Type: number[]
destinationKubernetesIdsInputOptional 
public readonly destinationKubernetesIdsInput: string[];
  • Type: string[]
destinationLoadBalancerUidsInputOptional 
public readonly destinationLoadBalancerUidsInput: string[];
  • Type: string[]
destinationTagsInputOptional 
public readonly destinationTagsInput: string[];
  • Type: string[]
portRangeInputOptional 
public readonly portRangeInput: string;
  • Type: string
protocolInputOptional 
public readonly protocolInput: string;
  • Type: string
destinationAddressesRequired 
public readonly destinationAddresses: string[];
  • Type: string[]
destinationDropletIdsRequired 
public readonly destinationDropletIds: number[];
  • Type: number[]
destinationKubernetesIdsRequired 
public readonly destinationKubernetesIds: string[];
  • Type: string[]
destinationLoadBalancerUidsRequired 
public readonly destinationLoadBalancerUids: string[];
  • Type: string[]
destinationTagsRequired 
public readonly destinationTags: string[];
  • Type: string[]
portRangeRequired 
public readonly portRange: string;
  • Type: string
protocolRequired 
public readonly protocol: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | FirewallOutboundRule;

FirewallPendingChangesList

Initializers 

import { firewall } from '@cdktf/provider-digitalocean'

new firewall.FirewallPendingChangesList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
wrapsSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.
allWithMapKey 
public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: string
computeFqn 
public computeFqn(): string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
public get(index: number): FirewallPendingChangesOutputReference
indexRequired
  • Type: number

the index of the item to return.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
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

FirewallPendingChangesOutputReference

Initializers 

import { firewall } from '@cdktf/provider-digitalocean'

new firewall.FirewallPendingChangesOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
complexObjectIndex number the index of this item in the list.
complexObjectIsFromSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
dropletId number No description.
removing cdktf.IResolvable No description.
status string No description.
internalValue FirewallPendingChanges 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
dropletIdRequired 
public readonly dropletId: number;
  • Type: number
removingRequired 
public readonly removing: IResolvable;
  • Type: cdktf.IResolvable
statusRequired 
public readonly status: string;
  • Type: string
internalValueOptional 
public readonly internalValue: FirewallPendingChanges;