Class: Google::Cloud::Kms::V1::CryptoKey
- Inherits:
-
Object
- Object
- Google::Cloud::Kms::V1::CryptoKey
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/kms/v1/resources.rb
Overview
Defined Under Namespace
Modules: CryptoKeyPurpose Classes: LabelsEntry
Instance Attribute Summary collapse
-
#create_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#crypto_key_backend ⇒ ::String
Immutable.
-
#destroy_scheduled_duration ⇒ ::Google::Protobuf::Duration
Immutable.
-
#import_only ⇒ ::Boolean
Immutable.
-
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Labels with user-defined metadata.
-
#name ⇒ ::String
readonly
Output only.
-
#next_rotation_time ⇒ ::Google::Protobuf::Timestamp
At next_rotation_time, the Key Management Service will automatically:.
-
#primary ⇒ ::Google::Cloud::Kms::V1::CryptoKeyVersion
readonly
Output only.
-
#purpose ⇒ ::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose
Immutable.
-
#rotation_period ⇒ ::Google::Protobuf::Duration
next_rotation_time will be advanced by this period when the service automatically rotates a key.
-
#version_template ⇒ ::Google::Cloud::Kms::V1::CryptoKeyVersionTemplate
A template describing settings for new CryptoKeyVersion instances.
Instance Attribute Details
#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The time at which this CryptoKey was created.
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140 class CryptoKey include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} # describes the cryptographic capabilities of a # {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used # for the operations allowed by its purpose. For more information, see [Key # purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes). module CryptoKeyPurpose # Not specified. CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#encrypt Encrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}. ENCRYPT_DECRYPT = 1 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_SIGN = 5 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_DECRYPT = 6 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#mac_sign MacSign}. MAC = 9 end end |
#crypto_key_backend ⇒ ::String
Returns Immutable. The resource name of the backend environment where the key
material for all CryptoKeyVersions
associated with this CryptoKey reside and
where all related cryptographic operations are performed. Only applicable
if CryptoKeyVersions have a
ProtectionLevel of
[EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], with the
resource name in the format projects/*/locations/*/ekmConnections/*
.
Note, this list is non-exhaustive and may apply to additional
ProtectionLevels in the future.
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140 class CryptoKey include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} # describes the cryptographic capabilities of a # {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used # for the operations allowed by its purpose. For more information, see [Key # purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes). module CryptoKeyPurpose # Not specified. CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#encrypt Encrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}. ENCRYPT_DECRYPT = 1 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_SIGN = 5 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_DECRYPT = 6 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#mac_sign MacSign}. MAC = 9 end end |
#destroy_scheduled_duration ⇒ ::Google::Protobuf::Duration
Returns Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 24 hours.
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140 class CryptoKey include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} # describes the cryptographic capabilities of a # {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used # for the operations allowed by its purpose. For more information, see [Key # purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes). module CryptoKeyPurpose # Not specified. CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#encrypt Encrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}. ENCRYPT_DECRYPT = 1 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_SIGN = 5 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_DECRYPT = 6 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#mac_sign MacSign}. MAC = 9 end end |
#import_only ⇒ ::Boolean
Returns Immutable. Whether this key may contain imported versions only.
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140 class CryptoKey include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} # describes the cryptographic capabilities of a # {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used # for the operations allowed by its purpose. For more information, see [Key # purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes). module CryptoKeyPurpose # Not specified. CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#encrypt Encrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}. ENCRYPT_DECRYPT = 1 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_SIGN = 5 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_DECRYPT = 6 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#mac_sign MacSign}. MAC = 9 end end |
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Returns Labels with user-defined metadata. For more information, see Labeling Keys.
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140 class CryptoKey include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} # describes the cryptographic capabilities of a # {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used # for the operations allowed by its purpose. For more information, see [Key # purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes). module CryptoKeyPurpose # Not specified. CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#encrypt Encrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}. ENCRYPT_DECRYPT = 1 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_SIGN = 5 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_DECRYPT = 6 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#mac_sign MacSign}. MAC = 9 end end |
#name ⇒ ::String (readonly)
Returns Output only. The resource name for this
CryptoKey in the format
projects/*/locations/*/keyRings/*/cryptoKeys/*
.
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140 class CryptoKey include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} # describes the cryptographic capabilities of a # {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used # for the operations allowed by its purpose. For more information, see [Key # purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes). module CryptoKeyPurpose # Not specified. CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#encrypt Encrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}. ENCRYPT_DECRYPT = 1 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_SIGN = 5 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_DECRYPT = 6 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#mac_sign MacSign}. MAC = 9 end end |
#next_rotation_time ⇒ ::Google::Protobuf::Timestamp
Returns At next_rotation_time, the Key Management Service will automatically:
- Create a new version of this CryptoKey.
- Mark the new version as primary.
Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time.
Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140 class CryptoKey include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} # describes the cryptographic capabilities of a # {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used # for the operations allowed by its purpose. For more information, see [Key # purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes). module CryptoKeyPurpose # Not specified. CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#encrypt Encrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}. ENCRYPT_DECRYPT = 1 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_SIGN = 5 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_DECRYPT = 6 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#mac_sign MacSign}. MAC = 9 end end |
#primary ⇒ ::Google::Cloud::Kms::V1::CryptoKeyVersion (readonly)
Returns Output only. A copy of the "primary" CryptoKeyVersion that will be used by Encrypt when this CryptoKey is given in EncryptRequest.name.
The CryptoKey's primary version can be updated via UpdateCryptoKeyPrimaryVersion.
Keys with purpose ENCRYPT_DECRYPT may have a primary. For other keys, this field will be omitted.
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140 class CryptoKey include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} # describes the cryptographic capabilities of a # {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used # for the operations allowed by its purpose. For more information, see [Key # purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes). module CryptoKeyPurpose # Not specified. CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#encrypt Encrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}. ENCRYPT_DECRYPT = 1 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_SIGN = 5 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_DECRYPT = 6 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#mac_sign MacSign}. MAC = 9 end end |
#purpose ⇒ ::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose
Returns Immutable. The immutable purpose of this CryptoKey.
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140 class CryptoKey include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} # describes the cryptographic capabilities of a # {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used # for the operations allowed by its purpose. For more information, see [Key # purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes). module CryptoKeyPurpose # Not specified. CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#encrypt Encrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}. ENCRYPT_DECRYPT = 1 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_SIGN = 5 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_DECRYPT = 6 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#mac_sign MacSign}. MAC = 9 end end |
#rotation_period ⇒ ::Google::Protobuf::Duration
Returns next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
If rotation_period is set, next_rotation_time must also be set.
Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140 class CryptoKey include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} # describes the cryptographic capabilities of a # {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used # for the operations allowed by its purpose. For more information, see [Key # purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes). module CryptoKeyPurpose # Not specified. CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#encrypt Encrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}. ENCRYPT_DECRYPT = 1 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_SIGN = 5 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_DECRYPT = 6 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#mac_sign MacSign}. MAC = 9 end end |
#version_template ⇒ ::Google::Cloud::Kms::V1::CryptoKeyVersionTemplate
Returns A template describing settings for new CryptoKeyVersion instances. The properties of new CryptoKeyVersion instances created by either CreateCryptoKeyVersion or auto-rotation are controlled by this template.
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140 class CryptoKey include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} # describes the cryptographic capabilities of a # {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used # for the operations allowed by its purpose. For more information, see [Key # purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes). module CryptoKeyPurpose # Not specified. CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#encrypt Encrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}. ENCRYPT_DECRYPT = 1 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_SIGN = 5 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} # and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_DECRYPT = 6 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used # with {::Google::Cloud::Kms::V1::KeyManagementService::Client#mac_sign MacSign}. MAC = 9 end end |