Contact UsGet started

Object Storage API, gRPC: BucketService.SetHTTPSConfig

Written by
Updated at November 26, 2024

Updates the HTTPS configuration for the specified bucket.

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

gRPC request

rpc SetHTTPSConfig (SetBucketHTTPSConfigRequest) returns (operation.Operation)

SetBucketHTTPSConfigRequest

{
  "name": "string",
  // Includes only one of the fields `self_managed`, `certificate_manager`
  "self_managed": {
    "certificate_pem": "string",
    "private_key_pem": "string"
  },
  "certificate_manager": {
    "certificate_id": "string"
  }
  // end of the list of possible fields
}

Field

Description

name

string

Required field. Name of the bucket to update the HTTPS configuration for.

self_managed

SelfManagedHTTPSConfigParams

Your TLS certificate, uploaded directly.

Object Storage only supports PEM-encoded certificates.

Includes only one of the fields self_managed, certificate_manager.

HTTPS configuration parameters.

certificate_manager

CertificateManagerHTTPSConfigParams

TLS certificate from Certificate Manager.

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

Includes only one of the fields self_managed, certificate_manager.

HTTPS configuration parameters.

SelfManagedHTTPSConfigParams

Field

Description

certificate_pem

string

PEM-encoded certificate.

private_key_pem

string

PEM-encoded private key for the certificate.

CertificateManagerHTTPSConfigParams

A resource for a TLS certificate from Certificate Manager.

Field

Description

certificate_id

string

ID of the certificate.

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

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "name": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "name": "string",
    "source_type": "SourceType",
    "issuer": "google.protobuf.StringValue",
    "subject": "google.protobuf.StringValue",
    "dns_names": [
      "string"
    ],
    "not_before": "google.protobuf.Timestamp",
    "not_after": "google.protobuf.Timestamp",
    "certificate_id": "string"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

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

modified_at

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

SetBucketHTTPSConfigMetadata

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.

error

google.rpc.Status

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

Includes only one of the fields error, response.

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.

response

HTTPSConfig

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.

Includes only one of the fields error, response.

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.

SetBucketHTTPSConfigMetadata

Field

Description

name

string

Name of the bucket the HTTPS configuration is being updated for.

HTTPSConfig

A resource for HTTPS configuration of a bucket.

Field

Description

name

string

Name of the bucket.

source_type

enum SourceType

Type of TLS certificate source.

  • SOURCE_TYPE_UNSPECIFIED
  • SOURCE_TYPE_SELF_MANAGED: Your certificate, uploaded directly.
  • SOURCE_TYPE_MANAGED_BY_CERTIFICATE_MANAGER: Certificate managed by Certificate Manager.

issuer

google.protobuf.StringValue

Issuer of the TLS certificate.

subject

google.protobuf.StringValue

Subject of the TLS certificate.

dns_names[]

string

List of DNS names of the TLS certificate (Subject Alternative Name field).

not_before

google.protobuf.Timestamp

Start of the TLS certificate validity period (Not Before field).

not_after

google.protobuf.Timestamp

End of the TLS certificate validity period (Not After field)

certificate_id

string

ID of the TLS certificate in Certificate Manager.

To get information about the certificate from Certificate Manager, make a
yandex.cloud.certificatemanager.v1.CertificateService.Get request.
Previous
GetHTTPSConfig
Next
DeleteHTTPSConfig