databaseRedisConfig.typescript.md

databaseRedisConfig Submodule

Constructs

DatabaseRedisConfig

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

Initializers

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

new databaseRedisConfig.DatabaseRedisConfig(scope: Construct, id: string, config: DatabaseRedisConfigConfig)

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

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: DatabaseRedisConfigConfig

---

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".
resetAclChannelsDefault	No description.
resetId	No description.
resetIoThreads	No description.
resetLfuDecayTime	No description.
resetLfuLogFactor	No description.
resetMaxmemoryPolicy	No description.
resetNotifyKeyspaceEvents	No description.
resetNumberOfDatabases	No description.
resetPersistence	No description.
resetPubsubClientOutputBufferLimit	No description.
resetSsl	No description.
resetTimeout	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

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

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

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

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

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

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

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

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

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

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

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

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

id^Required

• Type: string

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

---

moveTo

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

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

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

---

index^Optional

• Type: string | number

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

---

moveToId

public moveToId(id: string): void

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

id^Required

• Type: string

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

---

resetAclChannelsDefault

public resetAclChannelsDefault(): void

resetId

public resetId(): void

resetIoThreads

public resetIoThreads(): void

resetLfuDecayTime

public resetLfuDecayTime(): void

resetLfuLogFactor

public resetLfuLogFactor(): void

resetMaxmemoryPolicy

public resetMaxmemoryPolicy(): void

resetNotifyKeyspaceEvents

public resetNotifyKeyspaceEvents(): void

resetNumberOfDatabases

public resetNumberOfDatabases(): void

resetPersistence

public resetPersistence(): void

resetPubsubClientOutputBufferLimit

public resetPubsubClientOutputBufferLimit(): void

resetSsl

public resetSsl(): void

resetTimeout

public resetTimeout(): 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 DatabaseRedisConfig resource upon running "cdktf plan ".

---

isConstruct

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

databaseRedisConfig.DatabaseRedisConfig.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

isTerraformElement

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

databaseRedisConfig.DatabaseRedisConfig.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

databaseRedisConfig.DatabaseRedisConfig.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

databaseRedisConfig.DatabaseRedisConfig.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

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

---

importFromId^Required

• Type: string

The id of the existing DatabaseRedisConfig that should be imported.

