Skip to content

Latest commit

 

History

History
2881 lines (1772 loc) · 145 KB

dataDigitaloceanFirewall.typescript.md

File metadata and controls

2881 lines (1772 loc) · 145 KB
Raw

dataDigitaloceanFirewall Submodule

Constructs

DataDigitaloceanFirewall

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

Initializers 

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

new dataDigitaloceanFirewall.DataDigitaloceanFirewall(scope: Construct, id: string, config: DataDigitaloceanFirewallConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DataDigitaloceanFirewallConfig 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 Adds this resource to the terraform JSON output.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
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.
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

Adds this resource to the terraform JSON output.

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

Adds this resource to the terraform JSON output.

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(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
putInboundRule 
public putInboundRule(value: IResolvable | DataDigitaloceanFirewallInboundRule[]): void
valueRequired
putOutboundRule 
public putOutboundRule(value: IResolvable | DataDigitaloceanFirewallOutboundRule[]): 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.
isTerraformDataSource No description.
generateConfigForImport Generates CDKTF code for importing a DataDigitaloceanFirewall resource upon running "cdktf plan ".
isConstruct 
import { dataDigitaloceanFirewall } from '@cdktf/provider-digitalocean'

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

dataDigitaloceanFirewall.DataDigitaloceanFirewall.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformDataSource 
import { dataDigitaloceanFirewall } from '@cdktf/provider-digitalocean'

dataDigitaloceanFirewall.DataDigitaloceanFirewall.isTerraformDataSource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { dataDigitaloceanFirewall } from '@cdktf/provider-digitalocean'

dataDigitaloceanFirewall.DataDigitaloceanFirewall.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

importFromIdRequired
  • Type: string

The id of the existing DataDigitaloceanFirewall that should be imported.

Refer to the {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/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 DataDigitaloceanFirewall 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.
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.
createdAt string No description.
inboundRule DataDigitaloceanFirewallInboundRuleList No description.
name string No description.
outboundRule DataDigitaloceanFirewallOutboundRuleList No description.
pendingChanges DataDigitaloceanFirewallPendingChangesList No description.
status string No description.
dropletIdsInput number[] No description.
firewallIdInput string No description.
idInput string No description.
inboundRuleInput cdktf.IResolvable | DataDigitaloceanFirewallInboundRule[] No description.
outboundRuleInput cdktf.IResolvable | DataDigitaloceanFirewallOutboundRule[] No description.
tagsInput string[] No description.
dropletIds number[] No description.
firewallId string No description.
id 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
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
createdAtRequired 
public readonly createdAt: string;
  • Type: string
inboundRuleRequired 
public readonly inboundRule: DataDigitaloceanFirewallInboundRuleList;
nameRequired 
public readonly name: string;
  • Type: string
outboundRuleRequired 
public readonly outboundRule: DataDigitaloceanFirewallOutboundRuleList;
pendingChangesRequired 
public readonly pendingChanges: DataDigitaloceanFirewallPendingChangesList;
statusRequired 
public readonly status: string;
  • Type: string
dropletIdsInputOptional 
public readonly dropletIdsInput: number[];
  • Type: number[]
firewallIdInputOptional 
public readonly firewallIdInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
inboundRuleInputOptional 
public readonly inboundRuleInput: IResolvable | DataDigitaloceanFirewallInboundRule[];
outboundRuleInputOptional 
public readonly outboundRuleInput: IResolvable | DataDigitaloceanFirewallOutboundRule[];
tagsInputOptional 
public readonly tagsInput: string[];
  • Type: string[]
dropletIdsRequired 
public readonly dropletIds: number[];
  • Type: number[]
firewallIdRequired 
public readonly firewallId: string;
  • Type: string
idRequired 
public readonly id: 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

DataDigitaloceanFirewallConfig

Initializer 

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

const dataDigitaloceanFirewallConfig: dataDigitaloceanFirewall.DataDigitaloceanFirewallConfig = { ... }

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.
firewallId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#firewall_id DataDigitaloceanFirewall#firewall_id}.
dropletIds number[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#droplet_ids DataDigitaloceanFirewall#droplet_ids}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#id DataDigitaloceanFirewall#id}.
inboundRule cdktf.IResolvable | DataDigitaloceanFirewallInboundRule[] inbound_rule block.
outboundRule cdktf.IResolvable | DataDigitaloceanFirewallOutboundRule[] outbound_rule block.
tags string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#tags DataDigitaloceanFirewall#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[]
firewallIdRequired 
public readonly firewallId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#firewall_id DataDigitaloceanFirewall#firewall_id}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#droplet_ids DataDigitaloceanFirewall#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/data-sources/firewall#id DataDigitaloceanFirewall#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 | DataDigitaloceanFirewallInboundRule[];

inbound_rule block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#inbound_rule DataDigitaloceanFirewall#inbound_rule}

outboundRuleOptional 
public readonly outboundRule: IResolvable | DataDigitaloceanFirewallOutboundRule[];

outbound_rule block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#outbound_rule DataDigitaloceanFirewall#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/data-sources/firewall#tags DataDigitaloceanFirewall#tags}.

DataDigitaloceanFirewallInboundRule

Initializer 

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

const dataDigitaloceanFirewallInboundRule: dataDigitaloceanFirewall.DataDigitaloceanFirewallInboundRule = { ... }

Properties

Name Type Description
protocol string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#protocol DataDigitaloceanFirewall#protocol}.
portRange string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#port_range DataDigitaloceanFirewall#port_range}.
sourceAddresses string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#source_addresses DataDigitaloceanFirewall#source_addresses}.
sourceDropletIds number[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#source_droplet_ids DataDigitaloceanFirewall#source_droplet_ids}.
sourceKubernetesIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#source_kubernetes_ids DataDigitaloceanFirewall#source_kubernetes_ids}.
sourceLoadBalancerUids string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#source_load_balancer_uids DataDigitaloceanFirewall#source_load_balancer_uids}.
sourceTags string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#source_tags DataDigitaloceanFirewall#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/data-sources/firewall#protocol DataDigitaloceanFirewall#protocol}.

portRangeOptional 
public readonly portRange: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#port_range DataDigitaloceanFirewall#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/data-sources/firewall#source_addresses DataDigitaloceanFirewall#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/data-sources/firewall#source_droplet_ids DataDigitaloceanFirewall#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/data-sources/firewall#source_kubernetes_ids DataDigitaloceanFirewall#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/data-sources/firewall#source_load_balancer_uids DataDigitaloceanFirewall#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/data-sources/firewall#source_tags DataDigitaloceanFirewall#source_tags}.

DataDigitaloceanFirewallOutboundRule

Initializer 

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

const dataDigitaloceanFirewallOutboundRule: dataDigitaloceanFirewall.DataDigitaloceanFirewallOutboundRule = { ... }

Properties

Name Type Description
protocol string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#protocol DataDigitaloceanFirewall#protocol}.
destinationAddresses string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#destination_addresses DataDigitaloceanFirewall#destination_addresses}.
destinationDropletIds number[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#destination_droplet_ids DataDigitaloceanFirewall#destination_droplet_ids}.
destinationKubernetesIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#destination_kubernetes_ids DataDigitaloceanFirewall#destination_kubernetes_ids}.
destinationLoadBalancerUids string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#destination_load_balancer_uids DataDigitaloceanFirewall#destination_load_balancer_uids}.
destinationTags string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#destination_tags DataDigitaloceanFirewall#destination_tags}.
portRange string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#port_range DataDigitaloceanFirewall#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/data-sources/firewall#protocol DataDigitaloceanFirewall#protocol}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/firewall#destination_addresses DataDigitaloceanFirewall#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/data-sources/firewall#destination_droplet_ids DataDigitaloceanFirewall#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/data-sources/firewall#destination_kubernetes_ids DataDigitaloceanFirewall#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/data-sources/firewall#destination_load_balancer_uids DataDigitaloceanFirewall#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/data-sources/firewall#destination_tags DataDigitaloceanFirewall#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/data-sources/firewall#port_range DataDigitaloceanFirewall#port_range}.

DataDigitaloceanFirewallPendingChanges

Initializer 

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

const dataDigitaloceanFirewallPendingChanges: dataDigitaloceanFirewall.DataDigitaloceanFirewallPendingChanges = { ... }

Classes

DataDigitaloceanFirewallInboundRuleList

Initializers 

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

new dataDigitaloceanFirewall.DataDigitaloceanFirewallInboundRuleList(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): DataDigitaloceanFirewallInboundRuleOutputReference
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 | DataDigitaloceanFirewallInboundRule[] 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 | DataDigitaloceanFirewallInboundRule[];

DataDigitaloceanFirewallInboundRuleOutputReference

Initializers 

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

new dataDigitaloceanFirewall.DataDigitaloceanFirewallInboundRuleOutputReference(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 | DataDigitaloceanFirewallInboundRule 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 | DataDigitaloceanFirewallInboundRule;

DataDigitaloceanFirewallOutboundRuleList

Initializers 

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

new dataDigitaloceanFirewall.DataDigitaloceanFirewallOutboundRuleList(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): DataDigitaloceanFirewallOutboundRuleOutputReference
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 | DataDigitaloceanFirewallOutboundRule[] 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 | DataDigitaloceanFirewallOutboundRule[];

DataDigitaloceanFirewallOutboundRuleOutputReference

Initializers 

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

new dataDigitaloceanFirewall.DataDigitaloceanFirewallOutboundRuleOutputReference(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 | DataDigitaloceanFirewallOutboundRule 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 | DataDigitaloceanFirewallOutboundRule;

DataDigitaloceanFirewallPendingChangesList

Initializers 

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

new dataDigitaloceanFirewall.DataDigitaloceanFirewallPendingChangesList(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): DataDigitaloceanFirewallPendingChangesOutputReference
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

DataDigitaloceanFirewallPendingChangesOutputReference

Initializers 

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

new dataDigitaloceanFirewall.DataDigitaloceanFirewallPendingChangesOutputReference(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 DataDigitaloceanFirewallPendingChanges 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: DataDigitaloceanFirewallPendingChanges;