AWS Classic v5.41.0, May 15 23

aws.neptune.Cluster

Explore with Pulumi AI

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 System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var @default = new Aws.Neptune.Cluster("default", new()
    {
        ApplyImmediately = true,
        BackupRetentionPeriod = 5,
        ClusterIdentifier = "neptune-cluster-demo",
        Engine = "neptune",
        IamDatabaseAuthenticationEnabled = true,
        PreferredBackupWindow = "07:00-09:00",
        SkipFinalSnapshot = true,
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/neptune"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := neptune.NewCluster(ctx, "default", &neptune.ClusterArgs{
			ApplyImmediately:                 pulumi.Bool(true),
			BackupRetentionPeriod:            pulumi.Int(5),
			ClusterIdentifier:                pulumi.String("neptune-cluster-demo"),
			Engine:                           pulumi.String("neptune"),
			IamDatabaseAuthenticationEnabled: pulumi.Bool(true),
			PreferredBackupWindow:            pulumi.String("07:00-09:00"),
			SkipFinalSnapshot:                pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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 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()        
            .applyImmediately(true)
            .backupRetentionPeriod(5)
            .clusterIdentifier("neptune-cluster-demo")
            .engine("neptune")
            .iamDatabaseAuthenticationEnabled(true)
            .preferredBackupWindow("07:00-09:00")
            .skipFinalSnapshot(true)
            .build());

    }
}

import pulumi
import pulumi_aws as aws

default = aws.neptune.Cluster("default",
    apply_immediately=True,
    backup_retention_period=5,
    cluster_identifier="neptune-cluster-demo",
    engine="neptune",
    iam_database_authentication_enabled=True,
    preferred_backup_window="07:00-09:00",
    skip_final_snapshot=True)

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const _default = new aws.neptune.Cluster("default", {
    applyImmediately: true,
    backupRetentionPeriod: 5,
    clusterIdentifier: "neptune-cluster-demo",
    engine: "neptune",
    iamDatabaseAuthenticationEnabled: true,
    preferredBackupWindow: "07:00-09:00",
    skipFinalSnapshot: true,
});

resources:
  default:
    type: aws:neptune:Cluster
    properties:
      applyImmediately: true
      backupRetentionPeriod: 5
      clusterIdentifier: neptune-cluster-demo
      engine: neptune
      iamDatabaseAuthenticationEnabled: true
      preferredBackupWindow: 07:00-09:00
      skipFinalSnapshot: true

Create Cluster Resource

new Cluster(name: string, args?: ClusterArgs, opts?: CustomResourceOptions);

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            allow_major_version_upgrade: Optional[bool] = None,
            apply_immediately: Optional[bool] = None,
            availability_zones: Optional[Sequence[str]] = None,
            backup_retention_period: Optional[int] = None,
            cluster_identifier: Optional[str] = None,
            cluster_identifier_prefix: Optional[str] = None,
            copy_tags_to_snapshot: Optional[bool] = None,
            deletion_protection: Optional[bool] = None,
            enable_cloudwatch_logs_exports: Optional[Sequence[str]] = None,
            engine: Optional[str] = None,
            engine_version: Optional[str] = None,
            final_snapshot_identifier: Optional[str] = None,
            global_cluster_identifier: Optional[str] = None,
            iam_database_authentication_enabled: Optional[bool] = None,
            iam_roles: Optional[Sequence[str]] = None,
            kms_key_arn: Optional[str] = None,
            neptune_cluster_parameter_group_name: Optional[str] = None,
            neptune_instance_parameter_group_name: Optional[str] = None,
            neptune_subnet_group_name: Optional[str] = None,
            port: Optional[int] = None,
            preferred_backup_window: Optional[str] = None,
            preferred_maintenance_window: Optional[str] = None,
            replication_source_identifier: Optional[str] = None,
            serverless_v2_scaling_configuration: Optional[ClusterServerlessV2ScalingConfigurationArgs] = None,
            skip_final_snapshot: Optional[bool] = None,
            snapshot_identifier: Optional[str] = None,
            storage_encrypted: Optional[bool] = None,
            tags: Optional[Mapping[str, str]] = None,
            vpc_security_group_ids: Optional[Sequence[str]] = None)
@overload
def Cluster(resource_name: str,
            args: Optional[ClusterArgs] = None,
            opts: Optional[ResourceOptions] = None)

func NewCluster(ctx *Context, name string, args *ClusterArgs, opts ...ResourceOption) (*Cluster, error)

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

public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

type: aws:neptune:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Cluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Cluster resource accepts the following input properties:

