Yandex

v0.10.0 published on Thursday, Nov 18, 2021 by Pulumi

getMdbRedisCluster

Get information about a Yandex Managed Redis cluster. For more information, see the official documentation.

Example Usage

using Pulumi;
using Yandex = Pulumi.Yandex;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = Output.Create(Yandex.GetMdbRedisCluster.InvokeAsync(new Yandex.GetMdbRedisClusterArgs
        {
            Name = "test",
        }));
        this.NetworkId = foo.Apply(foo => foo.NetworkId);
    }

    [Output("networkId")]
    public Output<string> NetworkId { get; set; }
}
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 {
		opt0 := "test"
		foo, err := yandex.LookupMdbRedisCluster(ctx, &GetMdbRedisClusterArgs{
			Name: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("networkId", foo.NetworkId)
		return nil
	})
}
import pulumi
import pulumi_yandex as yandex

foo = yandex.get_mdb_redis_cluster(name="test")
pulumi.export("networkId", foo.network_id)
import * as pulumi from "@pulumi/pulumi";
import * as yandex from "@pulumi/yandex";

const foo = pulumi.output(yandex.getMdbRedisCluster({
    name: "test",
}));

export const networkId = foo.networkId;

Using getMdbRedisCluster

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 getMdbRedisCluster(args: GetMdbRedisClusterArgs, opts?: InvokeOptions): Promise<GetMdbRedisClusterResult>
function getMdbRedisClusterOutput(args: GetMdbRedisClusterOutputArgs, opts?: InvokeOptions): Output<GetMdbRedisClusterResult>
def get_mdb_redis_cluster(cluster_id: Optional[str] = None,
                          deletion_protection: Optional[bool] = None,
                          folder_id: Optional[str] = None,
                          name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetMdbRedisClusterResult
def get_mdb_redis_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
                          deletion_protection: Optional[pulumi.Input[bool]] = None,
                          folder_id: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetMdbRedisClusterResult]
func LookupMdbRedisCluster(ctx *Context, args *LookupMdbRedisClusterArgs, opts ...InvokeOption) (*LookupMdbRedisClusterResult, error)
func LookupMdbRedisClusterOutput(ctx *Context, args *LookupMdbRedisClusterOutputArgs, opts ...InvokeOption) LookupMdbRedisClusterResultOutput

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

