SetHTTPSConfig

Updates the HTTPS configuration for the specified bucket.

The updated configuration could take up to 30 minutes to apply to the bucket.

TypeScript

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

const HTTPSConfig = cloudApi.storage.bucket.HTTPSConfig;
const SetBucketHTTPSConfigRequest =
  cloudApi.storage.bucket_service.SetBucketHTTPSConfigRequest;

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

  const operation = await client.setHttpsConfig(
    SetBucketHTTPSConfigRequest.fromPartial({
      name: "name",
      // selfManaged: {
      // certificatePem: "certificatePem",
      // privateKeyPem: "privateKeyPem"
      // },
      // certificateManager: {
      // certificateId: "certificateId"
      // }
    })
  );
  const finishedOp = await waitForOperation(operation, session);

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

Python

import os
import grpc
import yandexcloud

from yandex.cloud.storage.v1.bucket_service_pb2_grpc import BucketServiceStub
from yandex.cloud.storage.v1.bucket_service_pb2 import CertificateManagerHTTPSConfigParams
from yandex.cloud.storage.v1.bucket_pb2 import HTTPSConfig
from yandex.cloud.storage.v1.bucket_service_pb2 import SelfManagedHTTPSConfigParams
from yandex.cloud.storage.v1.bucket_service_pb2 import SetBucketHTTPSConfigMetadata
from yandex.cloud.storage.v1.bucket_service_pb2 import SetBucketHTTPSConfigRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(BucketServiceStub)
operation = service.SetHTTPSConfig(
    SetBucketHTTPSConfigRequest(
        name="name",
        # self_managed = SelfManagedHTTPSConfigParams(
        # certificate_pem = "certificatePem",
        # private_key_pem = "privateKeyPem"
        # ),
        # certificate_manager = CertificateManagerHTTPSConfigParams(
        # certificate_id = "certificateId"
        # )
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=HTTPSConfig,
    meta_type=SetBucketHTTPSConfigMetadata,
)
print(operation_result)

SetBucketHTTPSConfigRequest

name : string

Name of the bucket to update the HTTPS configuration for.

One of params

HTTPS configuration parameters.

• selfManaged : SelfManagedHTTPSConfigParams

  Your TLS certificate, uploaded directly.

Object Storage only supports PEM-encoded certificates.

• certificateManager : CertificateManagerHTTPSConfigParams

  TLS certificate from Certificate Manager.

To create a certificate in Certificate Manager, make a yandex.cloud.certificatemanager.v1.CertificateService.Create request.

SelfManagedHTTPSConfigParams

certificatePem : string

PEM-encoded certificate.

privateKeyPem : string

PEM-encoded private key for the certificate.

CertificateManagerHTTPSConfigParams

A resource for a TLS certificate from Certificate Manager.

certificateId : string

ID of the certificate.

To get the list of all available certificates, make a yandex.cloud.certificatemanager.v1.CertificateService.List request.

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.

---