|
1 | | ---- |
2 | | -title: About the google_secret_manager_regional_secret resource |
3 | | -platform: gcp |
4 | | ---- |
5 | | - |
6 | | -## Syntax |
7 | | -A `google_secret_manager_regional_secret` is used to test a Google Regional Secret resource |
8 | | - |
9 | | -## Examples |
10 | | -``` |
11 | | -describe google_secret_manager_regional_secret(name: 'projects/<project>/locations/<location>/secrets/<secret>', region: 'value_region') do |
12 | | - it { should exist } |
13 | | -
|
14 | | -end |
15 | | -
|
16 | | -describe google_secret_manager_regional_secret(name: "does_not_exit", region: 'value_region') do |
17 | | - it { should_not exist } |
18 | | -end |
19 | | -``` |
20 | | - |
21 | | -## Properties |
22 | | -Properties that can be accessed from the `google_secret_manager_regional_secret` resource: |
23 | | - |
24 | | - |
25 | | - * `name`: The resource name of the Regional Secret. Format: `projects/{{project}}/locations/{{location}}/secrets/{{secret_id}}` |
26 | | - |
27 | | - * `create_time`: The time at which the Regional Secret was created. |
28 | | - |
29 | | - * `labels`: The labels assigned to this Regional Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62} Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be assigned to a given resource. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. |
30 | | - |
31 | | - * `annotations`: Custom metadata about the regional secret. |
32 | | - Annotations are distinct from various forms of labels. Annotations exist to allow |
33 | | - client tools to store their own state information without requiring a database. |
34 | | - Annotation keys must be between 1 and 63 characters long, have a UTF-8 encoding of |
35 | | - maximum 128 bytes, begin and end with an alphanumeric character ([a-z0-9A-Z]), and |
36 | | - may have dashes (-), underscores (_), dots (.), and alphanumerics in between these |
37 | | - symbols. |
38 | | - The total size of annotation keys and values must be less than 16KiB. |
39 | | - |
40 | | - * `customer_managed_encryption`: Customer Managed Encryption for the secret. |
41 | | - |
42 | | - * `kms_key_name`: Describes the Cloud KMS encryption key that will be used to protect destination secret. |
43 | | - |
44 | | - * `topics`: A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions. |
45 | | - |
46 | | - * `name`: The resource name of the Pub/Sub topic that will be published to, in the following format: projects/*/topics/*. For publication to succeed, the Secret Manager Service Agent service account must have pubsub.publisher permissions on the topic. |
47 | | - |
48 | | - * `expire_time`: Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". |
49 | | - |
50 | | - * `ttl`: The TTL for the Secret. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". |
51 | | - |
52 | | - * `version_destroy_ttl`: Secret Version TTL after destruction request. This is a part of the delayed delete feature on Secret Version. For secret with versionDestroyTtl>0, version destruction doesn't happen immediately on calling destroy instead the version goes to a disabled state and the actual destruction happens after this TTL expires. It must be atleast 24h. |
53 | | - |
54 | | - * `rotation`: The rotation time and period for a Secret. At `next_rotation_time`, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. `topics` must be set to configure rotation. |
55 | | - |
56 | | - * `next_rotation_time`: Timestamp in UTC at which the Secret is scheduled to rotate. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". |
57 | | - |
58 | | - * `rotation_period`: The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotationPeriod is set, `next_rotation_time` must be set. `next_rotation_time` will be advanced by this period when the service automatically sends rotation notifications. |
59 | | - |
60 | | - |
61 | | -## GCP Permissions |
62 | | - |
| 1 | +--- |
| 2 | +title: About the google_secret_manager_regional_secret resource |
| 3 | +platform: gcp |
| 4 | +--- |
| 5 | + |
| 6 | +## Syntax |
| 7 | +A `google_secret_manager_regional_secret` is used to test a Google Regional Secret resource |
| 8 | + |
| 9 | +## Examples |
| 10 | +``` |
| 11 | +describe google_secret_manager_regional_secret(name: 'projects/<project>/locations/<location>/secrets/<secret>', region: 'value_region') do |
| 12 | + it { should exist } |
| 13 | +
|
| 14 | +end |
| 15 | +
|
| 16 | +describe google_secret_manager_regional_secret(name: "does_not_exit", region: 'value_region') do |
| 17 | + it { should_not exist } |
| 18 | +end |
| 19 | +``` |
| 20 | + |
| 21 | +## Properties |
| 22 | +Properties that can be accessed from the `google_secret_manager_regional_secret` resource: |
| 23 | + |
| 24 | + |
| 25 | + * `name`: The resource name of the Regional Secret. Format: `projects/{{project}}/locations/{{location}}/secrets/{{secret_id}}` |
| 26 | + |
| 27 | + * `create_time`: The time at which the Regional Secret was created. |
| 28 | + |
| 29 | + * `labels`: The labels assigned to this Regional Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62} Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be assigned to a given resource. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. |
| 30 | + |
| 31 | + * `annotations`: Custom metadata about the regional secret. |
| 32 | + Annotations are distinct from various forms of labels. Annotations exist to allow |
| 33 | + client tools to store their own state information without requiring a database. |
| 34 | + Annotation keys must be between 1 and 63 characters long, have a UTF-8 encoding of |
| 35 | + maximum 128 bytes, begin and end with an alphanumeric character ([a-z0-9A-Z]), and |
| 36 | + may have dashes (-), underscores (_), dots (.), and alphanumerics in between these |
| 37 | + symbols. |
| 38 | + The total size of annotation keys and values must be less than 16KiB. |
| 39 | + |
| 40 | + * `customer_managed_encryption`: Customer Managed Encryption for the secret. |
| 41 | + |
| 42 | + * `kms_key_name`: Describes the Cloud KMS encryption key that will be used to protect destination secret. |
| 43 | + |
| 44 | + * `topics`: A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions. |
| 45 | + |
| 46 | + * `name`: The resource name of the Pub/Sub topic that will be published to, in the following format: projects/*/topics/*. For publication to succeed, the Secret Manager Service Agent service account must have pubsub.publisher permissions on the topic. |
| 47 | + |
| 48 | + * `expire_time`: Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". |
| 49 | + |
| 50 | + * `ttl`: The TTL for the Secret. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". |
| 51 | + |
| 52 | + * `version_destroy_ttl`: Secret Version TTL after destruction request. This is a part of the delayed delete feature on Secret Version. For secret with versionDestroyTtl>0, version destruction doesn't happen immediately on calling destroy instead the version goes to a disabled state and the actual destruction happens after this TTL expires. It must be atleast 24h. |
| 53 | + |
| 54 | + * `rotation`: The rotation time and period for a Secret. At `next_rotation_time`, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. `topics` must be set to configure rotation. |
| 55 | + |
| 56 | + * `next_rotation_time`: Timestamp in UTC at which the Secret is scheduled to rotate. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". |
| 57 | + |
| 58 | + * `rotation_period`: The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotationPeriod is set, `next_rotation_time` must be set. `next_rotation_time` will be advanced by this period when the service automatically sends rotation notifications. |
| 59 | + |
| 60 | + |
| 61 | +## GCP Permissions |
| 62 | + |
63 | 63 | Ensure the [Secret Manager API](https://console.cloud.google.com/apis/library/secretmanager.googleapis.com/) is enabled for the current project. |
0 commit comments