1. Packages
  2. Digitalocean Provider
  3. API Docs
  4. DatabaseRedisConfig
DigitalOcean v4.36.0 published on Wednesday, Dec 4, 2024 by Pulumi

digitalocean.DatabaseRedisConfig

Explore with Pulumi AI

digitalocean logo
DigitalOcean v4.36.0 published on Wednesday, Dec 4, 2024 by Pulumi

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

    Note Redis 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-redis-cluster",
        engine: "redis",
        version: "7",
        size: digitalocean.DatabaseSlug.DB_1VPCU1GB,
        region: digitalocean.Region.NYC1,
        nodeCount: 1,
    });
    const example = new digitalocean.DatabaseRedisConfig("example", {
        clusterId: exampleDatabaseCluster.id,
        maxmemoryPolicy: "allkeys-lru",
        notifyKeyspaceEvents: "KEA",
        timeout: 90,
    });
    
    import pulumi
    import pulumi_digitalocean as digitalocean
    
    example_database_cluster = digitalocean.DatabaseCluster("example",
        name="example-redis-cluster",
        engine="redis",
        version="7",
        size=digitalocean.DatabaseSlug.D_B_1_VPCU1_GB,
        region=digitalocean.Region.NYC1,
        node_count=1)
    example = digitalocean.DatabaseRedisConfig("example",
        cluster_id=example_database_cluster.id,
        maxmemory_policy="allkeys-lru",
        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-redis-cluster"),
    			Engine:    pulumi.String("redis"),
    			Version:   pulumi.String("7"),
    			Size:      pulumi.String(digitalocean.DatabaseSlug_DB_1VPCU1GB),
    			Region:    pulumi.String(digitalocean.RegionNYC1),
    			NodeCount: pulumi.Int(1),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = digitalocean.NewDatabaseRedisConfig(ctx, "example", &digitalocean.DatabaseRedisConfigArgs{
    			ClusterId:            exampleDatabaseCluster.ID(),
    			MaxmemoryPolicy:      pulumi.String("allkeys-lru"),
    			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-redis-cluster",
            Engine = "redis",
            Version = "7",
            Size = DigitalOcean.DatabaseSlug.DB_1VPCU1GB,
            Region = DigitalOcean.Region.NYC1,
            NodeCount = 1,
        });
    
        var example = new DigitalOcean.DatabaseRedisConfig("example", new()
        {
            ClusterId = exampleDatabaseCluster.Id,
            MaxmemoryPolicy = "allkeys-lru",
            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.DatabaseRedisConfig;
    import com.pulumi.digitalocean.DatabaseRedisConfigArgs;
    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-redis-cluster")
                .engine("redis")
                .version("7")
                .size("db-s-1vcpu-1gb")
                .region("nyc1")
                .nodeCount(1)
                .build());
    
            var example = new DatabaseRedisConfig("example", DatabaseRedisConfigArgs.builder()
                .clusterId(exampleDatabaseCluster.id())
                .maxmemoryPolicy("allkeys-lru")
                .notifyKeyspaceEvents("KEA")
                .timeout(90)
                .build());
    
        }
    }
    
    resources:
      example:
        type: digitalocean:DatabaseRedisConfig
        properties:
          clusterId: ${exampleDatabaseCluster.id}
          maxmemoryPolicy: allkeys-lru
          notifyKeyspaceEvents: KEA
          timeout: 90
      exampleDatabaseCluster:
        type: digitalocean:DatabaseCluster
        name: example
        properties:
          name: example-redis-cluster
          engine: redis
          version: '7'
          size: db-s-1vcpu-1gb
          region: nyc1
          nodeCount: 1
    

    Create DatabaseRedisConfig Resource

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

    Constructor syntax

    new DatabaseRedisConfig(name: string, args: DatabaseRedisConfigArgs, opts?: CustomResourceOptions);
    @overload
    def DatabaseRedisConfig(resource_name: str,
                            args: DatabaseRedisConfigArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def DatabaseRedisConfig(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            cluster_id: Optional[str] = None,
                            acl_channels_default: Optional[str] = None,
                            io_threads: Optional[int] = None,
                            lfu_decay_time: Optional[int] = None,
                            lfu_log_factor: Optional[int] = None,
                            maxmemory_policy: Optional[str] = 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)
    func NewDatabaseRedisConfig(ctx *Context, name string, args DatabaseRedisConfigArgs, opts ...ResourceOption) (*DatabaseRedisConfig, error)
    public DatabaseRedisConfig(string name, DatabaseRedisConfigArgs args, CustomResourceOptions? opts = null)
    public DatabaseRedisConfig(String name, DatabaseRedisConfigArgs args)
    public DatabaseRedisConfig(String name, DatabaseRedisConfigArgs args, CustomResourceOptions options)
    
    type: digitalocean:DatabaseRedisConfig
    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 DatabaseRedisConfigArgs
    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 DatabaseRedisConfigArgs
    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 DatabaseRedisConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseRedisConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseRedisConfigArgs
    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 databaseRedisConfigResource = new DigitalOcean.DatabaseRedisConfig("databaseRedisConfigResource", new()
    {
        ClusterId = "string",
        AclChannelsDefault = "string",
        IoThreads = 0,
        LfuDecayTime = 0,
        LfuLogFactor = 0,
        MaxmemoryPolicy = "string",
        NotifyKeyspaceEvents = "string",
        NumberOfDatabases = 0,
        Persistence = "string",
        PubsubClientOutputBufferLimit = 0,
        Ssl = false,
        Timeout = 0,
    });
    
    example, err := digitalocean.NewDatabaseRedisConfig(ctx, "databaseRedisConfigResource", &digitalocean.DatabaseRedisConfigArgs{
    	ClusterId:                     pulumi.String("string"),
    	AclChannelsDefault:            pulumi.String("string"),
    	IoThreads:                     pulumi.Int(0),
    	LfuDecayTime:                  pulumi.Int(0),
    	LfuLogFactor:                  pulumi.Int(0),
    	MaxmemoryPolicy:               pulumi.String("string"),
    	NotifyKeyspaceEvents:          pulumi.String("string"),
    	NumberOfDatabases:             pulumi.Int(0),
    	Persistence:                   pulumi.String("string"),
    	PubsubClientOutputBufferLimit: pulumi.Int(0),
    	Ssl:                           pulumi.Bool(false),
    	Timeout:                       pulumi.Int(0),
    })
    
    var databaseRedisConfigResource = new DatabaseRedisConfig("databaseRedisConfigResource", DatabaseRedisConfigArgs.builder()
        .clusterId("string")
        .aclChannelsDefault("string")
        .ioThreads(0)
        .lfuDecayTime(0)
        .lfuLogFactor(0)
        .maxmemoryPolicy("string")
        .notifyKeyspaceEvents("string")
        .numberOfDatabases(0)
        .persistence("string")
        .pubsubClientOutputBufferLimit(0)
        .ssl(false)
        .timeout(0)
        .build());
    
    database_redis_config_resource = digitalocean.DatabaseRedisConfig("databaseRedisConfigResource",
        cluster_id="string",
        acl_channels_default="string",
        io_threads=0,
        lfu_decay_time=0,
        lfu_log_factor=0,
        maxmemory_policy="string",
        notify_keyspace_events="string",
        number_of_databases=0,
        persistence="string",
        pubsub_client_output_buffer_limit=0,
        ssl=False,
        timeout=0)
    
    const databaseRedisConfigResource = new digitalocean.DatabaseRedisConfig("databaseRedisConfigResource", {
        clusterId: "string",
        aclChannelsDefault: "string",
        ioThreads: 0,
        lfuDecayTime: 0,
        lfuLogFactor: 0,
        maxmemoryPolicy: "string",
        notifyKeyspaceEvents: "string",
        numberOfDatabases: 0,
        persistence: "string",
        pubsubClientOutputBufferLimit: 0,
        ssl: false,
        timeout: 0,
    });
    
    type: digitalocean:DatabaseRedisConfig
    properties:
        aclChannelsDefault: string
        clusterId: string
        ioThreads: 0
        lfuDecayTime: 0
        lfuLogFactor: 0
        maxmemoryPolicy: string
        notifyKeyspaceEvents: string
        numberOfDatabases: 0
        persistence: string
        pubsubClientOutputBufferLimit: 0
        ssl: false
        timeout: 0
    

    DatabaseRedisConfig 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 DatabaseRedisConfig resource accepts the following input properties:

    ClusterId string
    The ID of the target Redis 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 Redis' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    IoThreads int
    The Redis 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.
    MaxmemoryPolicy string
    A string specifying the desired eviction policy for the Redis cluster.Supported values are: noeviction, allkeys-lru, allkeys-random, volatile-lru, volatile-random, volatile-ttl
    NotifyKeyspaceEvents string
    The notify-keyspace-events option. Requires at least K or E.
    NumberOfDatabases int
    The number of Redis databases. Changing this will cause a restart of Redis service.
    Persistence string
    When persistence is rdb, Redis 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 Redis.

    • When enabled, Redis accepts only SSL connections on port 25061.
    • When disabled, port 25060 is opened for non-SSL connections, while port 25061 remains available for SSL connections.
    Timeout int
    The Redis idle connection timeout in seconds.
    ClusterId string
    The ID of the target Redis 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 Redis' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    IoThreads int
    The Redis 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.
    MaxmemoryPolicy string
    A string specifying the desired eviction policy for the Redis cluster.Supported values are: noeviction, allkeys-lru, allkeys-random, volatile-lru, volatile-random, volatile-ttl
    NotifyKeyspaceEvents string
    The notify-keyspace-events option. Requires at least K or E.
    NumberOfDatabases int
    The number of Redis databases. Changing this will cause a restart of Redis service.
    Persistence string
    When persistence is rdb, Redis 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 Redis.

    • When enabled, Redis accepts only SSL connections on port 25061.
    • When disabled, port 25060 is opened for non-SSL connections, while port 25061 remains available for SSL connections.
    Timeout int
    The Redis idle connection timeout in seconds.
    clusterId String
    The ID of the target Redis 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 Redis' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    ioThreads Integer
    The Redis 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.
    maxmemoryPolicy String
    A string specifying the desired eviction policy for the Redis cluster.Supported values are: noeviction, allkeys-lru, allkeys-random, volatile-lru, volatile-random, volatile-ttl
    notifyKeyspaceEvents String
    The notify-keyspace-events option. Requires at least K or E.
    numberOfDatabases Integer
    The number of Redis databases. Changing this will cause a restart of Redis service.
    persistence String
    When persistence is rdb, Redis 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 Redis.

    • When enabled, Redis accepts only SSL connections on port 25061.
    • When disabled, port 25060 is opened for non-SSL connections, while port 25061 remains available for SSL connections.
    timeout Integer
    The Redis idle connection timeout in seconds.
    clusterId string
    The ID of the target Redis 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 Redis' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    ioThreads number
    The Redis 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.
    maxmemoryPolicy string
    A string specifying the desired eviction policy for the Redis cluster.Supported values are: noeviction, allkeys-lru, allkeys-random, volatile-lru, volatile-random, volatile-ttl
    notifyKeyspaceEvents string
    The notify-keyspace-events option. Requires at least K or E.
    numberOfDatabases number
    The number of Redis databases. Changing this will cause a restart of Redis service.
    persistence string
    When persistence is rdb, Redis 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 Redis.

    • When enabled, Redis accepts only SSL connections on port 25061.
    • When disabled, port 25060 is opened for non-SSL connections, while port 25061 remains available for SSL connections.
    timeout number
    The Redis idle connection timeout in seconds.
    cluster_id str
    The ID of the target Redis 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 Redis' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    io_threads int
    The Redis 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.
    maxmemory_policy str
    A string specifying the desired eviction policy for the Redis cluster.Supported values are: noeviction, allkeys-lru, allkeys-random, volatile-lru, volatile-random, volatile-ttl
    notify_keyspace_events str
    The notify-keyspace-events option. Requires at least K or E.
    number_of_databases int
    The number of Redis databases. Changing this will cause a restart of Redis service.
    persistence str
    When persistence is rdb, Redis 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 Redis.

    • When enabled, Redis accepts only SSL connections on port 25061.
    • When disabled, port 25060 is opened for non-SSL connections, while port 25061 remains available for SSL connections.
    timeout int
    The Redis idle connection timeout in seconds.
    clusterId String
    The ID of the target Redis 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 Redis' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    ioThreads Number
    The Redis 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.
    maxmemoryPolicy String
    A string specifying the desired eviction policy for the Redis cluster.Supported values are: noeviction, allkeys-lru, allkeys-random, volatile-lru, volatile-random, volatile-ttl
    notifyKeyspaceEvents String
    The notify-keyspace-events option. Requires at least K or E.
    numberOfDatabases Number
    The number of Redis databases. Changing this will cause a restart of Redis service.
    persistence String
    When persistence is rdb, Redis 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 Redis.

    • When enabled, Redis accepts only SSL connections on port 25061.
    • When disabled, port 25060 is opened for non-SSL connections, while port 25061 remains available for SSL connections.
    timeout Number
    The Redis idle connection timeout in seconds.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DatabaseRedisConfig 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 DatabaseRedisConfig Resource

    Get an existing DatabaseRedisConfig 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?: DatabaseRedisConfigState, opts?: CustomResourceOptions): DatabaseRedisConfig
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            acl_channels_default: Optional[str] = None,
            cluster_id: Optional[str] = None,
            io_threads: Optional[int] = None,
            lfu_decay_time: Optional[int] = None,
            lfu_log_factor: Optional[int] = None,
            maxmemory_policy: Optional[str] = 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) -> DatabaseRedisConfig
    func GetDatabaseRedisConfig(ctx *Context, name string, id IDInput, state *DatabaseRedisConfigState, opts ...ResourceOption) (*DatabaseRedisConfig, error)
    public static DatabaseRedisConfig Get(string name, Input<string> id, DatabaseRedisConfigState? state, CustomResourceOptions? opts = null)
    public static DatabaseRedisConfig get(String name, Output<String> id, DatabaseRedisConfigState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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 Redis' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    ClusterId string
    The ID of the target Redis cluster.
    IoThreads int
    The Redis 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.
    MaxmemoryPolicy string
    A string specifying the desired eviction policy for the Redis cluster.Supported values are: noeviction, allkeys-lru, allkeys-random, volatile-lru, volatile-random, volatile-ttl
    NotifyKeyspaceEvents string
    The notify-keyspace-events option. Requires at least K or E.
    NumberOfDatabases int
    The number of Redis databases. Changing this will cause a restart of Redis service.
    Persistence string
    When persistence is rdb, Redis 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 Redis.

    • When enabled, Redis accepts only SSL connections on port 25061.
    • When disabled, port 25060 is opened for non-SSL connections, while port 25061 remains available for SSL connections.
    Timeout int
    The Redis idle connection timeout in seconds.
    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 Redis' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    ClusterId string
    The ID of the target Redis cluster.
    IoThreads int
    The Redis 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.
    MaxmemoryPolicy string
    A string specifying the desired eviction policy for the Redis cluster.Supported values are: noeviction, allkeys-lru, allkeys-random, volatile-lru, volatile-random, volatile-ttl
    NotifyKeyspaceEvents string
    The notify-keyspace-events option. Requires at least K or E.
    NumberOfDatabases int
    The number of Redis databases. Changing this will cause a restart of Redis service.
    Persistence string
    When persistence is rdb, Redis 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 Redis.

    • When enabled, Redis accepts only SSL connections on port 25061.
    • When disabled, port 25060 is opened for non-SSL connections, while port 25061 remains available for SSL connections.
    Timeout int
    The Redis idle connection timeout in seconds.
    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 Redis' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    clusterId String
    The ID of the target Redis cluster.
    ioThreads Integer
    The Redis 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.
    maxmemoryPolicy String
    A string specifying the desired eviction policy for the Redis cluster.Supported values are: noeviction, allkeys-lru, allkeys-random, volatile-lru, volatile-random, volatile-ttl
    notifyKeyspaceEvents String
    The notify-keyspace-events option. Requires at least K or E.
    numberOfDatabases Integer
    The number of Redis databases. Changing this will cause a restart of Redis service.
    persistence String
    When persistence is rdb, Redis 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 Redis.

    • When enabled, Redis accepts only SSL connections on port 25061.
    • When disabled, port 25060 is opened for non-SSL connections, while port 25061 remains available for SSL connections.
    timeout Integer
    The Redis idle connection timeout in seconds.
    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 Redis' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    clusterId string
    The ID of the target Redis cluster.
    ioThreads number
    The Redis 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.
    maxmemoryPolicy string
    A string specifying the desired eviction policy for the Redis cluster.Supported values are: noeviction, allkeys-lru, allkeys-random, volatile-lru, volatile-random, volatile-ttl
    notifyKeyspaceEvents string
    The notify-keyspace-events option. Requires at least K or E.
    numberOfDatabases number
    The number of Redis databases. Changing this will cause a restart of Redis service.
    persistence string
    When persistence is rdb, Redis 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 Redis.

    • When enabled, Redis accepts only SSL connections on port 25061.
    • When disabled, port 25060 is opened for non-SSL connections, while port 25061 remains available for SSL connections.
    timeout number
    The Redis idle connection timeout in seconds.
    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 Redis' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    cluster_id str
    The ID of the target Redis cluster.
    io_threads int
    The Redis 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.
    maxmemory_policy str
    A string specifying the desired eviction policy for the Redis cluster.Supported values are: noeviction, allkeys-lru, allkeys-random, volatile-lru, volatile-random, volatile-ttl
    notify_keyspace_events str
    The notify-keyspace-events option. Requires at least K or E.
    number_of_databases int
    The number of Redis databases. Changing this will cause a restart of Redis service.
    persistence str
    When persistence is rdb, Redis 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 Redis.

    • When enabled, Redis accepts only SSL connections on port 25061.
    • When disabled, port 25060 is opened for non-SSL connections, while port 25061 remains available for SSL connections.
    timeout int
    The Redis idle connection timeout in seconds.
    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 Redis' acl-pubsub-default configuration. Supported values are: allchannels and resetchannels
    clusterId String
    The ID of the target Redis cluster.
    ioThreads Number
    The Redis 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.
    maxmemoryPolicy String
    A string specifying the desired eviction policy for the Redis cluster.Supported values are: noeviction, allkeys-lru, allkeys-random, volatile-lru, volatile-random, volatile-ttl
    notifyKeyspaceEvents String
    The notify-keyspace-events option. Requires at least K or E.
    numberOfDatabases Number
    The number of Redis databases. Changing this will cause a restart of Redis service.
    persistence String
    When persistence is rdb, Redis 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 Redis.

    • When enabled, Redis accepts only SSL connections on port 25061.
    • When disabled, port 25060 is opened for non-SSL connections, while port 25061 remains available for SSL connections.
    timeout Number
    The Redis idle connection timeout in seconds.

    Import

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

    $ pulumi import digitalocean:index/databaseRedisConfig:DatabaseRedisConfig 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.36.0 published on Wednesday, Dec 4, 2024 by Pulumi