- Resource: SecretVersion
- State
- ReplicationStatus
- AutomaticStatus
- CustomerManagedEncryptionStatus
- UserManagedStatus
- ReplicaStatus
- Methods
Resource: SecretVersion
A secret version resource in the Secret Manager API.
JSON representation |
---|
{ "name": string, "createTime": string, "destroyTime": string, "state": enum ( |
Fields | |
---|---|
name |
Output only. The resource name of the
|
createTime |
Output only. The time at which the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
destroyTime |
Output only. The time this A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
state |
Output only. The current state of the |
replicationStatus |
The replication status of the |
etag |
Output only. Etag of the currently stored |
clientSpecifiedPayloadChecksum |
Output only. True if payload checksum specified in |
State
The state of a SecretVersion
, indicating if it can be accessed.
Enums | |
---|---|
STATE_UNSPECIFIED |
Not specified. This value is unused and invalid. |
ENABLED |
The SecretVersion may be accessed. |
DISABLED |
The SecretVersion may not be accessed, but the secret data is still available and can be placed back into the ENABLED state. |
DESTROYED |
The SecretVersion is destroyed and the secret data is no longer stored. A version may not leave this state once entered. |
ReplicationStatus
The replication status of a SecretVersion
.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field replication_status . The replication status of the SecretVersion . replication_status can be only one of the following: |
|
automatic |
Describes the replication status of a Only populated if the parent |
userManaged |
Describes the replication status of a Only populated if the parent |
AutomaticStatus
The replication status of a SecretVersion
using automatic replication.
Only populated if the parent Secret
has an automatic replication policy.
JSON representation |
---|
{
"customerManagedEncryption": {
object ( |
Fields | |
---|---|
customerManagedEncryption |
Output only. The customer-managed encryption status of the |
CustomerManagedEncryptionStatus
Describes the status of customer-managed encryption.
JSON representation |
---|
{ "kmsKeyVersionName": string } |
Fields | |
---|---|
kmsKeyVersionName |
Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: |
UserManagedStatus
The replication status of a SecretVersion
using user-managed replication.
Only populated if the parent Secret
has a user-managed replication policy.
JSON representation |
---|
{
"replicas": [
{
object ( |
Fields | |
---|---|
replicas[] |
Output only. The list of replica statuses for the |
ReplicaStatus
Describes the status of a user-managed replica for the SecretVersion
.
JSON representation |
---|
{
"location": string,
"customerManagedEncryption": {
object ( |
Fields | |
---|---|
location |
Output only. The canonical ID of the replica location. For example: |
customerManagedEncryption |
Output only. The customer-managed encryption status of the |
Methods |
|
---|---|
|
Accesses a SecretVersion . |
|
Destroys a SecretVersion . |
|
Disables a SecretVersion . |
|
Enables a SecretVersion . |
|
Gets metadata for a SecretVersion . |
|
Lists SecretVersions . |