@pulumi/aws/backup/vaultNotifications.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides an AWS Backup vault notifications resource.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const testTopic = new aws.sns.Topic("test", {name: "backup-vault-events"});
 * const test = aws.iam.getPolicyDocumentOutput({
 *     policyId: "__default_policy_ID",
 *     statements: [{
 *         actions: ["SNS:Publish"],
 *         effect: "Allow",
 *         principals: [{
 *             type: "Service",
 *             identifiers: ["backup.amazonaws.com"],
 *         }],
 *         resources: [testTopic.arn],
 *         sid: "__default_statement_ID",
 *     }],
 * });
 * const testTopicPolicy = new aws.sns.TopicPolicy("test", {
 *     arn: testTopic.arn,
 *     policy: test.apply(test => test.json),
 * });
 * const testVaultNotifications = new aws.backup.VaultNotifications("test", {
 *     backupVaultName: "example_backup_vault",
 *     snsTopicArn: testTopic.arn,
 *     backupVaultEvents: [
 *         "BACKUP_JOB_STARTED",
 *         "RESTORE_JOB_COMPLETED",
 *     ],
 * });
 * ```
 *
 * ## Import
 *
 * Using `pulumi import`, import Backup vault notifications using the `name`. For example:
 *
 * ```sh
 * $ pulumi import aws:backup/vaultNotifications:VaultNotifications test TestVault
 * ```
 */
export declare class VaultNotifications extends pulumi.CustomResource {
    /**
     * Get an existing VaultNotifications 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 state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VaultNotificationsState, opts?: pulumi.CustomResourceOptions): VaultNotifications;
    /**
     * Returns true if the given object is an instance of VaultNotifications.  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 VaultNotifications;
    /**
     * The ARN of the vault.
     */
    readonly backupVaultArn: pulumi.Output<string>;
    /**
     * An array of events that indicate the status of jobs to back up resources to the backup vault.
     */
    readonly backupVaultEvents: pulumi.Output<string[]>;
    /**
     * Name of the backup vault to add notifications for.
     */
    readonly backupVaultName: pulumi.Output<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    readonly region: pulumi.Output<string>;
    /**
     * The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events
     */
    readonly snsTopicArn: pulumi.Output<string>;
    /**
     * Create a VaultNotifications 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: VaultNotificationsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering VaultNotifications resources.
 */
export interface VaultNotificationsState {
    /**
     * The ARN of the vault.
     */
    backupVaultArn?: pulumi.Input<string>;
    /**
     * An array of events that indicate the status of jobs to back up resources to the backup vault.
     */
    backupVaultEvents?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Name of the backup vault to add notifications for.
     */
    backupVaultName?: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    /**
     * The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events
     */
    snsTopicArn?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a VaultNotifications resource.
 */
export interface VaultNotificationsArgs {
    /**
     * An array of events that indicate the status of jobs to back up resources to the backup vault.
     */
    backupVaultEvents: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Name of the backup vault to add notifications for.
     */
    backupVaultName: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    /**
     * The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events
     */
    snsTopicArn: pulumi.Input<string>;
}