AllowMajorVersionUpgrade bool: Specifies whether upgrades between different major versions are allowed. You must set it to true when providing an engine_version parameter that uses a different major version than the DB cluster's current version. Default is false.
ApplyImmediately bool: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
AvailabilityZones List<string>: A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.
BackupRetentionPeriod int: The days to retain backups for. Default 1
ClusterIdentifier string: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
ClusterIdentifierPrefix string: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
CopyTagsToSnapshot bool: If set to true, tags are copied to any snapshot of the DB cluster that is created.
DeletionProtection bool: 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.
EnableCloudwatchLogsExports List<string>: A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports audit.
Engine string: The name of the database engine to be used for this Neptune cluster. Defaults to neptune.
EngineVersion string: The database engine version.
FinalSnapshotIdentifier string: The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
GlobalClusterIdentifier string: The global cluster identifier specified on aws.neptune.GlobalCluster.
IamDatabaseAuthenticationEnabled bool: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
IamRoles List<string>: A List of ARNs for the IAM roles to associate to the Neptune Cluster.
KmsKeyArn string: The ARN for the KMS encryption key. When specifying kms_key_arn, storage_encrypted needs to be set to true.
NeptuneClusterParameterGroupName string: A cluster parameter group to associate with the cluster.
NeptuneInstanceParameterGroupName string: The name of the DB parameter group to apply to all instances of the DB cluster.
NeptuneSubnetGroupName string: A Neptune subnet group to associate with this Neptune instance.
Port int: The port on which the Neptune accepts connections. Default is 8182.
PreferredBackupWindow string: 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 regionE.g., 04:00-09:00
PreferredMaintenanceWindow string: The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
ReplicationSourceIdentifier string: ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
ServerlessV2ScalingConfiguration ClusterServerlessV2ScalingConfigurationArgs: If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
SkipFinalSnapshot bool: 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.
SnapshotIdentifier string: 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.
StorageEncrypted bool: Specifies whether the Neptune cluster is encrypted. The default is false if not specified.
Tags Dictionary<string, string>: A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
VpcSecurityGroupIds List<string>: List of VPC security groups to associate with the Cluster

AllowMajorVersionUpgrade bool: Specifies whether upgrades between different major versions are allowed. You must set it to true when providing an engine_version parameter that uses a different major version than the DB cluster's current version. Default is false.
ApplyImmediately bool: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
AvailabilityZones []string: A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.
BackupRetentionPeriod int: The days to retain backups for. Default 1
ClusterIdentifier string: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
ClusterIdentifierPrefix string: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
CopyTagsToSnapshot bool: If set to true, tags are copied to any snapshot of the DB cluster that is created.
DeletionProtection bool: 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.
EnableCloudwatchLogsExports []string: A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports audit.
Engine string: The name of the database engine to be used for this Neptune cluster. Defaults to neptune.
EngineVersion string: The database engine version.
FinalSnapshotIdentifier string: The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
GlobalClusterIdentifier string: The global cluster identifier specified on aws.neptune.GlobalCluster.
IamDatabaseAuthenticationEnabled bool: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
IamRoles []string: A List of ARNs for the IAM roles to associate to the Neptune Cluster.
KmsKeyArn string: The ARN for the KMS encryption key. When specifying kms_key_arn, storage_encrypted needs to be set to true.
NeptuneClusterParameterGroupName string: A cluster parameter group to associate with the cluster.
NeptuneInstanceParameterGroupName string: The name of the DB parameter group to apply to all instances of the DB cluster.
NeptuneSubnetGroupName string: A Neptune subnet group to associate with this Neptune instance.
Port int: The port on which the Neptune accepts connections. Default is 8182.
PreferredBackupWindow string: 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 regionE.g., 04:00-09:00
PreferredMaintenanceWindow string: The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
ReplicationSourceIdentifier string: ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
ServerlessV2ScalingConfiguration ClusterServerlessV2ScalingConfigurationArgs: If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
SkipFinalSnapshot bool: 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.
SnapshotIdentifier string: 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.
StorageEncrypted bool: Specifies whether the Neptune cluster is encrypted. The default is false if not specified.
Tags map[string]string: A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
VpcSecurityGroupIds []string: List of VPC security groups to associate with the Cluster