public static class GetMdbRedisCluster 
{
    public static Task<GetMdbRedisClusterResult> InvokeAsync(GetMdbRedisClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetMdbRedisClusterResult> Invoke(GetMdbRedisClusterInvokeArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ClusterId string
The ID of the Redis cluster.
DeletionProtection bool
FolderId string
Folder that the resource belongs to. If value is omitted, the default provider folder is used.
Name string
The name of the Redis cluster.
ClusterId string
The ID of the Redis cluster.
DeletionProtection bool
FolderId string
Folder that the resource belongs to. If value is omitted, the default provider folder is used.
Name string
The name of the Redis cluster.
clusterId string
The ID of the Redis cluster.
deletionProtection boolean
folderId string
Folder that the resource belongs to. If value is omitted, the default provider folder is used.
name string
The name of the Redis cluster.
cluster_id str
The ID of the Redis cluster.
deletion_protection bool
folder_id str
Folder that the resource belongs to. If value is omitted, the default provider folder is used.
name str
The name of the Redis cluster.

getMdbRedisCluster Result

The following output properties are available:

ClusterId string
Config GetMdbRedisClusterConfig
Configuration of the Redis cluster. The structure is documented below.
CreatedAt string
Creation timestamp of the key.
DeletionProtection bool
Description string
Description of the Redis cluster.
Environment string
Deployment environment of the Redis cluster.
FolderId string
Health string
Aggregated health of the cluster.
Hosts List<GetMdbRedisClusterHost>
A host of the Redis cluster. The structure is documented below.
Id string
The provider-assigned unique ID for this managed resource.
Labels Dictionary<string, string>
A set of key/value label pairs to assign to the Redis cluster.
MaintenanceWindow GetMdbRedisClusterMaintenanceWindow
Name string
NetworkId string
ID of the network, to which the Redis cluster belongs.
Resources GetMdbRedisClusterResources
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.
TlsEnabled bool
tls support mode enabled/disabled.
ClusterId string
Config GetMdbRedisClusterConfig
Configuration of the Redis cluster. The structure is documented below.
CreatedAt string
Creation timestamp of the key.
DeletionProtection bool
Description string
Description of the Redis cluster.
Environment string
Deployment environment of the Redis cluster.
FolderId string
Health string
Aggregated health of the cluster.
Hosts []GetMdbRedisClusterHost
A host of the Redis cluster. The structure is documented below.
Id string
The provider-assigned unique ID for this managed resource.
Labels map[string]string
A set of key/value label pairs to assign to the Redis cluster.
MaintenanceWindow GetMdbRedisClusterMaintenanceWindow
Name string
NetworkId string
ID of the network, to which the Redis cluster belongs.
Resources GetMdbRedisClusterResources
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.
TlsEnabled bool
tls support mode enabled/disabled.
clusterId string
config GetMdbRedisClusterConfig
Configuration of the Redis cluster. The structure is documented below.
createdAt string
Creation timestamp of the key.
deletionProtection boolean
description string
Description of the Redis cluster.
environment string
Deployment environment of the Redis cluster.
folderId string
health string
Aggregated health of the cluster.
hosts GetMdbRedisClusterHost[]
A host of the Redis cluster. The structure is documented below.
id string
The provider-assigned unique ID for this managed resource.
labels {[key: string]: string}
A set of key/value label pairs to assign to the Redis cluster.
maintenanceWindow GetMdbRedisClusterMaintenanceWindow
name string
networkId string
ID of the network, to which the Redis cluster belongs.
resources GetMdbRedisClusterResources
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.
tlsEnabled boolean
tls support mode enabled/disabled.
cluster_id str
config GetMdbRedisClusterConfig
Configuration of the Redis cluster. The structure is documented below.
created_at str
Creation timestamp of the key.
deletion_protection bool
description str
Description of the Redis cluster.
environment str
Deployment environment of the Redis cluster.
folder_id str
health str
Aggregated health of the cluster.
hosts Sequence[GetMdbRedisClusterHost]
A host of the Redis cluster. The structure is documented below.
id str
The provider-assigned unique ID for this managed resource.
labels Mapping[str, str]
A set of key/value label pairs to assign to the Redis cluster.
maintenance_window GetMdbRedisClusterMaintenanceWindow
name str
network_id str
ID of the network, to which the Redis cluster belongs.
resources GetMdbRedisClusterResources
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.
tls_enabled bool
tls support mode enabled/disabled.

Supporting Types

GetMdbRedisClusterConfig

Databases int
Number of databases (changing requires redis-server restart).
MaxmemoryPolicy string
Redis key eviction policy for a dataset that reaches maximum memory.
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.
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.
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.
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.
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.
version string
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.
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.
version str
Version of Redis (5.0, 6.0 or 6.2).

GetMdbRedisClusterHost

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.
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.
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.
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 str
The availability zone where the Redis host will be created.

GetMdbRedisClusterMaintenanceWindow

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 number
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 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 str
Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

GetMdbRedisClusterResources

DiskSize int
Volume of the storage available to a host, in gigabytes.
DiskTypeId string
Type of the storage of a host.
ResourcePresetId string
DiskSize int
Volume of the storage available to a host, in gigabytes.
DiskTypeId string
Type of the storage of a host.
ResourcePresetId string
diskSize number
Volume of the storage available to a host, in gigabytes.
diskTypeId string
Type of the storage of a host.
resourcePresetId string
disk_size int
Volume of the storage available to a host, in gigabytes.
disk_type_id str
Type of the storage of a host.
resource_preset_id str

Package Details

Repository
https://github.com/pulumi/pulumi-yandex
License
Apache-2.0
Notes
This Pulumi package is based on the yandex Terraform Provider.