Refer to the {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the DatabaseRedisConfig 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.
aclChannelsDefaultInput	string	No description.
clusterIdInput	string	No description.
idInput	string	No description.
ioThreadsInput	number	No description.
lfuDecayTimeInput	number	No description.
lfuLogFactorInput	number	No description.
maxmemoryPolicyInput	string	No description.
notifyKeyspaceEventsInput	string	No description.
numberOfDatabasesInput	number	No description.
persistenceInput	string	No description.
pubsubClientOutputBufferLimitInput	number	No description.
sslInput	boolean | cdktf.IResolvable	No description.
timeoutInput	number	No description.
aclChannelsDefault	string	No description.
clusterId	string	No description.
id	string	No description.
ioThreads	number	No description.
lfuDecayTime	number	No description.
lfuLogFactor	number	No description.
maxmemoryPolicy	string	No description.
notifyKeyspaceEvents	string	No description.
numberOfDatabases	number	No description.
persistence	string	No description.
pubsubClientOutputBufferLimit	number	No description.
ssl	boolean | cdktf.IResolvable	No description.
timeout	number	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

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

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

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

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

---

aclChannelsDefaultInput^Optional

public readonly aclChannelsDefaultInput: string;

• Type: string

---

clusterIdInput^Optional

public readonly clusterIdInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

ioThreadsInput^Optional

public readonly ioThreadsInput: number;

• Type: number

---

lfuDecayTimeInput^Optional

public readonly lfuDecayTimeInput: number;

• Type: number

---

lfuLogFactorInput^Optional

public readonly lfuLogFactorInput: number;

• Type: number

---

maxmemoryPolicyInput^Optional

public readonly maxmemoryPolicyInput: string;

• Type: string

---

notifyKeyspaceEventsInput^Optional

public readonly notifyKeyspaceEventsInput: string;

• Type: string

---

numberOfDatabasesInput^Optional

public readonly numberOfDatabasesInput: number;

• Type: number

---

persistenceInput^Optional

public readonly persistenceInput: string;

• Type: string

---

pubsubClientOutputBufferLimitInput^Optional

public readonly pubsubClientOutputBufferLimitInput: number;

• Type: number

---

sslInput^Optional

public readonly sslInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

timeoutInput^Optional

public readonly timeoutInput: number;

• Type: number

---

aclChannelsDefault^Required

public readonly aclChannelsDefault: string;

• Type: string

---

clusterId^Required

public readonly clusterId: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

ioThreads^Required

public readonly ioThreads: number;

• Type: number

---

lfuDecayTime^Required

public readonly lfuDecayTime: number;

• Type: number

---

lfuLogFactor^Required

public readonly lfuLogFactor: number;

• Type: number

---

maxmemoryPolicy^Required

public readonly maxmemoryPolicy: string;

• Type: string

---

notifyKeyspaceEvents^Required

public readonly notifyKeyspaceEvents: string;

• Type: string

---

numberOfDatabases^Required

public readonly numberOfDatabases: number;

• Type: number

---

persistence^Required

public readonly persistence: string;

• Type: string

---

pubsubClientOutputBufferLimit^Required

public readonly pubsubClientOutputBufferLimit: number;

• Type: number

---

ssl^Required

public readonly ssl: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

timeout^Required

public readonly timeout: number;

• Type: number

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DatabaseRedisConfigConfig

Initializer

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

const databaseRedisConfigConfig: databaseRedisConfig.DatabaseRedisConfigConfig = { ... }

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.
clusterId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#cluster_id DatabaseRedisConfig#cluster_id}.
aclChannelsDefault	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#acl_channels_default DatabaseRedisConfig#acl_channels_default}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#id DatabaseRedisConfig#id}.
ioThreads	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#io_threads DatabaseRedisConfig#io_threads}.
lfuDecayTime	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#lfu_decay_time DatabaseRedisConfig#lfu_decay_time}.
lfuLogFactor	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#lfu_log_factor DatabaseRedisConfig#lfu_log_factor}.
maxmemoryPolicy	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#maxmemory_policy DatabaseRedisConfig#maxmemory_policy}.
notifyKeyspaceEvents	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#notify_keyspace_events DatabaseRedisConfig#notify_keyspace_events}.
numberOfDatabases	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#number_of_databases DatabaseRedisConfig#number_of_databases}.
persistence	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#persistence DatabaseRedisConfig#persistence}.
pubsubClientOutputBufferLimit	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#pubsub_client_output_buffer_limit DatabaseRedisConfig#pubsub_client_output_buffer_limit}.
ssl	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#ssl DatabaseRedisConfig#ssl}.
timeout	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#timeout DatabaseRedisConfig#timeout}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

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

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

---

clusterId^Required

public readonly clusterId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#cluster_id DatabaseRedisConfig#cluster_id}.

---

aclChannelsDefault^Optional

public readonly aclChannelsDefault: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#acl_channels_default DatabaseRedisConfig#acl_channels_default}.

---

id^Optional

public readonly id: string;

• Type: string

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

---

ioThreads^Optional

public readonly ioThreads: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#io_threads DatabaseRedisConfig#io_threads}.

---

lfuDecayTime^Optional

public readonly lfuDecayTime: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#lfu_decay_time DatabaseRedisConfig#lfu_decay_time}.

---

lfuLogFactor^Optional

public readonly lfuLogFactor: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#lfu_log_factor DatabaseRedisConfig#lfu_log_factor}.

---

maxmemoryPolicy^Optional

public readonly maxmemoryPolicy: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#maxmemory_policy DatabaseRedisConfig#maxmemory_policy}.

---

notifyKeyspaceEvents^Optional

public readonly notifyKeyspaceEvents: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#notify_keyspace_events DatabaseRedisConfig#notify_keyspace_events}.

---

numberOfDatabases^Optional

public readonly numberOfDatabases: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#number_of_databases DatabaseRedisConfig#number_of_databases}.

---

persistence^Optional

public readonly persistence: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#persistence DatabaseRedisConfig#persistence}.

---

pubsubClientOutputBufferLimit^Optional

public readonly pubsubClientOutputBufferLimit: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#pubsub_client_output_buffer_limit DatabaseRedisConfig#pubsub_client_output_buffer_limit}.

---

ssl^Optional

public readonly ssl: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#ssl DatabaseRedisConfig#ssl}.

---

timeout^Optional

public readonly timeout: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_redis_config#timeout DatabaseRedisConfig#timeout}.

---