Package com.pulumi.aws.redshiftserverless

Class Snapshot

  • public class Snapshot
extends com.pulumi.resources.CustomResource
    Creates a new Amazon Redshift Serverless Snapshot. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.redshiftserverless.Snapshot;
 import com.pulumi.aws.redshiftserverless.SnapshotArgs;
 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 Snapshot("example", SnapshotArgs.builder()
             .namespaceName(exampleAwsRedshiftserverlessWorkgroup.namespaceName())
             .snapshotName("example")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Redshift Serverless Snapshots using the `snapshotName`. For example: ```sh $ pulumi import aws:redshiftserverless/snapshot:Snapshot example example ```

    • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      Snapshot​(java.lang.String name)  
      Snapshot​(java.lang.String name, SnapshotArgs args)  
      Snapshot​(java.lang.String name, SnapshotArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.List<java.lang.String>> accountsWithProvisionedRestoreAccesses()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> accountsWithRestoreAccesses()  
      com.pulumi.core.Output<java.lang.String> adminUsername()  
      com.pulumi.core.Output<java.lang.String> arn()  
      static Snapshot get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, SnapshotState 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.lang.String> namespaceArn()  
      com.pulumi.core.Output<java.lang.String> namespaceName()  
      com.pulumi.core.Output<java.lang.String> ownerAccount()  
      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> snapshotName()  

      • 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

      • Snapshot

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

      • Snapshot

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

      • Snapshot

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

      • accountsWithProvisionedRestoreAccesses

        public com.pulumi.core.Output<java.util.List<java.lang.String>> accountsWithProvisionedRestoreAccesses()
        Returns:
        All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

      • accountsWithRestoreAccesses

        public com.pulumi.core.Output<java.util.List<java.lang.String>> accountsWithRestoreAccesses()
        Returns:
        All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.

      • adminUsername

        public com.pulumi.core.Output<java.lang.String> adminUsername()
        Returns:
        The username of the database within a snapshot.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the snapshot.

      • kmsKeyId

        public com.pulumi.core.Output<java.lang.String> kmsKeyId()
        Returns:
        The unique identifier of the KMS key used to encrypt the snapshot.

      • namespaceArn

        public com.pulumi.core.Output<java.lang.String> namespaceArn()
        Returns:
        ARN of the namespace the snapshot was created from.

      • namespaceName

        public com.pulumi.core.Output<java.lang.String> namespaceName()
        Returns:
        The namespace to create a snapshot for.

      • ownerAccount

        public com.pulumi.core.Output<java.lang.String> ownerAccount()
        Returns:
        The owner Amazon Web Services; account of the snapshot.

      • 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:
        How long to retain the created snapshot. Default value is `-1`.

      • snapshotName

        public com.pulumi.core.Output<java.lang.String> snapshotName()
        Returns:
        The name of the snapshot.

      • get

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