Configuring resource caching

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id.

If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

1. View the description of the CLI command to update a resource:

   yc cdn resource update --help
   

2. Get a list of all resources in the default folder:

   yc cdn resource list --format yaml
   

   Result:

   id: s0me1dkfjq********
   folder_id: s0mef01der7p********
   cname: testexample.com
   created_at: "2022-01-19T09:23:57.921365Z"
   updated_at: "2022-01-19T10:55:30.305141Z"
   active: true
   options:
     edge_cache_settings:
       enabled: true
       default value: "345600"
     cache_http_headers:
       enabled: true
       value:
       - content-type
       - content-length
       - connection
       - server
       - date
       - test
     stale:
       enabled: true
       value:
       - error
       - updating
     allowed_http_methods:
       value:
       - GET
       - POST
       - HEAD
       - OPTIONS
   origin_group_id: "89783"
   origin_group_name: My origins group
   origin_protocol: HTTP
   ssl_certificate:
     type: DONT_USE
     status: READY
   

3. To change the cache lifetime, run:

   yc cdn resource update <resource_ID> \
     --cache-expiration-time <time> \
     --browser-cache-expiration-time <time> \
     --ignore-cookie true \
     --ignore-query-string
   

   Where:

   • --cache-expiration-time: Cache lifetime in seconds.
   • --browser-cache-expiration-time: Browser cache lifetime in seconds.
   • --ignore-cookie: If true, ignores cookies.
   • --ignore-query-string: Ignores query parameters.

   Using the CLI, you can only choose to evaluate or ignore all query parameters. To evaluate specific parameters or all parameters except the specified ones, use the management console or API.

   For more information about the yc cdn resource update command, see the CLI reference.

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

To manage infrastructure using Terraform under a service account or user accounts (a Yandex account, a federated account, or a local user), authenticate using the appropriate method.

1. In the configuration file, describe the properties of the yandex_cdn_resource CDN resource you want to create:

   resource "yandex_cdn_resource" "my_resource" {
     cname               = "cdn1.yandex-example.ru"
     active              = false
     origin_protocol     = "https"
     secondary_hostnames = ["cdn-example-1.yandex.ru", "cdn-example-2.yandex.ru"]
     origin_group_id     = yandex_cdn_origin_group.my_group.id
     options {
       edge_cache_settings    = "345600"
       browser_cache_settings = "1800"
       ignore_cookie          = true
       ignore_query_params    = false
     }
   }
   

   Where:

   • cname: Primary domain name used for content distribution. This is a required setting.
   • active: Flag indicating content availability to end users. True: CDN content will be available to clients. This is an optional setting. The default value is true.
   • origin_protocol: Protocol for origins. This is an optional setting. The default value is http.
   • secondary_hostnames: Additional domain names. This is an optional setting.
   • origin_group_id: Origin group ID. This is a required setting. Use the ID from the description of the origin group in the yandex_cdn_origin_group resource.
   • The options section contains additional parameters of CDN resources:
     • browser_cache_settings: Browser cache lifetime in seconds. This is an optional setting. The default value is 0.
     • edge_cache_settings: Cache lifetime for response codes in seconds. This is an optional setting. The default value is 345600.
     • ignore_query_params: Ignore query parameters. This is an optional setting. The default value is false.
     • ignore_cookie: Ignore cookies. This is an optional setting. The default value is false.

   Using Terraform, you can only choose to evaluate or ignore all query parameters. To evaluate specific parameters or all parameters except the specified ones, use the management console or API.

   For more on the properties of yandex_cdn_resource in Terraform, see this provider guide.

2. In the command line, navigate to the directory with the Terraform configuration file.

3. Check the configuration using this command:

   terraform validate
   

   If the configuration is valid, you will get this message:

   Success! The configuration is valid.
   

4. Run this command:

   terraform plan
   

   You will see a list of resources and their properties. No changes will be made at this step. Terraform will show any errors detected in the configuration.

5. Apply the configuration changes:

   terraform apply
   

6. Type yes and press Enter to confirm the changes.

   You can check the CDN resource update in the management console or using this CLI command:

   yc cdn resource list
   

Use the update REST API method for the Resource resource or the ResourceService/Update gRPC API call.

To configure caching of query parameters, provide only one of the fields in the options.queryParamsOptions object and set enabled: true for it:

• ignoreQueryString: If value: true, ignore query parameters in the cache key; if value: false, consider all query parameters.
• queryParamsWhitelist: Consider only query parameters listed in value.
• queryParamsBlacklist: Consider all query parameters except those listed in value.

In the gRPC API, these fields correspond to ignore_query_string, query_params_whitelist, and query_params_blacklist in the options.query_params_options object.