import * as pulumi from "@pulumi/pulumi"; /** * Manage cross-region replication of automated backups to a different AWS Region. Documentation for cross-region automated backup replication can be found at: * * * [Replicating automated backups to another AWS Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) * * > **Note:** This resource has to be created in the destination region. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const _default = new aws.rds.InstanceAutomatedBackupsReplication("default", { * sourceDbInstanceArn: "arn:aws:rds:us-west-2:123456789012:db:mydatabase", * retentionPeriod: 14, * }); * ``` * * ### Encrypting the automated backup with KMS * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const _default = new aws.rds.InstanceAutomatedBackupsReplication("default", { * sourceDbInstanceArn: "arn:aws:rds:us-west-2:123456789012:db:mydatabase", * kmsKeyId: "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012", * }); * ``` * * ### Example including a RDS DB instance * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const _default = new aws.rds.Instance("default", { * allocatedStorage: 10, * identifier: "mydb", * engine: "postgres", * engineVersion: "13.4", * instanceClass: aws.rds.InstanceType.T3_Micro, * dbName: "mydb", * username: "masterusername", * password: "mustbeeightcharacters", * backupRetentionPeriod: 7, * storageEncrypted: true, * skipFinalSnapshot: true, * }); * const defaultKey = new aws.kms.Key("default", {description: "Encryption key for automated backups"}); * const defaultInstanceAutomatedBackupsReplication = new aws.rds.InstanceAutomatedBackupsReplication("default", { * sourceDbInstanceArn: _default.arn, * kmsKeyId: defaultKey.arn, * }); * ``` * * ## Import * * Using `pulumi import`, import RDS instance automated backups replication using the `arn`. For example: * * ```sh * $ pulumi import aws:rds/instanceAutomatedBackupsReplication:InstanceAutomatedBackupsReplication default arn:aws:rds:us-east-1:123456789012:auto-backup:ab-faaa2mgdj1vmp4xflr7yhsrmtbtob7ltrzzz2my * ``` */ export declare class InstanceAutomatedBackupsReplication extends pulumi.CustomResource { /** * Get an existing InstanceAutomatedBackupsReplication 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, state?: InstanceAutomatedBackupsReplicationState, opts?: pulumi.CustomResourceOptions): InstanceAutomatedBackupsReplication; /** * Returns true if the given object is an instance of InstanceAutomatedBackupsReplication. 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 InstanceAutomatedBackupsReplication; /** * AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the ARN for the KMS encryption key in the destination AWS Region, for example, `arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE`. */ readonly kmsKeyId: pulumi.Output; /** * URL that contains a [Signature Version 4](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) signed request for the [`StartDBInstanceAutomatedBackupsReplication`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartDBInstanceAutomatedBackupsReplication.html) action to be called in the AWS Region of the source DB instance. */ readonly preSignedUrl: pulumi.Output; /** * 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; /** * Retention period for the replicated automated backups, defaults to `7`. */ readonly retentionPeriod: pulumi.Output; /** * ARN of the source DB instance for the replicated automated backups, for example, `arn:aws:rds:us-west-2:123456789012:db:mydatabase`. */ readonly sourceDbInstanceArn: pulumi.Output; /** * Create a InstanceAutomatedBackupsReplication 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: InstanceAutomatedBackupsReplicationArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering InstanceAutomatedBackupsReplication resources. */ export interface InstanceAutomatedBackupsReplicationState { /** * AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the ARN for the KMS encryption key in the destination AWS Region, for example, `arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE`. */ kmsKeyId?: pulumi.Input; /** * URL that contains a [Signature Version 4](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) signed request for the [`StartDBInstanceAutomatedBackupsReplication`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartDBInstanceAutomatedBackupsReplication.html) action to be called in the AWS Region of the source DB instance. */ preSignedUrl?: pulumi.Input; /** * 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; /** * Retention period for the replicated automated backups, defaults to `7`. */ retentionPeriod?: pulumi.Input; /** * ARN of the source DB instance for the replicated automated backups, for example, `arn:aws:rds:us-west-2:123456789012:db:mydatabase`. */ sourceDbInstanceArn?: pulumi.Input; } /** * The set of arguments for constructing a InstanceAutomatedBackupsReplication resource. */ export interface InstanceAutomatedBackupsReplicationArgs { /** * AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the ARN for the KMS encryption key in the destination AWS Region, for example, `arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE`. */ kmsKeyId?: pulumi.Input; /** * URL that contains a [Signature Version 4](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) signed request for the [`StartDBInstanceAutomatedBackupsReplication`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartDBInstanceAutomatedBackupsReplication.html) action to be called in the AWS Region of the source DB instance. */ preSignedUrl?: pulumi.Input; /** * 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; /** * Retention period for the replicated automated backups, defaults to `7`. */ retentionPeriod?: pulumi.Input; /** * ARN of the source DB instance for the replicated automated backups, for example, `arn:aws:rds:us-west-2:123456789012:db:mydatabase`. */ sourceDbInstanceArn: pulumi.Input; } //# sourceMappingURL=instanceAutomatedBackupsReplication.d.ts.map