allowMajorVersionUpgrade Boolean: Specifies whether upgrades between different major versions are allowed. You must set it to true when providing an engine_version parameter that uses a different major version than the DB cluster's current version. Default is false.
applyImmediately Boolean: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
availabilityZones List<String>: A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.
backupRetentionPeriod Integer: The days to retain backups for. Default 1
clusterIdentifier String: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
clusterIdentifierPrefix String: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
copyTagsToSnapshot Boolean: If set to true, tags are copied to any snapshot of the DB cluster that is created.
deletionProtection Boolean: 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.
enableCloudwatchLogsExports List<String>: A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports audit.
engine String: The name of the database engine to be used for this Neptune cluster. Defaults to neptune.
engineVersion String: The database engine version.
finalSnapshotIdentifier String: The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
globalClusterIdentifier String: The global cluster identifier specified on aws.neptune.GlobalCluster.
iamDatabaseAuthenticationEnabled Boolean: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
iamRoles List<String>: A List of ARNs for the IAM roles to associate to the Neptune Cluster.
kmsKeyArn String: The ARN for the KMS encryption key. When specifying kms_key_arn, storage_encrypted needs to be set to true.
neptuneClusterParameterGroupName String: A cluster parameter group to associate with the cluster.
neptuneInstanceParameterGroupName String: The name of the DB parameter group to apply to all instances of the DB cluster.
neptuneSubnetGroupName String: A Neptune subnet group to associate with this Neptune instance.
port Integer: The port on which the Neptune accepts connections. Default is 8182.
preferredBackupWindow String: 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 regionE.g., 04:00-09:00
preferredMaintenanceWindow String: The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
replicationSourceIdentifier String: ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
serverlessV2ScalingConfiguration ClusterServerlessV2ScalingConfigurationArgs: If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
skipFinalSnapshot Boolean: 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.
snapshotIdentifier String: 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.
storageEncrypted Boolean: Specifies whether the Neptune cluster is encrypted. The default is false if not specified.
tags Map<String,String>: A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
vpcSecurityGroupIds List<String>: List of VPC security groups to associate with the Cluster

allowMajorVersionUpgrade boolean: Specifies whether upgrades between different major versions are allowed. You must set it to true when providing an engine_version parameter that uses a different major version than the DB cluster's current version. Default is false.
applyImmediately boolean: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
availabilityZones string[]: A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.
backupRetentionPeriod number: The days to retain backups for. Default 1
clusterIdentifier string: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
clusterIdentifierPrefix string: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
copyTagsToSnapshot boolean: If set to true, tags are copied to any snapshot of the DB cluster that is created.
deletionProtection boolean: 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.
enableCloudwatchLogsExports string[]: A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports audit.
engine string: The name of the database engine to be used for this Neptune cluster. Defaults to neptune.
engineVersion string: The database engine version.
finalSnapshotIdentifier string: The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
globalClusterIdentifier string: The global cluster identifier specified on aws.neptune.GlobalCluster.
iamDatabaseAuthenticationEnabled boolean: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
iamRoles string[]: A List of ARNs for the IAM roles to associate to the Neptune Cluster.
kmsKeyArn string: The ARN for the KMS encryption key. When specifying kms_key_arn, storage_encrypted needs to be set to true.
neptuneClusterParameterGroupName string: A cluster parameter group to associate with the cluster.
neptuneInstanceParameterGroupName string: The name of the DB parameter group to apply to all instances of the DB cluster.
neptuneSubnetGroupName string: A Neptune subnet group to associate with this Neptune instance.
port number: The port on which the Neptune accepts connections. Default is 8182.
preferredBackupWindow string: 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 regionE.g., 04:00-09:00
preferredMaintenanceWindow string: The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
replicationSourceIdentifier string: ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
serverlessV2ScalingConfiguration ClusterServerlessV2ScalingConfigurationArgs: If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
skipFinalSnapshot boolean: 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.
snapshotIdentifier string: 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.
storageEncrypted boolean: Specifies whether the Neptune cluster is encrypted. The default is false if not specified.
tags {[key: string]: string}: A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
vpcSecurityGroupIds string[]: List of VPC security groups to associate with the Cluster

allow_major_version_upgrade bool: Specifies whether upgrades between different major versions are allowed. You must set it to true when providing an engine_version parameter that uses a different major version than the DB cluster's current version. Default is false.
apply_immediately bool: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
availability_zones Sequence[str]: A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.
backup_retention_period int: The days to retain backups for. Default 1
cluster_identifier str: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
cluster_identifier_prefix str: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
copy_tags_to_snapshot bool: If set to true, tags are copied to any snapshot of the DB cluster that is created.
deletion_protection bool: 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.
enable_cloudwatch_logs_exports Sequence[str]: A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports audit.
engine str: The name of the database engine to be used for this Neptune cluster. Defaults to neptune.
engine_version str: The database engine version.
final_snapshot_identifier str: The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
global_cluster_identifier str: The global cluster identifier specified on aws.neptune.GlobalCluster.
iam_database_authentication_enabled bool: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
iam_roles Sequence[str]: A List of ARNs for the IAM roles to associate to the Neptune Cluster.
kms_key_arn str: The ARN for the KMS encryption key. When specifying kms_key_arn, storage_encrypted needs to be set to true.
neptune_cluster_parameter_group_name str: A cluster parameter group to associate with the cluster.
neptune_instance_parameter_group_name str: The name of the DB parameter group to apply to all instances of the DB cluster.
neptune_subnet_group_name str: A Neptune subnet group to associate with this Neptune instance.
port int: The port on which the Neptune accepts connections. Default is 8182.
preferred_backup_window str: 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 regionE.g., 04:00-09:00
preferred_maintenance_window str: The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
replication_source_identifier str: ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
serverless_v2_scaling_configuration ClusterServerlessV2ScalingConfigurationArgs: If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
skip_final_snapshot bool: 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.
snapshot_identifier str: 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.
storage_encrypted bool: Specifies whether the Neptune cluster is encrypted. The default is false if not specified.
tags Mapping[str, str]: A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
vpc_security_group_ids Sequence[str]: List of VPC security groups to associate with the Cluster

allowMajorVersionUpgrade Boolean: Specifies whether upgrades between different major versions are allowed. You must set it to true when providing an engine_version parameter that uses a different major version than the DB cluster's current version. Default is false.
applyImmediately Boolean: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
availabilityZones List<String>: A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.
backupRetentionPeriod Number: The days to retain backups for. Default 1
clusterIdentifier String: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
clusterIdentifierPrefix String: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
copyTagsToSnapshot Boolean: If set to true, tags are copied to any snapshot of the DB cluster that is created.
deletionProtection Boolean: 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.
enableCloudwatchLogsExports List<String>: A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports audit.
engine String: The name of the database engine to be used for this Neptune cluster. Defaults to neptune.
engineVersion String: The database engine version.
finalSnapshotIdentifier String: The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
globalClusterIdentifier String: The global cluster identifier specified on aws.neptune.GlobalCluster.
iamDatabaseAuthenticationEnabled Boolean: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
iamRoles List<String>: A List of ARNs for the IAM roles to associate to the Neptune Cluster.
kmsKeyArn String: The ARN for the KMS encryption key. When specifying kms_key_arn, storage_encrypted needs to be set to true.
neptuneClusterParameterGroupName String: A cluster parameter group to associate with the cluster.
neptuneInstanceParameterGroupName String: The name of the DB parameter group to apply to all instances of the DB cluster.
neptuneSubnetGroupName String: A Neptune subnet group to associate with this Neptune instance.
port Number: The port on which the Neptune accepts connections. Default is 8182.
preferredBackupWindow String: 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 regionE.g., 04:00-09:00
preferredMaintenanceWindow String: The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
replicationSourceIdentifier String: ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
serverlessV2ScalingConfiguration Property Map: If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
skipFinalSnapshot Boolean: 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.
snapshotIdentifier String: 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.
storageEncrypted Boolean: Specifies whether the Neptune cluster is encrypted. The default is false if not specified.
tags Map<String>: A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
vpcSecurityGroupIds List<String>: List of VPC security groups to associate with the Cluster

Outputs

All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

Arn string: The Neptune Cluster Amazon Resource Name (ARN)
ClusterMembers List<string>: List of Neptune Instances that are a part of this cluster
ClusterResourceId string: The Neptune Cluster Resource ID
Endpoint string: The DNS address of the Neptune instance
HostedZoneId string: The Route53 Hosted Zone ID of the endpoint
Id string: The provider-assigned unique ID for this managed resource.
ReaderEndpoint string: A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string: The Neptune Cluster Amazon Resource Name (ARN)
ClusterMembers []string: List of Neptune Instances that are a part of this cluster
ClusterResourceId string: The Neptune Cluster Resource ID
Endpoint string: The DNS address of the Neptune instance
HostedZoneId string: The Route53 Hosted Zone ID of the endpoint
Id string: The provider-assigned unique ID for this managed resource.
ReaderEndpoint string: A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: The Neptune Cluster Amazon Resource Name (ARN)
clusterMembers List<String>: List of Neptune Instances that are a part of this cluster
clusterResourceId String: The Neptune Cluster Resource ID
endpoint String: The DNS address of the Neptune instance
hostedZoneId String: The Route53 Hosted Zone ID of the endpoint
id String: The provider-assigned unique ID for this managed resource.
readerEndpoint String: A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string: The Neptune Cluster Amazon Resource Name (ARN)
clusterMembers string[]: List of Neptune Instances that are a part of this cluster
clusterResourceId string: The Neptune Cluster Resource ID
endpoint string: The DNS address of the Neptune instance
hostedZoneId string: The Route53 Hosted Zone ID of the endpoint
id string: The provider-assigned unique ID for this managed resource.
readerEndpoint string: A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str: The Neptune Cluster Amazon Resource Name (ARN)
cluster_members Sequence[str]: List of Neptune Instances that are a part of this cluster
cluster_resource_id str: The Neptune Cluster Resource ID
endpoint str: The DNS address of the Neptune instance
hosted_zone_id str: The Route53 Hosted Zone ID of the endpoint
id str: The provider-assigned unique ID for this managed resource.
reader_endpoint str: A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: The Neptune Cluster Amazon Resource Name (ARN)
clusterMembers List<String>: List of Neptune Instances that are a part of this cluster
clusterResourceId String: The Neptune Cluster Resource ID
endpoint String: The DNS address of the Neptune instance
hostedZoneId String: The Route53 Hosted Zone ID of the endpoint
id String: The provider-assigned unique ID for this managed resource.
readerEndpoint String: A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up Existing Cluster Resource

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

