# KMSKeyRing

# KMSKeyRing

| **Property** | **Value** |
|---|---|
| Google Cloud Service Name | Cloud Key Management Service |
| Google Cloud Service Documentation | [/kms/docs/](https://docs.cloud.google.com/kms/docs) |
| Google Cloud REST Resource Name | v1.projects.locations.keyRings |
| Google Cloud REST Resource Documentation | <https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings> |
| Config Connector Resource Short Names | gcpkmskeyring gcpkmskeyrings kmskeyring |
| Config Connector Service Name | cloudkms.googleapis.com |
| Config Connector Resource Fully Qualified Name | kmskeyrings.kms.cnrm.cloud.google.com |
| Can Be Referenced by IAMPolicy/IAMPolicyMember | Yes |
| Supports IAM Conditions | Yes |
| Supports IAM Audit Configs | No |
| IAM External Reference Format | projects/{{project}}/locations/{{location}}/keyRings/{{name}} |
| Config Connector Default Average Reconcile Interval In Seconds | 600 |

## Custom Resource Definition Properties

### Annotations

| Fields ||
|---|---|
| `cnrm.cloud.google.com/project-id` |

### Spec

#### Schema

    location: string
    resourceID: string

| Fields ||
|---|---|
| `location` *Required* | `string` Immutable. The location for the KeyRing. A full list of valid locations can be found by running 'gcloud kms locations list'. |
| `resourceID` *Optional* | `string` Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of \`metadata.name\` is used as the default. |

### Status

#### Schema

    conditions:
    - lastTransitionTime: string
      message: string
      reason: string
      status: string
      type: string
    observedGeneration: integer
    selfLink: string

| Fields ||
|---|---|
| `conditions` | `list (object)` Conditions represent the latest available observations of the KMSKeyRing's current state. |
| `conditions[]` | `object` <br /> |
| `conditions[].lastTransitionTime` | `string` Last time the condition transitioned from one status to another. |
| `conditions[].message` | `string` Human-readable message indicating details about last transition. |
| `conditions[].reason` | `string` Unique, one-word, CamelCase reason for the condition's last transition. |
| `conditions[].status` | `string` Status is the status of the condition. Can be True, False, Unknown. |
| `conditions[].type` | `string` Type is the type of the condition. |
| `observedGeneration` | `integer` ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. |
| `selfLink` | `string` The self link of the created KeyRing in the format projects/{project}/locations/{location}/keyRings/{name}. |

## Sample YAML(s)

### Typical Use Case

    # Copyright 2020 Google LLC
    #
    # Licensed under the Apache License, Version 2.0 (the "License");
    # you may not use this file except in compliance with the License.
    # You may obtain a copy of the License at
    #
    #     http://www.apache.org/licenses/LICENSE-2.0
    #
    # Unless required by applicable law or agreed to in writing, software
    # distributed under the License is distributed on an "AS IS" BASIS,
    # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    # See the License for the specific language governing permissions and
    # limitations under the License.

    apiVersion: kms.cnrm.cloud.google.com/v1beta1
    kind: KMSKeyRing
    metadata:
      name: kmskeyring-sample
    spec:
      location: us-central1

> [!NOTE]
> **Note:** If you have any trouble with instantiating the resource, refer to [Troubleshoot Config Connector](https://docs.cloud.google.com/config-connector/docs/troubleshooting).