Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aiven Provider
  3. API Docs
  4. Valkey
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven

aiven.Valkey

Explore with Pulumi AI

Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven

Creates and manages an Aiven for Valkey™ service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const exampleValkey = new aiven.Valkey("example_valkey", {
    project: exampleProject.project,
    plan: "startup-4",
    cloudName: "google-europe-west1",
    serviceName: "example-valkey-service",
    valkeyUserConfig: {
        valkeyMaxmemoryPolicy: "allkeys-random",
    },
});
Copy
import pulumi
import pulumi_aiven as aiven

example_valkey = aiven.Valkey("example_valkey",
    project=example_project["project"],
    plan="startup-4",
    cloud_name="google-europe-west1",
    service_name="example-valkey-service",
    valkey_user_config={
        "valkey_maxmemory_policy": "allkeys-random",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.NewValkey(ctx, "example_valkey", &aiven.ValkeyArgs{
			Project:     pulumi.Any(exampleProject.Project),
			Plan:        pulumi.String("startup-4"),
			CloudName:   pulumi.String("google-europe-west1"),
			ServiceName: pulumi.String("example-valkey-service"),
			ValkeyUserConfig: &aiven.ValkeyValkeyUserConfigArgs{
				ValkeyMaxmemoryPolicy: pulumi.String("allkeys-random"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var exampleValkey = new Aiven.Valkey("example_valkey", new()
    {
        Project = exampleProject.Project,
        Plan = "startup-4",
        CloudName = "google-europe-west1",
        ServiceName = "example-valkey-service",
        ValkeyUserConfig = new Aiven.Inputs.ValkeyValkeyUserConfigArgs
        {
            ValkeyMaxmemoryPolicy = "allkeys-random",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.Valkey;
import com.pulumi.aiven.ValkeyArgs;
import com.pulumi.aiven.inputs.ValkeyValkeyUserConfigArgs;
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 exampleValkey = new Valkey("exampleValkey", ValkeyArgs.builder()
            .project(exampleProject.project())
            .plan("startup-4")
            .cloudName("google-europe-west1")
            .serviceName("example-valkey-service")
            .valkeyUserConfig(ValkeyValkeyUserConfigArgs.builder()
                .valkeyMaxmemoryPolicy("allkeys-random")
                .build())
            .build());

    }
}
Copy
resources:
  exampleValkey:
    type: aiven:Valkey
    name: example_valkey
    properties:
      project: ${exampleProject.project}
      plan: startup-4
      cloudName: google-europe-west1
      serviceName: example-valkey-service
      valkeyUserConfig:
        valkeyMaxmemoryPolicy: allkeys-random
Copy

Create Valkey Resource

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

Constructor syntax

new Valkey(name: string, args: ValkeyArgs, opts?: CustomResourceOptions);
@overload
def Valkey(resource_name: str,
           args: ValkeyArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Valkey(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           plan: Optional[str] = None,
           service_name: Optional[str] = None,
           project: Optional[str] = None,
           service_integrations: Optional[Sequence[ValkeyServiceIntegrationArgs]] = None,
           maintenance_window_time: Optional[str] = None,
           maintenance_window_dow: Optional[str] = None,
           disk_space: Optional[str] = None,
           project_vpc_id: Optional[str] = None,
           additional_disk_space: Optional[str] = None,
           cloud_name: Optional[str] = None,
           static_ips: Optional[Sequence[str]] = None,
           tags: Optional[Sequence[ValkeyTagArgs]] = None,
           tech_emails: Optional[Sequence[ValkeyTechEmailArgs]] = None,
           termination_protection: Optional[bool] = None,
           valkey: Optional[ValkeyValkeyArgs] = None,
           valkey_user_config: Optional[ValkeyValkeyUserConfigArgs] = None)
func NewValkey(ctx *Context, name string, args ValkeyArgs, opts ...ResourceOption) (*Valkey, error)
public Valkey(string name, ValkeyArgs args, CustomResourceOptions? opts = null)
public Valkey(String name, ValkeyArgs args)
public Valkey(String name, ValkeyArgs args, CustomResourceOptions options)

type: aiven:Valkey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ValkeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ValkeyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ValkeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ValkeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ValkeyArgs
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 valkeyResource = new Aiven.Valkey("valkeyResource", new()
{
    Plan = "string",
    ServiceName = "string",
    Project = "string",
    ServiceIntegrations = new[]
    {
        new Aiven.Inputs.ValkeyServiceIntegrationArgs
        {
            IntegrationType = "string",
            SourceServiceName = "string",
        },
    },
    MaintenanceWindowTime = "string",
    MaintenanceWindowDow = "string",
    ProjectVpcId = "string",
    AdditionalDiskSpace = "string",
    CloudName = "string",
    StaticIps = new[]
    {
        "string",
    },
    Tags = new[]
    {
        new Aiven.Inputs.ValkeyTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    TechEmails = new[]
    {
        new Aiven.Inputs.ValkeyTechEmailArgs
        {
            Email = "string",
        },
    },
    TerminationProtection = false,
    ValkeyServer = new Aiven.Inputs.ValkeyValkeyArgs
    {
        Password = "string",
        ReplicaUri = "string",
        SlaveUris = new[]
        {
            "string",
        },
        Uris = new[]
        {
            "string",
        },
    },
    ValkeyUserConfig = new Aiven.Inputs.ValkeyValkeyUserConfigArgs
    {
        AdditionalBackupRegions = "string",
        BackupHour = 0,
        BackupMinute = 0,
        EnableIpv6 = false,
        FrequentSnapshots = false,
        IpFilterObjects = new[]
        {
            new Aiven.Inputs.ValkeyValkeyUserConfigIpFilterObjectArgs
            {
                Network = "string",
                Description = "string",
            },
        },
        IpFilterStrings = new[]
        {
            "string",
        },
        Migration = new Aiven.Inputs.ValkeyValkeyUserConfigMigrationArgs
        {
            Host = "string",
            Port = 0,
            Dbname = "string",
            IgnoreDbs = "string",
            IgnoreRoles = "string",
            Method = "string",
            Password = "string",
            Ssl = false,
            Username = "string",
        },
        PrivateAccess = new Aiven.Inputs.ValkeyValkeyUserConfigPrivateAccessArgs
        {
            Prometheus = false,
            Valkey = false,
        },
        PrivatelinkAccess = new Aiven.Inputs.ValkeyValkeyUserConfigPrivatelinkAccessArgs
        {
            Prometheus = false,
            Valkey = false,
        },
        ProjectToForkFrom = "string",
        PublicAccess = new Aiven.Inputs.ValkeyValkeyUserConfigPublicAccessArgs
        {
            Prometheus = false,
            Valkey = false,
        },
        RecoveryBasebackupName = "string",
        ServiceLog = false,
        ServiceToForkFrom = "string",
        StaticIps = false,
        ValkeyAclChannelsDefault = "string",
        ValkeyActiveExpireEffort = 0,
        ValkeyIoThreads = 0,
        ValkeyLfuDecayTime = 0,
        ValkeyLfuLogFactor = 0,
        ValkeyMaxmemoryPolicy = "string",
        ValkeyNotifyKeyspaceEvents = "string",
        ValkeyNumberOfDatabases = 0,
        ValkeyPersistence = "string",
        ValkeyPubsubClientOutputBufferLimit = 0,
        ValkeySsl = false,
        ValkeyTimeout = 0,
    },
});
Copy
example, err := aiven.NewValkey(ctx, "valkeyResource", &aiven.ValkeyArgs{
	Plan:        pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	Project:     pulumi.String("string"),
	ServiceIntegrations: aiven.ValkeyServiceIntegrationArray{
		&aiven.ValkeyServiceIntegrationArgs{
			IntegrationType:   pulumi.String("string"),
			SourceServiceName: pulumi.String("string"),
		},
	},
	MaintenanceWindowTime: pulumi.String("string"),
	MaintenanceWindowDow:  pulumi.String("string"),
	ProjectVpcId:          pulumi.String("string"),
	AdditionalDiskSpace:   pulumi.String("string"),
	CloudName:             pulumi.String("string"),
	StaticIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: aiven.ValkeyTagArray{
		&aiven.ValkeyTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	TechEmails: aiven.ValkeyTechEmailArray{
		&aiven.ValkeyTechEmailArgs{
			Email: pulumi.String("string"),
		},
	},
	TerminationProtection: pulumi.Bool(false),
	Valkey: &aiven.ValkeyValkeyArgs{
		Password:   pulumi.String("string"),
		ReplicaUri: pulumi.String("string"),
		SlaveUris: pulumi.StringArray{
			pulumi.String("string"),
		},
		Uris: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	ValkeyUserConfig: &aiven.ValkeyValkeyUserConfigArgs{
		AdditionalBackupRegions: pulumi.String("string"),
		BackupHour:              pulumi.Int(0),
		BackupMinute:            pulumi.Int(0),
		EnableIpv6:              pulumi.Bool(false),
		FrequentSnapshots:       pulumi.Bool(false),
		IpFilterObjects: aiven.ValkeyValkeyUserConfigIpFilterObjectArray{
			&aiven.ValkeyValkeyUserConfigIpFilterObjectArgs{
				Network:     pulumi.String("string"),
				Description: pulumi.String("string"),
			},
		},
		IpFilterStrings: pulumi.StringArray{
			pulumi.String("string"),
		},
		Migration: &aiven.ValkeyValkeyUserConfigMigrationArgs{
			Host:        pulumi.String("string"),
			Port:        pulumi.Int(0),
			Dbname:      pulumi.String("string"),
			IgnoreDbs:   pulumi.String("string"),
			IgnoreRoles: pulumi.String("string"),
			Method:      pulumi.String("string"),
			Password:    pulumi.String("string"),
			Ssl:         pulumi.Bool(false),
			Username:    pulumi.String("string"),
		},
		PrivateAccess: &aiven.ValkeyValkeyUserConfigPrivateAccessArgs{
			Prometheus: pulumi.Bool(false),
			Valkey:     pulumi.Bool(false),
		},
		PrivatelinkAccess: &aiven.ValkeyValkeyUserConfigPrivatelinkAccessArgs{
			Prometheus: pulumi.Bool(false),
			Valkey:     pulumi.Bool(false),
		},
		ProjectToForkFrom: pulumi.String("string"),
		PublicAccess: &aiven.ValkeyValkeyUserConfigPublicAccessArgs{
			Prometheus: pulumi.Bool(false),
			Valkey:     pulumi.Bool(false),
		},
		RecoveryBasebackupName:              pulumi.String("string"),
		ServiceLog:                          pulumi.Bool(false),
		ServiceToForkFrom:                   pulumi.String("string"),
		StaticIps:                           pulumi.Bool(false),
		ValkeyAclChannelsDefault:            pulumi.String("string"),
		ValkeyActiveExpireEffort:            pulumi.Int(0),
		ValkeyIoThreads:                     pulumi.Int(0),
		ValkeyLfuDecayTime:                  pulumi.Int(0),
		ValkeyLfuLogFactor:                  pulumi.Int(0),
		ValkeyMaxmemoryPolicy:               pulumi.String("string"),
		ValkeyNotifyKeyspaceEvents:          pulumi.String("string"),
		ValkeyNumberOfDatabases:             pulumi.Int(0),
		ValkeyPersistence:                   pulumi.String("string"),
		ValkeyPubsubClientOutputBufferLimit: pulumi.Int(0),
		ValkeySsl:                           pulumi.Bool(false),
		ValkeyTimeout:                       pulumi.Int(0),
	},
})
Copy
var valkeyResource = new Valkey("valkeyResource", ValkeyArgs.builder()
    .plan("string")
    .serviceName("string")
    .project("string")
    .serviceIntegrations(ValkeyServiceIntegrationArgs.builder()
        .integrationType("string")
        .sourceServiceName("string")
        .build())
    .maintenanceWindowTime("string")
    .maintenanceWindowDow("string")
    .projectVpcId("string")
    .additionalDiskSpace("string")
    .cloudName("string")
    .staticIps("string")
    .tags(ValkeyTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .techEmails(ValkeyTechEmailArgs.builder()
        .email("string")
        .build())
    .terminationProtection(false)
    .valkey(ValkeyValkeyArgs.builder()
        .password("string")
        .replicaUri("string")
        .slaveUris("string")
        .uris("string")
        .build())
    .valkeyUserConfig(ValkeyValkeyUserConfigArgs.builder()
        .additionalBackupRegions("string")
        .backupHour(0)
        .backupMinute(0)
        .enableIpv6(false)
        .frequentSnapshots(false)
        .ipFilterObjects(ValkeyValkeyUserConfigIpFilterObjectArgs.builder()
            .network("string")
            .description("string")
            .build())
        .ipFilterStrings("string")
        .migration(ValkeyValkeyUserConfigMigrationArgs.builder()
            .host("string")
            .port(0)
            .dbname("string")
            .ignoreDbs("string")
            .ignoreRoles("string")
            .method("string")
            .password("string")
            .ssl(false)
            .username("string")
            .build())
        .privateAccess(ValkeyValkeyUserConfigPrivateAccessArgs.builder()
            .prometheus(false)
            .valkey(false)
            .build())
        .privatelinkAccess(ValkeyValkeyUserConfigPrivatelinkAccessArgs.builder()
            .prometheus(false)
            .valkey(false)
            .build())
        .projectToForkFrom("string")
        .publicAccess(ValkeyValkeyUserConfigPublicAccessArgs.builder()
            .prometheus(false)
            .valkey(false)
            .build())
        .recoveryBasebackupName("string")
        .serviceLog(false)
        .serviceToForkFrom("string")
        .staticIps(false)
        .valkeyAclChannelsDefault("string")
        .valkeyActiveExpireEffort(0)
        .valkeyIoThreads(0)
        .valkeyLfuDecayTime(0)
        .valkeyLfuLogFactor(0)
        .valkeyMaxmemoryPolicy("string")
        .valkeyNotifyKeyspaceEvents("string")
        .valkeyNumberOfDatabases(0)
        .valkeyPersistence("string")
        .valkeyPubsubClientOutputBufferLimit(0)
        .valkeySsl(false)
        .valkeyTimeout(0)
        .build())
    .build());
Copy
valkey_resource = aiven.Valkey("valkeyResource",
    plan="string",
    service_name="string",
    project="string",
    service_integrations=[{
        "integration_type": "string",
        "source_service_name": "string",
    }],
    maintenance_window_time="string",
    maintenance_window_dow="string",
    project_vpc_id="string",
    additional_disk_space="string",
    cloud_name="string",
    static_ips=["string"],
    tags=[{
        "key": "string",
        "value": "string",
    }],
    tech_emails=[{
        "email": "string",
    }],
    termination_protection=False,
    valkey={
        "password": "string",
        "replica_uri": "string",
        "slave_uris": ["string"],
        "uris": ["string"],
    },
    valkey_user_config={
        "additional_backup_regions": "string",
        "backup_hour": 0,
        "backup_minute": 0,
        "enable_ipv6": False,
        "frequent_snapshots": False,
        "ip_filter_objects": [{
            "network": "string",
            "description": "string",
        }],
        "ip_filter_strings": ["string"],
        "migration": {
            "host": "string",
            "port": 0,
            "dbname": "string",
            "ignore_dbs": "string",
            "ignore_roles": "string",
            "method": "string",
            "password": "string",
            "ssl": False,
            "username": "string",
        },
        "private_access": {
            "prometheus": False,
            "valkey": False,
        },
        "privatelink_access": {
            "prometheus": False,
            "valkey": False,
        },
        "project_to_fork_from": "string",
        "public_access": {
            "prometheus": False,
            "valkey": False,
        },
        "recovery_basebackup_name": "string",
        "service_log": False,
        "service_to_fork_from": "string",
        "static_ips": False,
        "valkey_acl_channels_default": "string",
        "valkey_active_expire_effort": 0,
        "valkey_io_threads": 0,
        "valkey_lfu_decay_time": 0,
        "valkey_lfu_log_factor": 0,
        "valkey_maxmemory_policy": "string",
        "valkey_notify_keyspace_events": "string",
        "valkey_number_of_databases": 0,
        "valkey_persistence": "string",
        "valkey_pubsub_client_output_buffer_limit": 0,
        "valkey_ssl": False,
        "valkey_timeout": 0,
    })
Copy
const valkeyResource = new aiven.Valkey("valkeyResource", {
    plan: "string",
    serviceName: "string",
    project: "string",
    serviceIntegrations: [{
        integrationType: "string",
        sourceServiceName: "string",
    }],
    maintenanceWindowTime: "string",
    maintenanceWindowDow: "string",
    projectVpcId: "string",
    additionalDiskSpace: "string",
    cloudName: "string",
    staticIps: ["string"],
    tags: [{
        key: "string",
        value: "string",
    }],
    techEmails: [{
        email: "string",
    }],
    terminationProtection: false,
    valkey: {
        password: "string",
        replicaUri: "string",
        slaveUris: ["string"],
        uris: ["string"],
    },
    valkeyUserConfig: {
        additionalBackupRegions: "string",
        backupHour: 0,
        backupMinute: 0,
        enableIpv6: false,
        frequentSnapshots: false,
        ipFilterObjects: [{
            network: "string",
            description: "string",
        }],
        ipFilterStrings: ["string"],
        migration: {
            host: "string",
            port: 0,
            dbname: "string",
            ignoreDbs: "string",
            ignoreRoles: "string",
            method: "string",
            password: "string",
            ssl: false,
            username: "string",
        },
        privateAccess: {
            prometheus: false,
            valkey: false,
        },
        privatelinkAccess: {
            prometheus: false,
            valkey: false,
        },
        projectToForkFrom: "string",
        publicAccess: {
            prometheus: false,
            valkey: false,
        },
        recoveryBasebackupName: "string",
        serviceLog: false,
        serviceToForkFrom: "string",
        staticIps: false,
        valkeyAclChannelsDefault: "string",
        valkeyActiveExpireEffort: 0,
        valkeyIoThreads: 0,
        valkeyLfuDecayTime: 0,
        valkeyLfuLogFactor: 0,
        valkeyMaxmemoryPolicy: "string",
        valkeyNotifyKeyspaceEvents: "string",
        valkeyNumberOfDatabases: 0,
        valkeyPersistence: "string",
        valkeyPubsubClientOutputBufferLimit: 0,
        valkeySsl: false,
        valkeyTimeout: 0,
    },
});
Copy
type: aiven:Valkey
properties:
    additionalDiskSpace: string
    cloudName: string
    maintenanceWindowDow: string
    maintenanceWindowTime: string
    plan: string
    project: string
    projectVpcId: string
    serviceIntegrations:
        - integrationType: string
          sourceServiceName: string
    serviceName: string
    staticIps:
        - string
    tags:
        - key: string
          value: string
    techEmails:
        - email: string
    terminationProtection: false
    valkey:
        password: string
        replicaUri: string
        slaveUris:
            - string
        uris:
            - string
    valkeyUserConfig:
        additionalBackupRegions: string
        backupHour: 0
        backupMinute: 0
        enableIpv6: false
        frequentSnapshots: false
        ipFilterObjects:
            - description: string
              network: string
        ipFilterStrings:
            - string
        migration:
            dbname: string
            host: string
            ignoreDbs: string
            ignoreRoles: string
            method: string
            password: string
            port: 0
            ssl: false
            username: string
        privateAccess:
            prometheus: false
            valkey: false
        privatelinkAccess:
            prometheus: false
            valkey: false
        projectToForkFrom: string
        publicAccess:
            prometheus: false
            valkey: false
        recoveryBasebackupName: string
        serviceLog: false
        serviceToForkFrom: string
        staticIps: false
        valkeyAclChannelsDefault: string
        valkeyActiveExpireEffort: 0
        valkeyIoThreads: 0
        valkeyLfuDecayTime: 0
        valkeyLfuLogFactor: 0
        valkeyMaxmemoryPolicy: string
        valkeyNotifyKeyspaceEvents: string
        valkeyNumberOfDatabases: 0
        valkeyPersistence: string
        valkeyPubsubClientOutputBufferLimit: 0
        valkeySsl: false
        valkeyTimeout: 0
Copy

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

Plan This property is required. string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
Project
This property is required.
Changes to this property will trigger replacement.
string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
AdditionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
DiskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
ProjectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceIntegrations List<ValkeyServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
StaticIps List<string>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
Tags List<ValkeyTag>
Tags are key-value pairs that allow you to categorize services.
TechEmails List<ValkeyTechEmail>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
ValkeyServer ValkeyValkey
Valkey server provided values
ValkeyUserConfig ValkeyValkeyUserConfig
Valkey user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
Plan This property is required. string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
Project
This property is required.
Changes to this property will trigger replacement.
string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
AdditionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
DiskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
ProjectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceIntegrations []ValkeyServiceIntegrationArgs
Service integrations to specify when creating a service. Not applied after initial service creation
StaticIps []string
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
Tags []ValkeyTagArgs
Tags are key-value pairs that allow you to categorize services.
TechEmails []ValkeyTechEmailArgs
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
Valkey ValkeyValkeyArgs
Valkey server provided values
ValkeyUserConfig ValkeyValkeyUserConfigArgs
Valkey user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
plan This property is required. String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project
This property is required.
Changes to this property will trigger replacement.
String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
additionalDiskSpace String
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
diskSpace String
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
projectVpcId String
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceIntegrations List<ValkeyServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
staticIps List<String>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags List<ValkeyTag>
Tags are key-value pairs that allow you to categorize services.
techEmails List<ValkeyTechEmail>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
valkey ValkeyValkey
Valkey server provided values
valkeyUserConfig ValkeyValkeyUserConfig
Valkey user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
plan This property is required. string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project
This property is required.
Changes to this property will trigger replacement.
string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
additionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
diskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

maintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
projectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceIntegrations ValkeyServiceIntegration[]
Service integrations to specify when creating a service. Not applied after initial service creation
staticIps string[]
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags ValkeyTag[]
Tags are key-value pairs that allow you to categorize services.
techEmails ValkeyTechEmail[]
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
valkey ValkeyValkey
Valkey server provided values
valkeyUserConfig ValkeyValkeyUserConfig
Valkey user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
plan This property is required. str
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project
This property is required.
Changes to this property will trigger replacement.
str
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
service_name
This property is required.
Changes to this property will trigger replacement.
str
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
additional_disk_space str
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloud_name str
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
disk_space str
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

maintenance_window_dow str
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenance_window_time str
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
project_vpc_id str
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
service_integrations Sequence[ValkeyServiceIntegrationArgs]
Service integrations to specify when creating a service. Not applied after initial service creation
static_ips Sequence[str]
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags Sequence[ValkeyTagArgs]
Tags are key-value pairs that allow you to categorize services.
tech_emails Sequence[ValkeyTechEmailArgs]
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
termination_protection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
valkey ValkeyValkeyArgs
Valkey server provided values
valkey_user_config ValkeyValkeyUserConfigArgs
Valkey user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
plan This property is required. String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project
This property is required.
Changes to this property will trigger replacement.
String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
additionalDiskSpace String
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
diskSpace String
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
projectVpcId String
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceIntegrations List<Property Map>
Service integrations to specify when creating a service. Not applied after initial service creation
staticIps List<String>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags List<Property Map>
Tags are key-value pairs that allow you to categorize services.
techEmails List<Property Map>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
valkey Property Map
Valkey server provided values
valkeyUserConfig Property Map
Valkey user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later

Outputs

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

Components List<ValkeyComponent>
Service component information objects
DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

Id string
The provider-assigned unique ID for this managed resource.
ServiceHost string
The hostname of the service.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
Components []ValkeyComponent
Service component information objects
DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

Id string
The provider-assigned unique ID for this managed resource.
ServiceHost string
The hostname of the service.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
components List<ValkeyComponent>
Service component information objects
diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

id String
The provider-assigned unique ID for this managed resource.
serviceHost String
The hostname of the service.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Integer
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String
components ValkeyComponent[]
Service component information objects
diskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

id string
The provider-assigned unique ID for this managed resource.
serviceHost string
The hostname of the service.
servicePassword string
Password used for connecting to the service, if applicable
servicePort number
The port of the service
serviceType string
Aiven internal service type code
serviceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername string
Username used for connecting to the service, if applicable
state string
components Sequence[ValkeyComponent]
Service component information objects
disk_space_cap str
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
disk_space_default str
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
disk_space_step str
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
disk_space_used str
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

id str
The provider-assigned unique ID for this managed resource.
service_host str
The hostname of the service.
service_password str
Password used for connecting to the service, if applicable
service_port int
The port of the service
service_type str
Aiven internal service type code
service_uri str
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
service_username str
Username used for connecting to the service, if applicable
state str
components List<Property Map>
Service component information objects
diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

id String
The provider-assigned unique ID for this managed resource.
serviceHost String
The hostname of the service.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Number
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String

Look up Existing Valkey Resource

Get an existing Valkey 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?: ValkeyState, opts?: CustomResourceOptions): Valkey
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_disk_space: Optional[str] = None,
        cloud_name: Optional[str] = None,
        components: Optional[Sequence[ValkeyComponentArgs]] = None,
        disk_space: Optional[str] = None,
        disk_space_cap: Optional[str] = None,
        disk_space_default: Optional[str] = None,
        disk_space_step: Optional[str] = None,
        disk_space_used: Optional[str] = None,
        maintenance_window_dow: Optional[str] = None,
        maintenance_window_time: Optional[str] = None,
        plan: Optional[str] = None,
        project: Optional[str] = None,
        project_vpc_id: Optional[str] = None,
        service_host: Optional[str] = None,
        service_integrations: Optional[Sequence[ValkeyServiceIntegrationArgs]] = None,
        service_name: Optional[str] = None,
        service_password: Optional[str] = None,
        service_port: Optional[int] = None,
        service_type: Optional[str] = None,
        service_uri: Optional[str] = None,
        service_username: Optional[str] = None,
        state: Optional[str] = None,
        static_ips: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[ValkeyTagArgs]] = None,
        tech_emails: Optional[Sequence[ValkeyTechEmailArgs]] = None,
        termination_protection: Optional[bool] = None,
        valkey: Optional[ValkeyValkeyArgs] = None,
        valkey_user_config: Optional[ValkeyValkeyUserConfigArgs] = None) -> Valkey
func GetValkey(ctx *Context, name string, id IDInput, state *ValkeyState, opts ...ResourceOption) (*Valkey, error)
public static Valkey Get(string name, Input<string> id, ValkeyState? state, CustomResourceOptions? opts = null)
public static Valkey get(String name, Output<String> id, ValkeyState state, CustomResourceOptions options)
resources:  _:    type: aiven:Valkey    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AdditionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
Components List<ValkeyComponent>
Service component information objects
DiskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
Plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
Project Changes to this property will trigger replacement. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ProjectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceHost string
The hostname of the service.
ServiceIntegrations List<ValkeyServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName Changes to this property will trigger replacement. string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
StaticIps List<string>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
Tags List<ValkeyTag>
Tags are key-value pairs that allow you to categorize services.
TechEmails List<ValkeyTechEmail>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
ValkeyServer ValkeyValkey
Valkey server provided values
ValkeyUserConfig ValkeyValkeyUserConfig
Valkey user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
AdditionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
Components []ValkeyComponentArgs
Service component information objects
DiskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
Plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
Project Changes to this property will trigger replacement. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ProjectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceHost string
The hostname of the service.
ServiceIntegrations []ValkeyServiceIntegrationArgs
Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName Changes to this property will trigger replacement. string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
StaticIps []string
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
Tags []ValkeyTagArgs
Tags are key-value pairs that allow you to categorize services.
TechEmails []ValkeyTechEmailArgs
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
Valkey ValkeyValkeyArgs
Valkey server provided values
ValkeyUserConfig ValkeyValkeyUserConfigArgs
Valkey user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
additionalDiskSpace String
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components List<ValkeyComponent>
Service component information objects
diskSpace String
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
plan String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project Changes to this property will trigger replacement. String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
projectVpcId String
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceHost String
The hostname of the service.
serviceIntegrations List<ValkeyServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName Changes to this property will trigger replacement. String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Integer
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String
staticIps List<String>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags List<ValkeyTag>
Tags are key-value pairs that allow you to categorize services.
techEmails List<ValkeyTechEmail>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
valkey ValkeyValkey
Valkey server provided values
valkeyUserConfig ValkeyValkeyUserConfig
Valkey user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
additionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components ValkeyComponent[]
Service component information objects
diskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

diskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

maintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project Changes to this property will trigger replacement. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
projectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceHost string
The hostname of the service.
serviceIntegrations ValkeyServiceIntegration[]
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName Changes to this property will trigger replacement. string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
servicePassword string
Password used for connecting to the service, if applicable
servicePort number
The port of the service
serviceType string
Aiven internal service type code
serviceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername string
Username used for connecting to the service, if applicable
state string
staticIps string[]
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags ValkeyTag[]
Tags are key-value pairs that allow you to categorize services.
techEmails ValkeyTechEmail[]
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
valkey ValkeyValkey
Valkey server provided values
valkeyUserConfig ValkeyValkeyUserConfig
Valkey user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
additional_disk_space str
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloud_name str
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components Sequence[ValkeyComponentArgs]
Service component information objects
disk_space str
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

disk_space_cap str
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
disk_space_default str
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
disk_space_step str
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
disk_space_used str
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

maintenance_window_dow str
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenance_window_time str
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
plan str
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project Changes to this property will trigger replacement. str
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
project_vpc_id str
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
service_host str
The hostname of the service.
service_integrations Sequence[ValkeyServiceIntegrationArgs]
Service integrations to specify when creating a service. Not applied after initial service creation
service_name Changes to this property will trigger replacement. str
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
service_password str
Password used for connecting to the service, if applicable
service_port int
The port of the service
service_type str
Aiven internal service type code
service_uri str
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
service_username str
Username used for connecting to the service, if applicable
state str
static_ips Sequence[str]
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags Sequence[ValkeyTagArgs]
Tags are key-value pairs that allow you to categorize services.
tech_emails Sequence[ValkeyTechEmailArgs]
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
termination_protection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
valkey ValkeyValkeyArgs
Valkey server provided values
valkey_user_config ValkeyValkeyUserConfigArgs
Valkey user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
additionalDiskSpace String
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components List<Property Map>
Service component information objects
diskSpace String
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
plan String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project Changes to this property will trigger replacement. String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
projectVpcId String
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceHost String
The hostname of the service.
serviceIntegrations List<Property Map>
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName Changes to this property will trigger replacement. String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Number
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String
staticIps List<String>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags List<Property Map>
Tags are key-value pairs that allow you to categorize services.
techEmails List<Property Map>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
valkey Property Map
Valkey server provided values
valkeyUserConfig Property Map
Valkey user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later

Supporting Types

ValkeyComponent
, ValkeyComponentArgs

Component string
Service component name
ConnectionUri string
Connection info for connecting to the service component. This is a combination of host and port.
Host string
Host name for connecting to the service component
KafkaAuthenticationMethod string
Kafka authentication method. This is a value specific to the 'kafka' service component
KafkaSslCa string
Kafka certificate used. The possible values are letsencrypt and project_ca.
Port int
Port number for connecting to the service component
Route string
Network access route
Ssl bool
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
Usage string
DNS usage name
Component string
Service component name
ConnectionUri string
Connection info for connecting to the service component. This is a combination of host and port.
Host string
Host name for connecting to the service component
KafkaAuthenticationMethod string
Kafka authentication method. This is a value specific to the 'kafka' service component
KafkaSslCa string
Kafka certificate used. The possible values are letsencrypt and project_ca.
Port int
Port number for connecting to the service component
Route string
Network access route
Ssl bool
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
Usage string
DNS usage name
component String
Service component name
connectionUri String
Connection info for connecting to the service component. This is a combination of host and port.
host String
Host name for connecting to the service component
kafkaAuthenticationMethod String
Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa String
Kafka certificate used. The possible values are letsencrypt and project_ca.
port Integer
Port number for connecting to the service component
route String
Network access route
ssl Boolean
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage String
DNS usage name
component string
Service component name
connectionUri string
Connection info for connecting to the service component. This is a combination of host and port.
host string
Host name for connecting to the service component
kafkaAuthenticationMethod string
Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa string
Kafka certificate used. The possible values are letsencrypt and project_ca.
port number
Port number for connecting to the service component
route string
Network access route
ssl boolean
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage string
DNS usage name
component str
Service component name
connection_uri str
Connection info for connecting to the service component. This is a combination of host and port.
host str
Host name for connecting to the service component
kafka_authentication_method str
Kafka authentication method. This is a value specific to the 'kafka' service component
kafka_ssl_ca str
Kafka certificate used. The possible values are letsencrypt and project_ca.
port int
Port number for connecting to the service component
route str
Network access route
ssl bool
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage str
DNS usage name
component String
Service component name
connectionUri String
Connection info for connecting to the service component. This is a combination of host and port.
host String
Host name for connecting to the service component
kafkaAuthenticationMethod String
Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa String
Kafka certificate used. The possible values are letsencrypt and project_ca.
port Number
Port number for connecting to the service component
route String
Network access route
ssl Boolean
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage String
DNS usage name

ValkeyServiceIntegration
, ValkeyServiceIntegrationArgs

IntegrationType This property is required. string
Type of the service integration. The possible value is read_replica.
SourceServiceName This property is required. string
Name of the source service
IntegrationType This property is required. string
Type of the service integration. The possible value is read_replica.
SourceServiceName This property is required. string
Name of the source service
integrationType This property is required. String
Type of the service integration. The possible value is read_replica.
sourceServiceName This property is required. String
Name of the source service
integrationType This property is required. string
Type of the service integration. The possible value is read_replica.
sourceServiceName This property is required. string
Name of the source service
integration_type This property is required. str
Type of the service integration. The possible value is read_replica.
source_service_name This property is required. str
Name of the source service
integrationType This property is required. String
Type of the service integration. The possible value is read_replica.
sourceServiceName This property is required. String
Name of the source service

ValkeyTag
, ValkeyTagArgs

Key This property is required. string
Service tag key
Value This property is required. string
Service tag value
Key This property is required. string
Service tag key
Value This property is required. string
Service tag value
key This property is required. String
Service tag key
value This property is required. String
Service tag value
key This property is required. string
Service tag key
value This property is required. string
Service tag value
key This property is required. str
Service tag key
value This property is required. str
Service tag value
key This property is required. String
Service tag key
value This property is required. String
Service tag value

ValkeyTechEmail
, ValkeyTechEmailArgs

Email This property is required. string
An email address to contact for technical issues
Email This property is required. string
An email address to contact for technical issues
email This property is required. String
An email address to contact for technical issues
email This property is required. string
An email address to contact for technical issues
email This property is required. str
An email address to contact for technical issues
email This property is required. String
An email address to contact for technical issues

ValkeyValkey
, ValkeyValkeyArgs

Password string
Valkey password.
ReplicaUri string
Valkey replica server URI.
SlaveUris List<string>
Valkey slave server URIs.
Uris List<string>
Valkey server URIs.
Password string
Valkey password.
ReplicaUri string
Valkey replica server URI.
SlaveUris []string
Valkey slave server URIs.
Uris []string
Valkey server URIs.
password String
Valkey password.
replicaUri String
Valkey replica server URI.
slaveUris List<String>
Valkey slave server URIs.
uris List<String>
Valkey server URIs.
password string
Valkey password.
replicaUri string
Valkey replica server URI.
slaveUris string[]
Valkey slave server URIs.
uris string[]
Valkey server URIs.
password str
Valkey password.
replica_uri str
Valkey replica server URI.
slave_uris Sequence[str]
Valkey slave server URIs.
uris Sequence[str]
Valkey server URIs.
password String
Valkey password.
replicaUri String
Valkey replica server URI.
slaveUris List<String>
Valkey slave server URIs.
uris List<String>
Valkey server URIs.

ValkeyValkeyUserConfig
, ValkeyValkeyUserConfigArgs

AdditionalBackupRegions string
Additional Cloud Regions for Backup Replication.
BackupHour int
The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
BackupMinute int
The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
EnableIpv6 bool
Register AAAA DNS records for the service, and allow IPv6 packets to service ports.
FrequentSnapshots bool
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. Default: true.
IpFilterObjects List<ValkeyValkeyUserConfigIpFilterObject>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
IpFilterStrings List<string>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
IpFilters List<string>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

Migration ValkeyValkeyUserConfigMigration
Migrate data from existing server
PrivateAccess ValkeyValkeyUserConfigPrivateAccess
Allow access to selected service ports from private networks
PrivatelinkAccess ValkeyValkeyUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
ProjectToForkFrom Changes to this property will trigger replacement. string
Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
PublicAccess ValkeyValkeyUserConfigPublicAccess
Allow access to selected service ports from the public Internet
RecoveryBasebackupName string
Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
ServiceLog bool
Store logs for the service so that they are available in the HTTP API and console.
ServiceToForkFrom Changes to this property will trigger replacement. string
Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
StaticIps bool
Use static public IP addresses.
ValkeyAclChannelsDefault string
Enum: allchannels, resetchannels. Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Valkey configuration acl-pubsub-default.
ValkeyActiveExpireEffort int
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. Default: 1.
ValkeyIoThreads int
Set Valkey IO thread count. Changing this will cause a restart of the Valkey service. Example: 1.
ValkeyLfuDecayTime int
LFU maxmemory-policy counter decay time in minutes. Default: 1.
ValkeyLfuLogFactor int
Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies. Default: 10.
ValkeyMaxmemoryPolicy string
Enum: allkeys-lfu, allkeys-lru, allkeys-random, noeviction, volatile-lfu, volatile-lru, volatile-random, volatile-ttl. Valkey maxmemory-policy. Default: noeviction.
ValkeyNotifyKeyspaceEvents string
Set notify-keyspace-events option.
ValkeyNumberOfDatabases int
Set number of Valkey databases. Changing this will cause a restart of the Valkey service. Example: 16.
ValkeyPersistence string
Enum: off, rdb. 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.
ValkeyPubsubClientOutputBufferLimit int
Set 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. Example: 64.
ValkeySsl bool
Require SSL to access Valkey. Default: true.
ValkeyTimeout int
Valkey idle connection timeout in seconds. Default: 300.
AdditionalBackupRegions string
Additional Cloud Regions for Backup Replication.
BackupHour int
The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
BackupMinute int
The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
EnableIpv6 bool
Register AAAA DNS records for the service, and allow IPv6 packets to service ports.
FrequentSnapshots bool
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. Default: true.
IpFilterObjects []ValkeyValkeyUserConfigIpFilterObject
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
IpFilterStrings []string
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
IpFilters []string
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

Migration ValkeyValkeyUserConfigMigration
Migrate data from existing server
PrivateAccess ValkeyValkeyUserConfigPrivateAccess
Allow access to selected service ports from private networks
PrivatelinkAccess ValkeyValkeyUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
ProjectToForkFrom Changes to this property will trigger replacement. string
Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
PublicAccess ValkeyValkeyUserConfigPublicAccess
Allow access to selected service ports from the public Internet
RecoveryBasebackupName string
Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
ServiceLog bool
Store logs for the service so that they are available in the HTTP API and console.
ServiceToForkFrom Changes to this property will trigger replacement. string
Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
StaticIps bool
Use static public IP addresses.
ValkeyAclChannelsDefault string
Enum: allchannels, resetchannels. Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Valkey configuration acl-pubsub-default.
ValkeyActiveExpireEffort int
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. Default: 1.
ValkeyIoThreads int
Set Valkey IO thread count. Changing this will cause a restart of the Valkey service. Example: 1.
ValkeyLfuDecayTime int
LFU maxmemory-policy counter decay time in minutes. Default: 1.
ValkeyLfuLogFactor int
Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies. Default: 10.
ValkeyMaxmemoryPolicy string
Enum: allkeys-lfu, allkeys-lru, allkeys-random, noeviction, volatile-lfu, volatile-lru, volatile-random, volatile-ttl. Valkey maxmemory-policy. Default: noeviction.
ValkeyNotifyKeyspaceEvents string
Set notify-keyspace-events option.
ValkeyNumberOfDatabases int
Set number of Valkey databases. Changing this will cause a restart of the Valkey service. Example: 16.
ValkeyPersistence string
Enum: off, rdb. 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.
ValkeyPubsubClientOutputBufferLimit int
Set 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. Example: 64.
ValkeySsl bool
Require SSL to access Valkey. Default: true.
ValkeyTimeout int
Valkey idle connection timeout in seconds. Default: 300.
additionalBackupRegions String
Additional Cloud Regions for Backup Replication.
backupHour Integer
The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
backupMinute Integer
The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
enableIpv6 Boolean
Register AAAA DNS records for the service, and allow IPv6 packets to service ports.
frequentSnapshots Boolean
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. Default: true.
ipFilterObjects List<ValkeyValkeyUserConfigIpFilterObject>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

migration ValkeyValkeyUserConfigMigration
Migrate data from existing server
privateAccess ValkeyValkeyUserConfigPrivateAccess
Allow access to selected service ports from private networks
privatelinkAccess ValkeyValkeyUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
projectToForkFrom Changes to this property will trigger replacement. String
Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
publicAccess ValkeyValkeyUserConfigPublicAccess
Allow access to selected service ports from the public Internet
recoveryBasebackupName String
Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
serviceLog Boolean
Store logs for the service so that they are available in the HTTP API and console.
serviceToForkFrom Changes to this property will trigger replacement. String
Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
staticIps Boolean
Use static public IP addresses.
valkeyAclChannelsDefault String
Enum: allchannels, resetchannels. Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Valkey configuration acl-pubsub-default.
valkeyActiveExpireEffort Integer
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. Default: 1.
valkeyIoThreads Integer
Set Valkey IO thread count. Changing this will cause a restart of the Valkey service. Example: 1.
valkeyLfuDecayTime Integer
LFU maxmemory-policy counter decay time in minutes. Default: 1.
valkeyLfuLogFactor Integer
Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies. Default: 10.
valkeyMaxmemoryPolicy String
Enum: allkeys-lfu, allkeys-lru, allkeys-random, noeviction, volatile-lfu, volatile-lru, volatile-random, volatile-ttl. Valkey maxmemory-policy. Default: noeviction.
valkeyNotifyKeyspaceEvents String
Set notify-keyspace-events option.
valkeyNumberOfDatabases Integer
Set number of Valkey databases. Changing this will cause a restart of the Valkey service. Example: 16.
valkeyPersistence String
Enum: off, rdb. 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.
valkeyPubsubClientOutputBufferLimit Integer
Set 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. Example: 64.
valkeySsl Boolean
Require SSL to access Valkey. Default: true.
valkeyTimeout Integer
Valkey idle connection timeout in seconds. Default: 300.
additionalBackupRegions string
Additional Cloud Regions for Backup Replication.
backupHour number
The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
backupMinute number
The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
enableIpv6 boolean
Register AAAA DNS records for the service, and allow IPv6 packets to service ports.
frequentSnapshots boolean
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. Default: true.
ipFilterObjects ValkeyValkeyUserConfigIpFilterObject[]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings string[]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters string[]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

migration ValkeyValkeyUserConfigMigration
Migrate data from existing server
privateAccess ValkeyValkeyUserConfigPrivateAccess
Allow access to selected service ports from private networks
privatelinkAccess ValkeyValkeyUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
projectToForkFrom Changes to this property will trigger replacement. string
Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
publicAccess ValkeyValkeyUserConfigPublicAccess
Allow access to selected service ports from the public Internet
recoveryBasebackupName string
Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
serviceLog boolean
Store logs for the service so that they are available in the HTTP API and console.
serviceToForkFrom Changes to this property will trigger replacement. string
Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
staticIps boolean
Use static public IP addresses.
valkeyAclChannelsDefault string
Enum: allchannels, resetchannels. Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Valkey configuration acl-pubsub-default.
valkeyActiveExpireEffort number
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. Default: 1.
valkeyIoThreads number
Set Valkey IO thread count. Changing this will cause a restart of the Valkey service. Example: 1.
valkeyLfuDecayTime number
LFU maxmemory-policy counter decay time in minutes. Default: 1.
valkeyLfuLogFactor number
Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies. Default: 10.
valkeyMaxmemoryPolicy string
Enum: allkeys-lfu, allkeys-lru, allkeys-random, noeviction, volatile-lfu, volatile-lru, volatile-random, volatile-ttl. Valkey maxmemory-policy. Default: noeviction.
valkeyNotifyKeyspaceEvents string
Set notify-keyspace-events option.
valkeyNumberOfDatabases number
Set number of Valkey databases. Changing this will cause a restart of the Valkey service. Example: 16.
valkeyPersistence string
Enum: off, rdb. 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.
valkeyPubsubClientOutputBufferLimit number
Set 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. Example: 64.
valkeySsl boolean
Require SSL to access Valkey. Default: true.
valkeyTimeout number
Valkey idle connection timeout in seconds. Default: 300.
additional_backup_regions str
Additional Cloud Regions for Backup Replication.
backup_hour int
The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
backup_minute int
The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
enable_ipv6 bool
Register AAAA DNS records for the service, and allow IPv6 packets to service ports.
frequent_snapshots bool
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. Default: true.
ip_filter_objects Sequence[ValkeyValkeyUserConfigIpFilterObject]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ip_filter_strings Sequence[str]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ip_filters Sequence[str]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

migration ValkeyValkeyUserConfigMigration
Migrate data from existing server
private_access ValkeyValkeyUserConfigPrivateAccess
Allow access to selected service ports from private networks
privatelink_access ValkeyValkeyUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
project_to_fork_from Changes to this property will trigger replacement. str
Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
public_access ValkeyValkeyUserConfigPublicAccess
Allow access to selected service ports from the public Internet
recovery_basebackup_name str
Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
service_log bool
Store logs for the service so that they are available in the HTTP API and console.
service_to_fork_from Changes to this property will trigger replacement. str
Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
static_ips bool
Use static public IP addresses.
valkey_acl_channels_default str
Enum: allchannels, resetchannels. Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Valkey configuration acl-pubsub-default.
valkey_active_expire_effort int
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. Default: 1.
valkey_io_threads int
Set Valkey IO thread count. Changing this will cause a restart of the Valkey service. Example: 1.
valkey_lfu_decay_time int
LFU maxmemory-policy counter decay time in minutes. Default: 1.
valkey_lfu_log_factor int
Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies. Default: 10.
valkey_maxmemory_policy str
Enum: allkeys-lfu, allkeys-lru, allkeys-random, noeviction, volatile-lfu, volatile-lru, volatile-random, volatile-ttl. Valkey maxmemory-policy. Default: noeviction.
valkey_notify_keyspace_events str
Set notify-keyspace-events option.
valkey_number_of_databases int
Set number of Valkey databases. Changing this will cause a restart of the Valkey service. Example: 16.
valkey_persistence str
Enum: off, rdb. 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.
valkey_pubsub_client_output_buffer_limit int
Set 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. Example: 64.
valkey_ssl bool
Require SSL to access Valkey. Default: true.
valkey_timeout int
Valkey idle connection timeout in seconds. Default: 300.
additionalBackupRegions String
Additional Cloud Regions for Backup Replication.
backupHour Number
The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
backupMinute Number
The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
enableIpv6 Boolean
Register AAAA DNS records for the service, and allow IPv6 packets to service ports.
frequentSnapshots Boolean
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. Default: true.
ipFilterObjects List<Property Map>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

migration Property Map
Migrate data from existing server
privateAccess Property Map
Allow access to selected service ports from private networks
privatelinkAccess Property Map
Allow access to selected service components through Privatelink
projectToForkFrom Changes to this property will trigger replacement. String
Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
publicAccess Property Map
Allow access to selected service ports from the public Internet
recoveryBasebackupName String
Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
serviceLog Boolean
Store logs for the service so that they are available in the HTTP API and console.
serviceToForkFrom Changes to this property will trigger replacement. String
Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
staticIps Boolean
Use static public IP addresses.
valkeyAclChannelsDefault String
Enum: allchannels, resetchannels. Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Valkey configuration acl-pubsub-default.
valkeyActiveExpireEffort Number
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. Default: 1.
valkeyIoThreads Number
Set Valkey IO thread count. Changing this will cause a restart of the Valkey service. Example: 1.
valkeyLfuDecayTime Number
LFU maxmemory-policy counter decay time in minutes. Default: 1.
valkeyLfuLogFactor Number
Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies. Default: 10.
valkeyMaxmemoryPolicy String
Enum: allkeys-lfu, allkeys-lru, allkeys-random, noeviction, volatile-lfu, volatile-lru, volatile-random, volatile-ttl. Valkey maxmemory-policy. Default: noeviction.
valkeyNotifyKeyspaceEvents String
Set notify-keyspace-events option.
valkeyNumberOfDatabases Number
Set number of Valkey databases. Changing this will cause a restart of the Valkey service. Example: 16.
valkeyPersistence String
Enum: off, rdb. 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.
valkeyPubsubClientOutputBufferLimit Number
Set 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. Example: 64.
valkeySsl Boolean
Require SSL to access Valkey. Default: true.
valkeyTimeout Number
Valkey idle connection timeout in seconds. Default: 300.

ValkeyValkeyUserConfigIpFilterObject
, ValkeyValkeyUserConfigIpFilterObjectArgs

Network This property is required. string
CIDR address block. Example: 10.20.0.0/16.
Description string
Description for IP filter list entry. Example: Production service IP range.
Network This property is required. string
CIDR address block. Example: 10.20.0.0/16.
Description string
Description for IP filter list entry. Example: Production service IP range.
network This property is required. String
CIDR address block. Example: 10.20.0.0/16.
description String
Description for IP filter list entry. Example: Production service IP range.
network This property is required. string
CIDR address block. Example: 10.20.0.0/16.
description string
Description for IP filter list entry. Example: Production service IP range.
network This property is required. str
CIDR address block. Example: 10.20.0.0/16.
description str
Description for IP filter list entry. Example: Production service IP range.
network This property is required. String
CIDR address block. Example: 10.20.0.0/16.
description String
Description for IP filter list entry. Example: Production service IP range.

ValkeyValkeyUserConfigMigration
, ValkeyValkeyUserConfigMigrationArgs

Host This property is required. string
Hostname or IP address of the server where to migrate data from. Example: my.server.com.
Port This property is required. int
Port number of the server where to migrate data from. Example: 1234.
Dbname string
Database name for bootstrapping the initial connection. Example: defaultdb.
IgnoreDbs string
Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment). Example: db1,db2.
IgnoreRoles string
Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment). Example: role1,role2.
Method string
Enum: dump, replication. The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types).
Password string
Password for authentication with the server where to migrate data from. Example: jjKk45Nnd.
Ssl bool
The server where to migrate data from is secured with SSL. Default: true.
Username string
User name for authentication with the server where to migrate data from. Example: myname.
Host This property is required. string
Hostname or IP address of the server where to migrate data from. Example: my.server.com.
Port This property is required. int
Port number of the server where to migrate data from. Example: 1234.
Dbname string
Database name for bootstrapping the initial connection. Example: defaultdb.
IgnoreDbs string
Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment). Example: db1,db2.
IgnoreRoles string
Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment). Example: role1,role2.
Method string
Enum: dump, replication. The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types).
Password string
Password for authentication with the server where to migrate data from. Example: jjKk45Nnd.
Ssl bool
The server where to migrate data from is secured with SSL. Default: true.
Username string
User name for authentication with the server where to migrate data from. Example: myname.
host This property is required. String
Hostname or IP address of the server where to migrate data from. Example: my.server.com.
port This property is required. Integer
Port number of the server where to migrate data from. Example: 1234.
dbname String
Database name for bootstrapping the initial connection. Example: defaultdb.
ignoreDbs String
Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment). Example: db1,db2.
ignoreRoles String
Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment). Example: role1,role2.
method String
Enum: dump, replication. The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types).
password String
Password for authentication with the server where to migrate data from. Example: jjKk45Nnd.
ssl Boolean
The server where to migrate data from is secured with SSL. Default: true.
username String
User name for authentication with the server where to migrate data from. Example: myname.
host This property is required. string
Hostname or IP address of the server where to migrate data from. Example: my.server.com.
port This property is required. number
Port number of the server where to migrate data from. Example: 1234.
dbname string
Database name for bootstrapping the initial connection. Example: defaultdb.
ignoreDbs string
Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment). Example: db1,db2.
ignoreRoles string
Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment). Example: role1,role2.
method string
Enum: dump, replication. The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types).
password string
Password for authentication with the server where to migrate data from. Example: jjKk45Nnd.
ssl boolean
The server where to migrate data from is secured with SSL. Default: true.
username string
User name for authentication with the server where to migrate data from. Example: myname.
host This property is required. str
Hostname or IP address of the server where to migrate data from. Example: my.server.com.
port This property is required. int
Port number of the server where to migrate data from. Example: 1234.
dbname str
Database name for bootstrapping the initial connection. Example: defaultdb.
ignore_dbs str
Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment). Example: db1,db2.
ignore_roles str
Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment). Example: role1,role2.
method str
Enum: dump, replication. The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types).
password str
Password for authentication with the server where to migrate data from. Example: jjKk45Nnd.
ssl bool
The server where to migrate data from is secured with SSL. Default: true.
username str
User name for authentication with the server where to migrate data from. Example: myname.
host This property is required. String
Hostname or IP address of the server where to migrate data from. Example: my.server.com.
port This property is required. Number
Port number of the server where to migrate data from. Example: 1234.
dbname String
Database name for bootstrapping the initial connection. Example: defaultdb.
ignoreDbs String
Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment). Example: db1,db2.
ignoreRoles String
Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment). Example: role1,role2.
method String
Enum: dump, replication. The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types).
password String
Password for authentication with the server where to migrate data from. Example: jjKk45Nnd.
ssl Boolean
The server where to migrate data from is secured with SSL. Default: true.
username String
User name for authentication with the server where to migrate data from. Example: myname.

