Package com.pulumi.aws.redshift

Class SnapshotCopy

  • public class SnapshotCopy
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS Redshift Snapshot Copy. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.redshift.SnapshotCopy;
 import com.pulumi.aws.redshift.SnapshotCopyArgs;
 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 SnapshotCopy("example", SnapshotCopyArgs.builder()
             .clusterIdentifier(exampleAwsRedshiftCluster.id())
             .destinationRegion("us-east-1")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Redshift Snapshot Copy using the `id`. For example: ```sh $ pulumi import aws:redshift/snapshotCopy:SnapshotCopy example cluster-id-12345678 ```

    • 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
      com.pulumi.core.Output<java.lang.String> clusterIdentifier()  
      com.pulumi.core.Output<java.lang.String> destinationRegion()  
      static SnapshotCopy get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, SnapshotCopyState 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.Integer> manualSnapshotRetentionPeriod()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.Integer> retentionPeriod()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> snapshotCopyGrantName()  

      • 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

      • SnapshotCopy

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

      • SnapshotCopy

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

      • SnapshotCopy

        public SnapshotCopy​(java.lang.String name,
                    SnapshotCopyArgs 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

      • clusterIdentifier

        public com.pulumi.core.Output<java.lang.String> clusterIdentifier()
        Returns:
        Identifier of the source cluster.

      • destinationRegion

        public com.pulumi.core.Output<java.lang.String> destinationRegion()
        Returns:
        AWS Region to copy snapshots to. The following arguments are optional:

      • manualSnapshotRetentionPeriod

        public com.pulumi.core.Output<java.lang.Integer> manualSnapshotRetentionPeriod()
        Returns:
        Number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is `-1`, the manual snapshot is retained indefinitely.

      • 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.lang.Integer> retentionPeriod()
        Returns:
        Number of days to retain automated snapshots in the destination region after they are copied from the source region.

      • snapshotCopyGrantName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> snapshotCopyGrantName()
        Returns:
        Name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

      • get

        public static SnapshotCopy get​(java.lang.String name,
                               com.pulumi.core.Output<java.lang.String> id,
                               @Nullable
                               SnapshotCopyState 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.