You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/dyn/cloudkms_v1.projects.locations.ekmConnections.html
+12
Original file line number
Diff line number
Diff line change
@@ -118,7 +118,9 @@ <h3>Method Details</h3>
118
118
119
119
{ # An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC, as well as performing cryptographic operations using keys created within the EkmConnection.
120
120
"createTime": "A String", # Output only. The time at which the EkmConnection was created.
121
+
"cryptoSpacePath": "A String", # Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.
121
122
"etag": "A String", # Optional. Etag of the currently stored EkmConnection.
123
+
"keyManagementMode": "A String", # Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.
122
124
"name": "A String", # Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`.
123
125
"serviceResolvers": [ # A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.
124
126
{ # A ServiceResolver represents an EKM replica that can be reached within an EkmConnection.
@@ -155,7 +157,9 @@ <h3>Method Details</h3>
155
157
156
158
{ # An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC, as well as performing cryptographic operations using keys created within the EkmConnection.
157
159
"createTime": "A String", # Output only. The time at which the EkmConnection was created.
160
+
"cryptoSpacePath": "A String", # Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.
158
161
"etag": "A String", # Optional. Etag of the currently stored EkmConnection.
162
+
"keyManagementMode": "A String", # Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.
159
163
"name": "A String", # Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`.
160
164
"serviceResolvers": [ # A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.
161
165
{ # A ServiceResolver represents an EKM replica that can be reached within an EkmConnection.
@@ -198,7 +202,9 @@ <h3>Method Details</h3>
198
202
199
203
{ # An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC, as well as performing cryptographic operations using keys created within the EkmConnection.
200
204
"createTime": "A String", # Output only. The time at which the EkmConnection was created.
205
+
"cryptoSpacePath": "A String", # Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.
201
206
"etag": "A String", # Optional. Etag of the currently stored EkmConnection.
207
+
"keyManagementMode": "A String", # Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.
202
208
"name": "A String", # Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`.
203
209
"serviceResolvers": [ # A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.
204
210
{ # A ServiceResolver represents an EKM replica that can be reached within an EkmConnection.
@@ -295,7 +301,9 @@ <h3>Method Details</h3>
295
301
"ekmConnections": [ # The list of EkmConnections.
296
302
{ # An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC, as well as performing cryptographic operations using keys created within the EkmConnection.
297
303
"createTime": "A String", # Output only. The time at which the EkmConnection was created.
304
+
"cryptoSpacePath": "A String", # Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.
298
305
"etag": "A String", # Optional. Etag of the currently stored EkmConnection.
306
+
"keyManagementMode": "A String", # Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.
299
307
"name": "A String", # Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`.
300
308
"serviceResolvers": [ # A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.
301
309
{ # A ServiceResolver represents an EKM replica that can be reached within an EkmConnection.
@@ -351,7 +359,9 @@ <h3>Method Details</h3>
351
359
352
360
{ # An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC, as well as performing cryptographic operations using keys created within the EkmConnection.
353
361
"createTime": "A String", # Output only. The time at which the EkmConnection was created.
362
+
"cryptoSpacePath": "A String", # Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.
354
363
"etag": "A String", # Optional. Etag of the currently stored EkmConnection.
364
+
"keyManagementMode": "A String", # Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.
355
365
"name": "A String", # Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`.
356
366
"serviceResolvers": [ # A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.
357
367
{ # A ServiceResolver represents an EKM replica that can be reached within an EkmConnection.
@@ -388,7 +398,9 @@ <h3>Method Details</h3>
388
398
389
399
{ # An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC, as well as performing cryptographic operations using keys created within the EkmConnection.
390
400
"createTime": "A String", # Output only. The time at which the EkmConnection was created.
401
+
"cryptoSpacePath": "A String", # Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.
391
402
"etag": "A String", # Optional. Etag of the currently stored EkmConnection.
403
+
"keyManagementMode": "A String", # Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.
392
404
"name": "A String", # Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`.
393
405
"serviceResolvers": [ # A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.
394
406
{ # A ServiceResolver represents an EKM replica that can be reached within an EkmConnection.
<pre>Returns the EkmConfig singleton resource for a given project and location.
177
+
178
+
Args:
179
+
name: string, Required. The name of the EkmConfig to get. (required)
180
+
x__xgafv: string, V1 error format.
181
+
Allowed values
182
+
1 - v1 error format
183
+
2 - v2 error format
184
+
185
+
Returns:
186
+
An object of the form:
187
+
188
+
{ # An EkmConfig is a singleton resource that represents configuration parameters that apply to all CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC in a given project and location.
189
+
"defaultEkmConnection": "A String", # Optional. Resource name of the default EkmConnection. Setting this field to the empty string removes the default.
190
+
"name": "A String", # Output only. The resource name for the EkmConfig in the format `projects/*/locations/*/ekmConfig`.
<pre>Updates the EkmConfig singleton resource for a given project and location.
246
+
247
+
Args:
248
+
name: string, Output only. The resource name for the EkmConfig in the format `projects/*/locations/*/ekmConfig`. (required)
249
+
body: object, The request body.
250
+
The object takes the form of:
251
+
252
+
{ # An EkmConfig is a singleton resource that represents configuration parameters that apply to all CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC in a given project and location.
253
+
"defaultEkmConnection": "A String", # Optional. Resource name of the default EkmConnection. Setting this field to the empty string removes the default.
254
+
"name": "A String", # Output only. The resource name for the EkmConfig in the format `projects/*/locations/*/ekmConfig`.
255
+
}
256
+
257
+
updateMask: string, Required. List of fields to be updated in this request.
258
+
x__xgafv: string, V1 error format.
259
+
Allowed values
260
+
1 - v1 error format
261
+
2 - v2 error format
262
+
263
+
Returns:
264
+
An object of the form:
265
+
266
+
{ # An EkmConfig is a singleton resource that represents configuration parameters that apply to all CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC in a given project and location.
267
+
"defaultEkmConnection": "A String", # Optional. Resource name of the default EkmConnection. Setting this field to the empty string removes the default.
268
+
"name": "A String", # Output only. The resource name for the EkmConfig in the format `projects/*/locations/*/ekmConfig`.
Copy file name to clipboardexpand all lines: docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html
+18
Original file line number
Diff line number
Diff line change
@@ -219,11 +219,13 @@ <h3>Method Details</h3>
219
219
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
220
220
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
221
221
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
222
+
"externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
222
223
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
223
224
"ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
224
225
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
225
226
},
226
227
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
228
+
"generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
227
229
"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
228
230
"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
229
231
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
@@ -261,11 +263,13 @@ <h3>Method Details</h3>
261
263
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
262
264
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
263
265
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
266
+
"externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
264
267
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
265
268
"ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
266
269
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
267
270
},
268
271
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
272
+
"generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
269
273
"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
270
274
"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
271
275
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
@@ -316,11 +320,13 @@ <h3>Method Details</h3>
316
320
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
317
321
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
318
322
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
323
+
"externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
319
324
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
320
325
"ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
321
326
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
322
327
},
323
328
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
329
+
"generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
324
330
"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
325
331
"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
326
332
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
@@ -365,11 +371,13 @@ <h3>Method Details</h3>
365
371
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
366
372
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
367
373
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
374
+
"externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
368
375
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
369
376
"ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
370
377
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
371
378
},
372
379
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
380
+
"generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
373
381
"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
374
382
"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
375
383
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
@@ -448,11 +456,13 @@ <h3>Method Details</h3>
448
456
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
449
457
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
450
458
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
459
+
"externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
451
460
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
452
461
"ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
453
462
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
454
463
},
455
464
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
465
+
"generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
456
466
"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
457
467
"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
458
468
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
@@ -507,11 +517,13 @@ <h3>Method Details</h3>
507
517
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
508
518
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
509
519
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
520
+
"externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
510
521
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
511
522
"ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
512
523
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
513
524
},
514
525
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
526
+
"generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
515
527
"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
516
528
"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
517
529
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
@@ -634,11 +646,13 @@ <h3>Method Details</h3>
634
646
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
635
647
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
636
648
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
649
+
"externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
637
650
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
638
651
"ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
639
652
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
640
653
},
641
654
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
655
+
"generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
642
656
"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
643
657
"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
644
658
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
@@ -677,11 +691,13 @@ <h3>Method Details</h3>
677
691
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
678
692
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
679
693
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
694
+
"externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
680
695
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
681
696
"ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
682
697
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
683
698
},
684
699
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
700
+
"generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
685
701
"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
686
702
"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
687
703
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
@@ -732,11 +748,13 @@ <h3>Method Details</h3>
732
748
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
733
749
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
734
750
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
751
+
"externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
735
752
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
736
753
"ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
737
754
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
738
755
},
739
756
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
757
+
"generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
740
758
"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
741
759
"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
742
760
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
Copy file name to clipboardexpand all lines: docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.html
+14
Original file line number
Diff line number
Diff line change
@@ -160,11 +160,13 @@ <h3>Method Details</h3>
160
160
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
161
161
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
162
162
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
163
+
"externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
163
164
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
164
165
"ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
165
166
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
166
167
},
167
168
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
169
+
"generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
168
170
"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
169
171
"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
170
172
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
@@ -221,11 +223,13 @@ <h3>Method Details</h3>
221
223
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
222
224
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
223
225
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
226
+
"externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
224
227
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
225
228
"ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
226
229
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
227
230
},
228
231
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
232
+
"generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
229
233
"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
230
234
"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
231
235
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
@@ -353,11 +357,13 @@ <h3>Method Details</h3>
353
357
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
354
358
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
355
359
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
360
+
"externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
356
361
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
357
362
"ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
358
363
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
359
364
},
360
365
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
366
+
"generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
361
367
"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
362
368
"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
363
369
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
@@ -477,11 +483,13 @@ <h3>Method Details</h3>
477
483
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
478
484
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
479
485
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
486
+
"externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
480
487
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
481
488
"ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
482
489
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
483
490
},
484
491
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
492
+
"generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
485
493
"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
486
494
"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
487
495
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
@@ -556,11 +564,13 @@ <h3>Method Details</h3>
556
564
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
557
565
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
558
566
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
567
+
"externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
559
568
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
560
569
"ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
561
570
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
562
571
},
563
572
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
573
+
"generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
564
574
"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
565
575
"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
566
576
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
@@ -616,11 +626,13 @@ <h3>Method Details</h3>
616
626
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
617
627
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
618
628
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
629
+
"externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
619
630
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
620
631
"ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
621
632
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
622
633
},
623
634
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
635
+
"generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
624
636
"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
625
637
"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
626
638
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
@@ -804,11 +816,13 @@ <h3>Method Details</h3>
804
816
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
805
817
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
806
818
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
819
+
"externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
807
820
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
808
821
"ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
809
822
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
810
823
},
811
824
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
825
+
"generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
812
826
"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
813
827
"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
814
828
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
"description": "Required. List of fields to be updated in this request.",
256
+
"format": "google-fieldmask",
257
+
"location": "query",
258
+
"type": "string"
259
+
}
260
+
},
261
+
"path": "v1/{+name}",
262
+
"request": {
263
+
"$ref": "EkmConfig"
264
+
},
265
+
"response": {
266
+
"$ref": "EkmConfig"
267
+
},
268
+
"scopes": [
269
+
"https://www.googleapis.com/auth/cloud-platform",
270
+
"https://www.googleapis.com/auth/cloudkms"
271
+
]
211
272
}
212
273
},
213
274
"resources": {
@@ -1676,7 +1737,7 @@
1676
1737
}
1677
1738
}
1678
1739
},
1679
-
"revision": "20230224",
1740
+
"revision": "20230307",
1680
1741
"rootUrl": "https://cloudkms.googleapis.com/",
1681
1742
"schemas": {
1682
1743
"AsymmetricDecryptRequest": {
@@ -2132,6 +2193,11 @@
2132
2193
"readOnly": true,
2133
2194
"type": "string"
2134
2195
},
2196
+
"externalDestructionFailureReason": {
2197
+
"description": "Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.",
2198
+
"readOnly": true,
2199
+
"type": "string"
2200
+
},
2135
2201
"externalProtectionLevelOptions": {
2136
2202
"$ref": "ExternalProtectionLevelOptions",
2137
2203
"description": "ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels."
@@ -2142,6 +2208,11 @@
2142
2208
"readOnly": true,
2143
2209
"type": "string"
2144
2210
},
2211
+
"generationFailureReason": {
2212
+
"description": "Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.",
2213
+
"readOnly": true,
2214
+
"type": "string"
2215
+
},
2145
2216
"importFailureReason": {
2146
2217
"description": "Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.",
2147
2218
"readOnly": true,
@@ -2197,7 +2268,10 @@
2197
2268
"DESTROYED",
2198
2269
"DESTROY_SCHEDULED",
2199
2270
"PENDING_IMPORT",
2200
-
"IMPORT_FAILED"
2271
+
"IMPORT_FAILED",
2272
+
"GENERATION_FAILED",
2273
+
"PENDING_EXTERNAL_DESTRUCTION",
2274
+
"EXTERNAL_DESTRUCTION_FAILED"
2201
2275
],
2202
2276
"enumDescriptions": [
2203
2277
"Not specified.",
@@ -2207,7 +2281,10 @@
2207
2281
"This version is destroyed, and the key material is no longer stored. This version may only become ENABLED again if this version is reimport_eligible and the original key material is reimported with a call to KeyManagementService.ImportCryptoKeyVersion.",
2208
2282
"This version is scheduled for destruction, and will be destroyed soon. Call RestoreCryptoKeyVersion to put it back into the DISABLED state.",
2209
2283
"This version is still being imported. It may not be used, enabled, disabled, or destroyed yet. Cloud KMS will automatically mark this version ENABLED as soon as the version is ready.",
2210
-
"This version was not imported successfully. It may not be used, enabled, disabled, or destroyed. The submitted key material has been discarded. Additional details can be found in CryptoKeyVersion.import_failure_reason."
2284
+
"This version was not imported successfully. It may not be used, enabled, disabled, or destroyed. The submitted key material has been discarded. Additional details can be found in CryptoKeyVersion.import_failure_reason.",
2285
+
"This version was not generated successfully. It may not be used, enabled, disabled, or destroyed. Additional details can be found in CryptoKeyVersion.generation_failure_reason.",
2286
+
"This version was destroyed, and it may not be used or enabled again. Cloud KMS is waiting for the corresponding key material residing in an external key manager to be destroyed.",
2287
+
"This version was destroyed, and it may not be used or enabled again. However, Cloud KMS could not confirm that the corresponding key material residing in an external key manager was destroyed. Additional details can be found in CryptoKeyVersion.external_destruction_failure_reason."
2211
2288
],
2212
2289
"type": "string"
2213
2290
}
@@ -2399,6 +2476,22 @@
2399
2476
},
2400
2477
"type": "object"
2401
2478
},
2479
+
"EkmConfig": {
2480
+
"description": "An EkmConfig is a singleton resource that represents configuration parameters that apply to all CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC in a given project and location.",
2481
+
"id": "EkmConfig",
2482
+
"properties": {
2483
+
"defaultEkmConnection": {
2484
+
"description": "Optional. Resource name of the default EkmConnection. Setting this field to the empty string removes the default.",
2485
+
"type": "string"
2486
+
},
2487
+
"name": {
2488
+
"description": "Output only. The resource name for the EkmConfig in the format `projects/*/locations/*/ekmConfig`.",
2489
+
"readOnly": true,
2490
+
"type": "string"
2491
+
}
2492
+
},
2493
+
"type": "object"
2494
+
},
2402
2495
"EkmConnection": {
2403
2496
"description": "An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC, as well as performing cryptographic operations using keys created within the EkmConnection.",
2404
2497
"id": "EkmConnection",
@@ -2409,10 +2502,28 @@
2409
2502
"readOnly": true,
2410
2503
"type": "string"
2411
2504
},
2505
+
"cryptoSpacePath": {
2506
+
"description": "Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.",
2507
+
"type": "string"
2508
+
},
2412
2509
"etag": {
2413
2510
"description": "Optional. Etag of the currently stored EkmConnection.",
2414
2511
"type": "string"
2415
2512
},
2513
+
"keyManagementMode": {
2514
+
"description": "Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.",
2515
+
"enum": [
2516
+
"KEY_MANAGEMENT_MODE_UNSPECIFIED",
2517
+
"MANUAL",
2518
+
"CLOUD_KMS"
2519
+
],
2520
+
"enumDescriptions": [
2521
+
"Not specified.",
2522
+
"EKM-side key management operations on CryptoKeys created with this EkmConnection must be initiated from the EKM directly and cannot be performed from Cloud KMS. This means that: * When creating a CryptoKeyVersion associated with this EkmConnection, the caller must supply the key path of pre-existing external key material that will be linked to the CryptoKeyVersion. * Destruction of external key material cannot be requested via the Cloud KMS API and must be performed directly in the EKM. * Automatic rotation of key material is not supported.",
2523
+
"All CryptoKeys created with this EkmConnection use EKM-side key management operations initiated from Cloud KMS. This means that: * When a CryptoKeyVersion associated with this EkmConnection is created, the EKM automatically generates new key material and a new key path. The caller cannot supply the key path of pre-existing external key material. * Destruction of external key material associated with this EkmConnection can be requested by calling DestroyCryptoKeyVersion. * Automatic rotation of key material is supported."
2524
+
],
2525
+
"type": "string"
2526
+
},
2416
2527
"name": {
2417
2528
"description": "Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`.",
0 commit comments