Bucket label management

Written by

Updated at October 17, 2024

Adding or updating labels
Viewing labels
Deleting labels

A bucket label is a key-value pair used for logical bucket labeling.

Note

In Yandex Cloud terminology, we use the label concept to denote logical resource labeling. However, as Object Storage is compatible with Amazon S3 API, in the AWS CLI commands and API parameters, we use tag, which is a term native to AWS.

Adding or updating labels

Management console

Yandex Cloud CLI

AWS CLI

Terraform

API

In the management console, select the folder where the bucket is located.
Select Object Storage.
Select a bucket from the list.
Click the Settings tab in the left-hand menu.
Click Add label.
Enter a label in key: value format. To edit an existing label, enter its key and a new value.
Click Enter.
Click Save.

Warning

Updating the bucket settings will completely overwrite the existing set of labels with the new one.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

View the description of the CLI command for changing the bucket settings:
```
yc storage bucket update --help
```

Get a list of buckets in the default folder:

yc storage bucket list

Result:

+------------------+----------------------+----------+-----------------------+---------------------+
|       NAME       |      FOLDER ID       | MAX SIZE | DEFAULT STORAGE CLASS |     CREATED AT      |
+------------------+----------------------+----------+-----------------------+---------------------+
| my-bucket        | b1gmit33ngp3******** | 10       | STANDARD              | 2022-12-16 13:58:18 |
+------------------+----------------------+----------+-----------------------+---------------------+

Add labels by specifying the name of the required bucket:

yc storage bucket update <bucket_name> \
  --tags <label_1_key>=<label_1_value>,<label_2_key>=<label_2_value>,...,<label_n_key>=<label_n_value>

Where --tags is a flag to list bucket labels in key=value format.

Result:

name: my-bucket
folder_id: b1gmit33ngp3********
default_storage_class: STANDARD
versioning: VERSIONING_ENABLED
acl: {}
created_at: "2023-04-24T14:15:28.240705Z"
tags:
  - key: key-tag
    value: key-value

Warning

Updating the bucket settings will completely overwrite the existing set of labels with the new one.

If you do not have the AWS CLI yet, install and configure it.

In the terminal, run this command:

aws s3api put-bucket-tagging \
  --bucket <bucket_name> \
  --tagging 'TagSet=[{Key=<label_key>,Value=<label_value>},{Key=<label_key>,Value=<label_value>}]' \
  --endpoint-url=https://storage.yandexcloud.net

Where:

--bucket: Bucket name.
--tagging: Array of bucket labels, where:
- Key: Label key of the string type
- Value: Label value of the string type
--endpoint-url: Object Storage endpoint

Warning

Updating the bucket settings will completely overwrite the existing set of labels with the new one.

Note

Terraform uses a service account to interact with Object Storage. Assign to the service account the required role, e.g., storage.admin, for the folder where you are going to create resources.

Terraform allows you to quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. Configuration files store the infrastructure description in the HashiCorp Configuration Language (HCL). Terraform and its providers are distributed under the Business Source License.

For more information about the provider resources, see the documentation on the Terraform website or the mirror.

If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

If you don't have Terraform, install it and configure the Yandex Cloud provider.

Open the Terraform configuration file and add a section called tags to the fragment describing the bucket:
```
resource "yandex_storage_bucket" "test-bucket" {
  bucket           = "<bucket_name>"
  ...
  tags             = {
    <label_1_key> = "<label_1_value>"
    <label_2_key> = "<label_2_value>"
  }
  ...
}
```
Where tags is an array of bucket labels in <key> = "<value>" format.

For more information about the yandex_storage_bucket resource parameters in Terraform, see the provider documentation.
Apply the changes:
1. In the terminal, change to the folder where you edited the configuration file.
2. Make sure the configuration file is correct using the command:
```
terraform validate
```
  If the configuration is correct, the following message is returned:
```
Success! The configuration is valid.
```
3. Run the command:
```
terraform plan
```
  The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.
4. Apply the configuration changes:
```
terraform apply
```
5. Confirm the changes: type yes in the terminal and press Enter.

That will add the labels to the bucket. You can check the new labels and the bucket's configuration using the management console or this CLI command:

yc storage bucket get <bucket_name> --full

Warning

Updating the bucket settings will completely overwrite the existing set of labels with the new one.

To add or update bucket labels, use the update REST API method for the Bucket resource, the BucketService/Update gRPC API call, or the putBucketTagging S3 API method.

