SecretState class

Input properties used for looking up and filtering Secret resources.

Constructors

SecretState({Input<Map<String, String>?>? annotations, Input<String?>? createTime, Input<String?>? deletionPolicy, Input<bool?>? deletionProtection, Input<Map<String, String>?>? effectiveAnnotations, Input<Map<String, String>?>? effectiveLabels, Input<String?>? expireTime, Input<Map<String, String>?>? labels, Input<String?>? name, Input<String?>? project, Input<Map<String, String>?>? pulumiLabels, Input<SecretReplication?>? replication, Input<SecretRotation?>? rotation, Input<String?>? secretId, Input<Map<String, String>?>? tags, Input<List<SecretTopic>?>? topics, Input<String?>? ttl, Input<Map<String, String>?>? versionAliases, Input<String?>? versionDestroyTtl})
Creates a new SecretState. annotations Custom metadata about the secret. createTime The time at which the Secret was created. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. deletionProtection Whether Terraform will be prevented from destroying the secret. Defaults to false. effectiveAnnotations All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services. effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. expireTime Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input. labels The labels assigned to this Secret. name The resource name of the Secret. Format: project The ID of the project in which the resource belongs. pulumiLabels The combination of labels configured directly on the resource replication The replication policy of the secret data attached to the Secret. It cannot be changed rotation The rotation time and period for a Secret. At nextRotationTime, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. topics must be set to configure rotation. secretId This must be unique within the project. tags A map of resource manager tags. topics 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 The TTL for the Secret. versionAliases Mapping from version alias to version name. versionDestroyTtl Secret Version TTL after destruction request.
const
SecretState.fromMap(Map<String, dynamic> map)
factory

Properties

annotations → Input<Map<String, String>?>?
Custom metadata about the secret. Annotations are distinct from various forms of labels. Annotations exist to allow client tools to store their own state information without requiring a database. Annotation keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, begin and end with an alphanumeric character (a-z0-9A-Z), and may have dashes (-), underscores (_), dots (.), and alphanumerics in between these symbols. The total size of annotation keys and values must be less than 16KiB. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
final
createTime → Input<String?>?
The time at which the Secret was created.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
deletionProtection → Input<bool?>?
Whether Terraform will be prevented from destroying the secret. Defaults to false. When the field is set to true in Terraform state, a pulumi up or terraform destroy that would delete the secret will fail.
final
effectiveAnnotations → Input<Map<String, String>?>?
All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
final
effectiveLabels → Input<Map<String, String>?>?
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
final
expireTime → Input<String?>?
Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". Only one of expireTime or ttl can be provided.
final
hashCode → int
The hash code for this object.
no setterinherited
labels → Input<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}\p{N}_-{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. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
final
name → Input<String?>?
The resource name of the Secret. Format: projects/{{project}}/secrets/{{secret_id}}
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
replication → Input<SecretReplication?>?
The replication policy of the secret data attached to the Secret. It cannot be changed after the Secret has been created. Structure is documented below.
final
rotation → Input<SecretRotation?>?
The rotation time and period for a Secret. At nextRotationTime, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. topics must be set to configure rotation. Structure is documented below.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secretId → Input<String?>?
This must be unique within the project.
final
tags → Input<Map<String, String>?>?
A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/{tag_value_id}.
final
topics → Input<List<SecretTopic>?>?
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. Structure is documented below.
final
ttl → Input<String?>?
The TTL for the Secret. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". Only one of ttl or expireTime can be provided.
final
versionAliases → Input<Map<String, String>?>?
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. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
final
versionDestroyTtl → Input<String?>?
Secret Version TTL after destruction request. This is a part of the delayed delete feature on Secret Version. For secret with versionDestroyTtl>0, version destruction doesn't happen immediately on calling destroy instead the version goes to a disabled state and the actual destruction happens after this TTL expires.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited