yandex-cloud
yandex-cloud
npm i yandex-cloud
yandex-cloud

yandex-cloud

Yandex.Cloud NodeJS SDK

by yandex-cloud

1.4.3 (see all)License:MITTypeScript:Not Found
npm i yandex-cloud
Readme

Yandex.Cloud SDK (nodejs)

npm License

Need to automate your infrastructure or use services provided by Yandex.Cloud? We've got you covered.

Requirements

  • nodejs >= 12

Installation

npm install @yandex-cloud/nodejs-sdk

Getting started

There are three options for authorization your requests:

OAuth Token

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

const { resourcemanager: { cloud_service: { ListCloudsRequest } } } = cloudApi;

// Initialize SDK with your token
const session = new Session({ oauthToken: 'YOUR_TOKEN' });

// Create service client
const cloudService = session.client(serviceClients.CloudServiceClient);

// Issue request (returns Promise)
const response = await cloudService.list(ListCloudsRequest.fromPartial({
    pageSize: 100,
}));

Metadata Service

Don't forget to assign Service Account for your Instance or Function.

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

const { resourcemanager: { cloud_service: { ListCloudsRequest } } } = cloudApi;

// Initialize SDK with your token
const session = new Session();

// Create service client
const cloudService = session.client(serviceClients.CloudServiceClient);

// Issue request (returns Promise)
const response = await cloudService.list(ListCloudsRequest.fromPartial({
    pageSize: 100,
}));

IAM Token

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

const { resourcemanager: { cloud_service: { ListCloudsRequest } } } = cloudApi;

// Initialize SDK with your token
const session = new Session({ iamToken: 'YOUR_TOKEN' });

// Create service client
const cloudService = session.client(serviceClients.CloudServiceClient);

// Issue request (returns Promise)
const response = await cloudService.list(ListCloudsRequest.fromPartial({
    pageSize: 100,
}));

Check examples directory for more examples.

To run example scripts, you should execute the following commands:

cd examples
npm i
YC_OAUTH_TOKEN=... YC_FOLDER_ID=... npm run start path/to/example.ts

Services

  • AI Translate;
  • AI Vision.
  • Application Load Balancer
  • Billing
  • Cloud CDN
  • Certificate Manager
  • Compute Cloud
  • Container Registry
  • Data Proc
  • DataSphere
  • Data Transfer
  • DNS
  • Identity and Access Management (IAM)
  • IoT Core
  • Managed Service for Kubernetes
  • Key Management Service (KMS)
  • Load Balancer
  • Lockbox
  • Logging
  • Managed DataBase
    • ClickHouse
    • ElasticSearch
    • Greenplum
    • Kafka
    • MongoDB
    • MySQL
    • PostgreSQL
    • Redis
    • MS SQL Server
  • Organization Manager
  • Resource Manager
  • Serverless
    • Functions
    • API Gateway
    • Containers
    • Triggers
    • MDB Proxy
  • Virtual Private Cloud (VPC)
  • Yandex Database (YDB)

If you need generated client for other Yandex.Cloud services, just open an issue.

Downloads/wk

130

GitHub Stars

47

LAST COMMIT

8mos ago

MAINTAINERS

2

CONTRIBUTORS

12

OPEN ISSUES

3

OPEN PRs

1
VersionTagPublished
1.4.3
latest
2yrs ago
2.0.0-alpha.4
alpha
10mos ago
No tutorials found
Add a tutorial
No dependencies found

Rate & Review

100
No reviews found
Be the first to rate