Vault

Provides an AWS Backup vault resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Backup.Vault("example", new Aws.Backup.VaultArgs
        {
            KmsKeyArn = aws_kms_key.Example.Arn,
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/backup"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := backup.NewVault(ctx, "example", &backup.VaultArgs{
            KmsKeyArn: pulumi.String(aws_kms_key.Example.Arn),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.backup.Vault("example", kms_key_arn=aws_kms_key["example"]["arn"])

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

const example = new aws.backup.Vault("example", {
    kmsKeyArn: aws_kms_key_example.arn,
});

Create a Vault Resource

new Vault(name: string, args?: VaultArgs, opts?: CustomResourceOptions);

def Vault(resource_name, opts=None, kms_key_arn=None, name=None, tags=None, __props__=None);

func NewVault(ctx *Context, name string, args *VaultArgs, opts ...ResourceOption) (*Vault, error)

public Vault(string name, VaultArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args VaultArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args VaultArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VaultArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Vault Resource Properties

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

Inputs

The Vault resource accepts the following input properties:

KmsKeyArn string: The server-side encryption key that is used to protect your backups.
Name string: Name of the backup vault to create.
Tags Dictionary<string, string>: Metadata that you can assign to help organize the resources that you create.

KmsKeyArn string: The server-side encryption key that is used to protect your backups.
Name string: Name of the backup vault to create.
Tags map[string]string: Metadata that you can assign to help organize the resources that you create.

kmsKeyArn string: The server-side encryption key that is used to protect your backups.
name string: Name of the backup vault to create.
tags {[key: string]: string}: Metadata that you can assign to help organize the resources that you create.

kms_key_arn str: The server-side encryption key that is used to protect your backups.
name str: Name of the backup vault to create.
tags Dict[str, str]: Metadata that you can assign to help organize the resources that you create.

Outputs

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

Arn string: The ARN of the vault.
Id string: The provider-assigned unique ID for this managed resource.
RecoveryPoints int: The number of recovery points that are stored in a backup vault.

Arn string: The ARN of the vault.
Id string: The provider-assigned unique ID for this managed resource.
RecoveryPoints int: The number of recovery points that are stored in a backup vault.

arn string: The ARN of the vault.
id string: The provider-assigned unique ID for this managed resource.
recoveryPoints number: The number of recovery points that are stored in a backup vault.

arn str: The ARN of the vault.
id str: The provider-assigned unique ID for this managed resource.
recovery_points float: The number of recovery points that are stored in a backup vault.

Look up an Existing Vault Resource

Get an existing Vault 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?: VaultState, opts?: CustomResourceOptions): Vault

static get(resource_name, id, opts=None, arn=None, kms_key_arn=None, name=None, recovery_points=None, tags=None, __props__=None);

func GetVault(ctx *Context, name string, id IDInput, state *VaultState, opts ...ResourceOption) (*Vault, error)

public static Vault Get(string name, Input<string> id, VaultState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

Arn string: The ARN of the vault.
KmsKeyArn string: The server-side encryption key that is used to protect your backups.
Name string: Name of the backup vault to create.
RecoveryPoints int: The number of recovery points that are stored in a backup vault.
Tags Dictionary<string, string>: Metadata that you can assign to help organize the resources that you create.

Arn string: The ARN of the vault.
KmsKeyArn string: The server-side encryption key that is used to protect your backups.
Name string: Name of the backup vault to create.
RecoveryPoints int: The number of recovery points that are stored in a backup vault.
Tags map[string]string: Metadata that you can assign to help organize the resources that you create.

arn string: The ARN of the vault.
kmsKeyArn string: The server-side encryption key that is used to protect your backups.
name string: Name of the backup vault to create.
recoveryPoints number: The number of recovery points that are stored in a backup vault.
tags {[key: string]: string}: Metadata that you can assign to help organize the resources that you create.

arn str: The ARN of the vault.
kms_key_arn str: The server-side encryption key that is used to protect your backups.
name str: Name of the backup vault to create.
recovery_points float: The number of recovery points that are stored in a backup vault.
tags Dict[str, str]: Metadata that you can assign to help organize the resources that you create.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud