Yandex

Pulumi Official
Package maintained by Pulumi
v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi

MdbRedisCluster

Manages a Redis cluster within the Yandex.Cloud. For more information, see the official documentation.

Example Usage

using Pulumi;
using Yandex = Pulumi.Yandex;

class MyStack : Stack
{
    public MyStack()
    {
        var fooVpcNetwork = new Yandex.VpcNetwork("fooVpcNetwork", new Yandex.VpcNetworkArgs
        {
        });
        var fooVpcSubnet = new Yandex.VpcSubnet("fooVpcSubnet", new Yandex.VpcSubnetArgs
        {
            NetworkId = fooVpcNetwork.Id,
            V4CidrBlocks = 
            {
                "10.5.0.0/24",
            },
            Zone = "ru-central1-a",
        });
        var fooMdbRedisCluster = new Yandex.MdbRedisCluster("fooMdbRedisCluster", new Yandex.MdbRedisClusterArgs
        {
            Config = new Yandex.Inputs.MdbRedisClusterConfigArgs
            {
                Password = "your_password",
                Version = "6.0",
            },
            Environment = "PRESTABLE",
            Hosts = 
            {
                new Yandex.Inputs.MdbRedisClusterHostArgs
                {
                    SubnetId = fooVpcSubnet.Id,
                    Zone = "ru-central1-a",
                },
            },
            MaintenanceWindow = new Yandex.Inputs.MdbRedisClusterMaintenanceWindowArgs
            {
                Type = "ANYTIME",
            },
            NetworkId = fooVpcNetwork.Id,
            Resources = new Yandex.Inputs.MdbRedisClusterResourcesArgs
            {
                DiskSize = 16,
                ResourcePresetId = "hm1.nano",
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-yandex/sdk/go/yandex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooVpcNetwork, err := yandex.NewVpcNetwork(ctx, "fooVpcNetwork", nil)
		if err != nil {
			return err
		}
		fooVpcSubnet, err := yandex.NewVpcSubnet(ctx, "fooVpcSubnet", &yandex.VpcSubnetArgs{
			NetworkId: fooVpcNetwork.ID(),
			V4CidrBlocks: pulumi.StringArray{
				pulumi.String("10.5.0.0/24"),
			},
			Zone: pulumi.String("ru-central1-a"),
		})
		if err != nil {
			return err
		}
		_, err = yandex.NewMdbRedisCluster(ctx, "fooMdbRedisCluster", &yandex.MdbRedisClusterArgs{
			Config: &MdbRedisClusterConfigArgs{
				Password: pulumi.String("your_password"),
				Version:  pulumi.String("6.0"),
			},
			Environment: pulumi.String("PRESTABLE"),
			Hosts: MdbRedisClusterHostArray{
				&MdbRedisClusterHostArgs{
					SubnetId: fooVpcSubnet.ID(),
					Zone:     pulumi.String("ru-central1-a"),
				},
			},
			MaintenanceWindow: &MdbRedisClusterMaintenanceWindowArgs{
				Type: pulumi.String("ANYTIME"),
			},
			NetworkId: fooVpcNetwork.ID(),
			Resources: &MdbRedisClusterResourcesArgs{
				DiskSize:         pulumi.Int(16),
				ResourcePresetId: pulumi.String("hm1.nano"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_yandex as yandex

foo_vpc_network = yandex.VpcNetwork("fooVpcNetwork")
foo_vpc_subnet = yandex.VpcSubnet("fooVpcSubnet",
    network_id=foo_vpc_network.id,
    v4_cidr_blocks=["10.5.0.0/24"],
    zone="ru-central1-a")
foo_mdb_redis_cluster = yandex.MdbRedisCluster("fooMdbRedisCluster",
    config=yandex.MdbRedisClusterConfigArgs(
        password="your_password",
        version="6.0",
    ),
    environment="PRESTABLE",
    hosts=[yandex.MdbRedisClusterHostArgs(
        subnet_id=foo_vpc_subnet.id,
        zone="ru-central1-a",
    )],
    maintenance_window=yandex.MdbRedisClusterMaintenanceWindowArgs(
        type="ANYTIME",
    ),
    network_id=foo_vpc_network.id,
    resources=yandex.MdbRedisClusterResourcesArgs(
        disk_size=16,
        resource_preset_id="hm1.nano",
    ))
import * as pulumi from "@pulumi/pulumi";
import * as yandex from "@pulumi/yandex";

const fooVpcNetwork = new yandex.VpcNetwork("foo", {});
const fooVpcSubnet = new yandex.VpcSubnet("foo", {
    networkId: fooVpcNetwork.id,
    v4CidrBlocks: ["10.5.0.0/24"],
    zone: "ru-central1-a",
});
const fooMdbRedisCluster = new yandex.MdbRedisCluster("foo", {
    config: {
        password: "your_password",
        version: "6.0",
    },
    environment: "PRESTABLE",
    hosts: [{
        subnetId: fooVpcSubnet.id,
        zone: "ru-central1-a",
    }],
    maintenanceWindow: {
        type: "ANYTIME",
    },
    networkId: fooVpcNetwork.id,
    resources: {
        diskSize: 16,
        resourcePresetId: "hm1.nano",
    },
});

Coming soon!

Create a MdbRedisCluster Resource

new MdbRedisCluster(name: string, args: MdbRedisClusterArgs, opts?: CustomResourceOptions);
@overload
def MdbRedisCluster(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    config: Optional[MdbRedisClusterConfigArgs] = None,
                    deletion_protection: Optional[bool] = None,
                    description: Optional[str] = None,
                    environment: Optional[str] = None,
                    folder_id: Optional[str] = None,
                    hosts: Optional[Sequence[MdbRedisClusterHostArgs]] = None,
                    labels: Optional[Mapping[str, str]] = None,
                    maintenance_window: Optional[MdbRedisClusterMaintenanceWindowArgs] = None,
                    name: Optional[str] = None,
                    network_id: Optional[str] = None,
                    resources: Optional[MdbRedisClusterResourcesArgs] = None,
                    security_group_ids: Optional[Sequence[str]] = None,
                    sharded: Optional[bool] = None,
                    tls_enabled: Optional[bool] = None)
@overload
def MdbRedisCluster(resource_name: str,
                    args: MdbRedisClusterArgs,
                    opts: Optional[ResourceOptions] = None)
func NewMdbRedisCluster(ctx *Context, name string, args MdbRedisClusterArgs, opts ...ResourceOption) (*MdbRedisCluster, error)
public MdbRedisCluster(string name, MdbRedisClusterArgs args, CustomResourceOptions? opts = null)
public MdbRedisCluster(String name, MdbRedisClusterArgs args)
public MdbRedisCluster(String name, MdbRedisClusterArgs args, CustomResourceOptions options)
type: yandex:MdbRedisCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args MdbRedisClusterArgs
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 MdbRedisClusterArgs
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 MdbRedisClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args MdbRedisClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args MdbRedisClusterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

MdbRedisCluster 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 MdbRedisCluster resource accepts the following input properties:

Config MdbRedisClusterConfigArgs

Configuration of the Redis cluster. The structure is documented below.

Environment string

Deployment environment of the Redis cluster. Can be either PRESTABLE or PRODUCTION.

Hosts List<MdbRedisClusterHostArgs>

A host of the Redis cluster. The structure is documented below.

NetworkId string

ID of the network, to which the Redis cluster belongs.

Resources MdbRedisClusterResourcesArgs

Resources allocated to hosts of the Redis cluster. The structure is documented below.

DeletionProtection bool

Inhibits deletion of the cluster. Can be either true or false.

Description string

Description of the Redis cluster.

FolderId string

The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.

Labels Dictionary<string, string>

A set of key/value label pairs to assign to the Redis cluster.

MaintenanceWindow MdbRedisClusterMaintenanceWindowArgs
Name string

Name of the Redis cluster. Provided by the client when the cluster is created.

SecurityGroupIds List<string>

A set of ids of security groups assigned to hosts of the cluster.

Sharded bool

Redis Cluster mode enabled/disabled.

TlsEnabled bool

tls support mode enabled/disabled.

Config MdbRedisClusterConfigArgs

Configuration of the Redis cluster. The structure is documented below.

Environment string

Deployment environment of the Redis cluster. Can be either PRESTABLE or PRODUCTION.

Hosts []MdbRedisClusterHostArgs

A host of the Redis cluster. The structure is documented below.

NetworkId string

ID of the network, to which the Redis cluster belongs.

Resources MdbRedisClusterResourcesArgs

Resources allocated to hosts of the Redis cluster. The structure is documented below.

DeletionProtection bool

Inhibits deletion of the cluster. Can be either true or false.

Description string

Description of the Redis cluster.

FolderId string

The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.

Labels map[string]string

A set of key/value label pairs to assign to the Redis cluster.

MaintenanceWindow MdbRedisClusterMaintenanceWindowArgs
Name string

Name of the Redis cluster. Provided by the client when the cluster is created.

SecurityGroupIds []string

A set of ids of security groups assigned to hosts of the cluster.

Sharded bool

Redis Cluster mode enabled/disabled.

TlsEnabled bool

tls support mode enabled/disabled.

config MdbRedisClusterConfigArgs

Configuration of the Redis cluster. The structure is documented below.

environment String

Deployment environment of the Redis cluster. Can be either PRESTABLE or PRODUCTION.

hosts List<MdbRedisClusterHostArgs>

A host of the Redis cluster. The structure is documented below.

networkId String

ID of the network, to which the Redis cluster belongs.

resources MdbRedisClusterResourcesArgs

Resources allocated to hosts of the Redis cluster. The structure is documented below.

deletionProtection Boolean

Inhibits deletion of the cluster. Can be either true or false.

description String

Description of the Redis cluster.

folderId String

The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.

labels Map<String,String>

A set of key/value label pairs to assign to the Redis cluster.

maintenanceWindow MdbRedisClusterMaintenanceWindowArgs
name String

Name of the Redis cluster. Provided by the client when the cluster is created.

securityGroupIds List<String>

A set of ids of security groups assigned to hosts of the cluster.

sharded Boolean

Redis Cluster mode enabled/disabled.

tlsEnabled Boolean

tls support mode enabled/disabled.

config MdbRedisClusterConfigArgs

Configuration of the Redis cluster. The structure is documented below.

environment string

Deployment environment of the Redis cluster. Can be either PRESTABLE or PRODUCTION.

hosts MdbRedisClusterHostArgs[]

A host of the Redis cluster. The structure is documented below.

networkId string

ID of the network, to which the Redis cluster belongs.

resources MdbRedisClusterResourcesArgs

Resources allocated to hosts of the Redis cluster. The structure is documented below.

deletionProtection boolean

Inhibits deletion of the cluster. Can be either true or false.

description string

Description of the Redis cluster.

folderId string

The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.

labels {[key: string]: string}

A set of key/value label pairs to assign to the Redis cluster.

maintenanceWindow MdbRedisClusterMaintenanceWindowArgs
name string

Name of the Redis cluster. Provided by the client when the cluster is created.

securityGroupIds string[]

A set of ids of security groups assigned to hosts of the cluster.

sharded boolean

Redis Cluster mode enabled/disabled.

tlsEnabled boolean

tls support mode enabled/disabled.

config MdbRedisClusterConfigArgs

Configuration of the Redis cluster. The structure is documented below.

environment str

Deployment environment of the Redis cluster. Can be either PRESTABLE or PRODUCTION.

hosts Sequence[MdbRedisClusterHostArgs]

A host of the Redis cluster. The structure is documented below.

network_id str

ID of the network, to which the Redis cluster belongs.

resources MdbRedisClusterResourcesArgs

Resources allocated to hosts of the Redis cluster. The structure is documented below.

deletion_protection bool

Inhibits deletion of the cluster. Can be either true or false.

description str

Description of the Redis cluster.

folder_id str

The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.

labels Mapping[str, str]

A set of key/value label pairs to assign to the Redis cluster.

maintenance_window MdbRedisClusterMaintenanceWindowArgs
name str

Name of the Redis cluster. Provided by the client when the cluster is created.

security_group_ids Sequence[str]

A set of ids of security groups assigned to hosts of the cluster.

sharded bool

Redis Cluster mode enabled/disabled.

tls_enabled bool

tls support mode enabled/disabled.

config Property Map

Configuration of the Redis cluster. The structure is documented below.

environment String

Deployment environment of the Redis cluster. Can be either PRESTABLE or PRODUCTION.

hosts List<Property Map>

A host of the Redis cluster. The structure is documented below.

networkId String

ID of the network, to which the Redis cluster belongs.

resources Property Map

Resources allocated to hosts of the Redis cluster. The structure is documented below.

deletionProtection Boolean

Inhibits deletion of the cluster. Can be either true or false.

description String

Description of the Redis cluster.

folderId String

The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.

labels Map<String>

A set of key/value label pairs to assign to the Redis cluster.

maintenanceWindow Property Map
name String

Name of the Redis cluster. Provided by the client when the cluster is created.

securityGroupIds List<String>

A set of ids of security groups assigned to hosts of the cluster.

sharded Boolean

Redis Cluster mode enabled/disabled.

tlsEnabled Boolean

tls support mode enabled/disabled.

Outputs

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

CreatedAt string

Creation timestamp of the key.

Health string

Aggregated health of the cluster. Can be either ALIVE, DEGRADED, DEAD or HEALTH_UNKNOWN. For more information see health field of JSON representation in the official documentation.

Id string

The provider-assigned unique ID for this managed resource.

Status string

Status of the cluster. Can be either CREATING, STARTING, RUNNING, UPDATING, STOPPING, STOPPED, ERROR or STATUS_UNKNOWN. For more information see status field of JSON representation in the official documentation.

CreatedAt string

Creation timestamp of the key.

Health string

Aggregated health of the cluster. Can be either ALIVE, DEGRADED, DEAD or HEALTH_UNKNOWN. For more information see health field of JSON representation in the official documentation.

Id string

The provider-assigned unique ID for this managed resource.

Status string

Status of the cluster. Can be either CREATING, STARTING, RUNNING, UPDATING, STOPPING, STOPPED, ERROR or STATUS_UNKNOWN. For more information see status field of JSON representation in the official documentation.

createdAt String

Creation timestamp of the key.

health String

Aggregated health of the cluster. Can be either ALIVE, DEGRADED, DEAD or HEALTH_UNKNOWN. For more information see health field of JSON representation in the official documentation.

id String

The provider-assigned unique ID for this managed resource.

status String

Status of the cluster. Can be either CREATING, STARTING, RUNNING, UPDATING, STOPPING, STOPPED, ERROR or STATUS_UNKNOWN. For more information see status field of JSON representation in the official documentation.

createdAt string

Creation timestamp of the key.

health string

Aggregated health of the cluster. Can be either ALIVE, DEGRADED, DEAD or HEALTH_UNKNOWN. For more information see health field of JSON representation in the official documentation.

id string

The provider-assigned unique ID for this managed resource.

status string

Status of the cluster. Can be either CREATING, STARTING, RUNNING, UPDATING, STOPPING, STOPPED, ERROR or STATUS_UNKNOWN. For more information see status field of JSON representation in the official documentation.

created_at str

Creation timestamp of the key.

health str

Aggregated health of the cluster. Can be either ALIVE, DEGRADED, DEAD or HEALTH_UNKNOWN. For more information see health field of JSON representation in the official documentation.

id str

The provider-assigned unique ID for this managed resource.

status str

Status of the cluster. Can be either CREATING, STARTING, RUNNING, UPDATING, STOPPING, STOPPED, ERROR or STATUS_UNKNOWN. For more information see status field of JSON representation in the official documentation.

createdAt String

Creation timestamp of the key.

health String

Aggregated health of the cluster. Can be either ALIVE, DEGRADED, DEAD or HEALTH_UNKNOWN. For more information see health field of JSON representation in the official documentation.

id String

The provider-assigned unique ID for this managed resource.

status String

Status of the cluster. Can be either CREATING, STARTING, RUNNING, UPDATING, STOPPING, STOPPED, ERROR or STATUS_UNKNOWN. For more information see status field of JSON representation in the official documentation.

Look up an Existing MdbRedisCluster Resource

Get an existing MdbRedisCluster 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?: MdbRedisClusterState, opts?: CustomResourceOptions): MdbRedisCluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[MdbRedisClusterConfigArgs] = None,
        created_at: Optional[str] = None,
        deletion_protection: Optional[bool] = None,
        description: Optional[str] = None,
        environment: Optional[str] = None,
        folder_id: Optional[str] = None,
        health: Optional[str] = None,
        hosts: Optional[Sequence[MdbRedisClusterHostArgs]] = None,
        labels: Optional[Mapping[str, str]] = None,
        maintenance_window: Optional[MdbRedisClusterMaintenanceWindowArgs] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        resources: Optional[MdbRedisClusterResourcesArgs] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        sharded: Optional[bool] = None,
        status: Optional[str] = None,
        tls_enabled: Optional[bool] = None) -> MdbRedisCluster
func GetMdbRedisCluster(ctx *Context, name string, id IDInput, state *MdbRedisClusterState, opts ...ResourceOption) (*MdbRedisCluster, error)
public static MdbRedisCluster Get(string name, Input<string> id, MdbRedisClusterState? state, CustomResourceOptions? opts = null)
public static MdbRedisCluster get(String name, Output<String> id, MdbRedisClusterState 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.
The following state arguments are supported:
Config MdbRedisClusterConfigArgs

Configuration of the Redis cluster. The structure is documented below.

CreatedAt string

Creation timestamp of the key.

DeletionProtection bool

Inhibits deletion of the cluster. Can be either true or false.

Description string

Description of the Redis cluster.

Environment string

Deployment environment of the Redis cluster. Can be either PRESTABLE or PRODUCTION.

FolderId string

The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.

Health string

Aggregated health of the cluster. Can be either ALIVE, DEGRADED, DEAD or HEALTH_UNKNOWN. For more information see health field of JSON representation in the official documentation.

Hosts List<MdbRedisClusterHostArgs>

A host of the Redis cluster. The structure is documented below.

Labels Dictionary<string, string>

A set of key/value label pairs to assign to the Redis cluster.

MaintenanceWindow MdbRedisClusterMaintenanceWindowArgs
Name string

Name of the Redis cluster. Provided by the client when the cluster is created.

NetworkId string

ID of the network, to which the Redis cluster belongs.

Resources MdbRedisClusterResourcesArgs

Resources allocated to hosts of the Redis cluster. The structure is documented below.

SecurityGroupIds List<string>

A set of ids of security groups assigned to hosts of the cluster.

Sharded bool

Redis Cluster mode enabled/disabled.

Status string

Status of the cluster. Can be either CREATING, STARTING, RUNNING, UPDATING, STOPPING, STOPPED, ERROR or STATUS_UNKNOWN. For more information see status field of JSON representation in the official documentation.

TlsEnabled bool

tls support mode enabled/disabled.

Config MdbRedisClusterConfigArgs

Configuration of the Redis cluster. The structure is documented below.

CreatedAt string

Creation timestamp of the key.

DeletionProtection bool

Inhibits deletion of the cluster. Can be either true or false.

Description string

Description of the Redis cluster.

Environment string

Deployment environment of the Redis cluster. Can be either PRESTABLE or PRODUCTION.

FolderId string

The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.

Health string

Aggregated health of the cluster. Can be either ALIVE, DEGRADED, DEAD or HEALTH_UNKNOWN. For more information see health field of JSON representation in the official documentation.

Hosts []MdbRedisClusterHostArgs

A host of the Redis cluster. The structure is documented below.

Labels map[string]string

A set of key/value label pairs to assign to the Redis cluster.

MaintenanceWindow MdbRedisClusterMaintenanceWindowArgs
Name string

Name of the Redis cluster. Provided by the client when the cluster is created.

NetworkId string

ID of the network, to which the Redis cluster belongs.

Resources MdbRedisClusterResourcesArgs

Resources allocated to hosts of the Redis cluster. The structure is documented below.

SecurityGroupIds []string

A set of ids of security groups assigned to hosts of the cluster.

Sharded bool

Redis Cluster mode enabled/disabled.

Status string

Status of the cluster. Can be either CREATING, STARTING, RUNNING, UPDATING, STOPPING, STOPPED, ERROR or STATUS_UNKNOWN. For more information see status field of JSON representation in the official documentation.

TlsEnabled bool

tls support mode enabled/disabled.

config MdbRedisClusterConfigArgs

Configuration of the Redis cluster. The structure is documented below.

createdAt String

Creation timestamp of the key.

deletionProtection Boolean

Inhibits deletion of the cluster. Can be either true or false.

description String

Description of the Redis cluster.

environment String

Deployment environment of the Redis cluster. Can be either PRESTABLE or PRODUCTION.

folderId String

The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.

health String

Aggregated health of the cluster. Can be either ALIVE, DEGRADED, DEAD or HEALTH_UNKNOWN. For more information see health field of JSON representation in the official documentation.

hosts List<MdbRedisClusterHostArgs>

A host of the Redis cluster. The structure is documented below.

labels Map<String,String>

A set of key/value label pairs to assign to the Redis cluster.

maintenanceWindow MdbRedisClusterMaintenanceWindowArgs
name String

Name of the Redis cluster. Provided by the client when the cluster is created.

networkId String

ID of the network, to which the Redis cluster belongs.

resources MdbRedisClusterResourcesArgs

Resources allocated to hosts of the Redis cluster. The structure is documented below.

securityGroupIds List<String>

A set of ids of security groups assigned to hosts of the cluster.

sharded Boolean

Redis Cluster mode enabled/disabled.

status String

Status of the cluster. Can be either CREATING, STARTING, RUNNING, UPDATING, STOPPING, STOPPED, ERROR or STATUS_UNKNOWN. For more information see status field of JSON representation in the official documentation.

tlsEnabled Boolean

tls support mode enabled/disabled.

config MdbRedisClusterConfigArgs

Configuration of the Redis cluster. The structure is documented below.

createdAt string

Creation timestamp of the key.

deletionProtection boolean

Inhibits deletion of the cluster. Can be either true or false.

description string

Description of the Redis cluster.

environment string

Deployment environment of the Redis cluster. Can be either PRESTABLE or PRODUCTION.

folderId string

The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.

health string

Aggregated health of the cluster. Can be either ALIVE, DEGRADED, DEAD or HEALTH_UNKNOWN. For more information see health field of JSON representation in the official documentation.

hosts MdbRedisClusterHostArgs[]

A host of the Redis cluster. The structure is documented below.

labels {[key: string]: string}

A set of key/value label pairs to assign to the Redis cluster.

maintenanceWindow MdbRedisClusterMaintenanceWindowArgs
name string

Name of the Redis cluster. Provided by the client when the cluster is created.

networkId string

ID of the network, to which the Redis cluster belongs.

resources MdbRedisClusterResourcesArgs

Resources allocated to hosts of the Redis cluster. The structure is documented below.

securityGroupIds string[]

A set of ids of security groups assigned to hosts of the cluster.

sharded boolean

Redis Cluster mode enabled/disabled.

status string

Status of the cluster. Can be either CREATING, STARTING, RUNNING, UPDATING, STOPPING, STOPPED, ERROR or STATUS_UNKNOWN. For more information see status field of JSON representation in the official documentation.

tlsEnabled boolean

tls support mode enabled/disabled.

config MdbRedisClusterConfigArgs

Configuration of the Redis cluster. The structure is documented below.

created_at str

Creation timestamp of the key.

deletion_protection bool

Inhibits deletion of the cluster. Can be either true or false.

description str

Description of the Redis cluster.

environment str

Deployment environment of the Redis cluster. Can be either PRESTABLE or PRODUCTION.

folder_id str

The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.

health str

Aggregated health of the cluster. Can be either ALIVE, DEGRADED, DEAD or HEALTH_UNKNOWN. For more information see health field of JSON representation in the official documentation.

hosts Sequence[MdbRedisClusterHostArgs]

A host of the Redis cluster. The structure is documented below.

labels Mapping[str, str]

A set of key/value label pairs to assign to the Redis cluster.

maintenance_window MdbRedisClusterMaintenanceWindowArgs
name str

Name of the Redis cluster. Provided by the client when the cluster is created.

network_id str

ID of the network, to which the Redis cluster belongs.

resources MdbRedisClusterResourcesArgs

Resources allocated to hosts of the Redis cluster. The structure is documented below.

security_group_ids Sequence[str]

A set of ids of security groups assigned to hosts of the cluster.

sharded bool

Redis Cluster mode enabled/disabled.

status str

Status of the cluster. Can be either CREATING, STARTING, RUNNING, UPDATING, STOPPING, STOPPED, ERROR or STATUS_UNKNOWN. For more information see status field of JSON representation in the official documentation.

tls_enabled bool

tls support mode enabled/disabled.

config Property Map

Configuration of the Redis cluster. The structure is documented below.

createdAt String

Creation timestamp of the key.

deletionProtection Boolean

Inhibits deletion of the cluster. Can be either true or false.

description String

Description of the Redis cluster.

environment String

Deployment environment of the Redis cluster. Can be either PRESTABLE or PRODUCTION.

folderId String

The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.

health String

Aggregated health of the cluster. Can be either ALIVE, DEGRADED, DEAD or HEALTH_UNKNOWN. For more information see health field of JSON representation in the official documentation.

hosts List<Property Map>

A host of the Redis cluster. The structure is documented below.

labels Map<String>

A set of key/value label pairs to assign to the Redis cluster.

maintenanceWindow Property Map
name String

Name of the Redis cluster. Provided by the client when the cluster is created.

networkId String

ID of the network, to which the Redis cluster belongs.

resources Property Map

Resources allocated to hosts of the Redis cluster. The structure is documented below.

securityGroupIds List<String>

A set of ids of security groups assigned to hosts of the cluster.

sharded Boolean

Redis Cluster mode enabled/disabled.

status String

Status of the cluster. Can be either CREATING, STARTING, RUNNING, UPDATING, STOPPING, STOPPED, ERROR or STATUS_UNKNOWN. For more information see status field of JSON representation in the official documentation.

tlsEnabled Boolean

tls support mode enabled/disabled.

Supporting Types

MdbRedisClusterConfig

Password string

Password for the Redis cluster.

Version string

Version of Redis (5.0, 6.0 or 6.2).

Databases int

Number of databases (changing requires redis-server restart).

MaxmemoryPolicy string

Redis key eviction policy for a dataset that reaches maximum memory. Can be any of the listed in the official RedisDB documentation.

NotifyKeyspaceEvents string

Select the events that Redis will notify among a set of classes.

SlowlogLogSlowerThan int

Log slow queries below this number in microseconds.

SlowlogMaxLen int

Slow queries log length.

Timeout int

Close the connection after a client is idle for N seconds.

Password string

Password for the Redis cluster.

Version string

Version of Redis (5.0, 6.0 or 6.2).

Databases int

Number of databases (changing requires redis-server restart).

MaxmemoryPolicy string

Redis key eviction policy for a dataset that reaches maximum memory. Can be any of the listed in the official RedisDB documentation.

NotifyKeyspaceEvents string

Select the events that Redis will notify among a set of classes.

SlowlogLogSlowerThan int

Log slow queries below this number in microseconds.

SlowlogMaxLen int

Slow queries log length.

Timeout int

Close the connection after a client is idle for N seconds.

password String

Password for the Redis cluster.

version String

Version of Redis (5.0, 6.0 or 6.2).

databases Integer

Number of databases (changing requires redis-server restart).

maxmemoryPolicy String

Redis key eviction policy for a dataset that reaches maximum memory. Can be any of the listed in the official RedisDB documentation.

notifyKeyspaceEvents String

Select the events that Redis will notify among a set of classes.

slowlogLogSlowerThan Integer

Log slow queries below this number in microseconds.

slowlogMaxLen Integer

Slow queries log length.

timeout Integer

Close the connection after a client is idle for N seconds.

password string

Password for the Redis cluster.

version string

Version of Redis (5.0, 6.0 or 6.2).

databases number

Number of databases (changing requires redis-server restart).

maxmemoryPolicy string

Redis key eviction policy for a dataset that reaches maximum memory. Can be any of the listed in the official RedisDB documentation.

notifyKeyspaceEvents string

Select the events that Redis will notify among a set of classes.

slowlogLogSlowerThan number

Log slow queries below this number in microseconds.

slowlogMaxLen number

Slow queries log length.

timeout number

Close the connection after a client is idle for N seconds.

password str

Password for the Redis cluster.

version str

Version of Redis (5.0, 6.0 or 6.2).

databases int

Number of databases (changing requires redis-server restart).

maxmemory_policy str

Redis key eviction policy for a dataset that reaches maximum memory. Can be any of the listed in the official RedisDB documentation.

notify_keyspace_events str

Select the events that Redis will notify among a set of classes.

slowlog_log_slower_than int

Log slow queries below this number in microseconds.

slowlog_max_len int

Slow queries log length.

timeout int

Close the connection after a client is idle for N seconds.

password String

Password for the Redis cluster.

version String

Version of Redis (5.0, 6.0 or 6.2).

databases Number

Number of databases (changing requires redis-server restart).

maxmemoryPolicy String

Redis key eviction policy for a dataset that reaches maximum memory. Can be any of the listed in the official RedisDB documentation.

notifyKeyspaceEvents String

Select the events that Redis will notify among a set of classes.

slowlogLogSlowerThan Number

Log slow queries below this number in microseconds.

slowlogMaxLen Number

Slow queries log length.

timeout Number

Close the connection after a client is idle for N seconds.

MdbRedisClusterHost

Zone string

The availability zone where the Redis host will be created. For more information see the official documentation.

Fqdn string

The fully qualified domain name of the host.

ShardName string

The name of the shard to which the host belongs.

SubnetId string

The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.

Zone string

The availability zone where the Redis host will be created. For more information see the official documentation.

Fqdn string

The fully qualified domain name of the host.

ShardName string

The name of the shard to which the host belongs.

SubnetId string

The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.

zone String

The availability zone where the Redis host will be created. For more information see the official documentation.

fqdn String

The fully qualified domain name of the host.

shardName String

The name of the shard to which the host belongs.

subnetId String

The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.

zone string

The availability zone where the Redis host will be created. For more information see the official documentation.

fqdn string

The fully qualified domain name of the host.

shardName string

The name of the shard to which the host belongs.

subnetId string

The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.

zone str

The availability zone where the Redis host will be created. For more information see the official documentation.

fqdn str

The fully qualified domain name of the host.

shard_name str

The name of the shard to which the host belongs.

subnet_id str

The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.

zone String

The availability zone where the Redis host will be created. For more information see the official documentation.

fqdn String

The fully qualified domain name of the host.

shardName String

The name of the shard to which the host belongs.

subnetId String

The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.

MdbRedisClusterMaintenanceWindow

Type string

Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

Day string

Day of week for maintenance window if window type is weekly. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.

Hour int

Hour of day in UTC time zone (1-24) for maintenance window if window type is weekly.

Type string

Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

Day string

Day of week for maintenance window if window type is weekly. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.

Hour int

Hour of day in UTC time zone (1-24) for maintenance window if window type is weekly.

type String

Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

day String

Day of week for maintenance window if window type is weekly. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.

hour Integer

Hour of day in UTC time zone (1-24) for maintenance window if window type is weekly.

type string

Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

day string

Day of week for maintenance window if window type is weekly. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.

hour number

Hour of day in UTC time zone (1-24) for maintenance window if window type is weekly.

type str

Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

day str

Day of week for maintenance window if window type is weekly. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.

hour int

Hour of day in UTC time zone (1-24) for maintenance window if window type is weekly.

type String

Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

day String

Day of week for maintenance window if window type is weekly. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.

hour Number

Hour of day in UTC time zone (1-24) for maintenance window if window type is weekly.

MdbRedisClusterResources

DiskSize int

Volume of the storage available to a host, in gigabytes.

ResourcePresetId string
DiskTypeId string

Type of the storage of Redis hosts - environment default is used if missing.

DiskSize int

Volume of the storage available to a host, in gigabytes.

ResourcePresetId string
DiskTypeId string

Type of the storage of Redis hosts - environment default is used if missing.

diskSize Integer

Volume of the storage available to a host, in gigabytes.

resourcePresetId String
diskTypeId String

Type of the storage of Redis hosts - environment default is used if missing.

diskSize number

Volume of the storage available to a host, in gigabytes.

resourcePresetId string
diskTypeId string

Type of the storage of Redis hosts - environment default is used if missing.

disk_size int

Volume of the storage available to a host, in gigabytes.

resource_preset_id str
disk_type_id str

Type of the storage of Redis hosts - environment default is used if missing.

diskSize Number

Volume of the storage available to a host, in gigabytes.

resourcePresetId String
diskTypeId String

Type of the storage of Redis hosts - environment default is used if missing.

Import

A cluster can be imported using the id of the resource, e.g.

 $ pulumi import yandex:index/mdbRedisCluster:MdbRedisCluster foo cluster_id

Package Details

Repository
https://github.com/pulumi/pulumi-yandex
License
Apache-2.0
Notes

This Pulumi package is based on the yandex Terraform Provider.