Package com.pulumi.aws.docdb

Class ClusterSnapshot

  • public class ClusterSnapshot
extends com.pulumi.resources.CustomResource
    Manages a DocumentDB database cluster snapshot for DocumentDB clusters. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.docdb.ClusterSnapshot;
 import com.pulumi.aws.docdb.ClusterSnapshotArgs;
 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 ClusterSnapshot("example", ClusterSnapshotArgs.builder()
             .dbClusterIdentifier(exampleAwsDocdbCluster.id())
             .dbClusterSnapshotIdentifier("resourcetestsnapshot1234")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.docdb.ClusterSnapshot` using the cluster snapshot identifier. For example: ```sh $ pulumi import aws:docdb/clusterSnapshot:ClusterSnapshot example my-cluster-snapshot ```

    • 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.util.List<java.lang.String>> availabilityZones()  
      com.pulumi.core.Output<java.lang.String> dbClusterIdentifier()  
      com.pulumi.core.Output<java.lang.String> dbClusterSnapshotArn()  
      com.pulumi.core.Output<java.lang.String> dbClusterSnapshotIdentifier()  
      com.pulumi.core.Output<java.lang.String> engine()  
      com.pulumi.core.Output<java.lang.String> engineVersion()  
      static ClusterSnapshot get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ClusterSnapshotState 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.Integer> port()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> snapshotType()  
      com.pulumi.core.Output<java.lang.String> sourceDbClusterSnapshotArn()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.lang.Boolean> storageEncrypted()  
      com.pulumi.core.Output<java.lang.String> vpcId()  

      • 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

      • ClusterSnapshot

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

      • ClusterSnapshot

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

      • ClusterSnapshot

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

      • availabilityZones

        public com.pulumi.core.Output<java.util.List<java.lang.String>> availabilityZones()
        Returns:
        List of EC2 Availability Zones that instances in the DocumentDB cluster snapshot can be restored in.

      • dbClusterIdentifier

        public com.pulumi.core.Output<java.lang.String> dbClusterIdentifier()
        Returns:
        The DocumentDB Cluster Identifier from which to take the snapshot.

      • dbClusterSnapshotArn

        public com.pulumi.core.Output<java.lang.String> dbClusterSnapshotArn()
        Returns:
        ARN for the DocumentDB Cluster Snapshot.

      • dbClusterSnapshotIdentifier

        public com.pulumi.core.Output<java.lang.String> dbClusterSnapshotIdentifier()
        Returns:
        The Identifier for the snapshot.

      • engine

        public com.pulumi.core.Output<java.lang.String> engine()
        Returns:
        Specifies the name of the database engine.

      • engineVersion

        public com.pulumi.core.Output<java.lang.String> engineVersion()
        Returns:
        Version of the database engine for this DocumentDB cluster snapshot.

      • kmsKeyId

        public com.pulumi.core.Output<java.lang.String> kmsKeyId()
        Returns:
        If storageEncrypted is true, the AWS KMS key identifier for the encrypted DocumentDB cluster snapshot.

      • port

        public com.pulumi.core.Output<java.lang.Integer> port()
        Returns:
        Port that the DocumentDB cluster was listening on at the time 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.

      • snapshotType

        public com.pulumi.core.Output<java.lang.String> snapshotType()

      • sourceDbClusterSnapshotArn

        public com.pulumi.core.Output<java.lang.String> sourceDbClusterSnapshotArn()

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        The status of this DocumentDB Cluster Snapshot.

      • storageEncrypted

        public com.pulumi.core.Output<java.lang.Boolean> storageEncrypted()
        Returns:
        Specifies whether the DocumentDB cluster snapshot is encrypted.

      • vpcId

        public com.pulumi.core.Output<java.lang.String> vpcId()
        Returns:
        The VPC ID associated with the DocumentDB cluster snapshot.

      • get

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