Package com.pulumi.aws.secretsmanager

Class SecretArgs.Builder

  • Enclosing class:
    SecretArgs
    public static final class SecretArgs.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder()

      • Builder

        public Builder​(SecretArgs defaults)

    • Method Detail

      • description

        public SecretArgs.Builder description​(@Nullable
                                      com.pulumi.core.Output<java.lang.String> description)
        Parameters:
        description - Description of the secret.
        Returns:
        builder

      • description

        public SecretArgs.Builder description​(java.lang.String description)
        Parameters:
        description - Description of the secret.
        Returns:
        builder

      • forceOverwriteReplicaSecret

        public SecretArgs.Builder forceOverwriteReplicaSecret​(@Nullable
                                                      com.pulumi.core.Output<java.lang.Boolean> forceOverwriteReplicaSecret)
        Parameters:
        forceOverwriteReplicaSecret - Accepts boolean value to specify whether to overwrite a secret with the same name in the destination Region.
        Returns:
        builder

      • forceOverwriteReplicaSecret

        public SecretArgs.Builder forceOverwriteReplicaSecret​(java.lang.Boolean forceOverwriteReplicaSecret)
        Parameters:
        forceOverwriteReplicaSecret - Accepts boolean value to specify whether to overwrite a secret with the same name in the destination Region.
        Returns:
        builder

      • kmsKeyId

        public SecretArgs.Builder kmsKeyId​(@Nullable
                                   com.pulumi.core.Output<java.lang.String> kmsKeyId)
        Parameters:
        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.
        Returns:
        builder

      • kmsKeyId

        public SecretArgs.Builder kmsKeyId​(java.lang.String kmsKeyId)
        Parameters:
        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.
        Returns:
        builder

      • name

        public SecretArgs.Builder name​(@Nullable
                               com.pulumi.core.Output<java.lang.String> name)
        Parameters:
        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`.
        Returns:
        builder

      • name

        public SecretArgs.Builder name​(java.lang.String name)
        Parameters:
        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`.
        Returns:
        builder

      • namePrefix

        public SecretArgs.Builder namePrefix​(@Nullable
                                     com.pulumi.core.Output<java.lang.String> namePrefix)
        Parameters:
        namePrefix - Creates a unique name beginning with the specified prefix. Conflicts with `name`.
        Returns:
        builder

      • namePrefix

        public SecretArgs.Builder namePrefix​(java.lang.String namePrefix)
        Parameters:
        namePrefix - Creates a unique name beginning with the specified prefix. Conflicts with `name`.
        Returns:
        builder

      • policy

        public SecretArgs.Builder policy​(@Nullable
                                 com.pulumi.core.Output<java.lang.String> policy)
        Parameters:
        policy - 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).
        Returns:
        builder

      • policy

        public SecretArgs.Builder policy​(java.lang.String policy)
        Parameters:
        policy - 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).
        Returns:
        builder

      • recoveryWindowInDays

        public SecretArgs.Builder recoveryWindowInDays​(@Nullable
                                               com.pulumi.core.Output<java.lang.Integer> recoveryWindowInDays)
        Parameters:
        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`.
        Returns:
        builder

      • recoveryWindowInDays

        public SecretArgs.Builder recoveryWindowInDays​(java.lang.Integer recoveryWindowInDays)
        Parameters:
        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`.
        Returns:
        builder

      • region

        public SecretArgs.Builder region​(@Nullable
                                 com.pulumi.core.Output<java.lang.String> region)
        Parameters:
        region - Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
        Returns:
        builder

      • region

        public SecretArgs.Builder region​(java.lang.String region)
        Parameters:
        region - Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
        Returns:
        builder

      • replicas

        public SecretArgs.Builder replicas​(@Nullable
                                   com.pulumi.core.Output<java.util.List<SecretReplicaArgs>> replicas)
        Parameters:
        replicas - Configuration block to support secret replication. See details below.
        Returns:
        builder

      • replicas

        public SecretArgs.Builder replicas​(java.util.List<SecretReplicaArgs> replicas)
        Parameters:
        replicas - Configuration block to support secret replication. See details below.
        Returns:
        builder

      • replicas

        public SecretArgs.Builder replicas​(SecretReplicaArgs... replicas)
        Parameters:
        replicas - Configuration block to support secret replication. See details below.
        Returns:
        builder

      • tags

        public SecretArgs.Builder tags​(@Nullable
                               com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tags)
        Parameters:
        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.
        Returns:
        builder

      • tags

        public SecretArgs.Builder tags​(java.util.Map<java.lang.String,​java.lang.String> tags)
        Parameters:
        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.
        Returns:
        builder

      • type

        public SecretArgs.Builder type​(@Nullable
                               com.pulumi.core.Output<java.lang.String> type)
        Parameters:
        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](https://docs.aws.amazon.com/secretsmanager/latest/userguide/mes-partners.html). This attribute cannot be changed after creation.
        Returns:
        builder

      • type

        public SecretArgs.Builder type​(java.lang.String type)
        Parameters:
        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](https://docs.aws.amazon.com/secretsmanager/latest/userguide/mes-partners.html). This attribute cannot be changed after creation.
        Returns:
        builder