1. Packages
  2. Aiven Provider
  3. API Docs
  4. Redis
Viewing docs for Aiven v4.5.2 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-aiven

aiven.Redis

aiven logo
Viewing docs for Aiven v4.5.2 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-aiven

    The Redis resource allows the creation and management of Aiven Redis services.

    Example Usage

    using Pulumi;
using Aiven = Pulumi.Aiven;

class MyStack : Stack
{
    public MyStack()
    {
        var redis1 = new Aiven.Redis("redis1", new Aiven.RedisArgs
        {
            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/v4/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: &RedisRedisUserConfigArgs{
				RedisMaxmemoryPolicy: pulumi.String("allkeys-random"),
				PublicAccess: &RedisRedisUserConfigPublicAccessArgs{
					Redis: pulumi.String("true"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

    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",
        ),
    ))

    Example coming soon!

    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,
          cloud_name: Optional[str] = None,
          disk_space: Optional[str] = None,
          maintenance_window_dow: Optional[str] = None,
          maintenance_window_time: Optional[str] = None,
          plan: Optional[str] = None,
          project_vpc_id: Optional[str] = None,
          redis_user_config: Optional[RedisRedisUserConfigArgs] = None,
          service_integrations: Optional[Sequence[RedisServiceIntegrationArgs]] = None,
          static_ips: Optional[Sequence[str]] = 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)
    public Redis(String name, RedisArgs args)
public Redis(String name, RedisArgs args, CustomResourceOptions options)

    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",
    CloudName = "string",
    DiskSpace = "string",
    MaintenanceWindowDow = "string",
    MaintenanceWindowTime = "string",
    Plan = "string",
    ProjectVpcId = "string",
    RedisUserConfig = new Aiven.Inputs.RedisRedisUserConfigArgs
    {
        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",
        },
    },
    StaticIps = new[]
    {
        "string",
    },
    TerminationProtection = false,
});

    example, err := aiven.NewRedis(ctx, "redisResource", &aiven.RedisArgs{
	Project:               pulumi.String("string"),
	ServiceName:           pulumi.String("string"),
	CloudName:             pulumi.String("string"),
	DiskSpace:             pulumi.String("string"),
	MaintenanceWindowDow:  pulumi.String("string"),
	MaintenanceWindowTime: pulumi.String("string"),
	Plan:                  pulumi.String("string"),
	ProjectVpcId:          pulumi.String("string"),
	RedisUserConfig: &aiven.RedisRedisUserConfigArgs{
		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"),
		},
	},
	StaticIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	TerminationProtection: pulumi.Bool(false),
})

    var redisResource = new Redis("redisResource", RedisArgs.builder()
    .project("string")
    .serviceName("string")
    .cloudName("string")
    .diskSpace("string")
    .maintenanceWindowDow("string")
    .maintenanceWindowTime("string")
    .plan("string")
    .projectVpcId("string")
    .redisUserConfig(RedisRedisUserConfigArgs.builder()
        .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())
    .staticIps("string")
    .terminationProtection(false)
    .build());

    redis_resource = aiven.Redis("redisResource",
    project="string",
    service_name="string",
    cloud_name="string",
    disk_space="string",
    maintenance_window_dow="string",
    maintenance_window_time="string",
    plan="string",
    project_vpc_id="string",
    redis_user_config={
        "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",
    }],
    static_ips=["string"],
    termination_protection=False)

    const redisResource = new aiven.Redis("redisResource", {
    project: "string",
    serviceName: "string",
    cloudName: "string",
    diskSpace: "string",
    maintenanceWindowDow: "string",
    maintenanceWindowTime: "string",
    plan: "string",
    projectVpcId: "string",
    redisUserConfig: {
        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",
    }],
    staticIps: ["string"],
    terminationProtection: false,
});

    type: aiven:Redis
properties:
    cloudName: string
    diskSpace: string
    maintenanceWindowDow: string
    maintenanceWindowTime: string
    plan: string
    project: string
    projectVpcId: string
    redisUserConfig:
        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
    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.
    ServiceName string
    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
    CloudName 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.
    DiskSpace string
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    MaintenanceWindowDow string
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    MaintenanceWindowTime string
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    Plan string
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page.
    ProjectVpcId string
    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
    RedisUserConfig RedisRedisUserConfig
    Redis user configurable settings
    ServiceIntegrations List<RedisServiceIntegration>
    Service integrations to specify when creating a service. Not applied after initial service creation
    StaticIps List<string>
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    TerminationProtection bool
    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
    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.
    ServiceName string
    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
    CloudName 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.
    DiskSpace string
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    MaintenanceWindowDow string
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    MaintenanceWindowTime string
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    Plan string
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page.
    ProjectVpcId string
    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
    RedisUserConfig RedisRedisUserConfigArgs
    Redis user configurable settings
    ServiceIntegrations []RedisServiceIntegrationArgs
    Service integrations to specify when creating a service. Not applied after initial service creation
    StaticIps []string
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    TerminationProtection bool
    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
    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.
    serviceName String
    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
    cloudName 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.
    diskSpace String
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    maintenanceWindowDow String
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenanceWindowTime String
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan String
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page.
    projectVpcId String
    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
    redisUserConfig RedisRedisUserConfig
    Redis user configurable settings
    serviceIntegrations List<RedisServiceIntegration>
    Service integrations to specify when creating a service. Not applied after initial service creation
    staticIps List<String>
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    terminationProtection Boolean
    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
    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.
    serviceName string
    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
    cloudName 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.
    diskSpace string
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    maintenanceWindowDow string
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenanceWindowTime string
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan string
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page.
    projectVpcId string
    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
    redisUserConfig RedisRedisUserConfig
    Redis user configurable settings
    serviceIntegrations RedisServiceIntegration[]
    Service integrations to specify when creating a service. Not applied after initial service creation
    staticIps string[]
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    terminationProtection boolean
    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
    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.
    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
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    maintenance_window_dow str
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenance_window_time str
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan str
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page.
    project_vpc_id str
    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
    redis_user_config RedisRedisUserConfigArgs
    Redis user configurable settings
    service_integrations Sequence[RedisServiceIntegrationArgs]
    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
    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.
    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.
    serviceName String
    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
    cloudName 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.
    diskSpace String
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    maintenanceWindowDow String
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenanceWindowTime String
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan String
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page.
    projectVpcId String
    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
    redisUserConfig Property Map
    Redis user configurable settings
    serviceIntegrations List<Property Map>
    Service integrations to specify when creating a service. Not applied after initial service creation
    staticIps List<String>
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    terminationProtection Boolean
    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

    Outputs

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

    Components List<RedisComponent>
    Service component information objects
    DiskSpaceCap string
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    DiskSpaceDefault string
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    DiskSpaceStep string
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    DiskSpaceUsed string
    Disk space that service is currently using
    Id string
    The provider-assigned unique ID for this managed resource.
    RedisServer List<RedisRedi>
    Redis server provided values
    ServiceHost string
    The hostname of the service.
    ServicePassword string
    Password used for connecting to the service, if applicable
    ServicePort int
    The port of the service
    ServiceType string
    Aiven internal service type code
    ServiceUri string
    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
    ServiceUsername string
    Username used for connecting to the service, if applicable
    State string
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    Components []RedisComponent
    Service component information objects
    DiskSpaceCap string
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    DiskSpaceDefault string
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    DiskSpaceStep string
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    DiskSpaceUsed string
    Disk space that service is currently using
    Id string
    The provider-assigned unique ID for this managed resource.
    Redis []RedisRedi
    Redis server provided values
    ServiceHost string
    The hostname of the service.
    ServicePassword string
    Password used for connecting to the service, if applicable
    ServicePort int
    The port of the service
    ServiceType string
    Aiven internal service type code
    ServiceUri string
    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
    ServiceUsername string
    Username used for connecting to the service, if applicable
    State string
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    components List<RedisComponent>
    Service component information objects
    diskSpaceCap String
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    diskSpaceDefault String
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    diskSpaceStep String
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    diskSpaceUsed String
    Disk space that service is currently using
    id String
    The provider-assigned unique ID for this managed resource.
    redis List<RedisRedi>
    Redis server provided values
    serviceHost String
    The hostname of the service.
    servicePassword String
    Password used for connecting to the service, if applicable
    servicePort Integer
    The port of the service
    serviceType String
    Aiven internal service type code
    serviceUri String
    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
    serviceUsername String
    Username used for connecting to the service, if applicable
    state String
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    components RedisComponent[]
    Service component information objects
    diskSpaceCap string
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    diskSpaceDefault string
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    diskSpaceStep string
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    diskSpaceUsed string
    Disk space that service is currently using
    id string
    The provider-assigned unique ID for this managed resource.
    redis RedisRedi[]
    Redis server provided values
    serviceHost string
    The hostname of the service.
    servicePassword string
    Password used for connecting to the service, if applicable
    servicePort number
    The port of the service
    serviceType string
    Aiven internal service type code
    serviceUri string
    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
    serviceUsername string
    Username used for connecting to the service, if applicable
    state string
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    components Sequence[RedisComponent]
    Service component information objects
    disk_space_cap str
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    disk_space_default str
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    disk_space_step str
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    disk_space_used str
    Disk space that service is currently using
    id str
    The provider-assigned unique ID for this managed resource.
    redis Sequence[RedisRedi]
    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, REBUILDING or RUNNING
    components List<Property Map>
    Service component information objects
    diskSpaceCap String
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    diskSpaceDefault String
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    diskSpaceStep String
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    diskSpaceUsed String
    Disk space that service is currently using
    id String
    The provider-assigned unique ID for this managed resource.
    redis List<Property Map>
    Redis server provided values
    serviceHost String
    The hostname of the service.
    servicePassword String
    Password used for connecting to the service, if applicable
    servicePort Number
    The port of the service
    serviceType String
    Aiven internal service type code
    serviceUri String
    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
    serviceUsername String
    Username used for connecting to the service, if applicable
    state String
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

    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,
        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,
        termination_protection: Optional[bool] = None) -> Redis
    func 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.
    The following state arguments are supported:
    CloudName 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<RedisComponent>
    Service component information objects
    DiskSpace string
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    DiskSpaceCap string
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    DiskSpaceDefault string
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    DiskSpaceStep string
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    DiskSpaceUsed string
    Disk space that service is currently using
    MaintenanceWindowDow string
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    MaintenanceWindowTime string
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    Plan string
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.
    ProjectVpcId string
    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
    RedisServer List<RedisRedi>
    Redis server provided values
    RedisUserConfig RedisRedisUserConfig
    Redis user configurable settings
    ServiceHost string
    The hostname of the service.
    ServiceIntegrations List<RedisServiceIntegration>
    Service integrations to specify when creating a service. Not applied after initial service creation
    ServiceName string
    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
    ServicePassword string
    Password used for connecting to the service, if applicable
    ServicePort int
    The port of the service
    ServiceType string
    Aiven internal service type code
    ServiceUri string
    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
    ServiceUsername string
    Username used for connecting to the service, if applicable
    State string
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    StaticIps List<string>
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    TerminationProtection bool
    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
    CloudName 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 []RedisComponentArgs
    Service component information objects
    DiskSpace string
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    DiskSpaceCap string
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    DiskSpaceDefault string
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    DiskSpaceStep string
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    DiskSpaceUsed string
    Disk space that service is currently using
    MaintenanceWindowDow string
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    MaintenanceWindowTime string
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    Plan string
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.
    ProjectVpcId string
    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
    Redis []RedisRediArgs
    Redis server provided values
    RedisUserConfig RedisRedisUserConfigArgs
    Redis user configurable settings
    ServiceHost string
    The hostname of the service.
    ServiceIntegrations []RedisServiceIntegrationArgs
    Service integrations to specify when creating a service. Not applied after initial service creation
    ServiceName string
    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
    ServicePassword string
    Password used for connecting to the service, if applicable
    ServicePort int
    The port of the service
    ServiceType string
    Aiven internal service type code
    ServiceUri string
    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
    ServiceUsername string
    Username used for connecting to the service, if applicable
    State string
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    StaticIps []string
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    TerminationProtection bool
    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
    cloudName 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<RedisComponent>
    Service component information objects
    diskSpace String
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    diskSpaceCap String
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    diskSpaceDefault String
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    diskSpaceStep String
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    diskSpaceUsed String
    Disk space that service is currently using
    maintenanceWindowDow String
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenanceWindowTime String
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan String
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.
    projectVpcId String
    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
    redis List<RedisRedi>
    Redis server provided values
    redisUserConfig RedisRedisUserConfig
    Redis user configurable settings
    serviceHost String
    The hostname of the service.
    serviceIntegrations List<RedisServiceIntegration>
    Service integrations to specify when creating a service. Not applied after initial service creation
    serviceName String
    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
    servicePassword String
    Password used for connecting to the service, if applicable
    servicePort Integer
    The port of the service
    serviceType String
    Aiven internal service type code
    serviceUri String
    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
    serviceUsername String
    Username used for connecting to the service, if applicable
    state String
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    staticIps List<String>
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    terminationProtection Boolean
    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
    cloudName 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 RedisComponent[]
    Service component information objects
    diskSpace string
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    diskSpaceCap string
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    diskSpaceDefault string
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    diskSpaceStep string
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    diskSpaceUsed string
    Disk space that service is currently using
    maintenanceWindowDow string
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenanceWindowTime string
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan string
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.
    projectVpcId string
    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
    redis RedisRedi[]
    Redis server provided values
    redisUserConfig RedisRedisUserConfig
    Redis user configurable settings
    serviceHost string
    The hostname of the service.
    serviceIntegrations RedisServiceIntegration[]
    Service integrations to specify when creating a service. Not applied after initial service creation
    serviceName string
    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
    servicePassword string
    Password used for connecting to the service, if applicable
    servicePort number
    The port of the service
    serviceType string
    Aiven internal service type code
    serviceUri string
    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
    serviceUsername string
    Username used for connecting to the service, if applicable
    state string
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    staticIps string[]
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    terminationProtection boolean
    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
    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[RedisComponentArgs]
    Service component information objects
    disk_space str
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    disk_space_cap str
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    disk_space_default str
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    disk_space_step str
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    disk_space_used str
    Disk space that service is currently using
    maintenance_window_dow str
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenance_window_time str
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan str
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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_id str
    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
    redis Sequence[RedisRediArgs]
    Redis server provided values
    redis_user_config RedisRedisUserConfigArgs
    Redis user configurable settings
    service_host str
    The hostname of the service.
    service_integrations Sequence[RedisServiceIntegrationArgs]
    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 or RUNNING
    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
    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.
    cloudName 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
    diskSpace String
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    diskSpaceCap String
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    diskSpaceDefault String
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    diskSpaceStep String
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    diskSpaceUsed String
    Disk space that service is currently using
    maintenanceWindowDow String
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenanceWindowTime String
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan String
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.
    projectVpcId String
    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
    redis List<Property Map>
    Redis server provided values
    redisUserConfig Property Map
    Redis user configurable settings
    serviceHost String
    The hostname of the service.
    serviceIntegrations List<Property Map>
    Service integrations to specify when creating a service. Not applied after initial service creation
    serviceName String
    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
    servicePassword String
    Password used for connecting to the service, if applicable
    servicePort Number
    The port of the service
    serviceType String
    Aiven internal service type code
    serviceUri String
    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
    serviceUsername String
    Username used for connecting to the service, if applicable
    state String
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    staticIps List<String>
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    terminationProtection Boolean
    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

    Supporting Types

    RedisComponent, RedisComponentArgs

    Component string
    Host string
    KafkaAuthenticationMethod string
    Port int
    Route string
    Ssl bool
    Usage string
    Component string
    Host string
    KafkaAuthenticationMethod string
    Port int
    Route string
    Ssl bool
    Usage string
    component String
    host String
    kafkaAuthenticationMethod String
    port Integer
    route String
    ssl Boolean
    usage String
    component string
    host string
    kafkaAuthenticationMethod string
    port number
    route string
    ssl boolean
    usage string
    component String
    host String
    kafkaAuthenticationMethod String
    port Number
    route String
    ssl Boolean
    usage String

    RedisRedisUserConfig, RedisRedisUserConfigArgs

    IpFilters List<string>
    IP filter
    Migration RedisRedisUserConfigMigration
    Migrate data from existing server
    PrivateAccess RedisRedisUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    PrivatelinkAccess RedisRedisUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    ProjectToForkFrom string
    Name of another project to fork a service from. This has effect only when a new service is being created.
    PublicAccess RedisRedisUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    RecoveryBasebackupName string
    Name of the basebackup to restore in forked service
    RedisAclChannelsDefault string
    Default ACL for pub/sub channels used when Redis user is created
    RedisIoThreads string
    Redis IO thread count
    RedisLfuDecayTime string
    LFU maxmemory-policy counter decay time in minutes
    RedisLfuLogFactor string
    Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies
    RedisMaxmemoryPolicy string
    Redis maxmemory-policy
    RedisNotifyKeyspaceEvents string
    Set notify-keyspace-events option
    RedisNumberOfDatabases string
    Number of redis databases
    RedisPersistence string
    Redis persistence
    RedisPubsubClientOutputBufferLimit string
    Pub/sub client output buffer hard limit in MB
    RedisSsl string
    Require SSL to access Redis
    RedisTimeout string
    Redis idle connection timeout in seconds
    ServiceToForkFrom string
    Name of another service to fork from. This has effect only when a new service is being created.
    StaticIps string
    Static IP addresses
    IpFilters []string
    IP filter
    Migration RedisRedisUserConfigMigration
    Migrate data from existing server
    PrivateAccess RedisRedisUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    PrivatelinkAccess RedisRedisUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    ProjectToForkFrom string
    Name of another project to fork a service from. This has effect only when a new service is being created.
    PublicAccess RedisRedisUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    RecoveryBasebackupName string
    Name of the basebackup to restore in forked service
    RedisAclChannelsDefault string
    Default ACL for pub/sub channels used when Redis user is created
    RedisIoThreads string
    Redis IO thread count
    RedisLfuDecayTime string
    LFU maxmemory-policy counter decay time in minutes
    RedisLfuLogFactor string
    Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies
    RedisMaxmemoryPolicy string
    Redis maxmemory-policy
    RedisNotifyKeyspaceEvents string
    Set notify-keyspace-events option
    RedisNumberOfDatabases string
    Number of redis databases
    RedisPersistence string
    Redis persistence
    RedisPubsubClientOutputBufferLimit string
    Pub/sub client output buffer hard limit in MB
    RedisSsl string
    Require SSL to access Redis
    RedisTimeout string
    Redis idle connection timeout in seconds
    ServiceToForkFrom string
    Name of another service to fork from. This has effect only when a new service is being created.
    StaticIps string
    Static IP addresses
    ipFilters List<String>
    IP filter
    migration RedisRedisUserConfigMigration
    Migrate data from existing server
    privateAccess RedisRedisUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    privatelinkAccess RedisRedisUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    projectToForkFrom String
    Name of another project to fork a service from. This has effect only when a new service is being created.
    publicAccess RedisRedisUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    recoveryBasebackupName String
    Name of the basebackup to restore in forked service
    redisAclChannelsDefault String
    Default ACL for pub/sub channels used when Redis user is created
    redisIoThreads String
    Redis IO thread count
    redisLfuDecayTime String
    LFU maxmemory-policy counter decay time in minutes
    redisLfuLogFactor String
    Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies
    redisMaxmemoryPolicy String
    Redis maxmemory-policy
    redisNotifyKeyspaceEvents String
    Set notify-keyspace-events option
    redisNumberOfDatabases String
    Number of redis databases
    redisPersistence String
    Redis persistence
    redisPubsubClientOutputBufferLimit String
    Pub/sub client output buffer hard limit in MB
    redisSsl String
    Require SSL to access Redis
    redisTimeout String
    Redis idle connection timeout in seconds
    serviceToForkFrom String
    Name of another service to fork from. This has effect only when a new service is being created.
    staticIps String
    Static IP addresses
    ipFilters string[]
    IP filter
    migration RedisRedisUserConfigMigration
    Migrate data from existing server
    privateAccess RedisRedisUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    privatelinkAccess RedisRedisUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    projectToForkFrom string
    Name of another project to fork a service from. This has effect only when a new service is being created.
    publicAccess RedisRedisUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    recoveryBasebackupName string
    Name of the basebackup to restore in forked service
    redisAclChannelsDefault string
    Default ACL for pub/sub channels used when Redis user is created
    redisIoThreads string
    Redis IO thread count
    redisLfuDecayTime string
    LFU maxmemory-policy counter decay time in minutes
    redisLfuLogFactor string
    Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies
    redisMaxmemoryPolicy string
    Redis maxmemory-policy
    redisNotifyKeyspaceEvents string
    Set notify-keyspace-events option
    redisNumberOfDatabases string
    Number of redis databases
    redisPersistence string
    Redis persistence
    redisPubsubClientOutputBufferLimit string
    Pub/sub client output buffer hard limit in MB
    redisSsl string
    Require SSL to access Redis
    redisTimeout string
    Redis idle connection timeout in seconds
    serviceToForkFrom string
    Name of another service to fork from. This has effect only when a new service is being created.
    staticIps string
    Static IP addresses
    ip_filters Sequence[str]
    IP filter
    migration RedisRedisUserConfigMigration
    Migrate data from existing server
    private_access RedisRedisUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    privatelink_access RedisRedisUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    project_to_fork_from str
    Name of another project to fork a service from. This has effect only when a new service is being created.
    public_access RedisRedisUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    recovery_basebackup_name str
    Name of the basebackup to restore in forked service
    redis_acl_channels_default str
    Default ACL for pub/sub channels used when Redis user is created
    redis_io_threads str
    Redis IO thread count
    redis_lfu_decay_time str
    LFU maxmemory-policy counter decay time in minutes
    redis_lfu_log_factor str
    Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies
    redis_maxmemory_policy str
    Redis maxmemory-policy
    redis_notify_keyspace_events str
    Set notify-keyspace-events option
    redis_number_of_databases str
    Number of redis databases
    redis_persistence str
    Redis persistence
    redis_pubsub_client_output_buffer_limit str
    Pub/sub client output buffer hard limit in MB
    redis_ssl str
    Require SSL to access Redis
    redis_timeout str
    Redis idle connection timeout in seconds
    service_to_fork_from str
    Name of another service to fork from. This has effect only when a new service is being created.
    static_ips str
    Static IP addresses
    ipFilters List<String>
    IP filter
    migration Property Map
    Migrate data from existing server
    privateAccess Property Map
    Allow access to selected service ports from private networks
    privatelinkAccess Property Map
    Allow access to selected service components through Privatelink
    projectToForkFrom String
    Name of another project to fork a service from. This has effect only when a new service is being created.
    publicAccess Property Map
    Allow access to selected service ports from the public Internet
    recoveryBasebackupName String
    Name of the basebackup to restore in forked service
    redisAclChannelsDefault String
    Default ACL for pub/sub channels used when Redis user is created
    redisIoThreads String
    Redis IO thread count
    redisLfuDecayTime String
    LFU maxmemory-policy counter decay time in minutes
    redisLfuLogFactor String
    Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies
    redisMaxmemoryPolicy String
    Redis maxmemory-policy
    redisNotifyKeyspaceEvents String
    Set notify-keyspace-events option
    redisNumberOfDatabases String
    Number of redis databases
    redisPersistence String
    Redis persistence
    redisPubsubClientOutputBufferLimit String
    Pub/sub client output buffer hard limit in MB
    redisSsl String
    Require SSL to access Redis
    redisTimeout String
    Redis idle connection timeout in seconds
    serviceToForkFrom String
    Name of another service to fork from. This has effect only when a new service is being created.
    staticIps String
    Static IP addresses

    RedisRedisUserConfigMigration, RedisRedisUserConfigMigrationArgs

    Dbname string
    Host string
    IgnoreDbs string
    Method string
    Password string
    Port string
    Ssl string
    Username string
    Dbname string
    Host string
    IgnoreDbs string
    Method string
    Password string
    Port string
    Ssl string
    Username string
    dbname String
    host String
    ignoreDbs String
    method String
    password String
    port String
    ssl String
    username String
    dbname string
    host string
    ignoreDbs string
    method string
    password string
    port string
    ssl string
    username string
    dbname String
    host String
    ignoreDbs String
    method String
    password String
    port String
    ssl String
    username String

    RedisRedisUserConfigPrivateAccess, RedisRedisUserConfigPrivateAccessArgs

    Prometheus string
    Redis string
    Redis server provided values
    Prometheus string
    Redis string
    Redis server provided values
    prometheus String
    redis String
    Redis server provided values
    prometheus string
    redis string
    Redis server provided values
    prometheus str
    redis str
    Redis server provided values
    prometheus String
    redis String
    Redis server provided values

    RedisRedisUserConfigPrivatelinkAccess, RedisRedisUserConfigPrivatelinkAccessArgs

    Prometheus string
    Redis string
    Redis server provided values
    Prometheus string
    Redis string
    Redis server provided values
    prometheus String
    redis String
    Redis server provided values
    prometheus string
    redis string
    Redis server provided values
    prometheus str
    redis str
    Redis server provided values
    prometheus String
    redis String
    Redis server provided values

    RedisRedisUserConfigPublicAccess, RedisRedisUserConfigPublicAccessArgs

    Prometheus string
    Redis string
    Redis server provided values
    Prometheus string
    Redis string
    Redis server provided values
    prometheus String
    redis String
    Redis server provided values
    prometheus string
    redis string
    Redis server provided values
    prometheus str
    redis str
    Redis server provided values
    prometheus String
    redis String
    Redis server provided values

    RedisServiceIntegration, RedisServiceIntegrationArgs

    IntegrationType string
    Type of the service integration. The only supported value at the moment is read_replica
    SourceServiceName string
    Name of the source service
    IntegrationType string
    Type of the service integration. The only supported value at the moment is read_replica
    SourceServiceName string
    Name of the source service
    integrationType String
    Type of the service integration. The only supported value at the moment is read_replica
    sourceServiceName String
    Name of the source service
    integrationType string
    Type of the service integration. The only supported value at the moment is read_replica
    sourceServiceName string
    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_name str
    Name of the source service
    integrationType String
    Type of the service integration. The only supported value at the moment is read_replica
    sourceServiceName String
    Name of the source service

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Viewing docs for Aiven v4.5.2 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-aiven
      Try Pulumi Cloud free. Your team will thank you.