public static get(name: string, id: Input<ID>, state?: ClusterState, opts?: CustomResourceOptions): Cluster

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_major_version_upgrade: Optional[bool] = None,
        apply_immediately: Optional[bool] = None,
        arn: Optional[str] = None,
        availability_zones: Optional[Sequence[str]] = None,
        backup_retention_period: Optional[int] = None,
        cluster_identifier: Optional[str] = None,
        cluster_identifier_prefix: Optional[str] = None,
        cluster_members: Optional[Sequence[str]] = None,
        cluster_resource_id: Optional[str] = None,
        copy_tags_to_snapshot: Optional[bool] = None,
        deletion_protection: Optional[bool] = None,
        enable_cloudwatch_logs_exports: Optional[Sequence[str]] = None,
        endpoint: Optional[str] = None,
        engine: Optional[str] = None,
        engine_version: Optional[str] = None,
        final_snapshot_identifier: Optional[str] = None,
        global_cluster_identifier: Optional[str] = None,
        hosted_zone_id: Optional[str] = None,
        iam_database_authentication_enabled: Optional[bool] = None,
        iam_roles: Optional[Sequence[str]] = None,
        kms_key_arn: Optional[str] = None,
        neptune_cluster_parameter_group_name: Optional[str] = None,
        neptune_instance_parameter_group_name: Optional[str] = None,
        neptune_subnet_group_name: Optional[str] = None,
        port: Optional[int] = None,
        preferred_backup_window: Optional[str] = None,
        preferred_maintenance_window: Optional[str] = None,
        reader_endpoint: Optional[str] = None,
        replication_source_identifier: Optional[str] = None,
        serverless_v2_scaling_configuration: Optional[ClusterServerlessV2ScalingConfigurationArgs] = None,
        skip_final_snapshot: Optional[bool] = None,
        snapshot_identifier: Optional[str] = None,
        storage_encrypted: Optional[bool] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc_security_group_ids: Optional[Sequence[str]] = None) -> Cluster

func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)

public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)

public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AllowMajorVersionUpgrade bool: Specifies whether upgrades between different major versions are allowed. You must set it to true when providing an engine_version parameter that uses a different major version than the DB cluster's current version. Default is false.
ApplyImmediately bool: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
Arn string: The Neptune Cluster Amazon Resource Name (ARN)
AvailabilityZones List<string>: A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.
BackupRetentionPeriod int: The days to retain backups for. Default 1
ClusterIdentifier string: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
ClusterIdentifierPrefix string: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
ClusterMembers List<string>: List of Neptune Instances that are a part of this cluster
ClusterResourceId string: The Neptune Cluster Resource ID
CopyTagsToSnapshot bool: If set to true, tags are copied to any snapshot of the DB cluster that is created.
DeletionProtection bool: 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.
EnableCloudwatchLogsExports List<string>: A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports audit.
Endpoint string: The DNS address of the Neptune instance
Engine string: The name of the database engine to be used for this Neptune cluster. Defaults to neptune.
EngineVersion string: The database engine version.
FinalSnapshotIdentifier string: The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
GlobalClusterIdentifier string: The global cluster identifier specified on aws.neptune.GlobalCluster.
HostedZoneId string: The Route53 Hosted Zone ID of the endpoint
IamDatabaseAuthenticationEnabled bool: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
IamRoles List<string>: A List of ARNs for the IAM roles to associate to the Neptune Cluster.
KmsKeyArn string: The ARN for the KMS encryption key. When specifying kms_key_arn, storage_encrypted needs to be set to true.
NeptuneClusterParameterGroupName string: A cluster parameter group to associate with the cluster.
NeptuneInstanceParameterGroupName string: The name of the DB parameter group to apply to all instances of the DB cluster.
NeptuneSubnetGroupName string: A Neptune subnet group to associate with this Neptune instance.
Port int: The port on which the Neptune accepts connections. Default is 8182.
PreferredBackupWindow string: 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 regionE.g., 04:00-09:00
PreferredMaintenanceWindow string: The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
ReaderEndpoint string: A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas
ReplicationSourceIdentifier string: ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
ServerlessV2ScalingConfiguration ClusterServerlessV2ScalingConfigurationArgs: If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
SkipFinalSnapshot bool: 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.
SnapshotIdentifier string: 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.
StorageEncrypted bool: Specifies whether the Neptune cluster is encrypted. The default is false if not specified.
Tags Dictionary<string, string>: A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
VpcSecurityGroupIds List<string>: List of VPC security groups to associate with the Cluster

AllowMajorVersionUpgrade bool: Specifies whether upgrades between different major versions are allowed. You must set it to true when providing an engine_version parameter that uses a different major version than the DB cluster's current version. Default is false.
ApplyImmediately bool: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
Arn string: The Neptune Cluster Amazon Resource Name (ARN)
AvailabilityZones []string: A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.
BackupRetentionPeriod int: The days to retain backups for. Default 1
ClusterIdentifier string: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
ClusterIdentifierPrefix string: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
ClusterMembers []string: List of Neptune Instances that are a part of this cluster
ClusterResourceId string: The Neptune Cluster Resource ID
CopyTagsToSnapshot bool: If set to true, tags are copied to any snapshot of the DB cluster that is created.
DeletionProtection bool: 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.
EnableCloudwatchLogsExports []string: A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports audit.
Endpoint string: The DNS address of the Neptune instance
Engine string: The name of the database engine to be used for this Neptune cluster. Defaults to neptune.
EngineVersion string: The database engine version.
FinalSnapshotIdentifier string: The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
GlobalClusterIdentifier string: The global cluster identifier specified on aws.neptune.GlobalCluster.
HostedZoneId string: The Route53 Hosted Zone ID of the endpoint
IamDatabaseAuthenticationEnabled bool: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
IamRoles []string: A List of ARNs for the IAM roles to associate to the Neptune Cluster.
KmsKeyArn string: The ARN for the KMS encryption key. When specifying kms_key_arn, storage_encrypted needs to be set to true.
NeptuneClusterParameterGroupName string: A cluster parameter group to associate with the cluster.
NeptuneInstanceParameterGroupName string: The name of the DB parameter group to apply to all instances of the DB cluster.
NeptuneSubnetGroupName string: A Neptune subnet group to associate with this Neptune instance.
Port int: The port on which the Neptune accepts connections. Default is 8182.
PreferredBackupWindow string: 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 regionE.g., 04:00-09:00
PreferredMaintenanceWindow string: The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
ReaderEndpoint string: A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas
ReplicationSourceIdentifier string: ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
ServerlessV2ScalingConfiguration ClusterServerlessV2ScalingConfigurationArgs: If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
SkipFinalSnapshot bool: 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.
SnapshotIdentifier string: 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.
StorageEncrypted bool: Specifies whether the Neptune cluster is encrypted. The default is false if not specified.
Tags map[string]string: A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
VpcSecurityGroupIds []string: List of VPC security groups to associate with the Cluster

allowMajorVersionUpgrade Boolean: Specifies whether upgrades between different major versions are allowed. You must set it to true when providing an engine_version parameter that uses a different major version than the DB cluster's current version. Default is false.
applyImmediately Boolean: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
arn String: The Neptune Cluster Amazon Resource Name (ARN)
availabilityZones List<String>: A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.
backupRetentionPeriod Integer: The days to retain backups for. Default 1
clusterIdentifier String: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
clusterIdentifierPrefix String: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
clusterMembers List<String>: List of Neptune Instances that are a part of this cluster
clusterResourceId String: The Neptune Cluster Resource ID
copyTagsToSnapshot Boolean: If set to true, tags are copied to any snapshot of the DB cluster that is created.
deletionProtection Boolean: 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.
enableCloudwatchLogsExports List<String>: A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports audit.
endpoint String: The DNS address of the Neptune instance
engine String: The name of the database engine to be used for this Neptune cluster. Defaults to neptune.
engineVersion String: The database engine version.
finalSnapshotIdentifier String: The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
globalClusterIdentifier String: The global cluster identifier specified on aws.neptune.GlobalCluster.
hostedZoneId String: The Route53 Hosted Zone ID of the endpoint
iamDatabaseAuthenticationEnabled Boolean: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
iamRoles List<String>: A List of ARNs for the IAM roles to associate to the Neptune Cluster.
kmsKeyArn String: The ARN for the KMS encryption key. When specifying kms_key_arn, storage_encrypted needs to be set to true.
neptuneClusterParameterGroupName String: A cluster parameter group to associate with the cluster.
neptuneInstanceParameterGroupName String: The name of the DB parameter group to apply to all instances of the DB cluster.
neptuneSubnetGroupName String: A Neptune subnet group to associate with this Neptune instance.
port Integer: The port on which the Neptune accepts connections. Default is 8182.
preferredBackupWindow String: 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 regionE.g., 04:00-09:00
preferredMaintenanceWindow String: The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
readerEndpoint String: A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas
replicationSourceIdentifier String: ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
serverlessV2ScalingConfiguration ClusterServerlessV2ScalingConfigurationArgs: If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
skipFinalSnapshot Boolean: 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.
snapshotIdentifier String: 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.
storageEncrypted Boolean: Specifies whether the Neptune cluster is encrypted. The default is false if not specified.
tags Map<String,String>: A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
vpcSecurityGroupIds List<String>: List of VPC security groups to associate with the Cluster

allowMajorVersionUpgrade boolean: Specifies whether upgrades between different major versions are allowed. You must set it to true when providing an engine_version parameter that uses a different major version than the DB cluster's current version. Default is false.
applyImmediately boolean: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
arn string: The Neptune Cluster Amazon Resource Name (ARN)
availabilityZones string[]: A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.
backupRetentionPeriod number: The days to retain backups for. Default 1
clusterIdentifier string: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
clusterIdentifierPrefix string: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
clusterMembers string[]: List of Neptune Instances that are a part of this cluster
clusterResourceId string: The Neptune Cluster Resource ID
copyTagsToSnapshot boolean: If set to true, tags are copied to any snapshot of the DB cluster that is created.
deletionProtection boolean: 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.
enableCloudwatchLogsExports string[]: A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports audit.
endpoint string: The DNS address of the Neptune instance
engine string: The name of the database engine to be used for this Neptune cluster. Defaults to neptune.
engineVersion string: The database engine version.
finalSnapshotIdentifier string: The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
globalClusterIdentifier string: The global cluster identifier specified on aws.neptune.GlobalCluster.
hostedZoneId string: The Route53 Hosted Zone ID of the endpoint
iamDatabaseAuthenticationEnabled boolean: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
iamRoles string[]: A List of ARNs for the IAM roles to associate to the Neptune Cluster.
kmsKeyArn string: The ARN for the KMS encryption key. When specifying kms_key_arn, storage_encrypted needs to be set to true.
neptuneClusterParameterGroupName string: A cluster parameter group to associate with the cluster.
neptuneInstanceParameterGroupName string: The name of the DB parameter group to apply to all instances of the DB cluster.
neptuneSubnetGroupName string: A Neptune subnet group to associate with this Neptune instance.
port number: The port on which the Neptune accepts connections. Default is 8182.
preferredBackupWindow string: 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 regionE.g., 04:00-09:00
preferredMaintenanceWindow string: The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
readerEndpoint string: A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas
replicationSourceIdentifier string: ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
serverlessV2ScalingConfiguration ClusterServerlessV2ScalingConfigurationArgs: If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
skipFinalSnapshot boolean: 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.
snapshotIdentifier string: 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.
storageEncrypted boolean: Specifies whether the Neptune cluster is encrypted. The default is false if not specified.
tags {[key: string]: string}: A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
vpcSecurityGroupIds string[]: List of VPC security groups to associate with the Cluster

allow_major_version_upgrade bool: Specifies whether upgrades between different major versions are allowed. You must set it to true when providing an engine_version parameter that uses a different major version than the DB cluster's current version. Default is false.
apply_immediately bool: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
arn str: The Neptune Cluster Amazon Resource Name (ARN)
availability_zones Sequence[str]: A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.
backup_retention_period int: The days to retain backups for. Default 1
cluster_identifier str: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
cluster_identifier_prefix str: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
cluster_members Sequence[str]: List of Neptune Instances that are a part of this cluster
cluster_resource_id str: The Neptune Cluster Resource ID
copy_tags_to_snapshot bool: If set to true, tags are copied to any snapshot of the DB cluster that is created.
deletion_protection bool: 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.
enable_cloudwatch_logs_exports Sequence[str]: A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports audit.
endpoint str: The DNS address of the Neptune instance
engine str: The name of the database engine to be used for this Neptune cluster. Defaults to neptune.
engine_version str: The database engine version.
final_snapshot_identifier str: The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
global_cluster_identifier str: The global cluster identifier specified on aws.neptune.GlobalCluster.
hosted_zone_id str: The Route53 Hosted Zone ID of the endpoint
iam_database_authentication_enabled bool: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
iam_roles Sequence[str]: A List of ARNs for the IAM roles to associate to the Neptune Cluster.
kms_key_arn str: The ARN for the KMS encryption key. When specifying kms_key_arn, storage_encrypted needs to be set to true.
neptune_cluster_parameter_group_name str: A cluster parameter group to associate with the cluster.
neptune_instance_parameter_group_name str: The name of the DB parameter group to apply to all instances of the DB cluster.
neptune_subnet_group_name str: A Neptune subnet group to associate with this Neptune instance.
port int: The port on which the Neptune accepts connections. Default is 8182.
preferred_backup_window str: 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 regionE.g., 04:00-09:00
preferred_maintenance_window str: The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
reader_endpoint str: A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas
replication_source_identifier str: ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
serverless_v2_scaling_configuration ClusterServerlessV2ScalingConfigurationArgs: If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
skip_final_snapshot bool: 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.
snapshot_identifier str: 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.
storage_encrypted bool: Specifies whether the Neptune cluster is encrypted. The default is false if not specified.
tags Mapping[str, str]: A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
vpc_security_group_ids Sequence[str]: List of VPC security groups to associate with the Cluster

allowMajorVersionUpgrade Boolean: Specifies whether upgrades between different major versions are allowed. You must set it to true when providing an engine_version parameter that uses a different major version than the DB cluster's current version. Default is false.
applyImmediately Boolean: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
arn String: The Neptune Cluster Amazon Resource Name (ARN)
availabilityZones List<String>: A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.
backupRetentionPeriod Number: The days to retain backups for. Default 1
clusterIdentifier String: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
clusterIdentifierPrefix String: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
clusterMembers List<String>: List of Neptune Instances that are a part of this cluster
clusterResourceId String: The Neptune Cluster Resource ID
copyTagsToSnapshot Boolean: If set to true, tags are copied to any snapshot of the DB cluster that is created.
deletionProtection Boolean: 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.
enableCloudwatchLogsExports List<String>: A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports audit.
endpoint String: The DNS address of the Neptune instance
engine String: The name of the database engine to be used for this Neptune cluster. Defaults to neptune.
engineVersion String: The database engine version.
finalSnapshotIdentifier String: The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
globalClusterIdentifier String: The global cluster identifier specified on aws.neptune.GlobalCluster.
hostedZoneId String: The Route53 Hosted Zone ID of the endpoint
iamDatabaseAuthenticationEnabled Boolean: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
iamRoles List<String>: A List of ARNs for the IAM roles to associate to the Neptune Cluster.
kmsKeyArn String: The ARN for the KMS encryption key. When specifying kms_key_arn, storage_encrypted needs to be set to true.
neptuneClusterParameterGroupName String: A cluster parameter group to associate with the cluster.
neptuneInstanceParameterGroupName String: The name of the DB parameter group to apply to all instances of the DB cluster.
neptuneSubnetGroupName String: A Neptune subnet group to associate with this Neptune instance.
port Number: The port on which the Neptune accepts connections. Default is 8182.
preferredBackupWindow String: 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 regionE.g., 04:00-09:00
preferredMaintenanceWindow String: The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
readerEndpoint String: A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas
replicationSourceIdentifier String: ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
serverlessV2ScalingConfiguration Property Map: If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
skipFinalSnapshot Boolean: 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.
snapshotIdentifier String: 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.
storageEncrypted Boolean: Specifies whether the Neptune cluster is encrypted. The default is false if not specified.
tags Map<String>: A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
vpcSecurityGroupIds List<String>: List of VPC security groups to associate with the Cluster

Supporting Types

ClusterServerlessV2ScalingConfiguration

MaxCapacity double: The maximum Neptune Capacity Units (NCUs) for this cluster. Must be lower or equal than 128. See AWS Documentation for more details.
MinCapacity double: The minimum Neptune Capacity Units (NCUs) for this cluster. Must be greater or equal than 1. See AWS Documentation for more details.

MaxCapacity float64: The maximum Neptune Capacity Units (NCUs) for this cluster. Must be lower or equal than 128. See AWS Documentation for more details.
MinCapacity float64: The minimum Neptune Capacity Units (NCUs) for this cluster. Must be greater or equal than 1. See AWS Documentation for more details.

maxCapacity Double: The maximum Neptune Capacity Units (NCUs) for this cluster. Must be lower or equal than 128. See AWS Documentation for more details.
minCapacity Double: The minimum Neptune Capacity Units (NCUs) for this cluster. Must be greater or equal than 1. See AWS Documentation for more details.

maxCapacity number: The maximum Neptune Capacity Units (NCUs) for this cluster. Must be lower or equal than 128. See AWS Documentation for more details.
minCapacity number: The minimum Neptune Capacity Units (NCUs) for this cluster. Must be greater or equal than 1. See AWS Documentation for more details.

max_capacity float: The maximum Neptune Capacity Units (NCUs) for this cluster. Must be lower or equal than 128. See AWS Documentation for more details.
min_capacity float: The minimum Neptune Capacity Units (NCUs) for this cluster. Must be greater or equal than 1. See AWS Documentation for more details.

maxCapacity Number: The maximum Neptune Capacity Units (NCUs) for this cluster. Must be lower or equal than 128. See AWS Documentation for more details.
minCapacity Number: The minimum Neptune Capacity Units (NCUs) for this cluster. Must be greater or equal than 1. See AWS Documentation for more details.

Import

aws_neptune_cluster can be imported by using the cluster identifier, e.g.,

 $ pulumi import aws:neptune/cluster:Cluster example my-cluster

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.