SecretRotationState class

Input properties used for looking up and filtering SecretRotation resources.

Constructors

SecretRotationState({Input<List<SecretRotationExternalSecretRotationMetadata>?>? externalSecretRotationMetadatas, Input<String?>? externalSecretRotationRoleArn, Input<String?>? region, Input<bool?>? rotateImmediately, Input<bool?>? rotationEnabled, Input<String?>? rotationLambdaArn, Input<SecretRotationRotationRules?>? rotationRules, Input<String?>? secretId})
Creates a new SecretRotationState. externalSecretRotationMetadatas Configuration block for metadata required by the external secret partner. Required for managed external secrets. See details below. externalSecretRotationRoleArn ARN of the IAM role that allows Secrets Manager to rotate the secret held by a third-party partner. Required for managed external secrets. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. rotateImmediately Whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in rotationRules. For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html) of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it. Defaults to true. rotationEnabled Whether automatic rotation is enabled for the secret. Set to false to disable rotation on a secret whose rotation is otherwise managed by AWS (for example, an RDS master user password secret). When false, rotationRules must be omitted. Defaults to enabled when rotationRules is configured. Destroying this resource does not re-enable the automatic rotation that AWS configured. rotationLambdaArn ARN of the Lambda function that can rotate the secret. Must be supplied if the secret is not managed by AWS. rotationRules Structure that defines the rotation configuration for this secret. Required unless rotationEnabled is false. Defined below. secretId Secret to which you want to add a new version. You can specify either the ARN or the friendly name of the secret. The secret must already exist.
const
SecretRotationState.fromMap(Map<String, dynamic> map)
factory

Properties

externalSecretRotationMetadatas → Input<List<SecretRotationExternalSecretRotationMetadata>?>?
Configuration block for metadata required by the external secret partner. Required for managed external secrets. See details below.
final
externalSecretRotationRoleArn → Input<String?>?
ARN of the IAM role that allows Secrets Manager to rotate the secret held by a third-party partner. Required for managed external secrets.
final
hashCode → int
The hash code for this object.
no setterinherited
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
rotateImmediately → Input<bool?>?
Whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in rotationRules. For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html) of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it. Defaults to true.
final
rotationEnabled → Input<bool?>?
Whether automatic rotation is enabled for the secret. Set to false to disable rotation on a secret whose rotation is otherwise managed by AWS (for example, an RDS master user password secret). When false, rotationRules must be omitted. Defaults to enabled when rotationRules is configured. Destroying this resource does not re-enable the automatic rotation that AWS configured.
final
rotationLambdaArn → Input<String?>?
ARN of the Lambda function that can rotate the secret. Must be supplied if the secret is not managed by AWS.
final
rotationRules → Input<SecretRotationRotationRules?>?
Structure that defines the rotation configuration for this secret. Required unless rotationEnabled is false. Defined below.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secretId → Input<String?>?
Secret to which you want to add a new version. You can specify either the ARN or the friendly name of the secret. The secret must already exist.
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