ValkeyValkeyUserConfigPrivateAccess
, ValkeyValkeyUserConfigPrivateAccessArgs

Prometheus bool
Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
Valkey bool
Allow clients to connect to valkey with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
Prometheus bool
Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
Valkey bool
Allow clients to connect to valkey with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
prometheus Boolean
Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
valkey Boolean
Allow clients to connect to valkey with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
prometheus boolean
Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
valkey boolean
Allow clients to connect to valkey with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
prometheus bool
Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
valkey bool
Allow clients to connect to valkey with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
prometheus Boolean
Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
valkey Boolean
Allow clients to connect to valkey with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

ValkeyValkeyUserConfigPrivatelinkAccess
, ValkeyValkeyUserConfigPrivatelinkAccessArgs

Prometheus bool
Enable prometheus.
Valkey bool
Enable valkey.
Prometheus bool
Enable prometheus.
Valkey bool
Enable valkey.
prometheus Boolean
Enable prometheus.
valkey Boolean
Enable valkey.
prometheus boolean
Enable prometheus.
valkey boolean
Enable valkey.
prometheus bool
Enable prometheus.
valkey bool
Enable valkey.
prometheus Boolean
Enable prometheus.
valkey Boolean
Enable valkey.

ValkeyValkeyUserConfigPublicAccess
, ValkeyValkeyUserConfigPublicAccessArgs

Prometheus bool
Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
Valkey bool
Allow clients to connect to valkey from the public internet for service nodes that are in a project VPC or another type of private network.
Prometheus bool
Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
Valkey bool
Allow clients to connect to valkey from the public internet for service nodes that are in a project VPC or another type of private network.
prometheus Boolean
Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
valkey Boolean
Allow clients to connect to valkey from the public internet for service nodes that are in a project VPC or another type of private network.
prometheus boolean
Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
valkey boolean
Allow clients to connect to valkey from the public internet for service nodes that are in a project VPC or another type of private network.
prometheus bool
Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
valkey bool
Allow clients to connect to valkey from the public internet for service nodes that are in a project VPC or another type of private network.
prometheus Boolean
Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
valkey Boolean
Allow clients to connect to valkey from the public internet for service nodes that are in a project VPC or another type of private network.

Import

$ pulumi import aiven:index/valkey:Valkey example_valkey PROJECT/SERVICE_NAME
Copy

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

Package Details

Repository
Aiven pulumi/pulumi-aiven
License
Apache-2.0
Notes
This Pulumi package is based on the aiven Terraform Provider.
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven