Class Cluster

Provides an Neptune Cluster Resource. A Cluster Resource defines attributes that are applied to the entire cluster of Neptune Cluster Instances.

Changes to a Neptune Cluster can occur when you manually change a parameter, such as backup_retention_period, and are reflected in the next maintenance window. Because of this, this provider may report a difference in its planning phase because a modification has not yet taken place. You can use the apply_immediately flag to instruct the service to apply the change immediately (see documentation below).

Example Usage

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,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Cluster

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 Cluster : CustomResource

Constructors

Cluster(String, ClusterArgs, CustomResourceOptions)

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

Declaration

public Cluster(string name, ClusterArgs args = null, CustomResourceOptions options = null)

Parameters

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

Properties

ApplyImmediately

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

Declaration

public Output<bool> ApplyImmediately { get; }

Property Value

Type	Description
Output<System.Boolean>

Arn

The Neptune Cluster Amazon Resource Name (ARN)

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

AvailabilityZones

A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.

Declaration

public Output<ImmutableArray<string>> AvailabilityZones { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

BackupRetentionPeriod

The days to retain backups for. Default 1

Declaration

public Output<int?> BackupRetentionPeriod { get; }

Property Value

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

ClusterIdentifier

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

Declaration

public Output<string> ClusterIdentifier { get; }

Property Value

Type	Description
Output<System.String>

ClusterIdentifierPrefix

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

Declaration

public Output<string> ClusterIdentifierPrefix { get; }

Property Value

Type	Description
Output<System.String>

ClusterMembers

List of Neptune Instances that are a part of this cluster

Declaration

public Output<ImmutableArray<string>> ClusterMembers { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

ClusterResourceId

The Neptune Cluster Resource ID

Declaration

public Output<string> ClusterResourceId { get; }

Property Value

Type	Description
Output<System.String>

DeletionProtection

A value that indicates whether the DB cluster has deletion protection enabled.The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Declaration

public Output<bool?> DeletionProtection { get; }

Property Value

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

EnableCloudwatchLogsExports

A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports audit.

Declaration

public Output<ImmutableArray<string>> EnableCloudwatchLogsExports { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Endpoint

The DNS address of the Neptune instance

Declaration

public Output<string> Endpoint { get; }

Property Value

Type	Description
Output<System.String>

Engine

The name of the database engine to be used for this Neptune cluster. Defaults to neptune.

Declaration

public Output<string> Engine { get; }

Property Value

Type	Description
Output<System.String>

EngineVersion

The database engine version.

Declaration

public Output<string> EngineVersion { get; }

Property Value

Type	Description
Output<System.String>

FinalSnapshotIdentifier

The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.

Declaration

public Output<string> FinalSnapshotIdentifier { get; }

Property Value

Type	Description
Output<System.String>

HostedZoneId

The Route53 Hosted Zone ID of the endpoint

Declaration

public Output<string> HostedZoneId { get; }

Property Value

Type	Description
Output<System.String>

IamDatabaseAuthenticationEnabled

Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

Declaration

public Output<bool?> IamDatabaseAuthenticationEnabled { get; }

Property Value

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

IamRoles

A List of ARNs for the IAM roles to associate to the Neptune Cluster.

Declaration

public Output<ImmutableArray<string>> IamRoles { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

KmsKeyArn

The ARN for the KMS encryption key. When specifying kms_key_arn, storage_encrypted needs to be set to true.

Declaration

public Output<string> KmsKeyArn { get; }

Property Value

Type	Description
Output<System.String>

NeptuneClusterParameterGroupName

A cluster parameter group to associate with the cluster.

Declaration

public Output<string> NeptuneClusterParameterGroupName { get; }

Property Value

Type	Description
Output<System.String>

NeptuneSubnetGroupName

A Neptune subnet group to associate with this Neptune instance.

Declaration

public Output<string> NeptuneSubnetGroupName { get; }

Property Value

Type	Description
Output<System.String>

Port

The port on which the Neptune accepts connections. Default is 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 using the BackupRetentionPeriod parameter. Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00

Declaration

public Output<string> PreferredBackupWindow { get; }

Property Value

Type	Description
Output<System.String>

PreferredMaintenanceWindow

The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30

Declaration

public Output<string> PreferredMaintenanceWindow { get; }

Property Value

Type	Description
Output<System.String>

ReaderEndpoint

A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas

Declaration

public Output<string> ReaderEndpoint { get; }

Property Value

Type	Description
Output<System.String>

ReplicationSourceIdentifier

ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.

Declaration

public Output<string> ReplicationSourceIdentifier { get; }

Property Value

Type	Description
Output<System.String>

SkipFinalSnapshot

Determines whether a final Neptune snapshot is created before the Neptune cluster is deleted. If true is specified, no Neptune snapshot is created. If false is specified, a Neptune snapshot is created before the Neptune cluster is deleted, using the value from final_snapshot_identifier. Default is false.

Declaration

public Output<bool?> SkipFinalSnapshot { get; }

Property Value

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

SnapshotIdentifier

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a Neptune cluster snapshot, or the ARN when specifying a Neptune snapshot.

Declaration

public Output<string> SnapshotIdentifier { get; }

Property Value

Type	Description
Output<System.String>

StorageEncrypted

Specifies whether the Neptune cluster is encrypted. The default is false if not specified.

Declaration

public Output<bool?> StorageEncrypted { get; }

Property Value

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

Tags

A map of tags to assign to the Neptune cluster.

Declaration

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

Property Value

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

VpcSecurityGroupIds

List of VPC security groups to associate with the Cluster

Declaration

public Output<ImmutableArray<string>> VpcSecurityGroupIds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Methods

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

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

Declaration

public static Cluster Get(string name, Input<string> id, ClusterState 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.
ClusterState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Cluster