1. Docs
  2. Reference
  3. API
  4. AWS
  5. backup
  6. GetVault

GetVault

Use this data source to get information on an existing backup vault.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Aws.Backup.GetVault.InvokeAsync(new Aws.Backup.GetVaultArgs
        {
            Name = "example_backup_vault",
        }));
    }

}

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.LookupVault(ctx, &backup.LookupVaultArgs{
            Name: "example_backup_vault",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aws as aws

example = aws.backup.get_vault(name="example_backup_vault")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = pulumi.output(aws.backup.getVault({
    name: "example_backup_vault",
}, { async: true }));

Using GetVault

function getVault(args: GetVaultArgs, opts?: InvokeOptions): Promise<GetVaultResult>
function  get_vault(name=None, tags=None, opts=None)
func LookupVault(ctx *Context, args *LookupVaultArgs, opts ...InvokeOption) (*LookupVaultResult, error)

Note: This function is named LookupVault in the Go SDK.

public static class GetVault {
    public static Task<GetVaultResult> InvokeAsync(GetVaultArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string

The name of the backup vault.

Tags Dictionary<string, string>

Metadata that you can assign to help organize the resources that you create.

Name string

The name of the backup vault.

Tags map[string]string

Metadata that you can assign to help organize the resources that you create.

name string

The name of the backup vault.

tags {[key: string]: string}

Metadata that you can assign to help organize the resources that you create.

name str

The name of the backup vault.

tags Dict[str, str]

Metadata that you can assign to help organize the resources that you create.

GetVault Result

The following output properties are available:

Arn string

The ARN of the vault.

Id string

The provider-assigned unique ID for this managed resource.

KmsKeyArn string

The server-side encryption key that is used to protect your backups.

Name string
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.

Id string

The provider-assigned unique ID for this managed resource.

KmsKeyArn string

The server-side encryption key that is used to protect your backups.

Name string
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.

id string

The provider-assigned unique ID for this managed resource.

kmsKeyArn string

The server-side encryption key that is used to protect your backups.

name string
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.

id str

The provider-assigned unique ID for this managed resource.

kms_key_arn str

The server-side encryption key that is used to protect your backups.

name str
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.