1. Packages
  2. DigitalOcean Provider
  3. API Docs
  4. DatabaseValkeyConfig
DigitalOcean v4.51.0 published on Thursday, Aug 14, 2025 by Pulumi

digitalocean.DatabaseValkeyConfig

Explore with Pulumi AI

digitalocean logo
DigitalOcean v4.51.0 published on Thursday, Aug 14, 2025 by Pulumi

    Provides a virtual resource that can be used to change advanced configuration options for a DigitalOcean managed Valkey database cluster.

    Note Valkey configurations are only removed from state when destroyed. The remote configuration is not unset.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as digitalocean from "@pulumi/digitalocean";
    
    const exampleDatabaseCluster = new digitalocean.DatabaseCluster("example", {
        name: "example-valkey-cluster",
        engine: "valkey",
        version: "8",
        size: digitalocean.DatabaseSlug.DB_1VPCU1GB,
        region: digitalocean.Region.NYC1,
        nodeCount: 1,
    });
    const example = new digitalocean.DatabaseValkeyConfig("example", {
        clusterId: exampleDatabaseCluster.id,
        notifyKeyspaceEvents: "KEA",
        timeout: 90,
    });
    
    import pulumi
    import pulumi_digitalocean as digitalocean
    
    example_database_cluster = digitalocean.DatabaseCluster("example",
        name="example-valkey-cluster",
        engine="valkey",
        version="8",
        size=digitalocean.DatabaseSlug.D_B_1_VPCU1_GB,
        region=digitalocean.Region.NYC1,
        node_count=1)
    example = digitalocean.DatabaseValkeyConfig("example",
        cluster_id=example_database_cluster.id,
        notify_keyspace_events="KEA",
        timeout=90)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleDatabaseCluster, err := digitalocean.NewDatabaseCluster(ctx, "example", &digitalocean.DatabaseClusterArgs{
    			Name:      pulumi.String("example-valkey-cluster"),
    			Engine:    pulumi.String("valkey"),
    			Version:   pulumi.String("8"),
    			Size:      pulumi.String(digitalocean.DatabaseSlug_DB_1VPCU1GB),
    			Region:    pulumi.String(digitalocean.RegionNYC1),
    			NodeCount: pulumi.Int(1),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = digitalocean.NewDatabaseValkeyConfig(ctx, "example", &digitalocean.DatabaseValkeyConfigArgs{
    			ClusterId:            exampleDatabaseCluster.ID(),
    			NotifyKeyspaceEvents: pulumi.String("KEA"),
    			Timeout:              pulumi.Int(90),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using DigitalOcean = Pulumi.DigitalOcean;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleDatabaseCluster = new DigitalOcean.DatabaseCluster("example", new()
        {
            Name = "example-valkey-cluster",
            Engine = "valkey",
            Version = "8",
            Size = DigitalOcean.DatabaseSlug.DB_1VPCU1GB,
            Region = DigitalOcean.Region.NYC1,
            NodeCount = 1,
        });
    
        var example = new DigitalOcean.DatabaseValkeyConfig("example", new()
        {
            ClusterId = exampleDatabaseCluster.Id,
            NotifyKeyspaceEvents = "KEA",
            Timeout = 90,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.digitalocean.DatabaseCluster;
    import com.pulumi.digitalocean.DatabaseClusterArgs;
    import com.pulumi.digitalocean.DatabaseValkeyConfig;
    import com.pulumi.digitalocean.DatabaseValkeyConfigArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var exampleDatabaseCluster = new DatabaseCluster("exampleDatabaseCluster", DatabaseClusterArgs.builder()
                .name("example-valkey-cluster")
                .engine("valkey")
                .version("8")
                .size("db-s-1vcpu-1gb")
                .region("nyc1")
                .nodeCount(1)
                .build());
    
            var example = new DatabaseValkeyConfig("example", DatabaseValkeyConfigArgs.builder()
                .clusterId(exampleDatabaseCluster.id())
                .notifyKeyspaceEvents("KEA")
                .timeout(90)
                .build());
    
        }
    }
    
    resources:
      example:
        type: digitalocean:DatabaseValkeyConfig
        properties:
          clusterId: ${exampleDatabaseCluster.id}
          notifyKeyspaceEvents: KEA
          timeout: 90
      exampleDatabaseCluster:
        type: digitalocean:DatabaseCluster
        name: example
        properties:
          name: example-valkey-cluster
          engine: valkey
          version: '8'
          size: db-s-1vcpu-1gb
          region: nyc1
          nodeCount: 1
    

    Create DatabaseValkeyConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DatabaseValkeyConfig(name: string, args: DatabaseValkeyConfigArgs, opts?: CustomResourceOptions);
    @overload
    def DatabaseValkeyConfig(resource_name: str,
                             args: DatabaseValkeyConfigArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def DatabaseValkeyConfig(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             cluster_id: Optional[str] = None,
                             notify_keyspace_events: Optional[str] = None,
                             frequent_snapshots: Optional[bool] = None,
                             io_threads: Optional[int] = None,
                             lfu_decay_time: Optional[int] = None,
                             lfu_log_factor: Optional[int] = None,
                             acl_channels_default: Optional[str] = None,
                             number_of_databases: Optional[int] = None,
                             persistence: Optional[str] = None,
                             pubsub_client_output_buffer_limit: Optional[int] = None,
                             ssl: Optional[bool] = None,
                             timeout: Optional[int] = None,
                             valkey_active_expire_effort: Optional[int] = None)
    func NewDatabaseValkeyConfig(ctx *Context, name string, args DatabaseValkeyConfigArgs, opts ...ResourceOption) (*DatabaseValkeyConfig, error)
    public DatabaseValkeyConfig(string name, DatabaseValkeyConfigArgs args, CustomResourceOptions? opts = null)
    public DatabaseValkeyConfig(String name, DatabaseValkeyConfigArgs args)
    public DatabaseValkeyConfig(String name, DatabaseValkeyConfigArgs args, CustomResourceOptions options)
    
    type: digitalocean:DatabaseValkeyConfig
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DatabaseValkeyConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DatabaseValkeyConfigArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DatabaseValkeyConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseValkeyConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseValkeyConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var databaseValkeyConfigResource = new DigitalOcean.DatabaseValkeyConfig("databaseValkeyConfigResource", new()
    {
        ClusterId = "string",
        NotifyKeyspaceEvents = "string",
        FrequentSnapshots = false,
        IoThreads = 0,
        LfuDecayTime = 0,
        LfuLogFactor = 0,
        AclChannelsDefault = "string",
        NumberOfDatabases = 0,
        Persistence = "string",
        PubsubClientOutputBufferLimit = 0,
        Ssl = false,
        Timeout = 0,
        ValkeyActiveExpireEffort = 0,
    });
    
    example, err := digitalocean.NewDatabaseValkeyConfig(ctx, "databaseValkeyConfigResource", &digitalocean.DatabaseValkeyConfigArgs{
    	ClusterId:                     pulumi.String("string"),
    	NotifyKeyspaceEvents:          pulumi.String("string"),
    	FrequentSnapshots:             pulumi.Bool(false),
    	IoThreads:                     pulumi.Int(0),
    	LfuDecayTime:                  pulumi.Int(0),
    	LfuLogFactor:                  pulumi.Int(0),
    	AclChannelsDefault:            pulumi.String("string"),
    	NumberOfDatabases:             pulumi.Int(0),
    	Persistence:                   pulumi.String("string"),
    	PubsubClientOutputBufferLimit: pulumi.Int(0),
    	Ssl:                           pulumi.Bool(false),
    	Timeout:                       pulumi.Int(0),
    	ValkeyActiveExpireEffort:      pulumi.Int(0),
    })
    
    var databaseValkeyConfigResource = new DatabaseValkeyConfig("databaseValkeyConfigResource", DatabaseValkeyConfigArgs.builder()
        .clusterId("string")
        .notifyKeyspaceEvents("string")
        .frequentSnapshots(false)
        .ioThreads(0)
        .lfuDecayTime(0)
        .lfuLogFactor(0)
        .aclChannelsDefault("string")
        .numberOfDatabases(0)
        .persistence("string")
        .pubsubClientOutputBufferLimit(0)
        .ssl(false)
        .timeout(0)
        .valkeyActiveExpireEffort(0)
        .build());
    
    database_valkey_config_resource = digitalocean.DatabaseValkeyConfig("databaseValkeyConfigResource",
        cluster_id="string",
        notify_keyspace_events="string",
        frequent_snapshots=False,
        io_threads=0,
        lfu_decay_time=0,
        lfu_log_factor=0,
        acl_channels_default="string",
        number_of_databases=0,
        persistence="string",
        pubsub_client_output_buffer_limit=0,
        ssl=False,
        timeout=0,
        valkey_active_expire_effort=0)
    
    const databaseValkeyConfigResource = new digitalocean.DatabaseValkeyConfig("databaseValkeyConfigResource", {
        clusterId: "string",
        notifyKeyspaceEvents: "string",
        frequentSnapshots: false,
        ioThreads: 0,
        lfuDecayTime: 0,
        lfuLogFactor: 0,
        aclChannelsDefault: "string",
        numberOfDatabases: 0,
        persistence: "string",
        pubsubClientOutputBufferLimit: 0,
        ssl: false,
        timeout: 0,
        valkeyActiveExpireEffort: 0,
    });
    
    type: digitalocean:DatabaseValkeyConfig
    properties:
        aclChannelsDefault: string
        clusterId: string
        frequentSnapshots: false
        ioThreads: 0
        lfuDecayTime: 0
        lfuLogFactor: 0
        notifyKeyspaceEvents: string
        numberOfDatabases: 0
        persistence: string
        pubsubClientOutputBufferLimit: 0
        ssl: false
        timeout: 0
        valkeyActiveExpireEffort: 0
    

    DatabaseValkeyConfig Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DatabaseValkeyConfig resource accepts the following input properties:

    ClusterId string
    The ID of the target Valkey cluster.
    AclChannelsDefault string
    Determines default pub/sub channels' ACL for new users if an ACL is not supplied. When this option is not defined, allchannels is assumed to keep backward compatibility. This option doesn't affect Valkey' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    FrequentSnapshots bool
    Frequent RDB snapshots. When enabled, Valkey will create frequent local RDB snapshots. When disabled, Valkey will only take RDB snapshots when a backup is created, based on the backup schedule. This setting is ignored when valkey_persistence is set to off.
    IoThreads int
    The Valkey IO thread count.
    LfuDecayTime int
    The LFU maxmemory policy counter decay time in minutes.
    LfuLogFactor int
    The counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory policies.
    NotifyKeyspaceEvents string
    The notify-keyspace-events option. Requires at least K or E.
    NumberOfDatabases int
    The number of Valkey databases. Changing this will cause a restart of Valkey service.
    Persistence string
    When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked.
    PubsubClientOutputBufferLimit int
    The output buffer limit for pub/sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.
    Ssl bool
    A boolean indicating whether to require SSL to access Valkey.
    Timeout int
    The Valkey idle connection timeout in seconds.
    ValkeyActiveExpireEffort int
    Active expire effort. Valkey reclaims expired keys both when accessed and in the background. The background process scans for expired keys to free memory. Increasing the active-expire-effort setting (default 1, max 10) uses more CPU to reclaim expired keys faster, reducing memory usage but potentially increasing latency.
    ClusterId string
    The ID of the target Valkey cluster.
    AclChannelsDefault string
    Determines default pub/sub channels' ACL for new users if an ACL is not supplied. When this option is not defined, allchannels is assumed to keep backward compatibility. This option doesn't affect Valkey' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    FrequentSnapshots bool
    Frequent RDB snapshots. When enabled, Valkey will create frequent local RDB snapshots. When disabled, Valkey will only take RDB snapshots when a backup is created, based on the backup schedule. This setting is ignored when valkey_persistence is set to off.
    IoThreads int
    The Valkey IO thread count.
    LfuDecayTime int
    The LFU maxmemory policy counter decay time in minutes.
    LfuLogFactor int
    The counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory policies.
    NotifyKeyspaceEvents string
    The notify-keyspace-events option. Requires at least K or E.
    NumberOfDatabases int
    The number of Valkey databases. Changing this will cause a restart of Valkey service.
    Persistence string
    When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked.
    PubsubClientOutputBufferLimit int
    The output buffer limit for pub/sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.
    Ssl bool
    A boolean indicating whether to require SSL to access Valkey.
    Timeout int
    The Valkey idle connection timeout in seconds.
    ValkeyActiveExpireEffort int
    Active expire effort. Valkey reclaims expired keys both when accessed and in the background. The background process scans for expired keys to free memory. Increasing the active-expire-effort setting (default 1, max 10) uses more CPU to reclaim expired keys faster, reducing memory usage but potentially increasing latency.
    clusterId String
    The ID of the target Valkey cluster.
    aclChannelsDefault String
    Determines default pub/sub channels' ACL for new users if an ACL is not supplied. When this option is not defined, allchannels is assumed to keep backward compatibility. This option doesn't affect Valkey' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    frequentSnapshots Boolean
    Frequent RDB snapshots. When enabled, Valkey will create frequent local RDB snapshots. When disabled, Valkey will only take RDB snapshots when a backup is created, based on the backup schedule. This setting is ignored when valkey_persistence is set to off.
    ioThreads Integer
    The Valkey IO thread count.
    lfuDecayTime Integer
    The LFU maxmemory policy counter decay time in minutes.
    lfuLogFactor Integer
    The counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory policies.
    notifyKeyspaceEvents String
    The notify-keyspace-events option. Requires at least K or E.
    numberOfDatabases Integer
    The number of Valkey databases. Changing this will cause a restart of Valkey service.
    persistence String
    When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked.
    pubsubClientOutputBufferLimit Integer
    The output buffer limit for pub/sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.
    ssl Boolean
    A boolean indicating whether to require SSL to access Valkey.
    timeout Integer
    The Valkey idle connection timeout in seconds.
    valkeyActiveExpireEffort Integer
    Active expire effort. Valkey reclaims expired keys both when accessed and in the background. The background process scans for expired keys to free memory. Increasing the active-expire-effort setting (default 1, max 10) uses more CPU to reclaim expired keys faster, reducing memory usage but potentially increasing latency.
    clusterId string
    The ID of the target Valkey cluster.
    aclChannelsDefault string
    Determines default pub/sub channels' ACL for new users if an ACL is not supplied. When this option is not defined, allchannels is assumed to keep backward compatibility. This option doesn't affect Valkey' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    frequentSnapshots boolean
    Frequent RDB snapshots. When enabled, Valkey will create frequent local RDB snapshots. When disabled, Valkey will only take RDB snapshots when a backup is created, based on the backup schedule. This setting is ignored when valkey_persistence is set to off.
    ioThreads number
    The Valkey IO thread count.
    lfuDecayTime number
    The LFU maxmemory policy counter decay time in minutes.
    lfuLogFactor number
    The counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory policies.
    notifyKeyspaceEvents string
    The notify-keyspace-events option. Requires at least K or E.
    numberOfDatabases number
    The number of Valkey databases. Changing this will cause a restart of Valkey service.
    persistence string
    When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked.
    pubsubClientOutputBufferLimit number
    The output buffer limit for pub/sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.
    ssl boolean
    A boolean indicating whether to require SSL to access Valkey.
    timeout number
    The Valkey idle connection timeout in seconds.
    valkeyActiveExpireEffort number
    Active expire effort. Valkey reclaims expired keys both when accessed and in the background. The background process scans for expired keys to free memory. Increasing the active-expire-effort setting (default 1, max 10) uses more CPU to reclaim expired keys faster, reducing memory usage but potentially increasing latency.
    cluster_id str
    The ID of the target Valkey cluster.
    acl_channels_default str
    Determines default pub/sub channels' ACL for new users if an ACL is not supplied. When this option is not defined, allchannels is assumed to keep backward compatibility. This option doesn't affect Valkey' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    frequent_snapshots bool
    Frequent RDB snapshots. When enabled, Valkey will create frequent local RDB snapshots. When disabled, Valkey will only take RDB snapshots when a backup is created, based on the backup schedule. This setting is ignored when valkey_persistence is set to off.
    io_threads int
    The Valkey IO thread count.
    lfu_decay_time int
    The LFU maxmemory policy counter decay time in minutes.
    lfu_log_factor int
    The counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory policies.
    notify_keyspace_events str
    The notify-keyspace-events option. Requires at least K or E.
    number_of_databases int
    The number of Valkey databases. Changing this will cause a restart of Valkey service.
    persistence str
    When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked.
    pubsub_client_output_buffer_limit int
    The output buffer limit for pub/sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.
    ssl bool
    A boolean indicating whether to require SSL to access Valkey.
    timeout int
    The Valkey idle connection timeout in seconds.
    valkey_active_expire_effort int
    Active expire effort. Valkey reclaims expired keys both when accessed and in the background. The background process scans for expired keys to free memory. Increasing the active-expire-effort setting (default 1, max 10) uses more CPU to reclaim expired keys faster, reducing memory usage but potentially increasing latency.
    clusterId String
    The ID of the target Valkey cluster.
    aclChannelsDefault String
    Determines default pub/sub channels' ACL for new users if an ACL is not supplied. When this option is not defined, allchannels is assumed to keep backward compatibility. This option doesn't affect Valkey' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    frequentSnapshots Boolean
    Frequent RDB snapshots. When enabled, Valkey will create frequent local RDB snapshots. When disabled, Valkey will only take RDB snapshots when a backup is created, based on the backup schedule. This setting is ignored when valkey_persistence is set to off.
    ioThreads Number
    The Valkey IO thread count.
    lfuDecayTime Number
    The LFU maxmemory policy counter decay time in minutes.
    lfuLogFactor Number
    The counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory policies.
    notifyKeyspaceEvents String
    The notify-keyspace-events option. Requires at least K or E.
    numberOfDatabases Number
    The number of Valkey databases. Changing this will cause a restart of Valkey service.
    persistence String
    When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked.
    pubsubClientOutputBufferLimit Number
    The output buffer limit for pub/sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.
    ssl Boolean
    A boolean indicating whether to require SSL to access Valkey.
    timeout Number
    The Valkey idle connection timeout in seconds.
    valkeyActiveExpireEffort Number
    Active expire effort. Valkey reclaims expired keys both when accessed and in the background. The background process scans for expired keys to free memory. Increasing the active-expire-effort setting (default 1, max 10) uses more CPU to reclaim expired keys faster, reducing memory usage but potentially increasing latency.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DatabaseValkeyConfig resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DatabaseValkeyConfig Resource

    Get an existing DatabaseValkeyConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DatabaseValkeyConfigState, opts?: CustomResourceOptions): DatabaseValkeyConfig
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            acl_channels_default: Optional[str] = None,
            cluster_id: Optional[str] = None,
            frequent_snapshots: Optional[bool] = None,
            io_threads: Optional[int] = None,
            lfu_decay_time: Optional[int] = None,
            lfu_log_factor: Optional[int] = None,
            notify_keyspace_events: Optional[str] = None,
            number_of_databases: Optional[int] = None,
            persistence: Optional[str] = None,
            pubsub_client_output_buffer_limit: Optional[int] = None,
            ssl: Optional[bool] = None,
            timeout: Optional[int] = None,
            valkey_active_expire_effort: Optional[int] = None) -> DatabaseValkeyConfig
    func GetDatabaseValkeyConfig(ctx *Context, name string, id IDInput, state *DatabaseValkeyConfigState, opts ...ResourceOption) (*DatabaseValkeyConfig, error)
    public static DatabaseValkeyConfig Get(string name, Input<string> id, DatabaseValkeyConfigState? state, CustomResourceOptions? opts = null)
    public static DatabaseValkeyConfig get(String name, Output<String> id, DatabaseValkeyConfigState state, CustomResourceOptions options)
    resources:  _:    type: digitalocean:DatabaseValkeyConfig    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AclChannelsDefault string
    Determines default pub/sub channels' ACL for new users if an ACL is not supplied. When this option is not defined, allchannels is assumed to keep backward compatibility. This option doesn't affect Valkey' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    ClusterId string
    The ID of the target Valkey cluster.
    FrequentSnapshots bool
    Frequent RDB snapshots. When enabled, Valkey will create frequent local RDB snapshots. When disabled, Valkey will only take RDB snapshots when a backup is created, based on the backup schedule. This setting is ignored when valkey_persistence is set to off.
    IoThreads int
    The Valkey IO thread count.
    LfuDecayTime int
    The LFU maxmemory policy counter decay time in minutes.
    LfuLogFactor int
    The counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory policies.
    NotifyKeyspaceEvents string
    The notify-keyspace-events option. Requires at least K or E.
    NumberOfDatabases int
    The number of Valkey databases. Changing this will cause a restart of Valkey service.
    Persistence string
    When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked.
    PubsubClientOutputBufferLimit int
    The output buffer limit for pub/sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.
    Ssl bool
    A boolean indicating whether to require SSL to access Valkey.
    Timeout int
    The Valkey idle connection timeout in seconds.
    ValkeyActiveExpireEffort int
    Active expire effort. Valkey reclaims expired keys both when accessed and in the background. The background process scans for expired keys to free memory. Increasing the active-expire-effort setting (default 1, max 10) uses more CPU to reclaim expired keys faster, reducing memory usage but potentially increasing latency.
    AclChannelsDefault string
    Determines default pub/sub channels' ACL for new users if an ACL is not supplied. When this option is not defined, allchannels is assumed to keep backward compatibility. This option doesn't affect Valkey' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    ClusterId string
    The ID of the target Valkey cluster.
    FrequentSnapshots bool
    Frequent RDB snapshots. When enabled, Valkey will create frequent local RDB snapshots. When disabled, Valkey will only take RDB snapshots when a backup is created, based on the backup schedule. This setting is ignored when valkey_persistence is set to off.
    IoThreads int
    The Valkey IO thread count.
    LfuDecayTime int
    The LFU maxmemory policy counter decay time in minutes.
    LfuLogFactor int
    The counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory policies.
    NotifyKeyspaceEvents string
    The notify-keyspace-events option. Requires at least K or E.
    NumberOfDatabases int
    The number of Valkey databases. Changing this will cause a restart of Valkey service.
    Persistence string
    When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked.
    PubsubClientOutputBufferLimit int
    The output buffer limit for pub/sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.
    Ssl bool
    A boolean indicating whether to require SSL to access Valkey.
    Timeout int
    The Valkey idle connection timeout in seconds.
    ValkeyActiveExpireEffort int
    Active expire effort. Valkey reclaims expired keys both when accessed and in the background. The background process scans for expired keys to free memory. Increasing the active-expire-effort setting (default 1, max 10) uses more CPU to reclaim expired keys faster, reducing memory usage but potentially increasing latency.
    aclChannelsDefault String
    Determines default pub/sub channels' ACL for new users if an ACL is not supplied. When this option is not defined, allchannels is assumed to keep backward compatibility. This option doesn't affect Valkey' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    clusterId String
    The ID of the target Valkey cluster.
    frequentSnapshots Boolean
    Frequent RDB snapshots. When enabled, Valkey will create frequent local RDB snapshots. When disabled, Valkey will only take RDB snapshots when a backup is created, based on the backup schedule. This setting is ignored when valkey_persistence is set to off.
    ioThreads Integer
    The Valkey IO thread count.
    lfuDecayTime Integer
    The LFU maxmemory policy counter decay time in minutes.
    lfuLogFactor Integer
    The counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory policies.
    notifyKeyspaceEvents String
    The notify-keyspace-events option. Requires at least K or E.
    numberOfDatabases Integer
    The number of Valkey databases. Changing this will cause a restart of Valkey service.
    persistence String
    When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked.
    pubsubClientOutputBufferLimit Integer
    The output buffer limit for pub/sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.
    ssl Boolean
    A boolean indicating whether to require SSL to access Valkey.
    timeout Integer
    The Valkey idle connection timeout in seconds.
    valkeyActiveExpireEffort Integer
    Active expire effort. Valkey reclaims expired keys both when accessed and in the background. The background process scans for expired keys to free memory. Increasing the active-expire-effort setting (default 1, max 10) uses more CPU to reclaim expired keys faster, reducing memory usage but potentially increasing latency.
    aclChannelsDefault string
    Determines default pub/sub channels' ACL for new users if an ACL is not supplied. When this option is not defined, allchannels is assumed to keep backward compatibility. This option doesn't affect Valkey' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    clusterId string
    The ID of the target Valkey cluster.
    frequentSnapshots boolean
    Frequent RDB snapshots. When enabled, Valkey will create frequent local RDB snapshots. When disabled, Valkey will only take RDB snapshots when a backup is created, based on the backup schedule. This setting is ignored when valkey_persistence is set to off.
    ioThreads number
    The Valkey IO thread count.
    lfuDecayTime number
    The LFU maxmemory policy counter decay time in minutes.
    lfuLogFactor number
    The counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory policies.
    notifyKeyspaceEvents string
    The notify-keyspace-events option. Requires at least K or E.
    numberOfDatabases number
    The number of Valkey databases. Changing this will cause a restart of Valkey service.
    persistence string
    When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked.
    pubsubClientOutputBufferLimit number
    The output buffer limit for pub/sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.
    ssl boolean
    A boolean indicating whether to require SSL to access Valkey.
    timeout number
    The Valkey idle connection timeout in seconds.
    valkeyActiveExpireEffort number
    Active expire effort. Valkey reclaims expired keys both when accessed and in the background. The background process scans for expired keys to free memory. Increasing the active-expire-effort setting (default 1, max 10) uses more CPU to reclaim expired keys faster, reducing memory usage but potentially increasing latency.
    acl_channels_default str
    Determines default pub/sub channels' ACL for new users if an ACL is not supplied. When this option is not defined, allchannels is assumed to keep backward compatibility. This option doesn't affect Valkey' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    cluster_id str
    The ID of the target Valkey cluster.
    frequent_snapshots bool
    Frequent RDB snapshots. When enabled, Valkey will create frequent local RDB snapshots. When disabled, Valkey will only take RDB snapshots when a backup is created, based on the backup schedule. This setting is ignored when valkey_persistence is set to off.
    io_threads int
    The Valkey IO thread count.
    lfu_decay_time int
    The LFU maxmemory policy counter decay time in minutes.
    lfu_log_factor int
    The counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory policies.
    notify_keyspace_events str
    The notify-keyspace-events option. Requires at least K or E.
    number_of_databases int
    The number of Valkey databases. Changing this will cause a restart of Valkey service.
    persistence str
    When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked.
    pubsub_client_output_buffer_limit int
    The output buffer limit for pub/sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.
    ssl bool
    A boolean indicating whether to require SSL to access Valkey.
    timeout int
    The Valkey idle connection timeout in seconds.
    valkey_active_expire_effort int
    Active expire effort. Valkey reclaims expired keys both when accessed and in the background. The background process scans for expired keys to free memory. Increasing the active-expire-effort setting (default 1, max 10) uses more CPU to reclaim expired keys faster, reducing memory usage but potentially increasing latency.
    aclChannelsDefault String
    Determines default pub/sub channels' ACL for new users if an ACL is not supplied. When this option is not defined, allchannels is assumed to keep backward compatibility. This option doesn't affect Valkey' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    clusterId String
    The ID of the target Valkey cluster.
    frequentSnapshots Boolean
    Frequent RDB snapshots. When enabled, Valkey will create frequent local RDB snapshots. When disabled, Valkey will only take RDB snapshots when a backup is created, based on the backup schedule. This setting is ignored when valkey_persistence is set to off.
    ioThreads Number
    The Valkey IO thread count.
    lfuDecayTime Number
    The LFU maxmemory policy counter decay time in minutes.
    lfuLogFactor Number
    The counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory policies.
    notifyKeyspaceEvents String
    The notify-keyspace-events option. Requires at least K or E.
    numberOfDatabases Number
    The number of Valkey databases. Changing this will cause a restart of Valkey service.
    persistence String
    When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked.
    pubsubClientOutputBufferLimit Number
    The output buffer limit for pub/sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.
    ssl Boolean
    A boolean indicating whether to require SSL to access Valkey.
    timeout Number
    The Valkey idle connection timeout in seconds.
    valkeyActiveExpireEffort Number
    Active expire effort. Valkey reclaims expired keys both when accessed and in the background. The background process scans for expired keys to free memory. Increasing the active-expire-effort setting (default 1, max 10) uses more CPU to reclaim expired keys faster, reducing memory usage but potentially increasing latency.

    Import

    A Valkey database cluster’s configuration can be imported using the id the parent cluster, e.g.

    $ pulumi import digitalocean:index/databaseValkeyConfig:DatabaseValkeyConfig example 245bcfd0-7f31-4ce6-a2bc-475a116cca97
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    DigitalOcean pulumi/pulumi-digitalocean
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the digitalocean Terraform Provider.
    digitalocean logo
    DigitalOcean v4.51.0 published on Thursday, Aug 14, 2025 by Pulumi