Create

Creates a MySQL cluster in the specified folder.

TypeScript

import {
  cloudApi,
  decodeMessage,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const Cluster = cloudApi.dataproc.cluster.Cluster;
const CreateClusterRequest =
  cloudApi.dataproc.cluster_service.CreateClusterRequest;
const HadoopConfig_Service = cloudApi.dataproc.cluster.HadoopConfig_Service;
const Role = cloudApi.dataproc.subcluster.Role;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.ClusterServiceClient);

  const operation = await client.create(
    CreateClusterRequest.fromPartial({
      folderId: "folderId",
      // name: "name",
      // description: "description",
      // labels: {"key": "labels"},
      configSpec: {
        // versionId: "versionId",
        // hadoop: {
        // services: [HadoopConfig_Service.HDFS],
        // properties: {"key": "properties"},
        // sshPublicKeys: ["sshPublicKeys"],
        // initializationActions: [{
        // uri: "uri",
        // args: ["args"],
        // timeout: 0
        // }]
        // },
        // subclustersSpec: [{
        // name: "name",
        // role: Role.MASTERNODE,
        // resources: {
        // resourcePresetId: "resourcePresetId",
        // diskTypeId: "diskTypeId",
        // diskSize: 0
        // },
        // subnetId: "subnetId",
        // hostsCount: 0,
        // assignPublicIp: true,
        // autoscalingConfig: {
        // maxHostsCount: 0,
        // preemptible: true,
        // measurementDuration: {
        // seconds: 0,
        // nanos: 0
        // },
        // warmupDuration: {
        // seconds: 0,
        // nanos: 0
        // },
        // stabilizationDuration: {
        // seconds: 0,
        // nanos: 0
        // },
        // cpuUtilizationTarget: 0,
        // decommissionTimeout: 0
        // }
        // }]
      },
      zoneId: "zoneId",
      serviceAccountId: "serviceAccountId",
      // bucket: "bucket",
      // uiProxy: true,
      // securityGroupIds: ["securityGroupIds"],
      // hostGroupIds: ["hostGroupIds"],
      // deletionProtection: true,
      // logGroupId: "logGroupId"
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof Cluster>(finishedOp.response);
    console.log(result);
  }
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.dataproc.v1.subcluster_pb2 import AutoscalingConfig
from yandex.cloud.dataproc.v1.cluster_pb2 import Cluster
from yandex.cloud.dataproc.v1.cluster_service_pb2_grpc import ClusterServiceStub
from yandex.cloud.dataproc.v1.cluster_service_pb2 import CreateClusterConfigSpec
from yandex.cloud.dataproc.v1.cluster_service_pb2 import CreateClusterMetadata
from yandex.cloud.dataproc.v1.cluster_service_pb2 import CreateClusterRequest
from yandex.cloud.dataproc.v1.cluster_service_pb2 import CreateSubclusterConfigSpec
from yandex.cloud.dataproc.v1.cluster_pb2 import HadoopConfig
from yandex.cloud.dataproc.v1.cluster_pb2 import InitializationAction
from yandex.cloud.dataproc.v1.common_pb2 import Resources
from yandex.cloud.dataproc.v1.subcluster_pb2 import Role

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(ClusterServiceStub)
operation = service.Create(
    CreateClusterRequest(
        folder_id="folderId",
        # name = "name",
        # description = "description",
        # labels = {"key": "labels"},
        config_spec=CreateClusterConfigSpec(
            # version_id = "versionId",
            # hadoop = HadoopConfig(
            # services = [HadoopConfig.Service.HDFS],
            # properties = {"key": "properties"},
            # ssh_public_keys = ["sshPublicKeys"],
            # initialization_actions = [InitializationAction(
            # uri = "uri",
            # args = ["args"],
            # timeout = 0
            # )]
            # ),
            # subclusters_spec = [CreateSubclusterConfigSpec(
            # name = "name",
            # role = Role.MASTERNODE,
            # resources = Resources(
            # resource_preset_id = "resourcePresetId",
            # disk_type_id = "diskTypeId",
            # disk_size = 0
            # ),
            # subnet_id = "subnetId",
            # hosts_count = 0,
            # assign_public_ip = true,
            # autoscaling_config = AutoscalingConfig(
            # max_hosts_count = 0,
            # preemptible = true,
            # measurement_duration = Duration(
            # seconds = 0,
            # nanos = 0
            # ),
            # warmup_duration = Duration(
            # seconds = 0,
            # nanos = 0
            # ),
            # stabilization_duration = Duration(
            # seconds = 0,
            # nanos = 0
            # ),
            # cpu_utilization_target = 0,
            # decommission_timeout = 0
            # )
            # )]
        ),
        zone_id="zoneId",
        service_account_id="serviceAccountId",
        # bucket = "bucket",
        # ui_proxy = true,
        # security_group_ids = ["securityGroupIds"],
        # host_group_ids = ["hostGroupIds"],
        # deletion_protection = true,
        # log_group_id = "logGroupId"
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=Cluster,
    meta_type=CreateClusterMetadata,
)
print(operation_result)

CreateClusterRequest

folderId : string

ID of the folder to create the MySQL cluster in.

name : string

Name of the MySQL cluster. The name must be unique within the folder.

description : string

Description of the MySQL cluster.

labels : string

Custom labels for the MySQL cluster as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary".

environment : Cluster.Environment

Deployment environment of the MySQL cluster.

configSpec : ConfigSpec

Configuration and resources for hosts that should be created for the MySQL cluster.

databaseSpecs : DatabaseSpec

Descriptions of databases to be created in the MySQL cluster.

userSpecs : UserSpec

Descriptions of database users to be created in the MySQL cluster.

hostSpecs : HostSpec

Individual configurations for hosts that should be created for the MySQL cluster.

networkId : string

ID of the network to create the cluster in.

ConfigSpec

version : string

Version of MySQL used in the cluster. Possible values:

• 5.7

One of mysqlConfig

Configuration of a MySQL cluster.

• mysqlConfig_5_7 : config.MysqlConfig5_7

  Configuration for a MySQL 5.7 cluster.

resources : Resources

Resources allocated to MySQL hosts.

backupWindowStart : google.type.TimeOfDay

Time to start the daily backup, in the UTC timezone.

DatabaseSpec

name : string

Name of the MySQL database.

UserSpec

name : string

Name of the MySQL user.

password : string

Password of the MySQL user.

permissions : Permission

Set of permissions to grant to the user.

HostSpec

zoneId : string

ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request.

subnetId : string

ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the field Cluster.network_id.

assignPublicIp : bool

Whether the host should get a public IP address on creation.

After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign a public IP to a host without one, recreate the host with assign_public_ip set as needed.

Possible values:

• false - don't assign a public IP to the host.
• true - the host should have a public IP address.

MysqlConfig5_7

Options and structure of MysqlConfig5_7 reflects MySQL 5.7 configuration file

innodbBufferPoolSize : google.protobuf.Int64Value

Size of the InnoDB buffer pool used for caching table and index data.

For details, see MySQL documentation for the parameter.

maxConnections : google.protobuf.Int64Value

The maximum permitted number of simultaneous client connections.

For details, see MySQL documentation for the variable.

longQueryTime : google.protobuf.DoubleValue

Time that it takes to process a query before it is considered slow.

For details, see MySQL documentation for the variable.

Resources

resourcePresetId : string

ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.

diskSize : int64

Volume of the storage available to a host.

diskTypeId : string

Type of the storage environment for the host. Possible values:

• network-ssd - network SSD drive,
• local-ssd - local SSD storage.

Permission

Privilege

• PRIVILEGE_UNSPECIFIED

• ALL_PRIVILEGES

  All privileges that can be made available to the user.

• ALTER

  Altering tables.

• ALTER_ROUTINE

  Altering stored routines (stored procedures and functions).

• CREATE

  Creating tables or indexes.

• CREATE_ROUTINE

  Creating stored routines.

• CREATE_TEMPORARY_TABLES

  Creating temporary tables.

• CREATE_VIEW

  Creating views.

• DELETE

  Deleting tables.

• DROP

  Removing tables or views.

• EVENT

  Creating, altering, dropping, or displaying events for the Event Scheduler.

• EXECUTE

  Executing stored routines.

• INDEX

  Creating and removing indexes.

• INSERT

  Inserting rows into the database.

• LOCK_TABLES

  Using LOCK TABLES statement for tables available with SELECT privilege.

• SELECT

  Selecting rows from tables. Some SELECT statements can be allowed without the SELECT privilege. All statements that read column values require the SELECT privilege. See details in MySQL documentation.

• SHOW_VIEW

  Using the SHOW CREATE VIEW statement. Also needed for views used with EXPLAIN.

• TRIGGER

  Creating, removing, executing, or displaying triggers for a table.

• UPDATE

  Updating rows in the database.

databaseName : string

Name of the database that the permission grants access to.

roles : Privilege

Roles granted to the user within the database.

Operation

An Operation resource. For more information, see Operation.

id : string

ID of the operation.

description : string

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp

Creation timestamp.

createdBy : string

ID of the user or service account who initiated the operation.

modifiedAt : google.protobuf.Timestamp

The time when the Operation resource was last modified.

done : bool

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata : google.protobuf.Any

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

One of result

The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.

• error : google.rpc.Status

  The error result of the operation in case of failure or cancellation.

• response : google.protobuf.Any

  The normal response of the operation in case of success.

  If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

---