Getting information about a security profile

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

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

1. See the description of the CLI command to get security profile information:

   yc smartwebsecurity security-profile --help
   

2. Get information about a security profile by specifying its name or ID:

   yc smartwebsecurity security-profile get <security_profile_name>
   

   Result:

   id: fev0mcqgth1q********
   folder_id: b1geoelk7fld********
   name: demo-profile-simple
   default_action: ALLOW
   security_rules:
     - name: smart-protection
       priority: "99999"
       smart_protection:
         mode: API
     - name: rule-condition-2
       priority: "1"
       rule_condition:
         action: ALLOW
         condition:
           authority:
             authorities:
               - exact_match: example.com
               - exact_match: example.net
   created_at: "2024-11-20T17:49:53.615527Z"
   cloud_id: b1gia87mbaom********
   captcha_id: bpna2egcj76e********
   advanced_rate_limiter_profile_id: fevihb5krdcp********
   

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

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

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

To get information about a security profile using Terraform:

1. Add the data and output sections to the Terraform configuration file:

   data "yandex_sws_security_profile" "my-profile" {
     security_profile_id = "<security_profile_ID>"
   }
   
   output "profile-created" {
     value = data.yandex_sws_security_profile.my-profile.created_at
   }
   

   Where:

   • data "yandex_sws_security_profile": Description of the security profile as a data source:
     • security_profile_id: Security profile ID.
   • output "profile-created": Output variable that contains information about the security profile creation timestamp:
     • value: Returned value.

   You can replace created_at with any other parameter to get the information you need. For more information about the yandex_sws_security_profile data source parameters, see the relevant provider documentation.

2. Create resources:

   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.

   Terraform will create all the required resources and display the output variable values in the terminal. To check the results, run this command:

   terraform output
   

   Result:

   profile-created = "2024-11-20T17:49:53Z"
   

To get detailed information about a security profile, use the get REST API method for the SecurityProfile resource or the SecurityProfile/Get gRPC API call and provide the security profile's ID in the securityProfileId request parameter.