pulumi-aws-kotlin/com.pulumi.aws.neptune.kotlin/ClusterInstance

ClusterInstance

class ClusterInstance : KotlinCustomResource

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 instance_class 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.List;
import java.util.ArrayList;
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

aws_neptune_cluster_instance can be imported by using the instance identifier, e.g.,

$ pulumi import aws:neptune/clusterInstance:ClusterInstance example my-instance

Properties

address

val address: Output<String>

The hostname of the instance. See also endpoint and port.

applyImmediately

val applyImmediately: Output<Boolean>

Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default isfalse.

arn

val arn: Output<String>

Amazon Resource Name (ARN) of neptune instance

autoMinorVersionUpgrade

val autoMinorVersionUpgrade: Output<Boolean>?

Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is true.

availabilityZone

val availabilityZone: Output<String>

The EC2 Availability Zone that the neptune instance is created in.

clusterIdentifier

val clusterIdentifier: Output<String>

The identifier of the aws.neptune.Cluster in which to launch this instance.

dbiResourceId

val dbiResourceId: Output<String>

The region-unique, immutable identifier for the neptune instance.

endpoint

val endpoint: Output<String>

The connection endpoint in address:port format.

engine

val engine: Output<String>?

The name of the database engine to be used for the neptune instance. Defaults to neptune. Valid Values: neptune.

engineVersion

val engineVersion: Output<String>

The neptune engine version.

val id: Output<String>

identifier

val identifier: Output<String>

The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier.

identifierPrefix

val identifierPrefix: Output<String>

Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.

instanceClass

val instanceClass: Output<String>

The instance class to use.

kmsKeyArn

val kmsKeyArn: Output<String>

The ARN for the KMS encryption key if one is set to the neptune cluster.

neptuneParameterGroupName

val neptuneParameterGroupName: Output<String>?

The name of the neptune parameter group to associate with this instance.

neptuneSubnetGroupName

val neptuneSubnetGroupName: Output<String>

A subnet group to associate with this neptune instance. NOTE: This must match the neptune_subnet_group_name of the attached aws.neptune.Cluster.

port