|
3 | 3 | page_title: "polaris_gcp_permissions Data Source - terraform-provider-polaris" |
4 | 4 | subcategory: "" |
5 | 5 | description: |- |
6 | | - |
| 6 | + The polaris_gcp_permissions data source is used to access information about |
| 7 | + the permissions required by RSC for an RSC feature. |
| 8 | + The polaris_gcp_permissions data source can be used with the |
| 9 | + google_project_iam_custom_role resource and the permissions field of the |
| 10 | + polaris_gcp_project resource to automatically update the permissions of roles |
| 11 | + and notify RSC about the updated. |
| 12 | + Permission Groups |
| 13 | + Following is a list of features and their applicable permission groups. These |
| 14 | + are used when specifying the feature. |
| 15 | + CLOUD_NATIVE_ARCHIVAL |
| 16 | + BASIC - Represents the basic set of permissions required to onboard the |
| 17 | + feature.ENCRYPTION - Represents the set of permissions required for encryption |
| 18 | + operation. |
| 19 | + CLOUD_NATIVE_PROTECTION |
| 20 | + BASIC - Represents the basic set of permissions required to onboard the |
| 21 | + feature.EXPORT_AND_RESTORE - Represents the set of permissions required for export |
| 22 | + and restore operations.FILE_LEVEL_RECOVERY - Represents the set of permissions required for |
| 23 | + file-level recovery operations. |
| 24 | + GCP_SHARED_VPC_HOST |
| 25 | + BASIC - Represents the basic set of permissions required to onboard the |
| 26 | + feature. |
| 27 | + EXOCOMPUTE |
| 28 | + BASIC - Represents the basic set of permissions required to onboard the |
| 29 | + feature. |
| 30 | + -> Note: When permission groups are specified, the BASIC permission group |
| 31 | + is always required . |
| 32 | + -> Note: Due to backward compatibility, the features field allow the |
| 33 | + feature names to be given in 3 different styles: EXAMPLE_FEATURE_NAME, |
| 34 | + example-feature-name or example_feature_name. The recommended style is |
| 35 | + EXAMPLE_FEATURE_NAME as it is what the RSC API itself uses. |
7 | 36 | --- |
8 | 37 |
|
9 | 38 | # polaris_gcp_permissions (Data Source) |
10 | 39 |
|
| 40 | +The `polaris_gcp_permissions` data source is used to access information about |
| 41 | +the permissions required by RSC for an RSC feature. |
11 | 42 |
|
| 43 | +The `polaris_gcp_permissions` data source can be used with the |
| 44 | +`google_project_iam_custom_role` resource and the `permissions` field of the |
| 45 | +`polaris_gcp_project` resource to automatically update the permissions of roles |
| 46 | +and notify RSC about the updated. |
| 47 | + |
| 48 | +## Permission Groups |
| 49 | +Following is a list of features and their applicable permission groups. These |
| 50 | +are used when specifying the feature. |
| 51 | + |
| 52 | +`CLOUD_NATIVE_ARCHIVAL` |
| 53 | + * `BASIC` - Represents the basic set of permissions required to onboard the |
| 54 | + feature. |
| 55 | + * `ENCRYPTION` - Represents the set of permissions required for encryption |
| 56 | + operation. |
| 57 | + |
| 58 | +`CLOUD_NATIVE_PROTECTION` |
| 59 | + * `BASIC` - Represents the basic set of permissions required to onboard the |
| 60 | + feature. |
| 61 | + * `EXPORT_AND_RESTORE` - Represents the set of permissions required for export |
| 62 | + and restore operations. |
| 63 | + * `FILE_LEVEL_RECOVERY` - Represents the set of permissions required for |
| 64 | + file-level recovery operations. |
| 65 | + |
| 66 | +`GCP_SHARED_VPC_HOST` |
| 67 | + * `BASIC` - Represents the basic set of permissions required to onboard the |
| 68 | + feature. |
| 69 | + |
| 70 | +`EXOCOMPUTE` |
| 71 | + * `BASIC` - Represents the basic set of permissions required to onboard the |
| 72 | + feature. |
| 73 | + |
| 74 | +-> **Note:** When permission groups are specified, the `BASIC` permission group |
| 75 | + is always required . |
| 76 | + |
| 77 | +-> **Note:** Due to backward compatibility, the `features` field allow the |
| 78 | + feature names to be given in 3 different styles: `EXAMPLE_FEATURE_NAME`, |
| 79 | + `example-feature-name` or `example_feature_name`. The recommended style is |
| 80 | + `EXAMPLE_FEATURE_NAME` as it is what the RSC API itself uses. |
12 | 81 |
|
13 | 82 | ## Example Usage |
14 | 83 |
|
15 | 84 | ```terraform |
16 | | -data "polaris_gcp_permissions" "default" { |
17 | | - features = [ |
18 | | - "CLOUD_NATIVE_PROTECTION", |
| 85 | +data "polaris_gcp_permissions" "cloud_native_archival" { |
| 86 | + feature = "CLOUD_NATIVE_ARCHIVAL" |
| 87 | + permission_groups = [ |
| 88 | + "BASIC", |
| 89 | + "ENCRYPTION", |
19 | 90 | ] |
20 | 91 | } |
21 | 92 | ``` |
22 | 93 |
|
23 | 94 | <!-- schema generated by tfplugindocs --> |
24 | 95 | ## Schema |
25 | 96 |
|
26 | | -### Required |
| 97 | +### Optional |
27 | 98 |
|
28 | | -- `features` (Set of String) Enabled features. |
| 99 | +- `feature` (String) RSC feature. Note that the feature must be given in the `EXAMPLE_FEATURE_NAME` style. Possible values are `CLOUD_NATIVE_ARCHIVAL`, `CLOUD_NATIVE_PROTECTION`, `GCP_SHARED_VPC_HOST` and `EXOCOMPUTE`. |
| 100 | +- `features` (Set of String, Deprecated) RSC features. Possible values are `CLOUD_NATIVE_ARCHIVAL`, `CLOUD_NATIVE_PROTECTION`, `GCP_SHARED_VPC_HOST` and `EXOCOMPUTE`. **Deprecated:** use `feature` instead. |
| 101 | +- `permission_groups` (Set of String) Permission groups for the RSC feature. Possible values are `BASIC`, `ENCRYPTION`, `EXPORT_AND_RESTORE` and `FILE_LEVEL_RECOVERY`. |
29 | 102 |
|
30 | 103 | ### Read-Only |
31 | 104 |
|
32 | | -- `hash` (String) SHA-256 hash of the permissions, can be used to detect changes to the permissions. |
33 | | -- `id` (String) The ID of this resource. |
34 | | -- `permissions` (List of String) Permissions required for the features enabled. |
| 105 | +- `conditions` (Set of String) Conditions for the permissions with conditions. |
| 106 | +- `hash` (String, Deprecated) SHA-256 hash of the permissions, can be used to detect changes to the permissions. **Deprecated:** use `id` instead. |
| 107 | +- `id` (String) SHA-256 hash of the required permissions, will be updated as the required permissions changes. |
| 108 | +- `permissions` (List of String, Deprecated) Permissions required for the set of RSC features. Includes permissions with conditions. **Deprecated:** use `with_conditions` and `without_conditions` instead. |
| 109 | +- `services` (Set of String) GCP services required for the RSC feature. |
| 110 | +- `with_conditions` (Set of String) Permissions with conditions required for the RSC feature. |
| 111 | +- `without_conditions` (Set of String) Permissions without conditions required for the RSC feature. |
0 commit comments