1. Packages
  2. Aiven Provider
  3. API Docs
  4. getRedis
Viewing docs for Aiven v4.5.2 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
aiven logo
Viewing docs for Aiven v4.5.2 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    The Redis data source provides information about the existing Aiven Redis service.

    Example Usage

    using Pulumi;
    using Aiven = Pulumi.Aiven;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            var redis1 = Output.Create(Aiven.GetRedis.InvokeAsync(new Aiven.GetRedisArgs
            {
                Project = data.Aiven_project.Pr1.Project,
                ServiceName = "my-redis1",
            }));
        }
    
    }
    
    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.LookupRedis(ctx, &GetRedisArgs{
    			Project:     data.Aiven_project.Pr1.Project,
    			ServiceName: "my-redis1",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const redis1 = aiven.getRedis({
        project: data.aiven_project.pr1.project,
        serviceName: "my-redis1",
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    redis1 = aiven.get_redis(project=data["aiven_project"]["pr1"]["project"],
        service_name="my-redis1")
    

    Example coming soon!

    Using getRedis

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

    function getRedis(args: GetRedisArgs, opts?: InvokeOptions): Promise<GetRedisResult>
    function getRedisOutput(args: GetRedisOutputArgs, opts?: InvokeOptions): Output<GetRedisResult>
    def get_redis(project: Optional[str] = None,
                  service_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetRedisResult
    def get_redis_output(project: Optional[pulumi.Input[str]] = None,
                  service_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetRedisResult]
    func LookupRedis(ctx *Context, args *LookupRedisArgs, opts ...InvokeOption) (*LookupRedisResult, error)
    func LookupRedisOutput(ctx *Context, args *LookupRedisOutputArgs, opts ...InvokeOption) LookupRedisResultOutput

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

    public static class GetRedis 
    {
        public static Task<GetRedisResult> InvokeAsync(GetRedisArgs args, InvokeOptions? opts = null)
        public static Output<GetRedisResult> Invoke(GetRedisInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRedisResult> getRedis(GetRedisArgs args, InvokeOptions options)
    public static Output<GetRedisResult> getRedis(GetRedisArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aiven:index/getRedis:getRedis
      arguments:
        # arguments dictionary

    The following arguments are supported:

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

    getRedis Result

    The following output properties are available:

    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<GetRedisComponent>
    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
    Id string
    The provider-assigned unique ID for this managed resource.
    MaintenanceWindowDow string
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    MaintenanceWindowTime string
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    Plan string
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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<GetRedisRedi>
    Redis server provided values
    RedisUserConfigs List<GetRedisRedisUserConfig>
    Redis user configurable settings
    ServiceHost string
    The hostname of the service.
    ServiceIntegrations List<GetRedisServiceIntegration>
    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 []GetRedisComponent
    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
    Id string
    The provider-assigned unique ID for this managed resource.
    MaintenanceWindowDow string
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    MaintenanceWindowTime string
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    Plan string
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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 []GetRedisRedi
    Redis server provided values
    RedisUserConfigs []GetRedisRedisUserConfig
    Redis user configurable settings
    ServiceHost string
    The hostname of the service.
    ServiceIntegrations []GetRedisServiceIntegration
    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<GetRedisComponent>
    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
    id String
    The provider-assigned unique ID for this managed resource.
    maintenanceWindowDow String
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenanceWindowTime String
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan String
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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<GetRedisRedi>
    Redis server provided values
    redisUserConfigs List<GetRedisRedisUserConfig>
    Redis user configurable settings
    serviceHost String
    The hostname of the service.
    serviceIntegrations List<GetRedisServiceIntegration>
    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 GetRedisComponent[]
    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
    id string
    The provider-assigned unique ID for this managed resource.
    maintenanceWindowDow string
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenanceWindowTime string
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan string
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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 GetRedisRedi[]
    Redis server provided values
    redisUserConfigs GetRedisRedisUserConfig[]
    Redis user configurable settings
    serviceHost string
    The hostname of the service.
    serviceIntegrations GetRedisServiceIntegration[]
    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[GetRedisComponent]
    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
    id str
    The provider-assigned unique ID for this managed resource.
    maintenance_window_dow str
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenance_window_time str
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan str
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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[GetRedisRedi]
    Redis server provided values
    redis_user_configs Sequence[GetRedisRedisUserConfig]
    Redis user configurable settings
    service_host str
    The hostname of the service.
    service_integrations Sequence[GetRedisServiceIntegration]
    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
    id String
    The provider-assigned unique ID for this managed resource.
    maintenanceWindowDow String
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenanceWindowTime String
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan String
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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
    redisUserConfigs List<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

    GetRedisComponent

    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

    GetRedisRedisUserConfig

    IpFilters List<string>
    Migration GetRedisRedisUserConfigMigration
    PrivateAccess GetRedisRedisUserConfigPrivateAccess
    PrivatelinkAccess GetRedisRedisUserConfigPrivatelinkAccess
    ProjectToForkFrom string
    PublicAccess GetRedisRedisUserConfigPublicAccess
    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
    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
    IpFilters []string
    Migration GetRedisRedisUserConfigMigration
    PrivateAccess GetRedisRedisUserConfigPrivateAccess
    PrivatelinkAccess GetRedisRedisUserConfigPrivatelinkAccess
    ProjectToForkFrom string
    PublicAccess GetRedisRedisUserConfigPublicAccess
    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
    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
    ipFilters List<String>
    migration GetRedisRedisUserConfigMigration
    privateAccess GetRedisRedisUserConfigPrivateAccess
    privatelinkAccess GetRedisRedisUserConfigPrivatelinkAccess
    projectToForkFrom String
    publicAccess GetRedisRedisUserConfigPublicAccess
    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
    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
    ipFilters string[]
    migration GetRedisRedisUserConfigMigration
    privateAccess GetRedisRedisUserConfigPrivateAccess
    privatelinkAccess GetRedisRedisUserConfigPrivatelinkAccess
    projectToForkFrom string
    publicAccess GetRedisRedisUserConfigPublicAccess
    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
    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
    ipFilters List<String>
    migration Property Map
    privateAccess Property Map
    privatelinkAccess Property Map
    projectToForkFrom String
    publicAccess Property Map
    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
    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

    GetRedisRedisUserConfigMigration

    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

    GetRedisRedisUserConfigPrivateAccess

    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

    GetRedisRedisUserConfigPrivatelinkAccess

    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

    GetRedisRedisUserConfigPublicAccess

    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

    GetRedisServiceIntegration

    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
      Try Pulumi Cloud free. Your team will thank you.