forked from GoogleCloudPlatform/python-docs-samples
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathenable_key_version.py
More file actions
55 lines (44 loc) · 2.03 KB
/
Copy pathenable_key_version.py
File metadata and controls
55 lines (44 loc) · 2.03 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# 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
# [START kms_enable_key_version]
def enable_key_version(project_id, location_id, key_ring_id, key_id, version_id):
"""
Enable a key.
Args:
project_id (string): Google Cloud project ID (e.g. 'my-project').
location_id (string): Cloud KMS location (e.g. 'us-east1').
key_ring_id (string): ID of the Cloud KMS key ring (e.g. 'my-key-ring').
key_id (string): ID of the key to use (e.g. 'my-key').
version_id (string): ID of the key version to enable (e.g. '1').
Returns:
CryptoKeyVersion: The version.
"""
# Import the client library.
from google.cloud import kms
# Create the client.
client = kms.KeyManagementServiceClient()
# Build the key version name.
key_version_name = client.crypto_key_version_path(project_id, location_id, key_ring_id, key_id, version_id)
# Build the key version. We need to build a full proto instead of a dict due
# to https://github.com/googleapis/gapic-generator-python/issues/364.
from google.cloud.kms_v1.proto import resources_pb2
key_version = resources_pb2.CryptoKeyVersion()
key_version.name = key_version_name
key_version.state = kms.enums.CryptoKeyVersion.CryptoKeyVersionState.ENABLED
# Build the update mask.
update_mask = {'paths': ['state']}
# Call the API.
enabled_version = client.update_crypto_key_version(key_version, update_mask)
print('Enabled key version: {}'.format(enabled_version.name))
return enabled_version
# [END kms_enable_key_version]