@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
100 lines (99 loc) • 5.62 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource Type definition for AWS::Backup::BackupVault
*/
export declare class BackupVault extends pulumi.CustomResource {
/**
* Get an existing BackupVault resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): BackupVault;
/**
* Returns true if the given object is an instance of BackupVault. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is BackupVault;
/**
* A resource-based policy that is used to manage access permissions on the target backup vault.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Backup::BackupVault` for more information about the expected schema for this property.
*/
readonly accessPolicy: pulumi.Output<any | undefined>;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault` .
*/
readonly backupVaultArn: pulumi.Output<string>;
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
*/
readonly backupVaultName: pulumi.Output<string>;
/**
* The tags to assign to the backup vault.
*/
readonly backupVaultTags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management; for example, `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` . If you specify a key, you must specify its ARN, not its alias. If you do not specify a key, AWS Backup creates a KMS key for you by default.
*
* To learn which AWS Backup services support full AWS Backup management and how AWS Backup handles encryption for backups from services that do not yet support full AWS Backup , see [Encryption for backups in AWS Backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/encryption.html)
*/
readonly encryptionKeyArn: pulumi.Output<string | undefined>;
/**
* Configuration for [AWS Backup Vault Lock](https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html) .
*/
readonly lockConfiguration: pulumi.Output<outputs.backup.BackupVaultLockConfigurationType | undefined>;
/**
* The SNS event notifications for the specified backup vault.
*/
readonly notifications: pulumi.Output<outputs.backup.BackupVaultNotificationObjectType | undefined>;
/**
* Create a BackupVault resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: BackupVaultArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a BackupVault resource.
*/
export interface BackupVaultArgs {
/**
* A resource-based policy that is used to manage access permissions on the target backup vault.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Backup::BackupVault` for more information about the expected schema for this property.
*/
accessPolicy?: any;
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
*/
backupVaultName?: pulumi.Input<string>;
/**
* The tags to assign to the backup vault.
*/
backupVaultTags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management; for example, `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` . If you specify a key, you must specify its ARN, not its alias. If you do not specify a key, AWS Backup creates a KMS key for you by default.
*
* To learn which AWS Backup services support full AWS Backup management and how AWS Backup handles encryption for backups from services that do not yet support full AWS Backup , see [Encryption for backups in AWS Backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/encryption.html)
*/
encryptionKeyArn?: pulumi.Input<string>;
/**
* Configuration for [AWS Backup Vault Lock](https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html) .
*/
lockConfiguration?: pulumi.Input<inputs.backup.BackupVaultLockConfigurationTypeArgs>;
/**
* The SNS event notifications for the specified backup vault.
*/
notifications?: pulumi.Input<inputs.backup.BackupVaultNotificationObjectTypeArgs>;
}