Sample gRPC API call

export IAM_TOKEN="<IAM token>"
grpcurl \
  -H "Authorization: Bearer $IAM_TOKEN" \
  -d '{"name": "test-bucket", "update_mask": {"paths": ["tags"]}, "tags": [{"key": "test-key", "value": "test-value"}]}' \
  storage.api.cloud.yandex.net:443 \
  yandex.cloud.storage.v1.BucketService/Update

Where:

IAM_TOKEN: IAM token.
name: Bucket name.
update_mask: List of bucket parameters to update.
tags: List of bucket labels.
key: Label key.
value: Label value.

Result:

{
  "id": "e3e5fsr6076bo*******",
  "description": "update bucket",
  "createdAt": "2023-04-27T12:01:03.636597Z",
  "createdBy": "ajelcjkv67arb*******",
  "modifiedAt": "2023-04-27T12:01:03.636597Z",
  "done": true,
  "metadata": {"@type":"type.googleapis.com/yandex.cloud.storage.v1.UpdateBucketMetadata","name":"test-bucket"},
  "response": {"@type":"type.googleapis.com/yandex.cloud.storage.v1.Bucket","acl":{},"createdAt":"2023-03-27T08:23:26.890770Z","defaultStorageClass":"STANDARD","folderId":"b1gsm0k26v1l2*******","maxSize":"53687091200","name":"test-bucket","tags":[{"key":"test-key","value":"test-value"}],"versioning":"VERSIONING_DISABLED"}
}

Viewing labels

Management console

Yandex Cloud CLI

AWS CLI

API

In the management console, select the folder where the bucket is located.
Select Object Storage.
Select a bucket from the list.
Click the Settings tab in the left-hand menu.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

See a description of the CLI command to get bucket information:
```
yc storage bucket get --help
```

Get a list of buckets in the default folder:

yc storage bucket list

Result:

 +------------------+----------------------+----------+-----------------------+---------------------+
 |       NAME       |      FOLDER ID       | MAX SIZE | DEFAULT STORAGE CLASS |     CREATED AT      |
 +------------------+----------------------+----------+-----------------------+---------------------+
 | my-bucket        | b1gmit33ngp3******** | 10       | STANDARD              | 2022-12-16 13:58:18 |
 +------------------+----------------------+----------+-----------------------+---------------------+

Get information about the labels by specifying the name of the required bucket:

yc storage bucket get <bucket_name> --full

Result:

name: my-bucket
folder_id: b1gmit33ngp3********
default_storage_class: STANDARD
...
tags:
  - key: key-tag
    value: key-value
...

If you do not have the AWS CLI yet, install and configure it.

In the terminal, run this command:

aws s3api get-bucket-tagging \
  --bucket <bucket_name> \
  --endpoint-url=https://storage.yandexcloud.net

Where:

--bucket: Bucket name.
--endpoint-url: Object Storage endpoint.

Result:

{
    "TagSet": [
        {
            "Key": "test-key-1",
            "Value": "test-value-1"
        },
        {
            "Key": "test-key-2",
            "Value": "test-value-2"
        }
    ]
}

To view bucket labels, use the get REST API method for the Bucket resource, the BucketService/Get gRPC API call, or the getBucketTagging S3 API method.

Sample gRPC API call

export IAM_TOKEN="<IAM token>"
grpcurl \
  -H "Authorization: Bearer $IAM_TOKEN" \
  -d '{"name": "test-bucket", "view": "VIEW_FULL"}' \
  storage.api.cloud.yandex.net:443 \
  yandex.cloud.storage.v1.BucketService/Get

Where:

IAM_TOKEN: IAM token.
name: Bucket name.
view: Amount of information being provided (VIEW_FULL means full information about the bucket).

Result:

{
  "name": "test-bucket",
  "folderId": "b1gsm0k26v1l2*******",
  "anonymousAccessFlags": {
    "read": true,
    "list": true,
    "configRead": true
  },
  "defaultStorageClass": "STANDARD",
  "versioning": "VERSIONING_DISABLED",
  "maxSize": "53687091200",
  "acl": {

  },
  "createdAt": "2023-03-27T08:23:26.890770Z",
  "websiteSettings": {
    "redirectAllRequests": {

    }
  },
  "tags": [
    {
      "key": "test-key",
      "value": "test-value"
    }
  ]
}

