Class ClusterInstance

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

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var @default = new Aws.Neptune.Cluster("default", new Aws.Neptune.ClusterArgs
    {
        ApplyImmediately = true,
        BackupRetentionPeriod = 5,
        ClusterIdentifier = "neptune-cluster-demo",
        Engine = "neptune",
        IamDatabaseAuthenticationEnabled = true,
        PreferredBackupWindow = "07:00-09:00",
        SkipFinalSnapshot = true,
    });
    var example = new List<Aws.Neptune.ClusterInstance>();
    for (var rangeIndex = 0; rangeIndex < 2; rangeIndex++)
    {
        var range = new { Value = rangeIndex };
        example.Add(new Aws.Neptune.ClusterInstance($"example-{range.Value}", new Aws.Neptune.ClusterInstanceArgs
        {
            ApplyImmediately = true,
            ClusterIdentifier = @default.Id,
            Engine = "neptune",
            InstanceClass = "db.r4.large",
        }));
    }
}

}

Inheritance

System.Object

Resource

CustomResource

ClusterInstance

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Neptune

Assembly: Pulumi.Aws.dll

Syntax

public class ClusterInstance : CustomResource

Constructors

ClusterInstance(String, ClusterInstanceArgs, CustomResourceOptions)

Create a ClusterInstance resource with the given unique name, arguments, and options.

Declaration

public ClusterInstance(string name, ClusterInstanceArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ClusterInstanceArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Address

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

Declaration

public Output<string> Address { get; }

Property Value

Type	Description
Output<System.String>

ApplyImmediately

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

Declaration

public Output<bool> ApplyImmediately { get; }

Property Value

Type	Description
Output<System.Boolean>

Arn

Amazon Resource Name (ARN) of neptune instance

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

AutoMinorVersionUpgrade

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

Declaration

public Output<bool?> AutoMinorVersionUpgrade { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

AvailabilityZone

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

Declaration

public Output<string> AvailabilityZone { get; }

Property Value

Type	Description
Output<System.String>

ClusterIdentifier

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

Declaration

public Output<string> ClusterIdentifier { get; }

Property Value

Type	Description
Output<System.String>

DbiResourceId

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

Declaration

public Output<string> DbiResourceId { get; }

Property Value

Type	Description
Output<System.String>

Endpoint

The connection endpoint in address:port format.

Declaration

public Output<string> Endpoint { get; }

Property Value

Type	Description
Output<System.String>

Engine

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

Declaration

public Output<string> Engine { get; }

Property Value

Type	Description
Output<System.String>

EngineVersion

The neptune engine version.

Declaration

public Output<string> EngineVersion { get; }

Property Value

Type	Description
Output<System.String>

Identifier

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

Declaration

public Output<string> Identifier { get; }

Property Value

Type	Description
Output<System.String>

IdentifierPrefix

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

Declaration

public Output<string> IdentifierPrefix { get; }

Property Value

Type	Description
Output<System.String>

InstanceClass

The instance class to use.

Declaration

public Output<string> InstanceClass { get; }

Property Value

Type	Description
Output<System.String>

KmsKeyArn

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

Declaration

public Output<string> KmsKeyArn { get; }

Property Value

Type	Description
Output<System.String>

NeptuneParameterGroupName

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

Declaration

public Output<string> NeptuneParameterGroupName { get; }

Property Value

Type	Description
Output<System.String>

NeptuneSubnetGroupName

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

Declaration

public Output<string> NeptuneSubnetGroupName { get; }

Property Value

Type	Description
Output<System.String>

Port

The port on which the DB accepts connections. Defaults to 8182.

Declaration

public Output<int?> Port { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

PreferredBackupWindow

The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"

Declaration

public Output<string> PreferredBackupWindow { get; }

Property Value

Type	Description
Output<System.String>

PreferredMaintenanceWindow

The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".

Declaration

public Output<string> PreferredMaintenanceWindow { get; }

Property Value

Type	Description
Output<System.String>

PromotionTier

Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.

Declaration

public Output<int?> PromotionTier { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

PubliclyAccessible

Bool to control if instance is publicly accessible. Default is false.

Declaration

public Output<bool?> PubliclyAccessible { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

StorageEncrypted

Specifies whether the neptune cluster is encrypted.

Declaration

public Output<bool> StorageEncrypted { get; }

Property Value

Type	Description
Output<System.Boolean>

Tags

A map of tags to assign to the instance.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Writer

Boolean indicating if this instance is writable. False indicates this instance is a read replica.

Declaration

public Output<bool> Writer { get; }

Property Value

Type	Description
Output<System.Boolean>

Methods

Get(String, Input<String>, ClusterInstanceState, CustomResourceOptions)

Get an existing ClusterInstance resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static ClusterInstance Get(string name, Input<string> id, ClusterInstanceState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ClusterInstanceState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ClusterInstance