Package com.pulumi.aws.secretsmanager

Class SecretArgs

  • public final class SecretArgs
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SecretArgs.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static SecretArgs Empty  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static SecretArgs.Builder builder()  
      static SecretArgs.Builder builder​(SecretArgs defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> forceOverwriteReplicaSecret()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> namePrefix()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> policy()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> recoveryWindowInDays()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<SecretReplicaArgs>>> replicas()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> rotationLambdaArn()
      Deprecated.
      Use the aws_secretsmanager_secret_rotation resource instead
      java.util.Optional<com.pulumi.core.Output<SecretRotationRulesArgs>> rotationRules()
      Deprecated.
      Use the aws_secretsmanager_secret_rotation resource instead
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • description

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        Description of the secret.

      • forceOverwriteReplicaSecret

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> forceOverwriteReplicaSecret()
        Returns:
        Accepts boolean value to specify whether to overwrite a secret with the same name in the destination Region.

      • kmsKeyId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()
        Returns:
        ARN, Key ID, or Alias of the AWS KMS key within the region secret is replicated to. If one is not specified, then Secrets Manager defaults to using the AWS account's default KMS key (`aws/secretsmanager`) in the region or creates one for use if non-existent.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        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 `name_prefix`.

      • namePrefix

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> namePrefix()
        Returns:
        Creates a unique name beginning with the specified prefix. Conflicts with `name`.

      • policy

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> policy()
        Returns:
        Valid JSON document representing a [resource policy](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html). 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

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> recoveryWindowInDays()
        Returns:
        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`.

      • replicas

        public java.util.Optional<com.pulumi.core.Output<java.util.List<SecretReplicaArgs>>> replicas()
        Returns:
        Configuration block to support secret replication. See details below.

      • rotationLambdaArn

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> rotationLambdaArn()
        Deprecated.
        Use the aws_secretsmanager_secret_rotation resource instead
        Returns:
        ARN of the Lambda function that can rotate the secret. Use the `aws.secretsmanager.SecretRotation` resource to manage this configuration instead. As of version 2.67.0, removal of this configuration will no longer remove rotation due to supporting the new resource. Either import the new resource and remove the configuration or manually remove rotation.

      • rotationRules

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<SecretRotationRulesArgs>> rotationRules()
        Deprecated.
        Use the aws_secretsmanager_secret_rotation resource instead
        Returns:
        Configuration block for the rotation configuration of this secret. Defined below. Use the `aws.secretsmanager.SecretRotation` resource to manage this configuration instead. As of version 2.67.0, removal of this configuration will no longer remove rotation due to supporting the new resource. Either import the new resource and remove the configuration or manually remove rotation.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of user-defined tags that are attached to the secret. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.