Package com.pulumi.aws.neptune

Class ClusterInstance

  • public class ClusterInstance
extends com.pulumi.resources.CustomResource
    A Cluster Instance Resource defines attributes that are specific to a single instance in a Neptune Cluster. You can simply add neptune instances and Neptune manages the replication. You can use the count meta-parameter to make multiple instances and join them all to the same Neptune Cluster, or you may specify different Cluster Instance resources with various `instanceClass` sizes. ## Example Usage The following example will create a neptune cluster with two neptune instances(one writer and one reader). 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.neptune.Cluster;
 import com.pulumi.aws.neptune.ClusterArgs;
 import com.pulumi.aws.neptune.ClusterInstance;
 import com.pulumi.aws.neptune.ClusterInstanceArgs;
 import com.pulumi.codegen.internal.KeyedValue;
 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 Cluster("default", ClusterArgs.builder()
             .clusterIdentifier("neptune-cluster-demo")
             .engine("neptune")
             .backupRetentionPeriod(5)
             .preferredBackupWindow("07:00-09:00")
             .skipFinalSnapshot(true)
             .iamDatabaseAuthenticationEnabled(true)
             .applyImmediately(true)
             .build());
 
         for (var i = 0; i < 2; i++) {
             new ClusterInstance("example-" + i, ClusterInstanceArgs.builder()
                 .clusterIdentifier(default_.id())
                 .engine("neptune")
                 .instanceClass("db.r4.large")
                 .applyImmediately(true)
                 .build());
 
         
 }
     }
 }
    ## Import Using `pulumi import`, import `aws.neptune.ClusterInstance` using the instance identifier. For example: ```sh $ pulumi import aws:neptune/clusterInstance:ClusterInstance example my-instance ```

    • 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> address()  
      com.pulumi.core.Output<java.lang.Boolean> applyImmediately()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> autoMinorVersionUpgrade()  
      com.pulumi.core.Output<java.lang.String> availabilityZone()  
      com.pulumi.core.Output<java.lang.String> clusterIdentifier()  
      com.pulumi.core.Output<java.lang.String> dbiResourceId()  
      com.pulumi.core.Output<java.lang.String> endpoint()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> engine()  
      com.pulumi.core.Output<java.lang.String> engineVersion()  
      static ClusterInstance get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ClusterInstanceState 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> identifier()  
      com.pulumi.core.Output<java.lang.String> identifierPrefix()  
      com.pulumi.core.Output<java.lang.String> instanceClass()  
      com.pulumi.core.Output<java.lang.String> kmsKeyArn()  
      com.pulumi.core.Output<java.lang.String> neptuneParameterGroupName()  
      com.pulumi.core.Output<java.lang.String> neptuneSubnetGroupName()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> port()  
      com.pulumi.core.Output<java.lang.String> preferredBackupWindow()  
      com.pulumi.core.Output<java.lang.String> preferredMaintenanceWindow()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> promotionTier()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> publiclyAccessible()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> skipFinalSnapshot()  
      com.pulumi.core.Output<java.lang.Boolean> storageEncrypted()  
      com.pulumi.core.Output<java.lang.String> storageType()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.Boolean> writer()  

      • 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

      • ClusterInstance

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

      • ClusterInstance

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

      • ClusterInstance

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

      • address

        public com.pulumi.core.Output<java.lang.String> address()
        Returns:
        The hostname of the instance. See also `endpoint` and `port`.

      • applyImmediately

        public com.pulumi.core.Output<java.lang.Boolean> applyImmediately()
        Returns:
        Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default is`false`.

      • arn

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

      • autoMinorVersionUpgrade

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> autoMinorVersionUpgrade()
        Returns:
        Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is `true`.

      • availabilityZone

        public com.pulumi.core.Output<java.lang.String> availabilityZone()
        Returns:
        The EC2 Availability Zone that the neptune instance is created in.

      • clusterIdentifier

        public com.pulumi.core.Output<java.lang.String> clusterIdentifier()
        Returns:
        The identifier of the `aws.neptune.Cluster` in which to launch this instance.

      • dbiResourceId

        public com.pulumi.core.Output<java.lang.String> dbiResourceId()
        Returns:
        The region-unique, immutable identifier for the neptune instance.

      • endpoint

        public com.pulumi.core.Output<java.lang.String> endpoint()
        Returns:
        The connection endpoint in `address:port` format.

      • engine

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> engine()
        Returns:
        The name of the database engine to be used for the neptune instance. Defaults to `neptune`. Valid Values: `neptune`.

      • engineVersion

        public com.pulumi.core.Output<java.lang.String> engineVersion()
        Returns:
        The neptune engine version. Currently configuring this argument has no effect.

      • identifier

        public com.pulumi.core.Output<java.lang.String> identifier()
        Returns:
        The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier.

      • identifierPrefix

        public com.pulumi.core.Output<java.lang.String> identifierPrefix()
        Returns:
        Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`.

      • instanceClass

        public com.pulumi.core.Output<java.lang.String> instanceClass()
        Returns:
        The instance class to use.

      • kmsKeyArn

        public com.pulumi.core.Output<java.lang.String> kmsKeyArn()
        Returns:
        The ARN for the KMS encryption key if one is set to the neptune cluster.

      • neptuneParameterGroupName

        public com.pulumi.core.Output<java.lang.String> neptuneParameterGroupName()
        Returns:
        The name of the neptune parameter group to associate with this instance.

      • neptuneSubnetGroupName

        public com.pulumi.core.Output<java.lang.String> neptuneSubnetGroupName()
        Returns:
        A subnet group to associate with this neptune instance. **NOTE:** This must match the `neptuneSubnetGroupName` of the attached `aws.neptune.Cluster`.

      • port

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> port()
        Returns:
        The port on which the DB accepts connections. Defaults to `8182`.

      • preferredBackupWindow

        public com.pulumi.core.Output<java.lang.String> preferredBackupWindow()
        Returns:
        The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"

      • preferredMaintenanceWindow

        public com.pulumi.core.Output<java.lang.String> preferredMaintenanceWindow()
        Returns:
        The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".

      • promotionTier

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> promotionTier()
        Returns:
        Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.

      • publiclyAccessible

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> publiclyAccessible()
        Returns:
        Bool to control if instance is publicly accessible. Default is `false`.

      • 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.

      • skipFinalSnapshot

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> skipFinalSnapshot()
        Returns:
        Determines whether a final DB snapshot is created before the DB instance is deleted.

      • storageEncrypted

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

      • storageType

        public com.pulumi.core.Output<java.lang.String> storageType()
        Returns:
        Storage type associated with the cluster `standard/iopt1`.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the instance. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • writer

        public com.pulumi.core.Output<java.lang.Boolean> writer()
        Returns:
        Boolean indicating if this instance is writable. `False` indicates this instance is a read replica.

      • get

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