Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

Google Native

v0.9.0 published on Wednesday, Nov 24, 2021 by Pulumi

getSecret

Gets metadata for a given Secret.

Using getSecret

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSecret(args: GetSecretArgs, opts?: InvokeOptions): Promise<GetSecretResult>
function getSecretOutput(args: GetSecretOutputArgs, opts?: InvokeOptions): Output<GetSecretResult>
def get_secret(project: Optional[str] = None,
               secret_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetSecretResult
def get_secret_output(project: Optional[pulumi.Input[str]] = None,
               secret_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetSecretResult]
func LookupSecret(ctx *Context, args *LookupSecretArgs, opts ...InvokeOption) (*LookupSecretResult, error)
func LookupSecretOutput(ctx *Context, args *LookupSecretOutputArgs, opts ...InvokeOption) LookupSecretResultOutput

> Note: This function is named LookupSecret in the Go SDK.

public static class GetSecret 
{
    public static Task<GetSecretResult> InvokeAsync(GetSecretArgs args, InvokeOptions? opts = null)
    public static Output<GetSecretResult> Invoke(GetSecretInvokeArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

SecretId string
Project string
SecretId string
Project string
secretId string
project string

getSecret Result

The following output properties are available:

CreateTime string
The time at which the Secret was created.
Etag string
Optional. Etag of the currently stored Secret.
ExpireTime string
Optional. Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input.
Labels Dictionary<string, string>
The labels assigned to this Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be assigned to a given resource.
Name string
The resource name of the Secret in the format projects//secrets/.
Replication Pulumi.GoogleNative.SecretManager.V1.Outputs.ReplicationResponse
Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created.
Rotation Pulumi.GoogleNative.SecretManager.V1.Outputs.RotationResponse
Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy.
Topics List<Pulumi.GoogleNative.SecretManager.V1.Outputs.TopicResponse>
Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions.
Ttl string
Input only. The TTL for the Secret.
CreateTime string
The time at which the Secret was created.
Etag string
Optional. Etag of the currently stored Secret.
ExpireTime string
Optional. Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input.
Labels map[string]string
The labels assigned to this Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be assigned to a given resource.
Name string
The resource name of the Secret in the format projects//secrets/.
Replication ReplicationResponse
Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created.
Rotation RotationResponse
Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy.
Topics []TopicResponse
Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions.
Ttl string
Input only. The TTL for the Secret.
createTime string
The time at which the Secret was created.
etag string
Optional. Etag of the currently stored Secret.
expireTime string
Optional. Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input.
labels {[key: string]: string}
The labels assigned to this Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be assigned to a given resource.
name string
The resource name of the Secret in the format projects//secrets/.
replication ReplicationResponse
Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created.
rotation RotationResponse
Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy.
topics TopicResponse[]
Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions.
ttl string
Input only. The TTL for the Secret.
create_time str
The time at which the Secret was created.
etag str
Optional. Etag of the currently stored Secret.
expire_time str
Optional. Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input.
labels Mapping[str, str]
The labels assigned to this Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be assigned to a given resource.
name str
The resource name of the Secret in the format projects//secrets/.
replication ReplicationResponse
Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created.
rotation RotationResponse
Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy.
topics Sequence[TopicResponse]
Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions.
ttl str
Input only. The TTL for the Secret.

Supporting Types

AutomaticResponse

CustomerManagedEncryption Pulumi.GoogleNative.SecretManager.V1.Inputs.CustomerManagedEncryptionResponse
Optional. The customer-managed encryption configuration of the Secret. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions.
CustomerManagedEncryption CustomerManagedEncryptionResponse
Optional. The customer-managed encryption configuration of the Secret. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions.
customerManagedEncryption CustomerManagedEncryptionResponse
Optional. The customer-managed encryption configuration of the Secret. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions.
customer_managed_encryption CustomerManagedEncryptionResponse
Optional. The customer-managed encryption configuration of the Secret. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions.

CustomerManagedEncryptionResponse

KmsKeyName string
The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads. For secrets using the UserManaged replication policy type, Cloud KMS CryptoKeys must reside in the same location as the replica location. For secrets using the Automatic replication policy type, Cloud KMS CryptoKeys must reside in global. The expected format is projects//locations//keyRings//cryptoKeys/.
KmsKeyName string
The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads. For secrets using the UserManaged replication policy type, Cloud KMS CryptoKeys must reside in the same location as the replica location. For secrets using the Automatic replication policy type, Cloud KMS CryptoKeys must reside in global. The expected format is projects//locations//keyRings//cryptoKeys/.
kmsKeyName string
The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads. For secrets using the UserManaged replication policy type, Cloud KMS CryptoKeys must reside in the same location as the replica location. For secrets using the Automatic replication policy type, Cloud KMS CryptoKeys must reside in global. The expected format is projects//locations//keyRings//cryptoKeys/.
kms_key_name str
The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads. For secrets using the UserManaged replication policy type, Cloud KMS CryptoKeys must reside in the same location as the replica location. For secrets using the Automatic replication policy type, Cloud KMS CryptoKeys must reside in global. The expected format is projects//locations//keyRings//cryptoKeys/.

ReplicaResponse

CustomerManagedEncryption Pulumi.GoogleNative.SecretManager.V1.Inputs.CustomerManagedEncryptionResponse
Optional. The customer-managed encryption configuration of the User-Managed Replica. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions.
Location string
The canonical IDs of the location to replicate data. For example: "us-east1".
CustomerManagedEncryption CustomerManagedEncryptionResponse
Optional. The customer-managed encryption configuration of the User-Managed Replica. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions.
Location string
The canonical IDs of the location to replicate data. For example: "us-east1".
customerManagedEncryption CustomerManagedEncryptionResponse
Optional. The customer-managed encryption configuration of the User-Managed Replica. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions.
location string
The canonical IDs of the location to replicate data. For example: "us-east1".
customer_managed_encryption CustomerManagedEncryptionResponse
Optional. The customer-managed encryption configuration of the User-Managed Replica. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions.
location str
The canonical IDs of the location to replicate data. For example: "us-east1".

ReplicationResponse

Automatic Pulumi.GoogleNative.SecretManager.V1.Inputs.AutomaticResponse
The Secret will automatically be replicated without any restrictions.
UserManaged Pulumi.GoogleNative.SecretManager.V1.Inputs.UserManagedResponse
The Secret will only be replicated into the locations specified.
Automatic AutomaticResponse
The Secret will automatically be replicated without any restrictions.
UserManaged UserManagedResponse
The Secret will only be replicated into the locations specified.
automatic AutomaticResponse
The Secret will automatically be replicated without any restrictions.
userManaged UserManagedResponse
The Secret will only be replicated into the locations specified.
automatic AutomaticResponse
The Secret will automatically be replicated without any restrictions.
user_managed UserManagedResponse
The Secret will only be replicated into the locations specified.

RotationResponse

NextRotationTime string
Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set.
RotationPeriod string
Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications.
NextRotationTime string
Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set.
RotationPeriod string
Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications.
nextRotationTime string
Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set.
rotationPeriod string
Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications.
next_rotation_time str
Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set.
rotation_period str
Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications.

TopicResponse

Name string
The resource name of the Pub/Sub topic that will be published to, in the following format: projects//topics/. For publication to succeed, the Secret Manager P4SA must have pubsub.publisher permissions on the topic.
Name string
The resource name of the Pub/Sub topic that will be published to, in the following format: projects//topics/. For publication to succeed, the Secret Manager P4SA must have pubsub.publisher permissions on the topic.
name string
The resource name of the Pub/Sub topic that will be published to, in the following format: projects//topics/. For publication to succeed, the Secret Manager P4SA must have pubsub.publisher permissions on the topic.
name str
The resource name of the Pub/Sub topic that will be published to, in the following format: projects//topics/. For publication to succeed, the Secret Manager P4SA must have pubsub.publisher permissions on the topic.

UserManagedResponse

Replicas List<Pulumi.GoogleNative.SecretManager.V1.Inputs.ReplicaResponse>
The list of Replicas for this Secret. Cannot be empty.
Replicas []ReplicaResponse
The list of Replicas for this Secret. Cannot be empty.
replicas ReplicaResponse[]
The list of Replicas for this Secret. Cannot be empty.
replicas Sequence[ReplicaResponse]
The list of Replicas for this Secret. Cannot be empty.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0