Class InstanceAutomatedBackupsReplication


  • public class InstanceAutomatedBackupsReplication
    extends com.pulumi.resources.CustomResource
    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
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.rds.InstanceAutomatedBackupsReplication;
     import com.pulumi.aws.rds.InstanceAutomatedBackupsReplicationArgs;
     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 default_ = new InstanceAutomatedBackupsReplication("default", InstanceAutomatedBackupsReplicationArgs.builder()
                 .sourceDbInstanceArn("arn:aws:rds:us-west-2:123456789012:db:mydatabase")
                 .retentionPeriod(14)
                 .build());
     
         }
     }
     
     
    ### Encrypting the automated backup with KMS
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.rds.InstanceAutomatedBackupsReplication;
     import com.pulumi.aws.rds.InstanceAutomatedBackupsReplicationArgs;
     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 default_ = new InstanceAutomatedBackupsReplication("default", InstanceAutomatedBackupsReplicationArgs.builder()
                 .sourceDbInstanceArn("arn:aws:rds:us-west-2:123456789012:db:mydatabase")
                 .kmsKeyId("arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012")
                 .build());
     
         }
     }
     
     
    ### Example including a RDS DB instance
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.rds.Instance;
     import com.pulumi.aws.rds.InstanceArgs;
     import com.pulumi.aws.kms.Key;
     import com.pulumi.aws.kms.KeyArgs;
     import com.pulumi.aws.rds.InstanceAutomatedBackupsReplication;
     import com.pulumi.aws.rds.InstanceAutomatedBackupsReplicationArgs;
     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 default_ = new Instance("default", InstanceArgs.builder()
                 .allocatedStorage(10)
                 .identifier("mydb")
                 .engine("postgres")
                 .engineVersion("13.4")
                 .instanceClass("db.t3.micro")
                 .dbName("mydb")
                 .username("masterusername")
                 .password("mustbeeightcharacters")
                 .backupRetentionPeriod(7)
                 .storageEncrypted(true)
                 .skipFinalSnapshot(true)
                 .build());
     
             var defaultKey = new Key("defaultKey", KeyArgs.builder()
                 .description("Encryption key for automated backups")
                 .build());
     
             var defaultInstanceAutomatedBackupsReplication = new InstanceAutomatedBackupsReplication("defaultInstanceAutomatedBackupsReplication", InstanceAutomatedBackupsReplicationArgs.builder()
                 .sourceDbInstanceArn(default_.arn())
                 .kmsKeyId(defaultKey.arn())
                 .build());
     
         }
     }
     
     
    ## 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 ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static InstanceAutomatedBackupsReplication get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, InstanceAutomatedBackupsReplicationState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> kmsKeyId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> preSignedUrl()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> retentionPeriod()  
      com.pulumi.core.Output<java.lang.String> sourceDbInstanceArn()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • InstanceAutomatedBackupsReplication

        public InstanceAutomatedBackupsReplication​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • InstanceAutomatedBackupsReplication

        public InstanceAutomatedBackupsReplication​(java.lang.String name,
                                                   InstanceAutomatedBackupsReplicationArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • InstanceAutomatedBackupsReplication

        public InstanceAutomatedBackupsReplication​(java.lang.String name,
                                                   InstanceAutomatedBackupsReplicationArgs args,
                                                   @Nullable
                                                   com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • kmsKeyId

        public com.pulumi.core.Output<java.lang.String> kmsKeyId()
        Returns:
        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`.
      • preSignedUrl

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> preSignedUrl()
        Returns:
        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.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        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.
      • retentionPeriod

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> retentionPeriod()
        Returns:
        Retention period for the replicated automated backups, defaults to `7`.
      • sourceDbInstanceArn

        public com.pulumi.core.Output<java.lang.String> sourceDbInstanceArn()
        Returns:
        ARN of the source DB instance for the replicated automated backups, for example, `arn:aws:rds:us-west-2:123456789012:db:mydatabase`.
      • get

        public static InstanceAutomatedBackupsReplication get​(java.lang.String name,
                                                              com.pulumi.core.Output<java.lang.String> id,
                                                              @Nullable
                                                              InstanceAutomatedBackupsReplicationState state,
                                                              @Nullable
                                                              com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.