SecretState class

Input properties used for looking up and filtering Secret resources.

Constructors

SecretState({Input<String?>? arn, Input<String?>? description, Input<bool?>? forceOverwriteReplicaSecret, Input<String?>? kmsKeyId, Input<String?>? name, Input<String?>? namePrefix, Input<String?>? policy, Input<int?>? recoveryWindowInDays, Input<String?>? region, Input<List<SecretReplica>?>? replicas, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<String?>? type})
Creates a new SecretState. arn ARN of the secret. description Description of the secret. forceOverwriteReplicaSecret Accepts boolean value to specify whether to overwrite a secret with the same name in the destination Region. kmsKeyId ARN or Id of the AWS KMS key to be used to encrypt the secret values in the versions stored in this secret. If you need to reference a CMK in a different account, you can use only the key ARN. If you don't specify this value, then Secrets Manager defaults to using the AWS account's default KMS key (the one named aws/secretsmanager). If the default KMS key with that name doesn't yet exist, then AWS Secrets Manager creates it for you automatically the first time. name Friendly name of the new secret. The secret name can consist of uppercase letters, lowercase letters, digits, and any of the following characters: /_+=.@- Conflicts with namePrefix. namePrefix Creates a unique name beginning with the specified prefix. Conflicts with name. policy Valid JSON document representing a resource policy. Removing policy from your configuration or setting policy to null or an empty string (i.e., policy = "") will not delete the policy since it could have been set by aws.secretsmanager.SecretPolicy. To delete the policy, set it to "{}" (an empty JSON document). recoveryWindowInDays Number of days that AWS Secrets Manager waits before it can delete the secret. This value can be 0 to force deletion without recovery or range from 7 to 30 days. The default value is 30. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. replicas Configuration block to support secret replication. See details below. tags Key-value map of user-defined tags that are attached to the secret. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. type Type of secret for managed external secrets. Valid values are SalesforceClientSecret, BigIDClientSecret, and SnowflakeKeyPairAuthentication. For more information about supported partners and their specific requirements, see Managed external secret partners. This attribute cannot be changed after creation.
const
SecretState.fromMap(Map<String, dynamic> map)
factory

Properties

arn → Input<String?>?
ARN of the secret.
final
description → Input<String?>?
Description of the secret.
final
forceOverwriteReplicaSecret → Input<bool?>?
Accepts boolean value to specify whether to overwrite a secret with the same name in the destination Region.
final
hashCode → int
The hash code for this object.
no setterinherited
kmsKeyId → Input<String?>?
ARN or Id of the AWS KMS key to be used to encrypt the secret values in the versions stored in this secret. If you need to reference a CMK in a different account, you can use only the key ARN. If you don't specify this value, then Secrets Manager defaults to using the AWS account's default KMS key (the one named aws/secretsmanager). If the default KMS key with that name doesn't yet exist, then AWS Secrets Manager creates it for you automatically the first time.
final
name → Input<String?>?
Friendly name of the new secret. The secret name can consist of uppercase letters, lowercase letters, digits, and any of the following characters: /_+=.@- Conflicts with namePrefix.
final
namePrefix → Input<String?>?
Creates a unique name beginning with the specified prefix. Conflicts with name.
final
policy → Input<String?>?
Valid JSON document representing a resource policy. Removing policy from your configuration or setting policy to null or an empty string (i.e., policy = "") will not delete the policy since it could have been set by aws.secretsmanager.SecretPolicy. To delete the policy, set it to "{}" (an empty JSON document).
final
recoveryWindowInDays → Input<int?>?
Number of days that AWS Secrets Manager waits before it can delete the secret. This value can be 0 to force deletion without recovery or range from 7 to 30 days. The default value is 30.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
replicas → Input<List<SecretReplica>?>?
Configuration block to support secret replication. See details below.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags → Input<Map<String, String>?>?
Key-value map of user-defined tags that are attached to the secret. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
type → Input<String?>?
Type of secret for managed external secrets. Valid values are SalesforceClientSecret, BigIDClientSecret, and SnowflakeKeyPairAuthentication. For more information about supported partners and their specific requirements, see Managed external secret partners. This attribute cannot be changed after creation.
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