aiven.Redis
Explore with Pulumi AI
The Redis resource allows the creation and management of Aiven Redis services.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;
return await Deployment.RunAsync(() =>
{
var redis1 = new Aiven.Redis("redis1", new()
{
Project = data.Aiven_project.Pr1.Project,
CloudName = "google-europe-west1",
Plan = "business-4",
ServiceName = "my-redis1",
MaintenanceWindowDow = "monday",
MaintenanceWindowTime = "10:00:00",
RedisUserConfig = new Aiven.Inputs.RedisRedisUserConfigArgs
{
RedisMaxmemoryPolicy = "allkeys-random",
PublicAccess = new Aiven.Inputs.RedisRedisUserConfigPublicAccessArgs
{
Redis = true,
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := aiven.NewRedis(ctx, "redis1", &aiven.RedisArgs{
Project: pulumi.Any(data.Aiven_project.Pr1.Project),
CloudName: pulumi.String("google-europe-west1"),
Plan: pulumi.String("business-4"),
ServiceName: pulumi.String("my-redis1"),
MaintenanceWindowDow: pulumi.String("monday"),
MaintenanceWindowTime: pulumi.String("10:00:00"),
RedisUserConfig: &aiven.RedisRedisUserConfigArgs{
RedisMaxmemoryPolicy: pulumi.String("allkeys-random"),
PublicAccess: &aiven.RedisRedisUserConfigPublicAccessArgs{
Redis: pulumi.Bool(true),
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.Redis;
import com.pulumi.aiven.RedisArgs;
import com.pulumi.aiven.inputs.RedisRedisUserConfigArgs;
import com.pulumi.aiven.inputs.RedisRedisUserConfigPublicAccessArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var redis1 = new Redis("redis1", RedisArgs.builder()
.project(data.aiven_project().pr1().project())
.cloudName("google-europe-west1")
.plan("business-4")
.serviceName("my-redis1")
.maintenanceWindowDow("monday")
.maintenanceWindowTime("10:00:00")
.redisUserConfig(RedisRedisUserConfigArgs.builder()
.redisMaxmemoryPolicy("allkeys-random")
.publicAccess(RedisRedisUserConfigPublicAccessArgs.builder()
.redis(true)
.build())
.build())
.build());
}
}
import 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,
),
))
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,
},
},
});
resources:
redis1:
type: aiven:Redis
properties:
project: ${data.aiven_project.pr1.project}
cloudName: google-europe-west1
plan: business-4
serviceName: my-redis1
maintenanceWindowDow: monday
maintenanceWindowTime: 10:00:00
redisUserConfig:
redisMaxmemoryPolicy: allkeys-random
publicAccess:
redis: true
Create Redis Resource
new Redis(name: string, args: RedisArgs, opts?: CustomResourceOptions);
@overload
def Redis(resource_name: str,
opts: Optional[ResourceOptions] = None,
additional_disk_space: 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: Optional[str] = None,
project_vpc_id: Optional[str] = None,
redis_user_config: Optional[RedisRedisUserConfigArgs] = None,
service_integrations: Optional[Sequence[RedisServiceIntegrationArgs]] = None,
service_name: Optional[str] = None,
static_ips: Optional[Sequence[str]] = None,
tags: Optional[Sequence[RedisTagArgs]] = None,
termination_protection: Optional[bool] = None)
@overload
def Redis(resource_name: str,
args: RedisArgs,
opts: Optional[ResourceOptions] = None)
func NewRedis(ctx *Context, name string, args RedisArgs, opts ...ResourceOption) (*Redis, error)
public Redis(string name, RedisArgs args, CustomResourceOptions? opts = null)
type: aiven:Redis
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- 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.
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
The Redis resource accepts the following input properties:
- Plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.
- Service
Name string Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- Additional
Disk stringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Cloud
Name string Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- Disk
Space string Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
This will be removed in v5.0.0. Please use
additional_disk_space
to specify the space to be added to the defaultdisk_space
defined by the plan.- Maintenance
Window stringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Project
Vpc stringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- Redis
User RedisConfig Redis User Config Redis user configurable settings
- Service
Integrations List<RedisService Integration> Service integrations to specify when creating a service. Not applied after initial service creation
- Static
Ips List<string> Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- List<Redis
Tag> Tags are key-value pairs that allow you to categorize services.
- Termination
Protection bool Prevents the service from being deleted. It is recommended to set this to
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.
- Plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.
- Service
Name string Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- Additional
Disk stringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Cloud
Name string Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- Disk
Space string Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
This will be removed in v5.0.0. Please use
additional_disk_space
to specify the space to be added to the defaultdisk_space
defined by the plan.- Maintenance
Window stringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Project
Vpc stringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- Redis
User RedisConfig Redis User Config Args Redis user configurable settings
- Service
Integrations []RedisService Integration Args Service integrations to specify when creating a service. Not applied after initial service creation
- Static
Ips []string Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- []Redis
Tag Args Tags are key-value pairs that allow you to categorize services.
- Termination
Protection bool Prevents the service from being deleted. It is recommended to set this to
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.
- plan String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.
- service
Name String Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- additional
Disk StringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name String Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- disk
Space String Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
This will be removed in v5.0.0. Please use
additional_disk_space
to specify the space to be added to the defaultdisk_space
defined by the plan.- maintenance
Window StringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project
Vpc StringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- redis
User RedisConfig Redis User Config Redis user configurable settings
- service
Integrations List<RedisService Integration> Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips List<String> Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- List<Redis
Tag> Tags are key-value pairs that allow you to categorize services.
- termination
Protection Boolean Prevents the service from being deleted. It is recommended to set this to
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.
- plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.
- service
Name string Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- additional
Disk stringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name string Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- disk
Space string Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
This will be removed in v5.0.0. Please use
additional_disk_space
to specify the space to be added to the defaultdisk_space
defined by the plan.- maintenance
Window stringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window stringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project
Vpc stringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- redis
User RedisConfig Redis User Config Redis user configurable settings
- service
Integrations RedisService Integration[] Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips string[] Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- Redis
Tag[] Tags are key-value pairs that allow you to categorize services.
- termination
Protection boolean Prevents the service from being deleted. It is recommended to set this to
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.
- plan str
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.
- service_
name str Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- additional_
disk_ strspace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud_
name str Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- disk_
space str Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
This will be removed in v5.0.0. Please use
additional_disk_space
to specify the space to be added to the defaultdisk_space
defined by the plan.- maintenance_
window_ strdow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance_
window_ strtime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project_
vpc_ strid Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- redis_
user_ Redisconfig Redis User Config Args Redis user configurable settings
- service_
integrations Sequence[RedisService Integration Args] Service integrations to specify when creating a service. Not applied after initial service creation
- static_
ips Sequence[str] Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- Sequence[Redis
Tag Args] Tags are key-value pairs that allow you to categorize services.
- termination_
protection bool Prevents the service from being deleted. It is recommended to set this to
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.
- plan String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.
- service
Name String Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- additional
Disk StringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name String Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- disk
Space String Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
This will be removed in v5.0.0. Please use
additional_disk_space
to specify the space to be added to the defaultdisk_space
defined by the plan.- maintenance
Window StringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project
Vpc StringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- redis
User Property MapConfig Redis user configurable settings
- service
Integrations List<Property Map> Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips List<String> Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- List<Property Map>
Tags are key-value pairs that allow you to categorize services.
- termination
Protection Boolean Prevents the service from being deleted. It is recommended to set this to
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<Redis
Component> Service component information objects
- Disk
Space stringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space
- Disk
Space stringStep The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_space
needs to increment fromdisk_space_default
by increments of this size.- Disk
Space stringUsed Disk space that service is currently using
- Id string
The provider-assigned unique ID for this managed resource.
- Redis
Server List<RedisRedi> Redis server provided values
- Service
Host string The hostname of the service.
- Service
Password string Password used for connecting to the service, if applicable
- Service
Port int The port of the service
- Service
Type string Aiven internal service type code
- Service
Uri string URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string Username used for connecting to the service, if applicable
- State string
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Components
[]Redis
Component Service component information objects
- Disk
Space stringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space
- Disk
Space stringStep The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_space
needs to increment fromdisk_space_default
by increments of this size.- Disk
Space stringUsed Disk space that service is currently using
- Id string
The provider-assigned unique ID for this managed resource.
- Redis
[]Redis
Redi Redis server provided values
- Service
Host string The hostname of the service.
- Service
Password string Password used for connecting to the service, if applicable
- Service
Port int The port of the service
- Service
Type string Aiven internal service type code
- Service
Uri string URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string Username used for connecting to the service, if applicable
- State string
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- components
List<Redis
Component> Service component information objects
- disk
Space StringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space
- disk
Space StringStep The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_space
needs to increment fromdisk_space_default
by increments of this size.- disk
Space StringUsed Disk space that service is currently using
- id String
The provider-assigned unique ID for this managed resource.
- redis
List<Redis
Redi> Redis server provided values
- service
Host String The hostname of the service.
- service
Password String Password used for connecting to the service, if applicable
- service
Port Integer The port of the service
- service
Type String Aiven internal service type code
- service
Uri String URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String Username used for connecting to the service, if applicable
- state String
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- components
Redis
Component[] Service component information objects
- disk
Space stringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space stringDefault The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space
- disk
Space stringStep The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_space
needs to increment fromdisk_space_default
by increments of this size.- disk
Space stringUsed Disk space that service is currently using
- id string
The provider-assigned unique ID for this managed resource.
- redis
Redis
Redi[] Redis server provided values
- service
Host string The hostname of the service.
- service
Password string Password used for connecting to the service, if applicable
- service
Port number The port of the service
- service
Type string Aiven internal service type code
- service
Uri string URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username string Username used for connecting to the service, if applicable
- state string
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- components
Sequence[Redis
Component] Service component information objects
- disk_
space_ strcap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk_
space_ strdefault The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space
- disk_
space_ strstep The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_space
needs to increment fromdisk_space_default
by increments of this size.- disk_
space_ strused Disk space that service is currently using
- id str
The provider-assigned unique ID for this managed resource.
- redis
Sequence[Redis
Redi] Redis server provided values
- service_
host str The hostname of the service.
- service_
password str Password used for connecting to the service, if applicable
- service_
port int The port of the service
- service_
type str Aiven internal service type code
- service_
uri str URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service_
username str Username used for connecting to the service, if applicable
- state str
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- components List<Property Map>
Service component information objects
- disk
Space StringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space
- disk
Space StringStep The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_space
needs to increment fromdisk_space_default
by increments of this size.- disk
Space StringUsed Disk space that service is currently using
- id String
The provider-assigned unique ID for this managed resource.
- redis List<Property Map>
Redis server provided values
- service
Host String The hostname of the service.
- service
Password String Password used for connecting to the service, if applicable
- service
Port Number The port of the service
- service
Type String Aiven internal service type code
- service
Uri String URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String Username used for connecting to the service, if applicable
- state String
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
Look up Existing Redis Resource
Get an existing Redis resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: RedisState, opts?: CustomResourceOptions): Redis
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
additional_disk_space: Optional[str] = None,
cloud_name: Optional[str] = None,
components: Optional[Sequence[RedisComponentArgs]] = None,
disk_space: Optional[str] = None,
disk_space_cap: Optional[str] = None,
disk_space_default: Optional[str] = None,
disk_space_step: Optional[str] = None,
disk_space_used: Optional[str] = None,
maintenance_window_dow: Optional[str] = None,
maintenance_window_time: Optional[str] = None,
plan: Optional[str] = None,
project: Optional[str] = None,
project_vpc_id: Optional[str] = None,
redis: Optional[Sequence[RedisRediArgs]] = None,
redis_user_config: Optional[RedisRedisUserConfigArgs] = None,
service_host: Optional[str] = None,
service_integrations: Optional[Sequence[RedisServiceIntegrationArgs]] = None,
service_name: Optional[str] = None,
service_password: Optional[str] = None,
service_port: Optional[int] = None,
service_type: Optional[str] = None,
service_uri: Optional[str] = None,
service_username: Optional[str] = None,
state: Optional[str] = None,
static_ips: Optional[Sequence[str]] = None,
tags: Optional[Sequence[RedisTagArgs]] = None,
termination_protection: Optional[bool] = None) -> 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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Additional
Disk stringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Cloud
Name string Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,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<Redis
Component> Service component information objects
- Disk
Space string Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
This will be removed in v5.0.0. Please use
additional_disk_space
to specify the space to be added to the defaultdisk_space
defined by the plan.- Disk
Space stringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space
- Disk
Space stringStep The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_space
needs to increment fromdisk_space_default
by increments of this size.- Disk
Space stringUsed Disk space that service is currently using
- Maintenance
Window stringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page.- Project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Project
Vpc stringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- Redis
Server List<RedisRedi> Redis server provided values
- Redis
User RedisConfig Redis User Config Redis user configurable settings
- Service
Host string The hostname of the service.
- Service
Integrations List<RedisService Integration> Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name string Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- Service
Password string Password used for connecting to the service, if applicable
- Service
Port int The port of the service
- Service
Type string Aiven internal service type code
- Service
Uri string URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string Username used for connecting to the service, if applicable
- State string
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Static
Ips List<string> Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- List<Redis
Tag> Tags are key-value pairs that allow you to categorize services.
- Termination
Protection bool Prevents the service from being deleted. It is recommended to set this to
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.
- Additional
Disk stringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Cloud
Name string Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,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
[]Redis
Component Args Service component information objects
- Disk
Space string Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
This will be removed in v5.0.0. Please use
additional_disk_space
to specify the space to be added to the defaultdisk_space
defined by the plan.- Disk
Space stringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space
- Disk
Space stringStep The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_space
needs to increment fromdisk_space_default
by increments of this size.- Disk
Space stringUsed Disk space that service is currently using
- Maintenance
Window stringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page.- Project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Project
Vpc stringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- Redis
[]Redis
Redi Args Redis server provided values
- Redis
User RedisConfig Redis User Config Args Redis user configurable settings
- Service
Host string The hostname of the service.
- Service
Integrations []RedisService Integration Args Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name string Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- Service
Password string Password used for connecting to the service, if applicable
- Service
Port int The port of the service
- Service
Type string Aiven internal service type code
- Service
Uri string URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string Username used for connecting to the service, if applicable
- State string
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Static
Ips []string Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- []Redis
Tag Args Tags are key-value pairs that allow you to categorize services.
- Termination
Protection bool Prevents the service from being deleted. It is recommended to set this to
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.
- additional
Disk StringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name String Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,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<Redis
Component> Service component information objects
- disk
Space String Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
This will be removed in v5.0.0. Please use
additional_disk_space
to specify the space to be added to the defaultdisk_space
defined by the plan.- disk
Space StringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space
- disk
Space StringStep The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_space
needs to increment fromdisk_space_default
by increments of this size.- disk
Space StringUsed Disk space that service is currently using
- maintenance
Window StringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page.- project String
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- project
Vpc StringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- redis
List<Redis
Redi> Redis server provided values
- redis
User RedisConfig Redis User Config Redis user configurable settings
- service
Host String The hostname of the service.
- service
Integrations List<RedisService Integration> Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name String Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- service
Password String Password used for connecting to the service, if applicable
- service
Port Integer The port of the service
- service
Type String Aiven internal service type code
- service
Uri String URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String Username used for connecting to the service, if applicable
- state String
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips List<String> Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- List<Redis
Tag> Tags are key-value pairs that allow you to categorize services.
- termination
Protection Boolean Prevents the service from being deleted. It is recommended to set this to
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.
- additional
Disk stringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name string Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,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
Redis
Component[] Service component information objects
- disk
Space string Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
This will be removed in v5.0.0. Please use
additional_disk_space
to specify the space to be added to the defaultdisk_space
defined by the plan.- disk
Space stringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space stringDefault The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space
- disk
Space stringStep The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_space
needs to increment fromdisk_space_default
by increments of this size.- disk
Space stringUsed Disk space that service is currently using
- maintenance
Window stringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window stringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page.- project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- project
Vpc stringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- redis
Redis
Redi[] Redis server provided values
- redis
User RedisConfig Redis User Config Redis user configurable settings
- service
Host string The hostname of the service.
- service
Integrations RedisService Integration[] Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name string Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- service
Password string Password used for connecting to the service, if applicable
- service
Port number The port of the service
- service
Type string Aiven internal service type code
- service
Uri string URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username string Username used for connecting to the service, if applicable
- state string
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips string[] Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- Redis
Tag[] Tags are key-value pairs that allow you to categorize services.
- termination
Protection boolean Prevents the service from being deleted. It is recommended to set this to
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.
- additional_
disk_ strspace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud_
name str Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,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[Redis
Component Args] Service component information objects
- disk_
space str Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
This will be removed in v5.0.0. Please use
additional_disk_space
to specify the space to be added to the defaultdisk_space
defined by the plan.- disk_
space_ strcap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk_
space_ strdefault The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space
- disk_
space_ strstep The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_space
needs to increment fromdisk_space_default
by increments of this size.- disk_
space_ strused Disk space that service is currently using
- maintenance_
window_ strdow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance_
window_ strtime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan str
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page.- project str
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- project_
vpc_ strid Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- redis
Sequence[Redis
Redi Args] Redis server provided values
- redis_
user_ Redisconfig Redis User Config Args Redis user configurable settings
- service_
host str The hostname of the service.
- service_
integrations Sequence[RedisService Integration Args] Service integrations to specify when creating a service. Not applied after initial service creation
- service_
name str Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- service_
password str Password used for connecting to the service, if applicable
- service_
port int The port of the service
- service_
type str Aiven internal service type code
- service_
uri str URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service_
username str Username used for connecting to the service, if applicable
- state str
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static_
ips Sequence[str] Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- Sequence[Redis
Tag Args] Tags are key-value pairs that allow you to categorize services.
- termination_
protection bool Prevents the service from being deleted. It is recommended to set this to
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.
- additional
Disk StringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name String Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- components List<Property Map>
Service component information objects
- disk
Space String Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
This will be removed in v5.0.0. Please use
additional_disk_space
to specify the space to be added to the defaultdisk_space
defined by the plan.- disk
Space StringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space
- disk
Space StringStep The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_space
needs to increment fromdisk_space_default
by increments of this size.- disk
Space StringUsed Disk space that service is currently using
- maintenance
Window StringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page.- project String
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- project
Vpc StringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- redis List<Property Map>
Redis server provided values
- redis
User Property MapConfig Redis user configurable settings
- service
Host String The hostname of the service.
- service
Integrations List<Property Map> Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name String Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- service
Password String Password used for connecting to the service, if applicable
- service
Port Number The port of the service
- service
Type String Aiven internal service type code
- service
Uri String URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String Username used for connecting to the service, if applicable
- state String
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips List<String> Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- List<Property Map>
Tags are key-value pairs that allow you to categorize services.
- termination
Protection Boolean Prevents the service from being deleted. It is recommended to set this to
true
for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
Supporting Types
RedisComponent, RedisComponentArgs
RedisRedisUserConfig, RedisRedisUserConfigArgs
- Additional
Backup stringRegions - Ip
Filter List<RedisObjects Redis User Config Ip Filter Object> - Ip
Filter List<string>Strings - Ip
Filters List<string> This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- Migration
Redis
Redis User Config Migration - Private
Access RedisRedis User Config Private Access - Privatelink
Access RedisRedis User Config Privatelink Access - Project
To stringFork From - Public
Access RedisRedis User Config Public Access - Recovery
Basebackup stringName - Redis
Acl stringChannels Default - Redis
Io intThreads - Redis
Lfu intDecay Time - Redis
Lfu intLog Factor - Redis
Maxmemory stringPolicy - Redis
Notify stringKeyspace Events - Redis
Number intOf Databases - Redis
Persistence string - Redis
Pubsub intClient Output Buffer Limit - Redis
Ssl bool - Redis
Timeout int - Service
To stringFork From - Static
Ips bool
- Additional
Backup stringRegions - Ip
Filter []RedisObjects Redis User Config Ip Filter Object - Ip
Filter []stringStrings - Ip
Filters []string This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- Migration
Redis
Redis User Config Migration - Private
Access RedisRedis User Config Private Access - Privatelink
Access RedisRedis User Config Privatelink Access - Project
To stringFork From - Public
Access RedisRedis User Config Public Access - Recovery
Basebackup stringName - Redis
Acl stringChannels Default - Redis
Io intThreads - Redis
Lfu intDecay Time - Redis
Lfu intLog Factor - Redis
Maxmemory stringPolicy - Redis
Notify stringKeyspace Events - Redis
Number intOf Databases - Redis
Persistence string - Redis
Pubsub intClient Output Buffer Limit - Redis
Ssl bool - Redis
Timeout int - Service
To stringFork From - Static
Ips bool
- additional
Backup StringRegions - ip
Filter List<RedisObjects Redis User Config Ip Filter Object> - ip
Filter List<String>Strings - ip
Filters List<String> This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- migration
Redis
Redis User Config Migration - private
Access RedisRedis User Config Private Access - privatelink
Access RedisRedis User Config Privatelink Access - project
To StringFork From - public
Access RedisRedis User Config Public Access - recovery
Basebackup StringName - redis
Acl StringChannels Default - redis
Io IntegerThreads - redis
Lfu IntegerDecay Time - redis
Lfu IntegerLog Factor - redis
Maxmemory StringPolicy - redis
Notify StringKeyspace Events - redis
Number IntegerOf Databases - redis
Persistence String - redis
Pubsub IntegerClient Output Buffer Limit - redis
Ssl Boolean - redis
Timeout Integer - service
To StringFork From - static
Ips Boolean
- additional
Backup stringRegions - ip
Filter RedisObjects Redis User Config Ip Filter Object[] - ip
Filter string[]Strings - ip
Filters string[] This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- migration
Redis
Redis User Config Migration - private
Access RedisRedis User Config Private Access - privatelink
Access RedisRedis User Config Privatelink Access - project
To stringFork From - public
Access RedisRedis User Config Public Access - recovery
Basebackup stringName - redis
Acl stringChannels Default - redis
Io numberThreads - redis
Lfu numberDecay Time - redis
Lfu numberLog Factor - redis
Maxmemory stringPolicy - redis
Notify stringKeyspace Events - redis
Number numberOf Databases - redis
Persistence string - redis
Pubsub numberClient Output Buffer Limit - redis
Ssl boolean - redis
Timeout number - service
To stringFork From - static
Ips boolean
- additional_
backup_ strregions - ip_
filter_ Sequence[Redisobjects Redis User Config Ip Filter Object] - ip_
filter_ Sequence[str]strings - ip_
filters Sequence[str] This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- migration
Redis
Redis User Config Migration - private_
access RedisRedis User Config Private Access - privatelink_
access RedisRedis User Config Privatelink Access - project_
to_ strfork_ from - public_
access RedisRedis User Config Public Access - recovery_
basebackup_ strname - redis_
acl_ strchannels_ default - redis_
io_ intthreads - redis_
lfu_ intdecay_ time - redis_
lfu_ intlog_ factor - redis_
maxmemory_ strpolicy - redis_
notify_ strkeyspace_ events - redis_
number_ intof_ databases - redis_
persistence str - redis_
pubsub_ intclient_ output_ buffer_ limit - redis_
ssl bool - redis_
timeout int - service_
to_ strfork_ from - static_
ips bool
- additional
Backup StringRegions - ip
Filter List<Property Map>Objects - ip
Filter List<String>Strings - ip
Filters List<String> This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- migration Property Map
- private
Access Property Map - privatelink
Access Property Map - project
To StringFork From - public
Access Property Map - recovery
Basebackup StringName - redis
Acl StringChannels Default - redis
Io NumberThreads - redis
Lfu NumberDecay Time - redis
Lfu NumberLog Factor - redis
Maxmemory StringPolicy - redis
Notify StringKeyspace Events - redis
Number NumberOf Databases - redis
Persistence String - redis
Pubsub NumberClient Output Buffer Limit - redis
Ssl Boolean - redis
Timeout Number - service
To StringFork From - static
Ips Boolean
RedisRedisUserConfigIpFilterObject, RedisRedisUserConfigIpFilterObjectArgs
- Network string
- Description string
- Network string
- Description string
- network String
- description String
- network string
- description string
- network str
- description str
- network String
- description String
RedisRedisUserConfigMigration, RedisRedisUserConfigMigrationArgs
RedisRedisUserConfigPrivateAccess, RedisRedisUserConfigPrivateAccessArgs
- Prometheus bool
- Redis bool
- Prometheus bool
- Redis bool
- prometheus Boolean
- redis Boolean
- prometheus boolean
- redis boolean
- prometheus bool
- redis bool
- prometheus Boolean
- redis Boolean
RedisRedisUserConfigPrivatelinkAccess, RedisRedisUserConfigPrivatelinkAccessArgs
- Prometheus bool
- Redis bool
- Prometheus bool
- Redis bool
- prometheus Boolean
- redis Boolean
- prometheus boolean
- redis boolean
- prometheus bool
- redis bool
- prometheus Boolean
- redis Boolean
RedisRedisUserConfigPublicAccess, RedisRedisUserConfigPublicAccessArgs
- Prometheus bool
- Redis bool
- Prometheus bool
- Redis bool
- prometheus Boolean
- redis Boolean
- prometheus boolean
- redis boolean
- prometheus bool
- redis bool
- prometheus Boolean
- redis Boolean
RedisServiceIntegration, RedisServiceIntegrationArgs
- Integration
Type string - Source
Service stringName
- Integration
Type string - Source
Service stringName
- integration
Type String - source
Service StringName
- integration
Type string - source
Service stringName
- integration
Type String - source
Service StringName
RedisTag, RedisTagArgs
Import
$ pulumi import aiven:index/redis:Redis redis1 project/service_name
Package Details
- Repository
- Aiven pulumi/pulumi-aiven
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aiven
Terraform Provider.