Class: Google::Apis::CloudkmsV1::CryptoKey
- Inherits:
-
Object
- Object
- Google::Apis::CloudkmsV1::CryptoKey
- Defined in:
- generated/google/apis/cloudkms_v1/classes.rb,
generated/google/apis/cloudkms_v1/representations.rb,
generated/google/apis/cloudkms_v1/representations.rb
Overview
A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of one or more versions, which represent the actual key material used in cryptographic operations.
Instance Attribute Summary collapse
-
#create_time ⇒ String
Output only.
-
#labels ⇒ Hash<String,String>
Labels with user-defined metadata.
-
#name ⇒ String
Output only.
-
#next_rotation_time ⇒ String
At next_rotation_time, the Key Management Service will automatically: 1.
-
#primary ⇒ Google::Apis::CloudkmsV1::CryptoKeyVersion
A CryptoKeyVersion represents an individual cryptographic key, and the associated key material.
-
#purpose ⇒ String
The immutable purpose of this CryptoKey.
-
#rotation_period ⇒ String
next_rotation_time will be advanced by this period when the service automatically rotates a key.
Instance Method Summary collapse
-
#initialize(**args) ⇒ CryptoKey
constructor
A new instance of CryptoKey.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ CryptoKey
Returns a new instance of CryptoKey
242 243 244 |
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 242 def initialize(**args) update!(**args) end |
Instance Attribute Details
#create_time ⇒ String
Output only. The time at which this CryptoKey was created.
Corresponds to the JSON property createTime
191 192 193 |
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 191 def create_time @create_time end |
#labels ⇒ Hash<String,String>
Labels with user-defined metadata. For more information, see
Labeling Keys.
Corresponds to the JSON property labels
197 198 199 |
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 197 def labels @labels end |
#name ⇒ String
Output only. The resource name for this CryptoKey in the format
projects/*/locations/*/keyRings/*/cryptoKeys/*
.
Corresponds to the JSON property name
203 204 205 |
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 203 def name @name end |
#next_rotation_time ⇒ String
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.
Corresponds to the JSON property
nextRotationTime
214 215 216 |
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 214 def next_rotation_time @next_rotation_time end |
#primary ⇒ Google::Apis::CloudkmsV1::CryptoKeyVersion
A CryptoKeyVersion represents an individual cryptographic key, and the
associated key material.
It can be used for cryptographic operations either directly, or via its
parent CryptoKey, in which case the server will choose the appropriate
version for the operation.
For security reasons, the raw cryptographic key material represented by a
CryptoKeyVersion can never be viewed or exported. It can only be used to
encrypt or decrypt data when an authorized user or application invokes Cloud
KMS.
Corresponds to the JSON property primary
227 228 229 |
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 227 def primary @primary end |
#purpose ⇒ String
The immutable purpose of this CryptoKey. Currently, the only acceptable
purpose is ENCRYPT_DECRYPT.
Corresponds to the JSON property purpose
233 234 235 |
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 233 def purpose @purpose end |
#rotation_period ⇒ String
next_rotation_time will be advanced by this period when the service
automatically rotates a key. Must be at least one day.
If rotation_period is set, next_rotation_time must also be set.
Corresponds to the JSON property rotationPeriod
240 241 242 |
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 240 def rotation_period @rotation_period end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
247 248 249 250 251 252 253 254 255 |
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 247 def update!(**args) @create_time = args[:create_time] if args.key?(:create_time) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @next_rotation_time = args[:next_rotation_time] if args.key?(:next_rotation_time) @primary = args[:primary] if args.key?(:primary) @purpose = args[:purpose] if args.key?(:purpose) @rotation_period = args[:rotation_period] if args.key?(:rotation_period) end |