aiven.Valkey
Explore with Pulumi AI
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",
},
});
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",
})
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
})
}
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",
},
});
});
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());
}
}
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
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 string
- The unique name of the resource.
- args ValkeyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args ValkeyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ValkeyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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,
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",
ValkeyIoThreads = 0,
ValkeyLfuDecayTime = 0,
ValkeyLfuLogFactor = 0,
ValkeyMaxmemoryPolicy = "string",
ValkeyNotifyKeyspaceEvents = "string",
ValkeyNumberOfDatabases = 0,
ValkeyPersistence = "string",
ValkeyPubsubClientOutputBufferLimit = 0,
ValkeySsl = false,
ValkeyTimeout = 0,
},
});
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),
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"),
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),
},
})
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)
.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")
.valkeyIoThreads(0)
.valkeyLfuDecayTime(0)
.valkeyLfuLogFactor(0)
.valkeyMaxmemoryPolicy("string")
.valkeyNotifyKeyspaceEvents("string")
.valkeyNumberOfDatabases(0)
.valkeyPersistence("string")
.valkeyPubsubClientOutputBufferLimit(0)
.valkeySsl(false)
.valkeyTimeout(0)
.build())
.build());
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,
"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_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,
})
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,
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",
valkeyIoThreads: 0,
valkeyLfuDecayTime: 0,
valkeyLfuLogFactor: 0,
valkeyMaxmemoryPolicy: "string",
valkeyNotifyKeyspaceEvents: "string",
valkeyNumberOfDatabases: 0,
valkeyPersistence: "string",
valkeyPubsubClientOutputBufferLimit: 0,
valkeySsl: false,
valkeyTimeout: 0,
},
});
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
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
valkeyIoThreads: 0
valkeyLfuDecayTime: 0
valkeyLfuLogFactor: 0
valkeyMaxmemoryPolicy: string
valkeyNotifyKeyspaceEvents: string
valkeyNumberOfDatabases: 0
valkeyPersistence: string
valkeyPubsubClientOutputBufferLimit: 0
valkeySsl: false
valkeyTimeout: 0
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 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
andpremium-x
wherex
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.
- Service
Name 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.
- Additional
Disk stringSpace - 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 with no HA capabilities.
- Cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - Disk
Space 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.
- Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Project
Vpc stringId - 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 List<ValkeyService Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- Static
Ips 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
- List<Valkey
Tag> - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails List<ValkeyTech Email> - 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
Server ValkeyValkey - Valkey server provided values
- Valkey
User ValkeyConfig Valkey User Config - 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 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
andpremium-x
wherex
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.
- Service
Name 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.
- Additional
Disk stringSpace - 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 with no HA capabilities.
- Cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - Disk
Space 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.
- Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Project
Vpc stringId - 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 []ValkeyService Integration Args - Service integrations to specify when creating a service. Not applied after initial service creation
- Static
Ips []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
- []Valkey
Tag Args - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails []ValkeyTech Email Args - 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
Valkey
Valkey Args - Valkey server provided values
- Valkey
User ValkeyConfig Valkey User Config Args - 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 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
andpremium-x
wherex
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.
- service
Name 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.
- additional
Disk StringSpace - 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 with no HA capabilities.
- cloud
Name String - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - disk
Space 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.
- maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project
Vpc StringId - 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 List<ValkeyService Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips 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
- List<Valkey
Tag> - Tags are key-value pairs that allow you to categorize services.
- tech
Emails List<ValkeyTech Email> - 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 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
Valkey
Valkey - Valkey server provided values
- valkey
User ValkeyConfig Valkey User Config - 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 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
andpremium-x
wherex
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.
- service
Name 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.
- additional
Disk stringSpace - 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 with no HA capabilities.
- cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - disk
Space 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.
- maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project
Vpc stringId - 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 ValkeyService Integration[] - Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips 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
- Valkey
Tag[] - Tags are key-value pairs that allow you to categorize services.
- tech
Emails ValkeyTech Email[] - 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 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
Valkey
Valkey - Valkey server provided values
- valkey
User ValkeyConfig Valkey User Config - 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 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
andpremium-x
wherex
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.
- 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.
- additional_
disk_ strspace - 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 with no HA capabilities.
- cloud_
name str - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - 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.
- maintenance_
window_ strdow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance_
window_ strtime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project_
vpc_ strid - 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[ValkeyService Integration Args] - 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
- Sequence[Valkey
Tag Args] - Tags are key-value pairs that allow you to categorize services.
- tech_
emails Sequence[ValkeyTech Email Args] - 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
Valkey
Valkey Args - Valkey server provided values
- valkey_
user_ Valkeyconfig Valkey User Config Args - 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 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
andpremium-x
wherex
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.
- service
Name 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.
- additional
Disk StringSpace - 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 with no HA capabilities.
- cloud
Name String - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - disk
Space 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.
- maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project
Vpc StringId - 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 List<Property Map> - Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips 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
- List<Property Map>
- Tags are key-value pairs that allow you to categorize services.
- tech
Emails 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.
- termination
Protection 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
- valkey
User Property MapConfig - 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<Valkey
Component> - Service component information objects
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Host string - The hostname of the service.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Components
[]Valkey
Component - Service component information objects
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Host string - The hostname of the service.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- components
List<Valkey
Component> - Service component information objects
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- id String
- The provider-assigned unique ID for this managed resource.
- service
Host String - The hostname of the service.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Integer - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- components
Valkey
Component[] - Service component information objects
- disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space stringUsed - Disk space that service is currently using
- id string
- The provider-assigned unique ID for this managed resource.
- service
Host string - The hostname of the service.
- service
Password string - Password used for connecting to the service, if applicable
- service
Port number - The port of the service
- service
Type string - Aiven internal service type code
- service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username string - Username used for connecting to the service, if applicable
- state string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- components
Sequence[Valkey
Component] - Service component information objects
- disk_
space_ strcap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk_
space_ strdefault - 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_ strstep - 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 fromdisk_space_default
by increments of this size. - disk_
space_ strused - Disk space that service is currently using
- 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
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- components List<Property Map>
- Service component information objects
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- id String
- The provider-assigned unique ID for this managed resource.
- service
Host String - The hostname of the service.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Number - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Additional
Disk stringSpace - 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 with no HA capabilities.
- Cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - Components
List<Valkey
Component> - Service component information objects
- Disk
Space 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.
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - 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
andpremium-x
wherex
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.
- Project
Vpc stringId - 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 string - The hostname of the service.
- Service
Integrations List<ValkeyService Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name 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.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Static
Ips 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
- List<Valkey
Tag> - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails List<ValkeyTech Email> - 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
Server ValkeyValkey - Valkey server provided values
- Valkey
User ValkeyConfig Valkey User Config - 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 stringSpace - 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 with no HA capabilities.
- Cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - Components
[]Valkey
Component Args - Service component information objects
- Disk
Space 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.
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - 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
andpremium-x
wherex
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.
- Project
Vpc stringId - 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 string - The hostname of the service.
- Service
Integrations []ValkeyService Integration Args - Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name 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.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Static
Ips []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
- []Valkey
Tag Args - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails []ValkeyTech Email Args - 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
Valkey
Valkey Args - Valkey server provided values
- Valkey
User ValkeyConfig Valkey User Config Args - 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 StringSpace - 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 with no HA capabilities.
- cloud
Name String - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - components
List<Valkey
Component> - Service component information objects
- disk
Space 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.
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - 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
andpremium-x
wherex
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.
- project
Vpc StringId - 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 String - The hostname of the service.
- service
Integrations List<ValkeyService Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Integer - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips 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
- List<Valkey
Tag> - Tags are key-value pairs that allow you to categorize services.
- tech
Emails List<ValkeyTech Email> - 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 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
Valkey
Valkey - Valkey server provided values
- valkey
User ValkeyConfig Valkey User Config - 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 stringSpace - 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 with no HA capabilities.
- cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - components
Valkey
Component[] - Service component information objects
- disk
Space 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.
- disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space stringUsed - Disk space that service is currently using
- maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window stringTime - 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
andpremium-x
wherex
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.
- project
Vpc stringId - 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 string - The hostname of the service.
- service
Integrations ValkeyService Integration[] - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password string - Password used for connecting to the service, if applicable
- service
Port number - The port of the service
- service
Type string - Aiven internal service type code
- service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username string - Username used for connecting to the service, if applicable
- state string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips 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
- Valkey
Tag[] - Tags are key-value pairs that allow you to categorize services.
- tech
Emails ValkeyTech Email[] - 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 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
Valkey
Valkey - Valkey server provided values
- valkey
User ValkeyConfig Valkey User Config - 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_ strspace - 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 with no HA capabilities.
- cloud_
name str - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - components
Sequence[Valkey
Component Args] - 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_ strcap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk_
space_ strdefault - 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_ strstep - 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 fromdisk_space_default
by increments of this size. - disk_
space_ strused - Disk space that service is currently using
- maintenance_
window_ strdow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance_
window_ strtime - 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
andpremium-x
wherex
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_ strid - 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[ValkeyService Integration Args] - 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
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- 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
- Sequence[Valkey
Tag Args] - Tags are key-value pairs that allow you to categorize services.
- tech_
emails Sequence[ValkeyTech Email Args] - 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
Valkey
Valkey Args - Valkey server provided values
- valkey_
user_ Valkeyconfig Valkey User Config Args - 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 StringSpace - 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 with no HA capabilities.
- cloud
Name String - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - components List<Property Map>
- Service component information objects
- disk
Space 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.
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - 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
andpremium-x
wherex
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.
- project
Vpc StringId - 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 String - The hostname of the service.
- service
Integrations List<Property Map> - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Number - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips 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
- List<Property Map>
- Tags are key-value pairs that allow you to categorize services.
- tech
Emails 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.
- termination
Protection 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
- valkey
User Property MapConfig - 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
- Connection
Uri 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
- Kafka
Authentication stringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- 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
- Connection
Uri 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
- Kafka
Authentication stringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- 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
- connection
Uri 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
- kafka
Authentication StringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- 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
- connection
Uri 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
- kafka
Authentication stringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- 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_ strmethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- 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
- connection
Uri 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
- kafka
Authentication StringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- 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
- Integration
Type string - Type of the service integration. The only supported value at the moment is
read_replica
- Source
Service stringName - Name of the source service
- Integration
Type string - Type of the service integration. The only supported value at the moment is
read_replica
- Source
Service stringName - Name of the source service
- integration
Type String - Type of the service integration. The only supported value at the moment is
read_replica
- source
Service StringName - Name of the source service
- integration
Type string - Type of the service integration. The only supported value at the moment is
read_replica
- source
Service stringName - Name of the source service
- integration_
type str - Type of the service integration. The only supported value at the moment is
read_replica
- source_
service_ strname - Name of the source service
- integration
Type String - Type of the service integration. The only supported value at the moment is
read_replica
- source
Service StringName - Name of the source service
ValkeyTag, ValkeyTagArgs
ValkeyTechEmail, ValkeyTechEmailArgs
- 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
ValkeyValkey, ValkeyValkeyArgs
- Password string
- Valkey password.
- Replica
Uri string - Valkey replica server URI.
- Slave
Uris List<string> - Valkey slave server URIs.
- Uris List<string>
- Valkey server URIs.
- Password string
- Valkey password.
- Replica
Uri string - Valkey replica server URI.
- Slave
Uris []string - Valkey slave server URIs.
- Uris []string
- Valkey server URIs.
- password String
- Valkey password.
- replica
Uri String - Valkey replica server URI.
- slave
Uris List<String> - Valkey slave server URIs.
- uris List<String>
- Valkey server URIs.
- password string
- Valkey password.
- replica
Uri string - Valkey replica server URI.
- slave
Uris 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.
- replica
Uri String - Valkey replica server URI.
- slave
Uris List<String> - Valkey slave server URIs.
- uris List<String>
- Valkey server URIs.
ValkeyValkeyUserConfig, ValkeyValkeyUserConfigArgs
- Additional
Backup stringRegions - 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
. - Ip
Filter List<ValkeyObjects Valkey User Config Ip Filter Object> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- Ip
Filter List<string>Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - Ip
Filters List<string> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - Migration
Valkey
Valkey User Config Migration - Migrate data from existing server
- Private
Access ValkeyValkey User Config Private Access - Allow access to selected service ports from private networks
- Privatelink
Access ValkeyValkey User Config Privatelink Access - Allow access to selected service components through Privatelink
- Project
To stringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - Public
Access ValkeyValkey User Config Public Access - Allow access to selected service ports from the public Internet
- Recovery
Basebackup stringName - 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 stringFork From - 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 stringChannels Default - 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
Io intThreads - Set Valkey IO thread count. Changing this will cause a restart of the Valkey service. Example:
1
. - Valkey
Lfu intDecay Time - LFU maxmemory-policy counter decay time in minutes. Default:
1
. - Valkey
Lfu intLog Factor - Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies. Default:
10
. - Valkey
Maxmemory stringPolicy - Enum:
allkeys-lfu
,allkeys-lru
,allkeys-random
,noeviction
,volatile-lfu
,volatile-lru
,volatile-random
,volatile-ttl
. Valkey maxmemory-policy. Default:noeviction
. - Valkey
Notify stringKeyspace Events - Set notify-keyspace-events option.
- Valkey
Number intOf Databases - Set number of Valkey databases. Changing this will cause a restart of the Valkey service. Example:
16
. - Valkey
Persistence string - Enum:
off
,rdb
. When persistence isrdb
, 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 isoff
, 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 intClient Output Buffer Limit - 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
.
- Additional
Backup stringRegions - 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
. - Ip
Filter []ValkeyObjects Valkey User Config Ip Filter Object - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- Ip
Filter []stringStrings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - Ip
Filters []string - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - Migration
Valkey
Valkey User Config Migration - Migrate data from existing server
- Private
Access ValkeyValkey User Config Private Access - Allow access to selected service ports from private networks
- Privatelink
Access ValkeyValkey User Config Privatelink Access - Allow access to selected service components through Privatelink
- Project
To stringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - Public
Access ValkeyValkey User Config Public Access - Allow access to selected service ports from the public Internet
- Recovery
Basebackup stringName - 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 stringFork From - 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 stringChannels Default - 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
Io intThreads - Set Valkey IO thread count. Changing this will cause a restart of the Valkey service. Example:
1
. - Valkey
Lfu intDecay Time - LFU maxmemory-policy counter decay time in minutes. Default:
1
. - Valkey
Lfu intLog Factor - Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies. Default:
10
. - Valkey
Maxmemory stringPolicy - Enum:
allkeys-lfu
,allkeys-lru
,allkeys-random
,noeviction
,volatile-lfu
,volatile-lru
,volatile-random
,volatile-ttl
. Valkey maxmemory-policy. Default:noeviction
. - Valkey
Notify stringKeyspace Events - Set notify-keyspace-events option.
- Valkey
Number intOf Databases - Set number of Valkey databases. Changing this will cause a restart of the Valkey service. Example:
16
. - Valkey
Persistence string - Enum:
off
,rdb
. When persistence isrdb
, 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 isoff
, 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 intClient Output Buffer Limit - 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
.
- additional
Backup StringRegions - Additional Cloud Regions for Backup Replication.
- backup
Hour 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
. - backup
Minute 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
. - ip
Filter List<ValkeyObjects Valkey User Config Ip Filter Object> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip
Filter List<String>Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - ip
Filters List<String> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - migration
Valkey
Valkey User Config Migration - Migrate data from existing server
- private
Access ValkeyValkey User Config Private Access - Allow access to selected service ports from private networks
- privatelink
Access ValkeyValkey User Config Privatelink Access - Allow access to selected service components through Privatelink
- project
To StringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - public
Access ValkeyValkey User Config Public Access - Allow access to selected service ports from the public Internet
- recovery
Basebackup StringName - Name of the basebackup to restore in forked service. Example:
backup-20191112t091354293891z
. - service
Log Boolean - Store logs for the service so that they are available in the HTTP API and console.
- service
To StringFork From - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename
. - static
Ips Boolean - Use static public IP addresses.
- valkey
Acl StringChannels Default - 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
Io IntegerThreads - Set Valkey IO thread count. Changing this will cause a restart of the Valkey service. Example:
1
. - valkey
Lfu IntegerDecay Time - LFU maxmemory-policy counter decay time in minutes. Default:
1
. - valkey
Lfu IntegerLog Factor - Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies. Default:
10
. - valkey
Maxmemory StringPolicy - Enum:
allkeys-lfu
,allkeys-lru
,allkeys-random
,noeviction
,volatile-lfu
,volatile-lru
,volatile-random
,volatile-ttl
. Valkey maxmemory-policy. Default:noeviction
. - valkey
Notify StringKeyspace Events - Set notify-keyspace-events option.
- valkey
Number IntegerOf Databases - Set number of Valkey databases. Changing this will cause a restart of the Valkey service. Example:
16
. - valkey
Persistence String - Enum:
off
,rdb
. When persistence isrdb
, 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 isoff
, 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 IntegerClient Output Buffer Limit - 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 Boolean - Require SSL to access Valkey. Default:
true
. - valkey
Timeout Integer - Valkey idle connection timeout in seconds. Default:
300
.
- additional
Backup stringRegions - Additional Cloud Regions for Backup Replication.
- backup
Hour 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
. - backup
Minute 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
. - ip
Filter ValkeyObjects Valkey User Config Ip Filter Object[] - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip
Filter string[]Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - ip
Filters string[] - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - migration
Valkey
Valkey User Config Migration - Migrate data from existing server
- private
Access ValkeyValkey User Config Private Access - Allow access to selected service ports from private networks
- privatelink
Access ValkeyValkey User Config Privatelink Access - Allow access to selected service components through Privatelink
- project
To stringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - public
Access ValkeyValkey User Config Public Access - Allow access to selected service ports from the public Internet
- recovery
Basebackup stringName - Name of the basebackup to restore in forked service. Example:
backup-20191112t091354293891z
. - service
Log boolean - Store logs for the service so that they are available in the HTTP API and console.
- service
To stringFork From - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename
. - static
Ips boolean - Use static public IP addresses.
- valkey
Acl stringChannels Default - 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
Io numberThreads - Set Valkey IO thread count. Changing this will cause a restart of the Valkey service. Example:
1
. - valkey
Lfu numberDecay Time - LFU maxmemory-policy counter decay time in minutes. Default:
1
. - valkey
Lfu numberLog Factor - Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies. Default:
10
. - valkey
Maxmemory stringPolicy - Enum:
allkeys-lfu
,allkeys-lru
,allkeys-random
,noeviction
,volatile-lfu
,volatile-lru
,volatile-random
,volatile-ttl
. Valkey maxmemory-policy. Default:noeviction
. - valkey
Notify stringKeyspace Events - Set notify-keyspace-events option.
- valkey
Number numberOf Databases - Set number of Valkey databases. Changing this will cause a restart of the Valkey service. Example:
16
. - valkey
Persistence string - Enum:
off
,rdb
. When persistence isrdb
, 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 isoff
, 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 numberClient Output Buffer Limit - 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 boolean - Require SSL to access Valkey. Default:
true
. - valkey
Timeout number - Valkey idle connection timeout in seconds. Default:
300
.
- additional_
backup_ strregions - 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
. - ip_
filter_ Sequence[Valkeyobjects Valkey User Config Ip Filter Object] - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip_
filter_ Sequence[str]strings - 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
. - migration
Valkey
Valkey User Config Migration - Migrate data from existing server
- private_
access ValkeyValkey User Config Private Access - Allow access to selected service ports from private networks
- privatelink_
access ValkeyValkey User Config Privatelink Access - Allow access to selected service components through Privatelink
- project_
to_ strfork_ from - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - public_
access ValkeyValkey User Config Public Access - Allow access to selected service ports from the public Internet
- recovery_
basebackup_ strname - 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_ strfork_ from - 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_ strchannels_ default - 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_
io_ intthreads - Set Valkey IO thread count. Changing this will cause a restart of the Valkey service. Example:
1
. - valkey_
lfu_ intdecay_ time - LFU maxmemory-policy counter decay time in minutes. Default:
1
. - valkey_
lfu_ intlog_ factor - Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies. Default:
10
. - valkey_
maxmemory_ strpolicy - Enum:
allkeys-lfu
,allkeys-lru
,allkeys-random
,noeviction
,volatile-lfu
,volatile-lru
,volatile-random
,volatile-ttl
. Valkey maxmemory-policy. Default:noeviction
. - valkey_
notify_ strkeyspace_ events - Set notify-keyspace-events option.
- valkey_
number_ intof_ databases - 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 isrdb
, 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 isoff
, 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_ intclient_ output_ buffer_ limit - 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
.
- additional
Backup StringRegions - Additional Cloud Regions for Backup Replication.
- backup
Hour 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
. - backup
Minute 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
. - ip
Filter List<Property Map>Objects - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip
Filter List<String>Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - ip
Filters List<String> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - migration Property Map
- Migrate data from existing server
- private
Access Property Map - Allow access to selected service ports from private networks
- privatelink
Access Property Map - Allow access to selected service components through Privatelink
- project
To StringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - public
Access Property Map - Allow access to selected service ports from the public Internet
- recovery
Basebackup StringName - Name of the basebackup to restore in forked service. Example:
backup-20191112t091354293891z
. - service
Log Boolean - Store logs for the service so that they are available in the HTTP API and console.
- service
To StringFork From - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename
. - static
Ips Boolean - Use static public IP addresses.
- valkey
Acl StringChannels Default - 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
Io NumberThreads - Set Valkey IO thread count. Changing this will cause a restart of the Valkey service. Example:
1
. - valkey
Lfu NumberDecay Time - LFU maxmemory-policy counter decay time in minutes. Default:
1
. - valkey
Lfu NumberLog Factor - Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies. Default:
10
. - valkey
Maxmemory StringPolicy - Enum:
allkeys-lfu
,allkeys-lru
,allkeys-random
,noeviction
,volatile-lfu
,volatile-lru
,volatile-random
,volatile-ttl
. Valkey maxmemory-policy. Default:noeviction
. - valkey
Notify StringKeyspace Events - Set notify-keyspace-events option.
- valkey
Number NumberOf Databases - Set number of Valkey databases. Changing this will cause a restart of the Valkey service. Example:
16
. - valkey
Persistence String - Enum:
off
,rdb
. When persistence isrdb
, 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 isoff
, 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 NumberClient Output Buffer Limit - 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 Boolean - Require SSL to access Valkey. Default:
true
. - valkey
Timeout Number - Valkey idle connection timeout in seconds. Default:
300
.
ValkeyValkeyUserConfigIpFilterObject, ValkeyValkeyUserConfigIpFilterObjectArgs
- 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
.
ValkeyValkeyUserConfigMigration, ValkeyValkeyUserConfigMigrationArgs
- 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
. - Ignore
Dbs string - 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 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
. - Ignore
Dbs string - 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 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
. - ignore
Dbs String - 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 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
. - ignore
Dbs string - 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 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
. - ignore
Dbs String - 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 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
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.