Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. secretsmanager
  5. SecretVersion

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.3.0 published on Thursday, Sep 28, 2023 by Pulumi
pulumi/pulumi-aws

aws.secretsmanager.SecretVersion

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.3.0 published on Thursday, Sep 28, 2023 by Pulumi
pulumi/pulumi-aws

    Provides a resource to manage AWS Secrets Manager secret version including its secret value. To manage secret metadata, see the aws.secretsmanager.Secret resource.

    NOTE: If the AWSCURRENT staging label is present on this version during resource deletion, that label cannot be removed and will be skipped to prevent errors when fully deleting the secret. That label will leave this secret version active even after the resource is deleted from this provider unless the secret itself is deleted. Move the AWSCURRENT staging label before or after deleting this resource from this provider to fully trigger version deprecation if necessary.

    Example Usage

    Simple String Value

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.SecretsManager.SecretVersion("example", new()
    {
        SecretId = aws_secretsmanager_secret.Example.Id,
        SecretString = "example-string-to-protect",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/secretsmanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := secretsmanager.NewSecretVersion(ctx, "example", &secretsmanager.SecretVersionArgs{
			SecretId:     pulumi.Any(aws_secretsmanager_secret.Example.Id),
			SecretString: pulumi.String("example-string-to-protect"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.secretsmanager.SecretVersion;
import com.pulumi.aws.secretsmanager.SecretVersionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new SecretVersion("example", SecretVersionArgs.builder()        
            .secretId(aws_secretsmanager_secret.example().id())
            .secretString("example-string-to-protect")
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.secretsmanager.SecretVersion("example",
    secret_id=aws_secretsmanager_secret["example"]["id"],
    secret_string="example-string-to-protect")

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.secretsmanager.SecretVersion("example", {
    secretId: aws_secretsmanager_secret.example.id,
    secretString: "example-string-to-protect",
});

    resources:
  example:
    type: aws:secretsmanager:SecretVersion
    properties:
      secretId: ${aws_secretsmanager_secret.example.id}
      secretString: example-string-to-protect

    Create SecretVersion Resource

    new SecretVersion(name: string, args: SecretVersionArgs, opts?: CustomResourceOptions);
    @overload
def SecretVersion(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  secret_binary: Optional[str] = None,
                  secret_id: Optional[str] = None,
                  secret_string: Optional[str] = None,
                  version_stages: Optional[Sequence[str]] = None)
@overload
def SecretVersion(resource_name: str,
                  args: SecretVersionArgs,
                  opts: Optional[ResourceOptions] = None)
    func NewSecretVersion(ctx *Context, name string, args SecretVersionArgs, opts ...ResourceOption) (*SecretVersion, error)
    public SecretVersion(string name, SecretVersionArgs args, CustomResourceOptions? opts = null)
    public SecretVersion(String name, SecretVersionArgs args)
public SecretVersion(String name, SecretVersionArgs args, CustomResourceOptions options)

    type: aws:secretsmanager:SecretVersion
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecretVersionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SecretVersionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SecretVersionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecretVersionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SecretVersionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    SecretVersion Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The SecretVersion resource accepts the following input properties:

    SecretId string

    Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

    SecretBinary string

    Specifies binary data that you want to encrypt and store in this version of the secret. This is required if secret_string is not set. Needs to be encoded to base64.

    SecretString string

    Specifies text data that you want to encrypt and store in this version of the secret. This is required if secret_binary is not set.

    VersionStages List<string>

    Specifies a list of staging labels that are attached to this version of the secret. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value, then AWS Secrets Manager automatically moves the staging label AWSCURRENT to this new version on creation.

    NOTE: If version_stages is configured, you must include the AWSCURRENT staging label if this secret version is the only version or if the label is currently present on this secret version, otherwise this provider will show a perpetual difference.

    SecretId string

    Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

    SecretBinary string

    Specifies binary data that you want to encrypt and store in this version of the secret. This is required if secret_string is not set. Needs to be encoded to base64.

    SecretString string

    Specifies text data that you want to encrypt and store in this version of the secret. This is required if secret_binary is not set.

    VersionStages []string

    Specifies a list of staging labels that are attached to this version of the secret. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value, then AWS Secrets Manager automatically moves the staging label AWSCURRENT to this new version on creation.

    NOTE: If version_stages is configured, you must include the AWSCURRENT staging label if this secret version is the only version or if the label is currently present on this secret version, otherwise this provider will show a perpetual difference.

    secretId String

    Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

    secretBinary String

    Specifies binary data that you want to encrypt and store in this version of the secret. This is required if secret_string is not set. Needs to be encoded to base64.

    secretString String

    Specifies text data that you want to encrypt and store in this version of the secret. This is required if secret_binary is not set.

    versionStages List<String>

    Specifies a list of staging labels that are attached to this version of the secret. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value, then AWS Secrets Manager automatically moves the staging label AWSCURRENT to this new version on creation.

    NOTE: If version_stages is configured, you must include the AWSCURRENT staging label if this secret version is the only version or if the label is currently present on this secret version, otherwise this provider will show a perpetual difference.

    secretId string

    Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

    secretBinary string

    Specifies binary data that you want to encrypt and store in this version of the secret. This is required if secret_string is not set. Needs to be encoded to base64.

    secretString string

    Specifies text data that you want to encrypt and store in this version of the secret. This is required if secret_binary is not set.

    versionStages string[]

    Specifies a list of staging labels that are attached to this version of the secret. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value, then AWS Secrets Manager automatically moves the staging label AWSCURRENT to this new version on creation.

    NOTE: If version_stages is configured, you must include the AWSCURRENT staging label if this secret version is the only version or if the label is currently present on this secret version, otherwise this provider will show a perpetual difference.

    secret_id str

    Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

    secret_binary str

    Specifies binary data that you want to encrypt and store in this version of the secret. This is required if secret_string is not set. Needs to be encoded to base64.

    secret_string str

    Specifies text data that you want to encrypt and store in this version of the secret. This is required if secret_binary is not set.

    version_stages Sequence[str]

    Specifies a list of staging labels that are attached to this version of the secret. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value, then AWS Secrets Manager automatically moves the staging label AWSCURRENT to this new version on creation.

    NOTE: If version_stages is configured, you must include the AWSCURRENT staging label if this secret version is the only version or if the label is currently present on this secret version, otherwise this provider will show a perpetual difference.

    secretId String

    Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

    secretBinary String

    Specifies binary data that you want to encrypt and store in this version of the secret. This is required if secret_string is not set. Needs to be encoded to base64.

    secretString String

    Specifies text data that you want to encrypt and store in this version of the secret. This is required if secret_binary is not set.

    versionStages List<String>

    Specifies a list of staging labels that are attached to this version of the secret. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value, then AWS Secrets Manager automatically moves the staging label AWSCURRENT to this new version on creation.

    NOTE: If version_stages is configured, you must include the AWSCURRENT staging label if this secret version is the only version or if the label is currently present on this secret version, otherwise this provider will show a perpetual difference.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SecretVersion resource produces the following output properties:

    Arn string

    The ARN of the secret.

    Id string

    The provider-assigned unique ID for this managed resource.

    VersionId string

    The unique identifier of the version of the secret.

    Arn string

    The ARN of the secret.

    Id string

    The provider-assigned unique ID for this managed resource.

    VersionId string

    The unique identifier of the version of the secret.

    arn String

    The ARN of the secret.

    id String

    The provider-assigned unique ID for this managed resource.

    versionId String

    The unique identifier of the version of the secret.

    arn string

    The ARN of the secret.

    id string

    The provider-assigned unique ID for this managed resource.

    versionId string

    The unique identifier of the version of the secret.

    arn str

    The ARN of the secret.

    id str

    The provider-assigned unique ID for this managed resource.

    version_id str

    The unique identifier of the version of the secret.

    arn String

    The ARN of the secret.

    id String

    The provider-assigned unique ID for this managed resource.

    versionId String

    The unique identifier of the version of the secret.

    Look up Existing SecretVersion Resource

    Get an existing SecretVersion resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SecretVersionState, opts?: CustomResourceOptions): SecretVersion
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        secret_binary: Optional[str] = None,
        secret_id: Optional[str] = None,
        secret_string: Optional[str] = None,
        version_id: Optional[str] = None,
        version_stages: Optional[Sequence[str]] = None) -> SecretVersion
    func GetSecretVersion(ctx *Context, name string, id IDInput, state *SecretVersionState, opts ...ResourceOption) (*SecretVersion, error)
    public static SecretVersion Get(string name, Input<string> id, SecretVersionState? state, CustomResourceOptions? opts = null)
    public static SecretVersion get(String name, Output<String> id, SecretVersionState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string

    The ARN of the secret.

    SecretBinary string

    Specifies binary data that you want to encrypt and store in this version of the secret. This is required if secret_string is not set. Needs to be encoded to base64.

    SecretId string

    Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

    SecretString string

    Specifies text data that you want to encrypt and store in this version of the secret. This is required if secret_binary is not set.

    VersionId string

    The unique identifier of the version of the secret.

    VersionStages List<string>

    Specifies a list of staging labels that are attached to this version of the secret. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value, then AWS Secrets Manager automatically moves the staging label AWSCURRENT to this new version on creation.

    NOTE: If version_stages is configured, you must include the AWSCURRENT staging label if this secret version is the only version or if the label is currently present on this secret version, otherwise this provider will show a perpetual difference.

    Arn string

    The ARN of the secret.

    SecretBinary string

    Specifies binary data that you want to encrypt and store in this version of the secret. This is required if secret_string is not set. Needs to be encoded to base64.

    SecretId string

    Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

    SecretString string

    Specifies text data that you want to encrypt and store in this version of the secret. This is required if secret_binary is not set.

    VersionId string

    The unique identifier of the version of the secret.

    VersionStages []string

    Specifies a list of staging labels that are attached to this version of the secret. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value, then AWS Secrets Manager automatically moves the staging label AWSCURRENT to this new version on creation.

    NOTE: If version_stages is configured, you must include the AWSCURRENT staging label if this secret version is the only version or if the label is currently present on this secret version, otherwise this provider will show a perpetual difference.

    arn String

    The ARN of the secret.

    secretBinary String

    Specifies binary data that you want to encrypt and store in this version of the secret. This is required if secret_string is not set. Needs to be encoded to base64.

    secretId String

    Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

    secretString String

    Specifies text data that you want to encrypt and store in this version of the secret. This is required if secret_binary is not set.

    versionId String

    The unique identifier of the version of the secret.

    versionStages List<String>

    Specifies a list of staging labels that are attached to this version of the secret. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value, then AWS Secrets Manager automatically moves the staging label AWSCURRENT to this new version on creation.

    NOTE: If version_stages is configured, you must include the AWSCURRENT staging label if this secret version is the only version or if the label is currently present on this secret version, otherwise this provider will show a perpetual difference.

    arn string

    The ARN of the secret.

    secretBinary string

    Specifies binary data that you want to encrypt and store in this version of the secret. This is required if secret_string is not set. Needs to be encoded to base64.

    secretId string

    Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

    secretString string

    Specifies text data that you want to encrypt and store in this version of the secret. This is required if secret_binary is not set.

    versionId string

    The unique identifier of the version of the secret.

    versionStages string[]

    Specifies a list of staging labels that are attached to this version of the secret. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value, then AWS Secrets Manager automatically moves the staging label AWSCURRENT to this new version on creation.

    NOTE: If version_stages is configured, you must include the AWSCURRENT staging label if this secret version is the only version or if the label is currently present on this secret version, otherwise this provider will show a perpetual difference.

    arn str

    The ARN of the secret.

    secret_binary str

    Specifies binary data that you want to encrypt and store in this version of the secret. This is required if secret_string is not set. Needs to be encoded to base64.

    secret_id str

    Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

    secret_string str

    Specifies text data that you want to encrypt and store in this version of the secret. This is required if secret_binary is not set.

    version_id str

    The unique identifier of the version of the secret.

    version_stages Sequence[str]

    Specifies a list of staging labels that are attached to this version of the secret. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value, then AWS Secrets Manager automatically moves the staging label AWSCURRENT to this new version on creation.

    NOTE: If version_stages is configured, you must include the AWSCURRENT staging label if this secret version is the only version or if the label is currently present on this secret version, otherwise this provider will show a perpetual difference.

    arn String

    The ARN of the secret.

    secretBinary String

    Specifies binary data that you want to encrypt and store in this version of the secret. This is required if secret_string is not set. Needs to be encoded to base64.

    secretId String

    Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

    secretString String

    Specifies text data that you want to encrypt and store in this version of the secret. This is required if secret_binary is not set.

    versionId String

    The unique identifier of the version of the secret.

    versionStages List<String>

    Specifies a list of staging labels that are attached to this version of the secret. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value, then AWS Secrets Manager automatically moves the staging label AWSCURRENT to this new version on creation.

    NOTE: If version_stages is configured, you must include the AWSCURRENT staging label if this secret version is the only version or if the label is currently present on this secret version, otherwise this provider will show a perpetual difference.

    Import

    Using pulumi import, import aws_secretsmanager_secret_version using the secret ID and version ID. For example:

     $ pulumi import aws:secretsmanager/secretVersion:SecretVersion example 'arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456|xxxxx-xxxxxxx-xxxxxxx-xxxxx'

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.3.0 published on Thursday, Sep 28, 2023 by Pulumi
    pulumi/pulumi-aws