Deleting labels

Management console

Yandex Cloud CLI

AWS CLI

Terraform

API

In the management console, select the folder where the bucket is located.
Select Object Storage.
Select a bucket from the list.
Click the Settings tab in the left-hand menu.
Click next to the appropriate label.
Click Save.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

View the description of the CLI command for changing the bucket settings:
```
yc storage bucket update --help
```

Get a list of buckets in the default folder:

yc storage bucket list

Result:

+------------------+----------------------+----------+-----------------------+---------------------+
|       NAME       |      FOLDER ID       | MAX SIZE | DEFAULT STORAGE CLASS |     CREATED AT      |
+------------------+----------------------+----------+-----------------------+---------------------+
| my-bucket        | b1gmit33ngp3******** | 10       | STANDARD              | 2022-12-16 13:58:18 |
+------------------+----------------------+----------+-----------------------+---------------------+

Delete labels by specifying the name of the required bucket:

yc storage bucket update <bucket_name> \
  --remove-tags

Result:

name: my-bucket
folder_id: b1gmit33ngp3********
default_storage_class: STANDARD
versioning: VERSIONING_ENABLED
acl: {}
created_at: "2023-04-24T14:15:28.240705Z"

If you do not have the AWS CLI yet, install and configure it.

In the terminal, run this command:

aws s3api delete-bucket-tagging \
  --bucket <bucket_name> \
  --endpoint-url=https://storage.yandexcloud.net

Where:

--bucket: Bucket name.
--endpoint-url: Object Storage endpoint.

Note

Terraform uses a service account to interact with Object Storage. Assign to the service account the required role, e.g., storage.admin, for the folder where you are going to create resources.

If you don't have Terraform, install it and configure the Yandex Cloud provider.

Open the Terraform configuration file and delete the tags section from the fragment describing the bucket.

Example of a bucket tag description in the Terraform configuration

resource "yandex_storage_bucket" "test-bucket" {
  bucket           = "<bucket_name>"
  ...
  tags             = {
    <label_1_key> = "<label_1_value>"
    <label_2_key> = "<label_2_value>"
  }
  ...
}

Apply the changes:
1. In the terminal, change to the folder where you edited the configuration file.
2. Make sure the configuration file is correct using the command:
```
terraform validate
```
  If the configuration is correct, the following message is returned:
```
Success! The configuration is valid.
```
3. Run the command:
```
terraform plan
```
  The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.
4. Apply the configuration changes:
```
terraform apply
```
5. Confirm the changes: type yes in the terminal and press Enter.

That will delete the bucket's labels. You can check the deletion of labels and the bucket's configuration using the management console or this CLI command:

yc storage bucket get <bucket_name> --full

To delete bucket labels, use the update REST API method for the Bucket resource, the BucketService/Update gRPC API call, or the deleteBucketTagging S3 API method.

Sample gRPC API call

export IAM_TOKEN="<IAM token>"
grpcurl \
  -H "Authorization: Bearer $IAM_TOKEN" \
  -d '{"name": "test-bucket", "update_mask": {"paths": ["tags"]}, "tags": []}' \
  storage.api.cloud.yandex.net:443 \
  yandex.cloud.storage.v1.BucketService/Update

Where:

IAM_TOKEN: IAM token.
name: Bucket name.
update_mask: List of bucket parameters to update.
tags: List of bucket labels.

Result:

{
  "id": "e3epc33apcche*******",
  "description": "update bucket",
  "createdAt": "2023-04-27T12:18:18.885391Z",
  "createdBy": "ajelcjkv67arb*******",
  "modifiedAt": "2023-04-27T12:18:18.885391Z",
  "done": true,
  "metadata": {"@type":"type.googleapis.com/yandex.cloud.storage.v1.UpdateBucketMetadata","name":"test-bucket-777"},
  "response": {"@type":"type.googleapis.com/yandex.cloud.storage.v1.Bucket","acl":{},"createdAt":"2023-03-27T08:23:26.890770Z","defaultStorageClass":"STANDARD","folderId":"b1gsm0k26v1l2*******","maxSize":"53687091200","name":"test-bucket-777","versioning":"VERSIONING_DISABLED"}
}

Bucket label management

Adding or updating labelsAdding or updating labels

Viewing labelsViewing labels

Deleting labelsDeleting labels

Was the article helpful?

Adding or updating labels

Viewing labels

Deleting labels