Yandex

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

getMdbMysqlCluster

Get information about a Yandex Managed MySQL 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.GetMdbMysqlCluster.InvokeAsync(new Yandex.GetMdbMysqlClusterArgs
        {
            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.LookupMdbMysqlCluster(ctx, &GetMdbMysqlClusterArgs{
			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_mysql_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.getMdbMysqlCluster({
    name: "test",
}));

export const networkId = foo.networkId;

Using getMdbMysqlCluster

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 getMdbMysqlCluster(args: GetMdbMysqlClusterArgs, opts?: InvokeOptions): Promise<GetMdbMysqlClusterResult>
function getMdbMysqlClusterOutput(args: GetMdbMysqlClusterOutputArgs, opts?: InvokeOptions): Output<GetMdbMysqlClusterResult>
def get_mdb_mysql_cluster(access: Optional[GetMdbMysqlClusterAccess] = None,
                          cluster_id: Optional[str] = None,
                          deletion_protection: Optional[bool] = None,
                          description: Optional[str] = None,
                          folder_id: Optional[str] = None,
                          labels: Optional[Mapping[str, str]] = None,
                          mysql_config: Optional[Mapping[str, str]] = None,
                          name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetMdbMysqlClusterResult
def get_mdb_mysql_cluster_output(access: Optional[pulumi.Input[GetMdbMysqlClusterAccessArgs]] = None,
                          cluster_id: Optional[pulumi.Input[str]] = None,
                          deletion_protection: Optional[pulumi.Input[bool]] = None,
                          description: Optional[pulumi.Input[str]] = None,
                          folder_id: Optional[pulumi.Input[str]] = None,
                          labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                          mysql_config: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetMdbMysqlClusterResult]
func LookupMdbMysqlCluster(ctx *Context, args *LookupMdbMysqlClusterArgs, opts ...InvokeOption) (*LookupMdbMysqlClusterResult, error)
func LookupMdbMysqlClusterOutput(ctx *Context, args *LookupMdbMysqlClusterOutputArgs, opts ...InvokeOption) LookupMdbMysqlClusterResultOutput

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

public static class GetMdbMysqlCluster 
{
    public static Task<GetMdbMysqlClusterResult> InvokeAsync(GetMdbMysqlClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetMdbMysqlClusterResult> Invoke(GetMdbMysqlClusterInvokeArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Access GetMdbMysqlClusterAccess
Access policy to the MySQL cluster. The structure is documented below.
ClusterId string
The ID of the MySQL cluster.
DeletionProtection bool
Description string
Description of the MySQL 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 MySQL cluster.
MysqlConfig Dictionary<string, string>
MySQL cluster config.
Name string
The name of the MySQL cluster.
Access GetMdbMysqlClusterAccess
Access policy to the MySQL cluster. The structure is documented below.
ClusterId string
The ID of the MySQL cluster.
DeletionProtection bool
Description string
Description of the MySQL 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 MySQL cluster.
MysqlConfig map[string]string
MySQL cluster config.
Name string
The name of the MySQL cluster.
access GetMdbMysqlClusterAccess
Access policy to the MySQL cluster. The structure is documented below.
clusterId string
The ID of the MySQL cluster.
deletionProtection boolean
description string
Description of the MySQL 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 MySQL cluster.
mysqlConfig {[key: string]: string}
MySQL cluster config.
name string
The name of the MySQL cluster.
access GetMdbMysqlClusterAccess
Access policy to the MySQL cluster. The structure is documented below.
cluster_id str
The ID of the MySQL cluster.
deletion_protection bool
description str
Description of the MySQL 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 MySQL cluster.
mysql_config Mapping[str, str]
MySQL cluster config.
name str
The name of the MySQL cluster.

getMdbMysqlCluster Result

The following output properties are available:

Access GetMdbMysqlClusterAccess
Access policy to the MySQL cluster. The structure is documented below.
BackupWindowStart GetMdbMysqlClusterBackupWindowStart
ClusterId string
CreatedAt string
Creation timestamp of the key.
Databases List<GetMdbMysqlClusterDatabase>
A database of the MySQL cluster. The structure is documented below.
DeletionProtection bool
Environment string
Deployment environment of the MySQL cluster.
FolderId string
Health string
Aggregated health of the cluster.
Hosts List<GetMdbMysqlClusterHost>
A host of the MySQL cluster. The structure is documented below.
Id string
The provider-assigned unique ID for this managed resource.
MaintenanceWindow GetMdbMysqlClusterMaintenanceWindow
Maintenance window settings of the MySQL cluster. The structure is documented below.
MysqlConfig Dictionary<string, string>
MySQL cluster config.
Name string
The name of the database.
NetworkId string
ID of the network, to which the MySQL cluster belongs.
Resources GetMdbMysqlClusterResources
Resources allocated to hosts of the MySQL cluster. The structure is documented below.
SecurityGroupIds List<string>
A set of ids of security groups assigned to hosts of the cluster.
Status string
Status of the cluster.
Users List<GetMdbMysqlClusterUser>
A user of the MySQL cluster. The structure is documented below.
Version string
Version of the MySQL cluster.
Description string
Description of the MySQL cluster.
Labels Dictionary<string, string>
A set of key/value label pairs to assign to the MySQL cluster.
Access GetMdbMysqlClusterAccess
Access policy to the MySQL cluster. The structure is documented below.
BackupWindowStart GetMdbMysqlClusterBackupWindowStart
ClusterId string
CreatedAt string
Creation timestamp of the key.
Databases []GetMdbMysqlClusterDatabase
A database of the MySQL cluster. The structure is documented below.
DeletionProtection bool
Environment string
Deployment environment of the MySQL cluster.
FolderId string
Health string
Aggregated health of the cluster.
Hosts []GetMdbMysqlClusterHost
A host of the MySQL cluster. The structure is documented below.
Id string
The provider-assigned unique ID for this managed resource.
MaintenanceWindow GetMdbMysqlClusterMaintenanceWindow
Maintenance window settings of the MySQL cluster. The structure is documented below.
MysqlConfig map[string]string
MySQL cluster config.
Name string
The name of the database.
NetworkId string
ID of the network, to which the MySQL cluster belongs.
Resources GetMdbMysqlClusterResources
Resources allocated to hosts of the MySQL cluster. The structure is documented below.
SecurityGroupIds []string
A set of ids of security groups assigned to hosts of the cluster.
Status string
Status of the cluster.
Users []GetMdbMysqlClusterUser
A user of the MySQL cluster. The structure is documented below.
Version string
Version of the MySQL cluster.
Description string
Description of the MySQL cluster.
Labels map[string]string
A set of key/value label pairs to assign to the MySQL cluster.
access GetMdbMysqlClusterAccess
Access policy to the MySQL cluster. The structure is documented below.
backupWindowStart GetMdbMysqlClusterBackupWindowStart
clusterId string
createdAt string
Creation timestamp of the key.
databases GetMdbMysqlClusterDatabase[]
A database of the MySQL cluster. The structure is documented below.
deletionProtection boolean
environment string
Deployment environment of the MySQL cluster.
folderId string
health string
Aggregated health of the cluster.
hosts GetMdbMysqlClusterHost[]
A host of the MySQL cluster. The structure is documented below.
id string
The provider-assigned unique ID for this managed resource.
maintenanceWindow GetMdbMysqlClusterMaintenanceWindow
Maintenance window settings of the MySQL cluster. The structure is documented below.
mysqlConfig {[key: string]: string}
MySQL cluster config.
name string
The name of the database.
networkId string
ID of the network, to which the MySQL cluster belongs.
resources GetMdbMysqlClusterResources
Resources allocated to hosts of the MySQL cluster. The structure is documented below.
securityGroupIds string[]
A set of ids of security groups assigned to hosts of the cluster.
status string
Status of the cluster.
users GetMdbMysqlClusterUser[]
A user of the MySQL cluster. The structure is documented below.
version string
Version of the MySQL cluster.
description string
Description of the MySQL cluster.
labels {[key: string]: string}
A set of key/value label pairs to assign to the MySQL cluster.
access GetMdbMysqlClusterAccess
Access policy to the MySQL cluster. The structure is documented below.
backup_window_start GetMdbMysqlClusterBackupWindowStart
cluster_id str
created_at str
Creation timestamp of the key.
databases Sequence[GetMdbMysqlClusterDatabase]
A database of the MySQL cluster. The structure is documented below.
deletion_protection bool
environment str
Deployment environment of the MySQL cluster.
folder_id str
health str
Aggregated health of the cluster.
hosts Sequence[GetMdbMysqlClusterHost]
A host of the MySQL cluster. The structure is documented below.
id str
The provider-assigned unique ID for this managed resource.
maintenance_window GetMdbMysqlClusterMaintenanceWindow
Maintenance window settings of the MySQL cluster. The structure is documented below.
mysql_config Mapping[str, str]
MySQL cluster config.
name str
The name of the database.
network_id str
ID of the network, to which the MySQL cluster belongs.
resources GetMdbMysqlClusterResources
Resources allocated to hosts of the MySQL cluster. The structure is documented below.
security_group_ids Sequence[str]
A set of ids of security groups assigned to hosts of the cluster.
status str
Status of the cluster.
users Sequence[GetMdbMysqlClusterUser]
A user of the MySQL cluster. The structure is documented below.
version str
Version of the MySQL cluster.
description str
Description of the MySQL cluster.
labels Mapping[str, str]
A set of key/value label pairs to assign to the MySQL cluster.

Supporting Types

GetMdbMysqlClusterAccess

DataLens bool
Allow access for Yandex DataLens.
WebSql bool
Allows access for SQL queries in the management console.
DataLens bool
Allow access for Yandex DataLens.
WebSql bool
Allows access for SQL queries in the management console.
dataLens boolean
Allow access for Yandex DataLens.
webSql boolean
Allows access for SQL queries in the management console.
data_lens bool
Allow access for Yandex DataLens.
web_sql bool
Allows access for SQL queries in the management console.

GetMdbMysqlClusterBackupWindowStart

Hours int
The hour at which backup will be started.
Minutes int
The minute at which backup will be started.
Hours int
The hour at which backup will be started.
Minutes int
The minute at which backup will be started.
hours number
The hour at which backup will be started.
minutes number
The minute at which backup will be started.
hours int
The hour at which backup will be started.
minutes int
The minute at which backup will be started.

GetMdbMysqlClusterDatabase

Name string
The name of the MySQL cluster.
Name string
The name of the MySQL cluster.
name string
The name of the MySQL cluster.
name str
The name of the MySQL cluster.

GetMdbMysqlClusterHost

Fqdn string
The fully qualified domain name of the host.
ReplicationSource string
Host replication source (fqdn), case when replication_source is empty then host in HA group.
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 MySQL host will be created.
AssignPublicIp bool
Sets whether the host should get a public IP address on creation. Changing this parameter for an existing host is not supported at the moment
Fqdn string
The fully qualified domain name of the host.
ReplicationSource string
Host replication source (fqdn), case when replication_source is empty then host in HA group.
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 MySQL host will be created.
AssignPublicIp bool
Sets whether the host should get a public IP address on creation. Changing this parameter for an existing host is not supported at the moment
fqdn string
The fully qualified domain name of the host.
replicationSource string
Host replication source (fqdn), case when replication_source is empty then host in HA group.
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 MySQL host will be created.
assignPublicIp boolean
Sets whether the host should get a public IP address on creation. Changing this parameter for an existing host is not supported at the moment
fqdn str
The fully qualified domain name of the host.
replication_source str
Host replication source (fqdn), case when replication_source is empty then host in HA group.
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 MySQL host will be created.
assign_public_ip bool
Sets whether the host should get a public IP address on creation. Changing this parameter for an existing host is not supported at the moment

GetMdbMysqlClusterMaintenanceWindow

Day string
Day of the week (in DDD format). Value is one of: “MON”, “TUE”, “WED”, “THU”, “FRI”, “SAT”, “SUN”
Hour int
Hour of the day in UTC (in HH format). Values is between 0 and 23.
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 the week (in DDD format). Value is one of: “MON”, “TUE”, “WED”, “THU”, “FRI”, “SAT”, “SUN”
Hour int
Hour of the day in UTC (in HH format). Values is between 0 and 23.
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 the week (in DDD format). Value is one of: “MON”, “TUE”, “WED”, “THU”, “FRI”, “SAT”, “SUN”
hour number
Hour of the day in UTC (in HH format). Values is between 0 and 23.
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 the week (in DDD format). Value is one of: “MON”, “TUE”, “WED”, “THU”, “FRI”, “SAT”, “SUN”
hour int
Hour of the day in UTC (in HH format). Values is between 0 and 23.
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.

GetMdbMysqlClusterResources

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

GetMdbMysqlClusterUser

AuthenticationPlugin string
Authentication plugin. Allowed values: MYSQL_NATIVE_PASSWORD, CACHING_SHA2_PASSWORD, SHA256_PASSWORD
ConnectionLimits GetMdbMysqlClusterUserConnectionLimits
User’s connection limits. The structure is documented below.
GlobalPermissions List<string>
List user’s global permissions. Allowed values: REPLICATION_CLIENT, REPLICATION_SLAVE, PROCESS or empty list.
Name string
The name of the MySQL cluster.
Password string
The password of the user.
Permissions List<GetMdbMysqlClusterUserPermission>
Set of permissions granted to the user. The structure is documented below.
AuthenticationPlugin string
Authentication plugin. Allowed values: MYSQL_NATIVE_PASSWORD, CACHING_SHA2_PASSWORD, SHA256_PASSWORD
ConnectionLimits GetMdbMysqlClusterUserConnectionLimits
User’s connection limits. The structure is documented below.
GlobalPermissions []string
List user’s global permissions. Allowed values: REPLICATION_CLIENT, REPLICATION_SLAVE, PROCESS or empty list.
Name string
The name of the MySQL cluster.
Password string
The password of the user.
Permissions []GetMdbMysqlClusterUserPermission
Set of permissions granted to the user. The structure is documented below.
authenticationPlugin string
Authentication plugin. Allowed values: MYSQL_NATIVE_PASSWORD, CACHING_SHA2_PASSWORD, SHA256_PASSWORD
connectionLimits GetMdbMysqlClusterUserConnectionLimits
User’s connection limits. The structure is documented below.
globalPermissions string[]
List user’s global permissions. Allowed values: REPLICATION_CLIENT, REPLICATION_SLAVE, PROCESS or empty list.
name string
The name of the MySQL cluster.
password string
The password of the user.
permissions GetMdbMysqlClusterUserPermission[]
Set of permissions granted to the user. The structure is documented below.
authentication_plugin str
Authentication plugin. Allowed values: MYSQL_NATIVE_PASSWORD, CACHING_SHA2_PASSWORD, SHA256_PASSWORD
connection_limits GetMdbMysqlClusterUserConnectionLimits
User’s connection limits. The structure is documented below.
global_permissions Sequence[str]
List user’s global permissions. Allowed values: REPLICATION_CLIENT, REPLICATION_SLAVE, PROCESS or empty list.
name str
The name of the MySQL cluster.
password str
The password of the user.
permissions Sequence[GetMdbMysqlClusterUserPermission]
Set of permissions granted to the user. The structure is documented below.

GetMdbMysqlClusterUserConnectionLimits

MaxConnectionsPerHour int
Max connections per hour.
MaxQuestionsPerHour int
Max questions per hour.
MaxUpdatesPerHour int
Max updates per hour.
MaxUserConnections int
Max user connections.
MaxConnectionsPerHour int
Max connections per hour.
MaxQuestionsPerHour int
Max questions per hour.
MaxUpdatesPerHour int
Max updates per hour.
MaxUserConnections int
Max user connections.
maxConnectionsPerHour number
Max connections per hour.
maxQuestionsPerHour number
Max questions per hour.
maxUpdatesPerHour number
Max updates per hour.
maxUserConnections number
Max user connections.
max_connections_per_hour int
Max connections per hour.
max_questions_per_hour int
Max questions per hour.
max_updates_per_hour int
Max updates per hour.
max_user_connections int
Max user connections.

GetMdbMysqlClusterUserPermission

DatabaseName string
The name of the database that the permission grants access to.
Roles List<string>
List user’s roles in the database. Allowed roles: ALL,ALTER,ALTER_ROUTINE,CREATE,CREATE_ROUTINE,CREATE_TEMPORARY_TABLES, CREATE_VIEW,DELETE,DROP,EVENT,EXECUTE,INDEX,INSERT,LOCK_TABLES,SELECT,SHOW_VIEW,TRIGGER,UPDATE.
DatabaseName string
The name of the database that the permission grants access to.
Roles []string
List user’s roles in the database. Allowed roles: ALL,ALTER,ALTER_ROUTINE,CREATE,CREATE_ROUTINE,CREATE_TEMPORARY_TABLES, CREATE_VIEW,DELETE,DROP,EVENT,EXECUTE,INDEX,INSERT,LOCK_TABLES,SELECT,SHOW_VIEW,TRIGGER,UPDATE.
databaseName string
The name of the database that the permission grants access to.
roles string[]
List user’s roles in the database. Allowed roles: ALL,ALTER,ALTER_ROUTINE,CREATE,CREATE_ROUTINE,CREATE_TEMPORARY_TABLES, CREATE_VIEW,DELETE,DROP,EVENT,EXECUTE,INDEX,INSERT,LOCK_TABLES,SELECT,SHOW_VIEW,TRIGGER,UPDATE.
database_name str
The name of the database that the permission grants access to.
roles Sequence[str]
List user’s roles in the database. Allowed roles: ALL,ALTER,ALTER_ROUTINE,CREATE,CREATE_ROUTINE,CREATE_TEMPORARY_TABLES, CREATE_VIEW,DELETE,DROP,EVENT,EXECUTE,INDEX,INSERT,LOCK_TABLES,SELECT,SHOW_VIEW,TRIGGER,UPDATE.

Package Details

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