Google Native
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)
}
public static CompletableFuture<GetSecretResult> getSecret(GetSecretArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: google-native:secretmanager/v1:getSecret
Arguments:
# Arguments dictionary
The following arguments are supported:
getSecret Result
The following output properties are available:
- Create
Time string The time at which the Secret was created.
- Etag string
Optional. Etag of the currently stored Secret.
- Expire
Time 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.
Google Native. Secret Manager. V1. Outputs. Replication Response 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.
Google Native. Secret Manager. V1. Outputs. Rotation Response Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy.
- Topics
List<Pulumi.
Google Native. Secret Manager. V1. Outputs. Topic Response> 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.
- Version
Aliases Dictionary<string, string> Optional. Mapping from version alias to version name. A version alias is a string with a maximum length of 63 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (
-
) and underscore ('_') characters. An alias string must start with a letter and cannot be the string 'latest' or 'NEW'. No more than 50 aliases can be assigned to a given secret. Version-Alias pairs will be viewable via GetSecret and modifiable via UpdateSecret. At launch Access by Allias will only be supported on GetSecretVersion and AccessSecretVersion.
- Create
Time string The time at which the Secret was created.
- Etag string
Optional. Etag of the currently stored Secret.
- Expire
Time 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
Replication
Response 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
Rotation
Response Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy.
- Topics
[]Topic
Response 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.
- Version
Aliases map[string]string Optional. Mapping from version alias to version name. A version alias is a string with a maximum length of 63 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (
-
) and underscore ('_') characters. An alias string must start with a letter and cannot be the string 'latest' or 'NEW'. No more than 50 aliases can be assigned to a given secret. Version-Alias pairs will be viewable via GetSecret and modifiable via UpdateSecret. At launch Access by Allias will only be supported on GetSecretVersion and AccessSecretVersion.
- create
Time String The time at which the Secret was created.
- etag String
Optional. Etag of the currently stored Secret.
- expire
Time 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
Replication
Response 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
Rotation
Response Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy.
- topics
List<Topic
Response> 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.
- version
Aliases Map<String,String> Optional. Mapping from version alias to version name. A version alias is a string with a maximum length of 63 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (
-
) and underscore ('_') characters. An alias string must start with a letter and cannot be the string 'latest' or 'NEW'. No more than 50 aliases can be assigned to a given secret. Version-Alias pairs will be viewable via GetSecret and modifiable via UpdateSecret. At launch Access by Allias will only be supported on GetSecretVersion and AccessSecretVersion.
- create
Time string The time at which the Secret was created.
- etag string
Optional. Etag of the currently stored Secret.
- expire
Time 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
Replication
Response 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
Rotation
Response Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy.
- topics
Topic
Response[] 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.
- version
Aliases {[key: string]: string} Optional. Mapping from version alias to version name. A version alias is a string with a maximum length of 63 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (
-
) and underscore ('_') characters. An alias string must start with a letter and cannot be the string 'latest' or 'NEW'. No more than 50 aliases can be assigned to a given secret. Version-Alias pairs will be viewable via GetSecret and modifiable via UpdateSecret. At launch Access by Allias will only be supported on GetSecretVersion and AccessSecretVersion.
- 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
Replication
Response 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
Rotation
Response Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy.
- topics
Sequence[Topic
Response] 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.
- version_
aliases Mapping[str, str] Optional. Mapping from version alias to version name. A version alias is a string with a maximum length of 63 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (
-
) and underscore ('_') characters. An alias string must start with a letter and cannot be the string 'latest' or 'NEW'. No more than 50 aliases can be assigned to a given secret. Version-Alias pairs will be viewable via GetSecret and modifiable via UpdateSecret. At launch Access by Allias will only be supported on GetSecretVersion and AccessSecretVersion.
- create
Time String The time at which the Secret was created.
- etag String
Optional. Etag of the currently stored Secret.
- expire
Time 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>
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 Property Map
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 Property Map
Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy.
- topics List<Property Map>
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.
- version
Aliases Map<String> Optional. Mapping from version alias to version name. A version alias is a string with a maximum length of 63 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (
-
) and underscore ('_') characters. An alias string must start with a letter and cannot be the string 'latest' or 'NEW'. No more than 50 aliases can be assigned to a given secret. Version-Alias pairs will be viewable via GetSecret and modifiable via UpdateSecret. At launch Access by Allias will only be supported on GetSecretVersion and AccessSecretVersion.
Supporting Types
AutomaticResponse
- Customer
Managed Pulumi.Encryption Google Native. Secret Manager. V1. Inputs. Customer Managed Encryption Response 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 CustomerEncryption Managed Encryption Response 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 CustomerEncryption Managed Encryption Response 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 CustomerEncryption Managed Encryption Response 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_ Customerencryption Managed Encryption Response 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 Property MapEncryption 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
- Kms
Key stringName 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 isprojects/*/locations/*/keyRings/*/cryptoKeys/*
.
- Kms
Key stringName 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 isprojects/*/locations/*/keyRings/*/cryptoKeys/*
.
- kms
Key StringName 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 isprojects/*/locations/*/keyRings/*/cryptoKeys/*
.
- kms
Key stringName 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 isprojects/*/locations/*/keyRings/*/cryptoKeys/*
.
- kms_
key_ strname 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 isprojects/*/locations/*/keyRings/*/cryptoKeys/*
.
- kms
Key StringName 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 isprojects/*/locations/*/keyRings/*/cryptoKeys/*
.
ReplicaResponse
- Customer
Managed Pulumi.Encryption Google Native. Secret Manager. V1. Inputs. Customer Managed Encryption Response 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 CustomerEncryption Managed Encryption Response 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 CustomerEncryption Managed Encryption Response 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 CustomerEncryption Managed Encryption Response 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_ Customerencryption Managed Encryption Response 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"
.
- customer
Managed Property MapEncryption 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"
.
ReplicationResponse
- Automatic
Pulumi.
Google Native. Secret Manager. V1. Inputs. Automatic Response The Secret will automatically be replicated without any restrictions.
- User
Managed Pulumi.Google Native. Secret Manager. V1. Inputs. User Managed Response The Secret will only be replicated into the locations specified.
- Automatic
Automatic
Response The Secret will automatically be replicated without any restrictions.
- User
Managed UserManaged Response The Secret will only be replicated into the locations specified.
- automatic
Automatic
Response The Secret will automatically be replicated without any restrictions.
- user
Managed UserManaged Response The Secret will only be replicated into the locations specified.
- automatic
Automatic
Response The Secret will automatically be replicated without any restrictions.
- user
Managed UserManaged Response The Secret will only be replicated into the locations specified.
- automatic
Automatic
Response The Secret will automatically be replicated without any restrictions.
- user_
managed UserManaged Response The Secret will only be replicated into the locations specified.
- automatic Property Map
The Secret will automatically be replicated without any restrictions.
- user
Managed Property Map The Secret will only be replicated into the locations specified.
RotationResponse
- Next
Rotation stringTime 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 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 stringTime 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 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 StringTime 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 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 stringTime 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 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_ strtime 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.
- next
Rotation StringTime 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 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.
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 havepubsub.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 havepubsub.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 havepubsub.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 havepubsub.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 havepubsub.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 havepubsub.publisher
permissions on the topic.
UserManagedResponse
- Replicas
List<Pulumi.
Google Native. Secret Manager. V1. Inputs. Replica Response> The list of Replicas for this Secret. Cannot be empty.
- Replicas
[]Replica
Response The list of Replicas for this Secret. Cannot be empty.
- replicas
List<Replica
Response> The list of Replicas for this Secret. Cannot be empty.
- replicas
Replica
Response[] The list of Replicas for this Secret. Cannot be empty.
- replicas
Sequence[Replica
Response] The list of Replicas for this Secret. Cannot be empty.
- replicas List<Property Map>
The list of Replicas for this Secret. Cannot be empty.
Package Details
- Repository
- https://github.com/pulumi/pulumi-google-native
- License
- Apache-2.0