Aiven v6.37.0, Apr 10 25

Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi

aiven.getValkey

Explore with Pulumi AI

Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi

Example Usage

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

const exampleValkey = aiven.getValkey({
    project: exampleProject.project,
    serviceName: "example-valkey-service",
});

import pulumi
import pulumi_aiven as aiven

example_valkey = aiven.get_valkey(project=example_project["project"],
    service_name="example-valkey-service")

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.LookupValkey(ctx, &aiven.LookupValkeyArgs{
			Project:     exampleProject.Project,
			ServiceName: "example-valkey-service",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var exampleValkey = Aiven.GetValkey.Invoke(new()
    {
        Project = exampleProject.Project,
        ServiceName = "example-valkey-service",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.AivenFunctions;
import com.pulumi.aiven.inputs.GetValkeyArgs;
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) {
        final var exampleValkey = AivenFunctions.getValkey(GetValkeyArgs.builder()
            .project(exampleProject.project())
            .serviceName("example-valkey-service")
            .build());

    }
}

variables:
  exampleValkey:
    fn::invoke:
      function: aiven:getValkey
      arguments:
        project: ${exampleProject.project}
        serviceName: example-valkey-service

Using getValkey

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getValkey(args: GetValkeyArgs, opts?: InvokeOptions): Promise<GetValkeyResult>
function getValkeyOutput(args: GetValkeyOutputArgs, opts?: InvokeOptions): Output<GetValkeyResult>

def get_valkey(project: Optional[str] = None,
               service_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetValkeyResult
def get_valkey_output(project: Optional[pulumi.Input[str]] = None,
               service_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetValkeyResult]

func LookupValkey(ctx *Context, args *LookupValkeyArgs, opts ...InvokeOption) (*LookupValkeyResult, error)
func LookupValkeyOutput(ctx *Context, args *LookupValkeyOutputArgs, opts ...InvokeOption) LookupValkeyResultOutput

> Note: This function is named LookupValkey in the Go SDK.

public static class GetValkey 
{
    public static Task<GetValkeyResult> InvokeAsync(GetValkeyArgs args, InvokeOptions? opts = null)
    public static Output<GetValkeyResult> Invoke(GetValkeyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetValkeyResult> getValkey(GetValkeyArgs args, InvokeOptions options)
public static Output<GetValkeyResult> getValkey(GetValkeyArgs args, InvokeOptions options)

fn::invoke:
  function: aiven:index/getValkey:getValkey
  arguments:
    # arguments dictionary

The following arguments are supported:

Project 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 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.

Project 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 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.

project 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 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.

project 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 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.

project 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 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.

project 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 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.

getValkey Result

The following output properties are available:

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<GetValkeyComponent>: 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.
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
Id string: The provider-assigned unique ID for this managed resource.
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 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<GetValkeyServiceIntegration>: Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName 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<GetValkeyTag>: Tags are key-value pairs that allow you to categorize services.
TechEmails List<GetValkeyTechEmail>: 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.
ValkeyUserConfigs List<GetValkeyValkeyUserConfig>: Valkey user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
Valkeys List<GetValkeyValkey>: Valkey server provided values

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 []GetValkeyComponent: 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.
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
Id string: The provider-assigned unique ID for this managed resource.
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 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 []GetValkeyServiceIntegration: Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName 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 []GetValkeyTag: Tags are key-value pairs that allow you to categorize services.
TechEmails []GetValkeyTechEmail: 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.
ValkeyUserConfigs []GetValkeyValkeyUserConfig: Valkey user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
Valkeys []GetValkeyValkey: Valkey server provided values

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<GetValkeyComponent>: 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.
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
id String: The provider-assigned unique ID for this managed resource.
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 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<GetValkeyServiceIntegration>: Service integrations to specify when creating a service. Not applied after initial service creation
serviceName 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<GetValkeyTag>: Tags are key-value pairs that allow you to categorize services.
techEmails List<GetValkeyTechEmail>: 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.
valkeyUserConfigs List<GetValkeyValkeyUserConfig>: Valkey user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
valkeys List<GetValkeyValkey>: Valkey server provided values

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 GetValkeyComponent[]: 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.
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
id string: The provider-assigned unique ID for this managed resource.
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 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 GetValkeyServiceIntegration[]: Service integrations to specify when creating a service. Not applied after initial service creation
serviceName 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 GetValkeyTag[]: Tags are key-value pairs that allow you to categorize services.
techEmails GetValkeyTechEmail[]: 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.
valkeyUserConfigs GetValkeyValkeyUserConfig[]: Valkey user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
valkeys GetValkeyValkey[]: Valkey server provided values

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[GetValkeyComponent]: 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.
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
id str: The provider-assigned unique ID for this managed resource.
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 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[GetValkeyServiceIntegration]: Service integrations to specify when creating a service. Not applied after initial service creation
service_name 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[GetValkeyTag]: Tags are key-value pairs that allow you to categorize services.
tech_emails Sequence[GetValkeyTechEmail]: 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_user_configs Sequence[GetValkeyValkeyUserConfig]: Valkey user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
valkeys Sequence[GetValkeyValkey]: Valkey server provided values

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.
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
id String: The provider-assigned unique ID for this managed resource.
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 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 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.
valkeyUserConfigs List<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
valkeys List<Property Map>: Valkey server provided values

Supporting Types

GetValkeyComponent

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

GetValkeyServiceIntegration

IntegrationType string: Type of the service integration. The possible value is read_replica.
SourceServiceName string: Name of the source service

IntegrationType string: Type of the service integration. The possible value is read_replica.
SourceServiceName string: Name of the source service

integrationType String: Type of the service integration. The possible value is read_replica.
sourceServiceName String: Name of the source service

integrationType string: Type of the service integration. The possible value is read_replica.
sourceServiceName string: Name of the source service

integration_type str: Type of the service integration. The possible value is read_replica.
source_service_name str: Name of the source service

integrationType String: Type of the service integration. The possible value is read_replica.
sourceServiceName String: Name of the source service

GetValkeyTag

Key string: Service tag key
Value string: Service tag value

Key string: Service tag key
Value string: Service tag value

key String: Service tag key
value String: Service tag value

key string: Service tag key
value string: Service tag value

key str: Service tag key
value str: Service tag value

key String: Service tag key
value String: Service tag value

GetValkeyTechEmail

Email string: An email address to contact for technical issues

Email string: An email address to contact for technical issues

email String: An email address to contact for technical issues

email string: An email address to contact for technical issues

email str: An email address to contact for technical issues

email String: An email address to contact for technical issues

GetValkeyValkey

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.

GetValkeyValkeyUserConfig

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<GetValkeyValkeyUserConfigIpFilterObject>: 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 GetValkeyValkeyUserConfigMigration: Migrate data from existing server
PrivateAccess GetValkeyValkeyUserConfigPrivateAccess: Allow access to selected service ports from private networks
PrivatelinkAccess GetValkeyValkeyUserConfigPrivatelinkAccess: Allow access to selected service components through Privatelink
ProjectToForkFrom string: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
PublicAccess GetValkeyValkeyUserConfigPublicAccess: 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 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 []GetValkeyValkeyUserConfigIpFilterObject: 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 GetValkeyValkeyUserConfigMigration: Migrate data from existing server
PrivateAccess GetValkeyValkeyUserConfigPrivateAccess: Allow access to selected service ports from private networks
PrivatelinkAccess GetValkeyValkeyUserConfigPrivatelinkAccess: Allow access to selected service components through Privatelink
ProjectToForkFrom string: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
PublicAccess GetValkeyValkeyUserConfigPublicAccess: 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 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<GetValkeyValkeyUserConfigIpFilterObject>: 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 GetValkeyValkeyUserConfigMigration: Migrate data from existing server
privateAccess GetValkeyValkeyUserConfigPrivateAccess: Allow access to selected service ports from private networks
privatelinkAccess GetValkeyValkeyUserConfigPrivatelinkAccess: Allow access to selected service components through Privatelink
projectToForkFrom String: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
publicAccess GetValkeyValkeyUserConfigPublicAccess: 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 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 GetValkeyValkeyUserConfigIpFilterObject[]: 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 GetValkeyValkeyUserConfigMigration: Migrate data from existing server
privateAccess GetValkeyValkeyUserConfigPrivateAccess: Allow access to selected service ports from private networks
privatelinkAccess GetValkeyValkeyUserConfigPrivatelinkAccess: Allow access to selected service components through Privatelink
projectToForkFrom string: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
publicAccess GetValkeyValkeyUserConfigPublicAccess: 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 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[GetValkeyValkeyUserConfigIpFilterObject]: 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 GetValkeyValkeyUserConfigMigration: Migrate data from existing server
private_access GetValkeyValkeyUserConfigPrivateAccess: Allow access to selected service ports from private networks
privatelink_access GetValkeyValkeyUserConfigPrivatelinkAccess: Allow access to selected service components through Privatelink
project_to_fork_from 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 GetValkeyValkeyUserConfigPublicAccess: 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 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 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 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.

GetValkeyValkeyUserConfigIpFilterObject

Network string: CIDR address block. Example: 10.20.0.0/16.
Description string: Description for IP filter list entry. Example: Production service IP range.

Network string: CIDR address block. Example: 10.20.0.0/16.
Description string: Description for IP filter list entry. Example: Production service IP range.

network String: CIDR address block. Example: 10.20.0.0/16.
description String: Description for IP filter list entry. Example: Production service IP range.

network string: CIDR address block. Example: 10.20.0.0/16.
description string: Description for IP filter list entry. Example: Production service IP range.

network str: CIDR address block. Example: 10.20.0.0/16.
description str: Description for IP filter list entry. Example: Production service IP range.

network String: CIDR address block. Example: 10.20.0.0/16.
description String: Description for IP filter list entry. Example: Production service IP range.

GetValkeyValkeyUserConfigMigration

Host string: Hostname or IP address of the server where to migrate data from. Example: my.server.com.
Port 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 string: Hostname or IP address of the server where to migrate data from. Example: my.server.com.
Port 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 String: Hostname or IP address of the server where to migrate data from. Example: my.server.com.
port 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 string: Hostname or IP address of the server where to migrate data from. Example: my.server.com.
port 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 str: Hostname or IP address of the server where to migrate data from. Example: my.server.com.
port 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 String: Hostname or IP address of the server where to migrate data from. Example: my.server.com.
port 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.

GetValkeyValkeyUserConfigPrivateAccess

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.

GetValkeyValkeyUserConfigPrivatelinkAccess

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.

GetValkeyValkeyUserConfigPublicAccess

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.

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

aiven.getValkey

On this page

On this page

Example Usage

Using getValkey

getValkey Result

Supporting Types

GetValkeyComponent

GetValkeyServiceIntegration

GetValkeyTag

GetValkeyTechEmail

GetValkeyValkey

GetValkeyValkeyUserConfig

GetValkeyValkeyUserConfigIpFilterObject

GetValkeyValkeyUserConfigMigration

GetValkeyValkeyUserConfigPrivateAccess

GetValkeyValkeyUserConfigPrivatelinkAccess

GetValkeyValkeyUserConfigPublicAccess

Package Details

On this page

On this page