Vault class
Provides an AWS Backup vault resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.backup.Vault("example", {
name: "example_backup_vault",
kmsKeyArn: exampleAwsKmsKey.arn,
});
import pulumi
import pulumi_aws as aws
example = aws.backup.Vault("example",
name="example_backup_vault",
kms_key_arn=example_aws_kms_key["arn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Backup.Vault("example", new()
{
Name = "example_backup_vault",
KmsKeyArn = exampleAwsKmsKey.Arn,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/backup"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := backup.NewVault(ctx, "example", &backup.VaultArgs{
Name: pulumi.String("example_backup_vault"),
KmsKeyArn: pulumi.Any(exampleAwsKmsKey.Arn),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_backup_vault" "example" {
name = "example_backup_vault"
kms_key_arn = exampleAwsKmsKey.arn
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.backup.Vault;
import com.pulumi.aws.backup.VaultArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 Vault("example", VaultArgs.builder()
.name("example_backup_vault")
.kmsKeyArn(exampleAwsKmsKey.arn())
.build());
}
}
resources:
example:
type: aws:backup:Vault
properties:
name: example_backup_vault
kmsKeyArn: ${exampleAwsKmsKey.arn}
Import
Identity Schema
Required
name(String) Name of the backup vault.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import Backup vault using the name. For example:
$ pulumi import aws:backup/vault:Vault test-vault TestVault
Constructors
- Vault(String name, {VaultArgs? args, CustomResourceOptions? options})
-
Creates a new Vault.
nameThe Pulumi resource name.argsArguments used to configure this Vault. The set of arguments for Vault.optionsResource options controlling this resource's behavior. - Vault.reference(String urn)
- Creates a typed reference to an existing Vault resource.
Properties
-
arn
↔ Output<
String> -
The ARN of the vault.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
forceDestroy
↔ Output<
bool?> -
A boolean that indicates that all recovery points stored in the vault are deleted so that the vault can be destroyed without error.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
kmsKeyArn
↔ Output<
String> -
The server-side encryption key that is used to protect your backups.
latefinal
-
name
↔ Output<
String> -
Name of the backup vault to create.
latefinal
-
recoveryPoints
↔ Output<
int> -
The number of recovery points that are stored in a backup vault.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Metadata that you can assign to help organize the resources that you create. .If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited