published on Monday, Mar 9, 2026 by Pulumi
published on Monday, Mar 9, 2026 by Pulumi
The Redis resource allows the creation and management of Aiven Redis services.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Aiven = Pulumi.Aiven;
return await Deployment.RunAsync(() =>
{
var redis1 = new Aiven.Redis("redis1", new()
{
Project = data.Aiven_project.Pr1.Project,
CloudName = "google-europe-west1",
Plan = "business-4",
ServiceName = "my-redis1",
MaintenanceWindowDow = "monday",
MaintenanceWindowTime = "10:00:00",
RedisUserConfig = new Aiven.Inputs.RedisRedisUserConfigArgs
{
RedisMaxmemoryPolicy = "allkeys-random",
PublicAccess = new Aiven.Inputs.RedisRedisUserConfigPublicAccessArgs
{
Redis = "true",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aiven/sdk/v5/go/aiven"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := aiven.NewRedis(ctx, "redis1", &aiven.RedisArgs{
Project: pulumi.Any(data.Aiven_project.Pr1.Project),
CloudName: pulumi.String("google-europe-west1"),
Plan: pulumi.String("business-4"),
ServiceName: pulumi.String("my-redis1"),
MaintenanceWindowDow: pulumi.String("monday"),
MaintenanceWindowTime: pulumi.String("10:00:00"),
RedisUserConfig: &aiven.RedisRedisUserConfigArgs{
RedisMaxmemoryPolicy: pulumi.String("allkeys-random"),
PublicAccess: &aiven.RedisRedisUserConfigPublicAccessArgs{
Redis: pulumi.String("true"),
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.Redis;
import com.pulumi.aiven.RedisArgs;
import com.pulumi.aiven.inputs.RedisRedisUserConfigArgs;
import com.pulumi.aiven.inputs.RedisRedisUserConfigPublicAccessArgs;
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 redis1 = new Redis("redis1", RedisArgs.builder()
.project(data.aiven_project().pr1().project())
.cloudName("google-europe-west1")
.plan("business-4")
.serviceName("my-redis1")
.maintenanceWindowDow("monday")
.maintenanceWindowTime("10:00:00")
.redisUserConfig(RedisRedisUserConfigArgs.builder()
.redisMaxmemoryPolicy("allkeys-random")
.publicAccess(RedisRedisUserConfigPublicAccessArgs.builder()
.redis(true)
.build())
.build())
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";
const redis1 = new aiven.Redis("redis1", {
project: data.aiven_project.pr1.project,
cloudName: "google-europe-west1",
plan: "business-4",
serviceName: "my-redis1",
maintenanceWindowDow: "monday",
maintenanceWindowTime: "10:00:00",
redisUserConfig: {
redisMaxmemoryPolicy: "allkeys-random",
publicAccess: {
redis: "true",
},
},
});
import pulumi
import pulumi_aiven as aiven
redis1 = aiven.Redis("redis1",
project=data["aiven_project"]["pr1"]["project"],
cloud_name="google-europe-west1",
plan="business-4",
service_name="my-redis1",
maintenance_window_dow="monday",
maintenance_window_time="10:00:00",
redis_user_config=aiven.RedisRedisUserConfigArgs(
redis_maxmemory_policy="allkeys-random",
public_access=aiven.RedisRedisUserConfigPublicAccessArgs(
redis="true",
),
))
resources:
redis1:
type: aiven:Redis
properties:
project: ${data.aiven_project.pr1.project}
cloudName: google-europe-west1
plan: business-4
serviceName: my-redis1
maintenanceWindowDow: monday
maintenanceWindowTime: 10:00:00
redisUserConfig:
redisMaxmemoryPolicy: allkeys-random
publicAccess:
redis: true
Create Redis Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Redis(name: string, args: RedisArgs, opts?: CustomResourceOptions);@overload
def Redis(resource_name: str,
args: RedisArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Redis(resource_name: str,
opts: Optional[ResourceOptions] = None,
project: Optional[str] = None,
service_name: Optional[str] = None,
maintenance_window_dow: Optional[str] = None,
additional_disk_space: Optional[str] = None,
maintenance_window_time: Optional[str] = None,
plan: Optional[str] = None,
disk_space: Optional[str] = None,
project_vpc_id: Optional[str] = None,
redis_user_config: Optional[RedisRedisUserConfigArgs] = None,
service_integrations: Optional[Sequence[RedisServiceIntegrationArgs]] = None,
cloud_name: Optional[str] = None,
static_ips: Optional[Sequence[str]] = None,
tags: Optional[Sequence[RedisTagArgs]] = None,
termination_protection: Optional[bool] = None)func NewRedis(ctx *Context, name string, args RedisArgs, opts ...ResourceOption) (*Redis, error)public Redis(string name, RedisArgs args, CustomResourceOptions? opts = null)type: aiven:Redis
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 RedisArgs
- 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 RedisArgs
- 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 RedisArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RedisArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RedisArgs
- 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 redisResource = new Aiven.Redis("redisResource", new()
{
Project = "string",
ServiceName = "string",
MaintenanceWindowDow = "string",
AdditionalDiskSpace = "string",
MaintenanceWindowTime = "string",
Plan = "string",
DiskSpace = "string",
ProjectVpcId = "string",
RedisUserConfig = new Aiven.Inputs.RedisRedisUserConfigArgs
{
AdditionalBackupRegions = "string",
IpFilterObjects = new[]
{
new Aiven.Inputs.RedisRedisUserConfigIpFilterObjectArgs
{
Description = "string",
Network = "string",
},
},
IpFilters = new[]
{
"string",
},
Migration = new Aiven.Inputs.RedisRedisUserConfigMigrationArgs
{
Dbname = "string",
Host = "string",
IgnoreDbs = "string",
Method = "string",
Password = "string",
Port = "string",
Ssl = "string",
Username = "string",
},
PrivateAccess = new Aiven.Inputs.RedisRedisUserConfigPrivateAccessArgs
{
Prometheus = "string",
Redis = "string",
},
PrivatelinkAccess = new Aiven.Inputs.RedisRedisUserConfigPrivatelinkAccessArgs
{
Prometheus = "string",
Redis = "string",
},
ProjectToForkFrom = "string",
PublicAccess = new Aiven.Inputs.RedisRedisUserConfigPublicAccessArgs
{
Prometheus = "string",
Redis = "string",
},
RecoveryBasebackupName = "string",
RedisAclChannelsDefault = "string",
RedisIoThreads = "string",
RedisLfuDecayTime = "string",
RedisLfuLogFactor = "string",
RedisMaxmemoryPolicy = "string",
RedisNotifyKeyspaceEvents = "string",
RedisNumberOfDatabases = "string",
RedisPersistence = "string",
RedisPubsubClientOutputBufferLimit = "string",
RedisSsl = "string",
RedisTimeout = "string",
ServiceToForkFrom = "string",
StaticIps = "string",
},
ServiceIntegrations = new[]
{
new Aiven.Inputs.RedisServiceIntegrationArgs
{
IntegrationType = "string",
SourceServiceName = "string",
},
},
CloudName = "string",
StaticIps = new[]
{
"string",
},
Tags = new[]
{
new Aiven.Inputs.RedisTagArgs
{
Key = "string",
Value = "string",
},
},
TerminationProtection = false,
});
example, err := aiven.NewRedis(ctx, "redisResource", &aiven.RedisArgs{
Project: pulumi.String("string"),
ServiceName: pulumi.String("string"),
MaintenanceWindowDow: pulumi.String("string"),
AdditionalDiskSpace: pulumi.String("string"),
MaintenanceWindowTime: pulumi.String("string"),
Plan: pulumi.String("string"),
DiskSpace: pulumi.String("string"),
ProjectVpcId: pulumi.String("string"),
RedisUserConfig: &aiven.RedisRedisUserConfigArgs{
AdditionalBackupRegions: pulumi.String("string"),
IpFilterObjects: aiven.RedisRedisUserConfigIpFilterObjectArray{
&aiven.RedisRedisUserConfigIpFilterObjectArgs{
Description: pulumi.String("string"),
Network: pulumi.String("string"),
},
},
IpFilters: pulumi.StringArray{
pulumi.String("string"),
},
Migration: &aiven.RedisRedisUserConfigMigrationArgs{
Dbname: pulumi.String("string"),
Host: pulumi.String("string"),
IgnoreDbs: pulumi.String("string"),
Method: pulumi.String("string"),
Password: pulumi.String("string"),
Port: pulumi.String("string"),
Ssl: pulumi.String("string"),
Username: pulumi.String("string"),
},
PrivateAccess: &aiven.RedisRedisUserConfigPrivateAccessArgs{
Prometheus: pulumi.String("string"),
Redis: pulumi.String("string"),
},
PrivatelinkAccess: &aiven.RedisRedisUserConfigPrivatelinkAccessArgs{
Prometheus: pulumi.String("string"),
Redis: pulumi.String("string"),
},
ProjectToForkFrom: pulumi.String("string"),
PublicAccess: &aiven.RedisRedisUserConfigPublicAccessArgs{
Prometheus: pulumi.String("string"),
Redis: pulumi.String("string"),
},
RecoveryBasebackupName: pulumi.String("string"),
RedisAclChannelsDefault: pulumi.String("string"),
RedisIoThreads: pulumi.String("string"),
RedisLfuDecayTime: pulumi.String("string"),
RedisLfuLogFactor: pulumi.String("string"),
RedisMaxmemoryPolicy: pulumi.String("string"),
RedisNotifyKeyspaceEvents: pulumi.String("string"),
RedisNumberOfDatabases: pulumi.String("string"),
RedisPersistence: pulumi.String("string"),
RedisPubsubClientOutputBufferLimit: pulumi.String("string"),
RedisSsl: pulumi.String("string"),
RedisTimeout: pulumi.String("string"),
ServiceToForkFrom: pulumi.String("string"),
StaticIps: pulumi.String("string"),
},
ServiceIntegrations: aiven.RedisServiceIntegrationArray{
&aiven.RedisServiceIntegrationArgs{
IntegrationType: pulumi.String("string"),
SourceServiceName: pulumi.String("string"),
},
},
CloudName: pulumi.String("string"),
StaticIps: pulumi.StringArray{
pulumi.String("string"),
},
Tags: aiven.RedisTagArray{
&aiven.RedisTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
TerminationProtection: pulumi.Bool(false),
})
var redisResource = new Redis("redisResource", RedisArgs.builder()
.project("string")
.serviceName("string")
.maintenanceWindowDow("string")
.additionalDiskSpace("string")
.maintenanceWindowTime("string")
.plan("string")
.diskSpace("string")
.projectVpcId("string")
.redisUserConfig(RedisRedisUserConfigArgs.builder()
.additionalBackupRegions("string")
.ipFilterObjects(RedisRedisUserConfigIpFilterObjectArgs.builder()
.description("string")
.network("string")
.build())
.ipFilters("string")
.migration(RedisRedisUserConfigMigrationArgs.builder()
.dbname("string")
.host("string")
.ignoreDbs("string")
.method("string")
.password("string")
.port("string")
.ssl("string")
.username("string")
.build())
.privateAccess(RedisRedisUserConfigPrivateAccessArgs.builder()
.prometheus("string")
.redis("string")
.build())
.privatelinkAccess(RedisRedisUserConfigPrivatelinkAccessArgs.builder()
.prometheus("string")
.redis("string")
.build())
.projectToForkFrom("string")
.publicAccess(RedisRedisUserConfigPublicAccessArgs.builder()
.prometheus("string")
.redis("string")
.build())
.recoveryBasebackupName("string")
.redisAclChannelsDefault("string")
.redisIoThreads("string")
.redisLfuDecayTime("string")
.redisLfuLogFactor("string")
.redisMaxmemoryPolicy("string")
.redisNotifyKeyspaceEvents("string")
.redisNumberOfDatabases("string")
.redisPersistence("string")
.redisPubsubClientOutputBufferLimit("string")
.redisSsl("string")
.redisTimeout("string")
.serviceToForkFrom("string")
.staticIps("string")
.build())
.serviceIntegrations(RedisServiceIntegrationArgs.builder()
.integrationType("string")
.sourceServiceName("string")
.build())
.cloudName("string")
.staticIps("string")
.tags(RedisTagArgs.builder()
.key("string")
.value("string")
.build())
.terminationProtection(false)
.build());
redis_resource = aiven.Redis("redisResource",
project="string",
service_name="string",
maintenance_window_dow="string",
additional_disk_space="string",
maintenance_window_time="string",
plan="string",
disk_space="string",
project_vpc_id="string",
redis_user_config={
"additional_backup_regions": "string",
"ip_filter_objects": [{
"description": "string",
"network": "string",
}],
"ip_filters": ["string"],
"migration": {
"dbname": "string",
"host": "string",
"ignore_dbs": "string",
"method": "string",
"password": "string",
"port": "string",
"ssl": "string",
"username": "string",
},
"private_access": {
"prometheus": "string",
"redis": "string",
},
"privatelink_access": {
"prometheus": "string",
"redis": "string",
},
"project_to_fork_from": "string",
"public_access": {
"prometheus": "string",
"redis": "string",
},
"recovery_basebackup_name": "string",
"redis_acl_channels_default": "string",
"redis_io_threads": "string",
"redis_lfu_decay_time": "string",
"redis_lfu_log_factor": "string",
"redis_maxmemory_policy": "string",
"redis_notify_keyspace_events": "string",
"redis_number_of_databases": "string",
"redis_persistence": "string",
"redis_pubsub_client_output_buffer_limit": "string",
"redis_ssl": "string",
"redis_timeout": "string",
"service_to_fork_from": "string",
"static_ips": "string",
},
service_integrations=[{
"integration_type": "string",
"source_service_name": "string",
}],
cloud_name="string",
static_ips=["string"],
tags=[{
"key": "string",
"value": "string",
}],
termination_protection=False)
const redisResource = new aiven.Redis("redisResource", {
project: "string",
serviceName: "string",
maintenanceWindowDow: "string",
additionalDiskSpace: "string",
maintenanceWindowTime: "string",
plan: "string",
diskSpace: "string",
projectVpcId: "string",
redisUserConfig: {
additionalBackupRegions: "string",
ipFilterObjects: [{
description: "string",
network: "string",
}],
ipFilters: ["string"],
migration: {
dbname: "string",
host: "string",
ignoreDbs: "string",
method: "string",
password: "string",
port: "string",
ssl: "string",
username: "string",
},
privateAccess: {
prometheus: "string",
redis: "string",
},
privatelinkAccess: {
prometheus: "string",
redis: "string",
},
projectToForkFrom: "string",
publicAccess: {
prometheus: "string",
redis: "string",
},
recoveryBasebackupName: "string",
redisAclChannelsDefault: "string",
redisIoThreads: "string",
redisLfuDecayTime: "string",
redisLfuLogFactor: "string",
redisMaxmemoryPolicy: "string",
redisNotifyKeyspaceEvents: "string",
redisNumberOfDatabases: "string",
redisPersistence: "string",
redisPubsubClientOutputBufferLimit: "string",
redisSsl: "string",
redisTimeout: "string",
serviceToForkFrom: "string",
staticIps: "string",
},
serviceIntegrations: [{
integrationType: "string",
sourceServiceName: "string",
}],
cloudName: "string",
staticIps: ["string"],
tags: [{
key: "string",
value: "string",
}],
terminationProtection: false,
});
type: aiven:Redis
properties:
additionalDiskSpace: string
cloudName: string
diskSpace: string
maintenanceWindowDow: string
maintenanceWindowTime: string
plan: string
project: string
projectVpcId: string
redisUserConfig:
additionalBackupRegions: string
ipFilterObjects:
- description: string
network: string
ipFilters:
- string
migration:
dbname: string
host: string
ignoreDbs: string
method: string
password: string
port: string
ssl: string
username: string
privateAccess:
prometheus: string
redis: string
privatelinkAccess:
prometheus: string
redis: string
projectToForkFrom: string
publicAccess:
prometheus: string
redis: string
recoveryBasebackupName: string
redisAclChannelsDefault: string
redisIoThreads: string
redisLfuDecayTime: string
redisLfuLogFactor: string
redisMaxmemoryPolicy: string
redisNotifyKeyspaceEvents: string
redisNumberOfDatabases: string
redisPersistence: string
redisPubsubClientOutputBufferLimit: string
redisSsl: string
redisTimeout: string
serviceToForkFrom: string
staticIps: string
serviceIntegrations:
- integrationType: string
sourceServiceName: string
serviceName: string
staticIps:
- string
tags:
- key: string
value: string
terminationProtection: false
Redis 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 Redis resource accepts the following input properties:
- Project string
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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 - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- 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,dogoogle,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.
- 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-xandpremium-xwherexis (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 seem from the Aiven pricing page. - 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.
- Redis
User RedisConfig Redis User Config - Redis user configurable settings
- Service
Integrations List<RedisService 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<Redis
Tag> - Tags are key-value pairs that allow you to categorize services.
- Termination
Protection bool - Prevents the service from being deleted. It is recommended to set this to
truefor 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.
- Project string
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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 - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- 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,dogoogle,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.
- 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-xandpremium-xwherexis (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 seem from the Aiven pricing page. - 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.
- Redis
User RedisConfig Redis User Config Args - Redis user configurable settings
- Service
Integrations []RedisService 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
-
[]Redis
Tag Args - Tags are key-value pairs that allow you to categorize services.
- Termination
Protection bool - Prevents the service from being deleted. It is recommended to set this to
truefor 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.
- project String
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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 - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- 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,dogoogle,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.
- 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-xandpremium-xwherexis (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 seem from the Aiven pricing page. - 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.
- redis
User RedisConfig Redis User Config - Redis user configurable settings
- service
Integrations List<RedisService 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<Redis
Tag> - Tags are key-value pairs that allow you to categorize services.
- termination
Protection Boolean - Prevents the service from being deleted. It is recommended to set this to
truefor 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.
- project string
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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 - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- 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,dogoogle,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.
- 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-xandpremium-xwherexis (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 seem from the Aiven pricing page. - 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.
- redis
User RedisConfig Redis User Config - Redis user configurable settings
- service
Integrations RedisService 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
-
Redis
Tag[] - Tags are key-value pairs that allow you to categorize services.
- termination
Protection boolean - Prevents the service from being deleted. It is recommended to set this to
truefor 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.
- project str
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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 - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- 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,dogoogle,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.
- 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-xandpremium-xwherexis (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 seem from the Aiven pricing page. - 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.
- redis_
user_ Redisconfig Redis User Config Args - Redis user configurable settings
- service_
integrations Sequence[RedisService 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[Redis
Tag Args] - Tags are key-value pairs that allow you to categorize services.
- termination_
protection bool - Prevents the service from being deleted. It is recommended to set this to
truefor 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.
- project String
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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 - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- 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,dogoogle,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.
- 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-xandpremium-xwherexis (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 seem from the Aiven pricing page. - 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.
- redis
User Property MapConfig - Redis user configurable settings
- 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.
- termination
Protection Boolean - Prevents the service from being deleted. It is recommended to set this to
truefor 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the Redis resource produces the following output properties:
- Components
List<Redis
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_spaceneeds to increment fromdisk_space_defaultby 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.
- Redis
Server List<RedisRedi> - Redis server provided values
- 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,REBUILDINGorRUNNING
- Components
[]Redis
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_spaceneeds to increment fromdisk_space_defaultby 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.
- Redis
[]Redis
Redi - Redis server provided values
- 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,REBUILDINGorRUNNING
- components
List<Redis
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_spaceneeds to increment fromdisk_space_defaultby 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.
- redis
List<Redis
Redi> - Redis server provided values
- 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,REBUILDINGorRUNNING
- components
Redis
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_spaceneeds to increment fromdisk_space_defaultby 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.
- redis
Redis
Redi[] - Redis server provided values
- 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,REBUILDINGorRUNNING
- components
Sequence[Redis
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_spaceneeds to increment fromdisk_space_defaultby 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.
- redis
Sequence[Redis
Redi] - Redis server provided values
- 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,REBUILDINGorRUNNING
- 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_spaceneeds to increment fromdisk_space_defaultby 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.
- redis List<Property Map>
- Redis server provided values
- 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,REBUILDINGorRUNNING
Look up Existing Redis Resource
Get an existing Redis 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?: RedisState, opts?: CustomResourceOptions): Redis@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[RedisComponentArgs]] = 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,
redis: Optional[Sequence[RedisRediArgs]] = None,
redis_user_config: Optional[RedisRedisUserConfigArgs] = None,
service_host: Optional[str] = None,
service_integrations: Optional[Sequence[RedisServiceIntegrationArgs]] = 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[RedisTagArgs]] = None,
termination_protection: Optional[bool] = None) -> Redisfunc GetRedis(ctx *Context, name string, id IDInput, state *RedisState, opts ...ResourceOption) (*Redis, error)public static Redis Get(string name, Input<string> id, RedisState? state, CustomResourceOptions? opts = null)public static Redis get(String name, Output<String> id, RedisState state, CustomResourceOptions options)resources: _: type: aiven:Redis get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Additional
Disk stringSpace - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- 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,dogoogle,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<Redis
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_spaceneeds to increment fromdisk_space_defaultby 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-xandpremium-xwherexis (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 seem from the Aiven pricing page. - Project string
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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.
- Redis
Server List<RedisRedi> - Redis server provided values
- Redis
User RedisConfig Redis User Config - Redis user configurable settings
- Service
Host string - The hostname of the service.
- Service
Integrations List<RedisService 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,REBUILDINGorRUNNING - 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<Redis
Tag> - Tags are key-value pairs that allow you to categorize services.
- Termination
Protection bool - Prevents the service from being deleted. It is recommended to set this to
truefor 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.
- Additional
Disk stringSpace - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- 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,dogoogle,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
[]Redis
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_spaceneeds to increment fromdisk_space_defaultby 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-xandpremium-xwherexis (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 seem from the Aiven pricing page. - Project string
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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.
- Redis
[]Redis
Redi Args - Redis server provided values
- Redis
User RedisConfig Redis User Config Args - Redis user configurable settings
- Service
Host string - The hostname of the service.
- Service
Integrations []RedisService 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,REBUILDINGorRUNNING - 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
-
[]Redis
Tag Args - Tags are key-value pairs that allow you to categorize services.
- Termination
Protection bool - Prevents the service from being deleted. It is recommended to set this to
truefor 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.
- additional
Disk StringSpace - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- 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,dogoogle,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<Redis
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_spaceneeds to increment fromdisk_space_defaultby 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-xandpremium-xwherexis (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 seem from the Aiven pricing page. - project String
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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.
- redis
List<Redis
Redi> - Redis server provided values
- redis
User RedisConfig Redis User Config - Redis user configurable settings
- service
Host String - The hostname of the service.
- service
Integrations List<RedisService 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,REBUILDINGorRUNNING - 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<Redis
Tag> - Tags are key-value pairs that allow you to categorize services.
- termination
Protection Boolean - Prevents the service from being deleted. It is recommended to set this to
truefor 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.
- additional
Disk stringSpace - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- 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,dogoogle,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
Redis
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_spaceneeds to increment fromdisk_space_defaultby 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-xandpremium-xwherexis (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 seem from the Aiven pricing page. - project string
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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.
- redis
Redis
Redi[] - Redis server provided values
- redis
User RedisConfig Redis User Config - Redis user configurable settings
- service
Host string - The hostname of the service.
- service
Integrations RedisService 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,REBUILDINGorRUNNING - 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
-
Redis
Tag[] - Tags are key-value pairs that allow you to categorize services.
- termination
Protection boolean - Prevents the service from being deleted. It is recommended to set this to
truefor 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.
- additional_
disk_ strspace - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- 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,dogoogle,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[Redis
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_spaceneeds to increment fromdisk_space_defaultby 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-xandpremium-xwherexis (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 seem from the Aiven pricing page. - project str
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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.
- redis
Sequence[Redis
Redi Args] - Redis server provided values
- redis_
user_ Redisconfig Redis User Config Args - Redis user configurable settings
- service_
host str - The hostname of the service.
- service_
integrations Sequence[RedisService 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,REBUILDINGorRUNNING - 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[Redis
Tag Args] - Tags are key-value pairs that allow you to categorize services.
- termination_
protection bool - Prevents the service from being deleted. It is recommended to set this to
truefor 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.
- additional
Disk StringSpace - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- 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,dogoogle,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_spaceneeds to increment fromdisk_space_defaultby 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-xandpremium-xwherexis (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 seem from the Aiven pricing page. - project String
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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.
- redis List<Property Map>
- Redis server provided values
- redis
User Property MapConfig - Redis user configurable settings
- 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,REBUILDINGorRUNNING - 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.
- termination
Protection Boolean - Prevents the service from being deleted. It is recommended to set this to
truefor 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.
Supporting Types
RedisComponent, RedisComponentArgs
RedisRedisUserConfig, RedisRedisUserConfigArgs
- Additional
Backup stringRegions - Ip
Filter List<RedisObjects Redis User Config Ip Filter Object> - Ip
Filters List<string> - Migration
Redis
Redis User Config Migration - Private
Access RedisRedis User Config Private Access - Privatelink
Access RedisRedis User Config Privatelink Access - Project
To stringFork From - Public
Access RedisRedis User Config Public Access - Recovery
Basebackup stringName - Redis
Acl stringChannels Default - Redis
Io stringThreads - Redis
Lfu stringDecay Time - Redis
Lfu stringLog Factor - Redis
Maxmemory stringPolicy - Redis
Notify stringKeyspace Events - Redis
Number stringOf Databases - Redis
Persistence string - Redis
Pubsub stringClient Output Buffer Limit - Redis
Ssl string - Redis
Timeout string - Service
To stringFork From - Static
Ips string
- Additional
Backup stringRegions - Ip
Filter []RedisObjects Redis User Config Ip Filter Object - Ip
Filters []string - Migration
Redis
Redis User Config Migration - Private
Access RedisRedis User Config Private Access - Privatelink
Access RedisRedis User Config Privatelink Access - Project
To stringFork From - Public
Access RedisRedis User Config Public Access - Recovery
Basebackup stringName - Redis
Acl stringChannels Default - Redis
Io stringThreads - Redis
Lfu stringDecay Time - Redis
Lfu stringLog Factor - Redis
Maxmemory stringPolicy - Redis
Notify stringKeyspace Events - Redis
Number stringOf Databases - Redis
Persistence string - Redis
Pubsub stringClient Output Buffer Limit - Redis
Ssl string - Redis
Timeout string - Service
To stringFork From - Static
Ips string
- additional
Backup StringRegions - ip
Filter List<RedisObjects Redis User Config Ip Filter Object> - ip
Filters List<String> - migration
Redis
Redis User Config Migration - private
Access RedisRedis User Config Private Access - privatelink
Access RedisRedis User Config Privatelink Access - project
To StringFork From - public
Access RedisRedis User Config Public Access - recovery
Basebackup StringName - redis
Acl StringChannels Default - redis
Io StringThreads - redis
Lfu StringDecay Time - redis
Lfu StringLog Factor - redis
Maxmemory StringPolicy - redis
Notify StringKeyspace Events - redis
Number StringOf Databases - redis
Persistence String - redis
Pubsub StringClient Output Buffer Limit - redis
Ssl String - redis
Timeout String - service
To StringFork From - static
Ips String
- additional
Backup stringRegions - ip
Filter RedisObjects Redis User Config Ip Filter Object[] - ip
Filters string[] - migration
Redis
Redis User Config Migration - private
Access RedisRedis User Config Private Access - privatelink
Access RedisRedis User Config Privatelink Access - project
To stringFork From - public
Access RedisRedis User Config Public Access - recovery
Basebackup stringName - redis
Acl stringChannels Default - redis
Io stringThreads - redis
Lfu stringDecay Time - redis
Lfu stringLog Factor - redis
Maxmemory stringPolicy - redis
Notify stringKeyspace Events - redis
Number stringOf Databases - redis
Persistence string - redis
Pubsub stringClient Output Buffer Limit - redis
Ssl string - redis
Timeout string - service
To stringFork From - static
Ips string
- additional_
backup_ strregions - ip_
filter_ Sequence[Redisobjects Redis User Config Ip Filter Object] - ip_
filters Sequence[str] - migration
Redis
Redis User Config Migration - private_
access RedisRedis User Config Private Access - privatelink_
access RedisRedis User Config Privatelink Access - project_
to_ strfork_ from - public_
access RedisRedis User Config Public Access - recovery_
basebackup_ strname - redis_
acl_ strchannels_ default - redis_
io_ strthreads - redis_
lfu_ strdecay_ time - redis_
lfu_ strlog_ factor - redis_
maxmemory_ strpolicy - redis_
notify_ strkeyspace_ events - redis_
number_ strof_ databases - redis_
persistence str - redis_
pubsub_ strclient_ output_ buffer_ limit - redis_
ssl str - redis_
timeout str - service_
to_ strfork_ from - static_
ips str
- additional
Backup StringRegions - ip
Filter List<Property Map>Objects - ip
Filters List<String> - migration Property Map
- private
Access Property Map - privatelink
Access Property Map - project
To StringFork From - public
Access Property Map - recovery
Basebackup StringName - redis
Acl StringChannels Default - redis
Io StringThreads - redis
Lfu StringDecay Time - redis
Lfu StringLog Factor - redis
Maxmemory StringPolicy - redis
Notify StringKeyspace Events - redis
Number StringOf Databases - redis
Persistence String - redis
Pubsub StringClient Output Buffer Limit - redis
Ssl String - redis
Timeout String - service
To StringFork From - static
Ips String
RedisRedisUserConfigIpFilterObject, RedisRedisUserConfigIpFilterObjectArgs
- Description string
- Network string
- Description string
- Network string
- description String
- network String
- description string
- network string
- description str
- network str
- description String
- network String
RedisRedisUserConfigMigration, RedisRedisUserConfigMigrationArgs
RedisRedisUserConfigPrivateAccess, RedisRedisUserConfigPrivateAccessArgs
- Prometheus string
- Redis string
- Prometheus string
- Redis string
- prometheus String
- redis String
- prometheus string
- redis string
- prometheus str
- redis str
- prometheus String
- redis String
RedisRedisUserConfigPrivatelinkAccess, RedisRedisUserConfigPrivatelinkAccessArgs
- Prometheus string
- Redis string
- Prometheus string
- Redis string
- prometheus String
- redis String
- prometheus string
- redis string
- prometheus str
- redis str
- prometheus String
- redis String
RedisRedisUserConfigPublicAccess, RedisRedisUserConfigPublicAccessArgs
- Prometheus string
- Redis string
- Prometheus string
- Redis string
- prometheus String
- redis String
- prometheus string
- redis string
- prometheus str
- redis str
- prometheus String
- redis String
RedisServiceIntegration, RedisServiceIntegrationArgs
- Integration
Type string - Source
Service stringName
- Integration
Type string - Source
Service stringName
- integration
Type String - source
Service StringName
- integration
Type string - source
Service stringName
- integration
Type String - source
Service StringName
RedisTag, RedisTagArgs
Import
$ pulumi import aiven:index/redis:Redis redis1 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
aivenTerraform Provider.
published on Monday, Mar 9, 2026 by Pulumi
