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
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const _default = new aws.neptune.Cluster("default", {
    clusterIdentifier: "neptune-cluster-demo",
    engine: "neptune",
    backupRetentionPeriod: 5,
    preferredBackupWindow: "07:00-09:00",
    skipFinalSnapshot: true,
    iamDatabaseAuthenticationEnabled: true,
    applyImmediately: true,
});
import pulumi
import pulumi_aws as aws
default = aws.neptune.Cluster("default",
    cluster_identifier="neptune-cluster-demo",
    engine="neptune",
    backup_retention_period=5,
    preferred_backup_window="07:00-09:00",
    skip_final_snapshot=True,
    iam_database_authentication_enabled=True,
    apply_immediately=True)
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			ClusterIdentifier:                pulumi.String("neptune-cluster-demo"),
			Engine:                           pulumi.String("neptune"),
			BackupRetentionPeriod:            pulumi.Int(5),
			PreferredBackupWindow:            pulumi.String("07:00-09:00"),
			SkipFinalSnapshot:                pulumi.Bool(true),
			IamDatabaseAuthenticationEnabled: pulumi.Bool(true),
			ApplyImmediately:                 pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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()
    {
        ClusterIdentifier = "neptune-cluster-demo",
        Engine = "neptune",
        BackupRetentionPeriod = 5,
        PreferredBackupWindow = "07:00-09:00",
        SkipFinalSnapshot = true,
        IamDatabaseAuthenticationEnabled = true,
        ApplyImmediately = true,
    });
});
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()
            .clusterIdentifier("neptune-cluster-demo")
            .engine("neptune")
            .backupRetentionPeriod(5)
            .preferredBackupWindow("07:00-09:00")
            .skipFinalSnapshot(true)
            .iamDatabaseAuthenticationEnabled(true)
            .applyImmediately(true)
            .build());
    }
}
resources:
  default:
    type: aws:neptune:Cluster
    properties:
      clusterIdentifier: neptune-cluster-demo
      engine: neptune
      backupRetentionPeriod: 5
      preferredBackupWindow: 07:00-09:00
      skipFinalSnapshot: true
      iamDatabaseAuthenticationEnabled: true
      applyImmediately: true
Note: AWS Neptune does not support user name/password–based access control. See the AWS Docs for more information.
Create Cluster Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Cluster(name: string, args?: ClusterArgs, opts?: CustomResourceOptions);@overload
def Cluster(resource_name: str,
            args: Optional[ClusterArgs] = None,
            opts: Optional[ResourceOptions] = None)
@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,
            storage_type: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            vpc_security_group_ids: Optional[Sequence[str]] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampleclusterResourceResourceFromNeptunecluster = new Aws.Neptune.Cluster("exampleclusterResourceResourceFromNeptunecluster", new()
{
    AllowMajorVersionUpgrade = false,
    ApplyImmediately = false,
    AvailabilityZones = new[]
    {
        "string",
    },
    BackupRetentionPeriod = 0,
    ClusterIdentifier = "string",
    ClusterIdentifierPrefix = "string",
    CopyTagsToSnapshot = false,
    DeletionProtection = false,
    EnableCloudwatchLogsExports = new[]
    {
        "string",
    },
    Engine = "string",
    EngineVersion = "string",
    FinalSnapshotIdentifier = "string",
    GlobalClusterIdentifier = "string",
    IamDatabaseAuthenticationEnabled = false,
    IamRoles = new[]
    {
        "string",
    },
    KmsKeyArn = "string",
    NeptuneClusterParameterGroupName = "string",
    NeptuneInstanceParameterGroupName = "string",
    NeptuneSubnetGroupName = "string",
    Port = 0,
    PreferredBackupWindow = "string",
    PreferredMaintenanceWindow = "string",
    ReplicationSourceIdentifier = "string",
    ServerlessV2ScalingConfiguration = new Aws.Neptune.Inputs.ClusterServerlessV2ScalingConfigurationArgs
    {
        MaxCapacity = 0,
        MinCapacity = 0,
    },
    SkipFinalSnapshot = false,
    SnapshotIdentifier = "string",
    StorageEncrypted = false,
    StorageType = "string",
    Tags = 
    {
        { "string", "string" },
    },
    VpcSecurityGroupIds = new[]
    {
        "string",
    },
});
example, err := neptune.NewCluster(ctx, "exampleclusterResourceResourceFromNeptunecluster", &neptune.ClusterArgs{
	AllowMajorVersionUpgrade: pulumi.Bool(false),
	ApplyImmediately:         pulumi.Bool(false),
	AvailabilityZones: pulumi.StringArray{
		pulumi.String("string"),
	},
	BackupRetentionPeriod:   pulumi.Int(0),
	ClusterIdentifier:       pulumi.String("string"),
	ClusterIdentifierPrefix: pulumi.String("string"),
	CopyTagsToSnapshot:      pulumi.Bool(false),
	DeletionProtection:      pulumi.Bool(false),
	EnableCloudwatchLogsExports: pulumi.StringArray{
		pulumi.String("string"),
	},
	Engine:                           pulumi.String("string"),
	EngineVersion:                    pulumi.String("string"),
	FinalSnapshotIdentifier:          pulumi.String("string"),
	GlobalClusterIdentifier:          pulumi.String("string"),
	IamDatabaseAuthenticationEnabled: pulumi.Bool(false),
	IamRoles: pulumi.StringArray{
		pulumi.String("string"),
	},
	KmsKeyArn:                         pulumi.String("string"),
	NeptuneClusterParameterGroupName:  pulumi.String("string"),
	NeptuneInstanceParameterGroupName: pulumi.String("string"),
	NeptuneSubnetGroupName:            pulumi.String("string"),
	Port:                              pulumi.Int(0),
	PreferredBackupWindow:             pulumi.String("string"),
	PreferredMaintenanceWindow:        pulumi.String("string"),
	ReplicationSourceIdentifier:       pulumi.String("string"),
	ServerlessV2ScalingConfiguration: &neptune.ClusterServerlessV2ScalingConfigurationArgs{
		MaxCapacity: pulumi.Float64(0),
		MinCapacity: pulumi.Float64(0),
	},
	SkipFinalSnapshot:  pulumi.Bool(false),
	SnapshotIdentifier: pulumi.String("string"),
	StorageEncrypted:   pulumi.Bool(false),
	StorageType:        pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VpcSecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})
var exampleclusterResourceResourceFromNeptunecluster = new Cluster("exampleclusterResourceResourceFromNeptunecluster", ClusterArgs.builder()
    .allowMajorVersionUpgrade(false)
    .applyImmediately(false)
    .availabilityZones("string")
    .backupRetentionPeriod(0)
    .clusterIdentifier("string")
    .clusterIdentifierPrefix("string")
    .copyTagsToSnapshot(false)
    .deletionProtection(false)
    .enableCloudwatchLogsExports("string")
    .engine("string")
    .engineVersion("string")
    .finalSnapshotIdentifier("string")
    .globalClusterIdentifier("string")
    .iamDatabaseAuthenticationEnabled(false)
    .iamRoles("string")
    .kmsKeyArn("string")
    .neptuneClusterParameterGroupName("string")
    .neptuneInstanceParameterGroupName("string")
    .neptuneSubnetGroupName("string")
    .port(0)
    .preferredBackupWindow("string")
    .preferredMaintenanceWindow("string")
    .replicationSourceIdentifier("string")
    .serverlessV2ScalingConfiguration(ClusterServerlessV2ScalingConfigurationArgs.builder()
        .maxCapacity(0)
        .minCapacity(0)
        .build())
    .skipFinalSnapshot(false)
    .snapshotIdentifier("string")
    .storageEncrypted(false)
    .storageType("string")
    .tags(Map.of("string", "string"))
    .vpcSecurityGroupIds("string")
    .build());
examplecluster_resource_resource_from_neptunecluster = aws.neptune.Cluster("exampleclusterResourceResourceFromNeptunecluster",
    allow_major_version_upgrade=False,
    apply_immediately=False,
    availability_zones=["string"],
    backup_retention_period=0,
    cluster_identifier="string",
    cluster_identifier_prefix="string",
    copy_tags_to_snapshot=False,
    deletion_protection=False,
    enable_cloudwatch_logs_exports=["string"],
    engine="string",
    engine_version="string",
    final_snapshot_identifier="string",
    global_cluster_identifier="string",
    iam_database_authentication_enabled=False,
    iam_roles=["string"],
    kms_key_arn="string",
    neptune_cluster_parameter_group_name="string",
    neptune_instance_parameter_group_name="string",
    neptune_subnet_group_name="string",
    port=0,
    preferred_backup_window="string",
    preferred_maintenance_window="string",
    replication_source_identifier="string",
    serverless_v2_scaling_configuration={
        "max_capacity": 0,
        "min_capacity": 0,
    },
    skip_final_snapshot=False,
    snapshot_identifier="string",
    storage_encrypted=False,
    storage_type="string",
    tags={
        "string": "string",
    },
    vpc_security_group_ids=["string"])
const exampleclusterResourceResourceFromNeptunecluster = new aws.neptune.Cluster("exampleclusterResourceResourceFromNeptunecluster", {
    allowMajorVersionUpgrade: false,
    applyImmediately: false,
    availabilityZones: ["string"],
    backupRetentionPeriod: 0,
    clusterIdentifier: "string",
    clusterIdentifierPrefix: "string",
    copyTagsToSnapshot: false,
    deletionProtection: false,
    enableCloudwatchLogsExports: ["string"],
    engine: "string",
    engineVersion: "string",
    finalSnapshotIdentifier: "string",
    globalClusterIdentifier: "string",
    iamDatabaseAuthenticationEnabled: false,
    iamRoles: ["string"],
    kmsKeyArn: "string",
    neptuneClusterParameterGroupName: "string",
    neptuneInstanceParameterGroupName: "string",
    neptuneSubnetGroupName: "string",
    port: 0,
    preferredBackupWindow: "string",
    preferredMaintenanceWindow: "string",
    replicationSourceIdentifier: "string",
    serverlessV2ScalingConfiguration: {
        maxCapacity: 0,
        minCapacity: 0,
    },
    skipFinalSnapshot: false,
    snapshotIdentifier: "string",
    storageEncrypted: false,
    storageType: "string",
    tags: {
        string: "string",
    },
    vpcSecurityGroupIds: ["string"],
});
type: aws:neptune:Cluster
properties:
    allowMajorVersionUpgrade: false
    applyImmediately: false
    availabilityZones:
        - string
    backupRetentionPeriod: 0
    clusterIdentifier: string
    clusterIdentifierPrefix: string
    copyTagsToSnapshot: false
    deletionProtection: false
    enableCloudwatchLogsExports:
        - string
    engine: string
    engineVersion: string
    finalSnapshotIdentifier: string
    globalClusterIdentifier: string
    iamDatabaseAuthenticationEnabled: false
    iamRoles:
        - string
    kmsKeyArn: string
    neptuneClusterParameterGroupName: string
    neptuneInstanceParameterGroupName: string
    neptuneSubnetGroupName: string
    port: 0
    preferredBackupWindow: string
    preferredMaintenanceWindow: string
    replicationSourceIdentifier: string
    serverlessV2ScalingConfiguration:
        maxCapacity: 0
        minCapacity: 0
    skipFinalSnapshot: false
    snapshotIdentifier: string
    storageEncrypted: false
    storageType: string
    tags:
        string: string
    vpcSecurityGroupIds:
        - string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Cluster resource accepts the following input properties:
- AllowMajor boolVersion Upgrade 
- Specifies whether upgrades between different major versions are allowed. You must set it to truewhen providing anengine_versionparameter that uses a different major version than the DB cluster's current version. Default isfalse.
- 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.
- BackupRetention intPeriod 
- The days to retain backups for. Default 1
- ClusterIdentifier string
- The cluster identifier. If omitted, this provider will assign a random, unique identifier.
- ClusterIdentifier stringPrefix 
- Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
- 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.
- EnableCloudwatch List<string>Logs Exports 
- A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports auditandslowquery.
- Engine string
- The name of the database engine to be used for this Neptune cluster. Defaults to neptune.
- EngineVersion string
- The database engine version.
- FinalSnapshot stringIdentifier 
- The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
- GlobalCluster stringIdentifier 
- The global cluster identifier specified on aws.neptune.GlobalCluster.
- IamDatabase boolAuthentication Enabled 
- 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.
- KmsKey stringArn 
- The ARN for the KMS encryption key. When specifying kms_key_arn,storage_encryptedneeds to be set to true.
- NeptuneCluster stringParameter Group Name 
- A cluster parameter group to associate with the cluster.
- NeptuneInstance stringParameter Group Name 
- The name of the DB parameter group to apply to all instances of the DB cluster.
- NeptuneSubnet stringGroup Name 
- A Neptune subnet group to associate with this Neptune instance.
- Port int
- The port on which the Neptune accepts connections. Default is 8182.
- PreferredBackup stringWindow 
- 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
- PreferredMaintenance stringWindow 
- The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
- ReplicationSource stringIdentifier 
- ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
- ServerlessV2Scaling ClusterConfiguration Serverless V2Scaling Configuration 
- If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
- SkipFinal boolSnapshot 
- 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 isfalse.
- 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. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
- StorageEncrypted bool
- Specifies whether the Neptune cluster is encrypted. The default is falseif not specified.
- StorageType string
- Storage type associated with the cluster standard/iopt1. Default:standard
- Dictionary<string, string>
- A map of tags to assign to the Neptune cluster. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- VpcSecurity List<string>Group Ids 
- List of VPC security groups to associate with the Cluster
- AllowMajor boolVersion Upgrade 
- Specifies whether upgrades between different major versions are allowed. You must set it to truewhen providing anengine_versionparameter that uses a different major version than the DB cluster's current version. Default isfalse.
- 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.
- BackupRetention intPeriod 
- The days to retain backups for. Default 1
- ClusterIdentifier string
- The cluster identifier. If omitted, this provider will assign a random, unique identifier.
- ClusterIdentifier stringPrefix 
- Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
- 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.
- EnableCloudwatch []stringLogs Exports 
- A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports auditandslowquery.
- Engine string
- The name of the database engine to be used for this Neptune cluster. Defaults to neptune.
- EngineVersion string
- The database engine version.
- FinalSnapshot stringIdentifier 
- The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
- GlobalCluster stringIdentifier 
- The global cluster identifier specified on aws.neptune.GlobalCluster.
- IamDatabase boolAuthentication Enabled 
- 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.
- KmsKey stringArn 
- The ARN for the KMS encryption key. When specifying kms_key_arn,storage_encryptedneeds to be set to true.
- NeptuneCluster stringParameter Group Name 
- A cluster parameter group to associate with the cluster.
- NeptuneInstance stringParameter Group Name 
- The name of the DB parameter group to apply to all instances of the DB cluster.
- NeptuneSubnet stringGroup Name 
- A Neptune subnet group to associate with this Neptune instance.
- Port int
- The port on which the Neptune accepts connections. Default is 8182.
- PreferredBackup stringWindow 
- 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
- PreferredMaintenance stringWindow 
- The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
- ReplicationSource stringIdentifier 
- ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
- ServerlessV2Scaling ClusterConfiguration Serverless V2Scaling Configuration Args 
- If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
- SkipFinal boolSnapshot 
- 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 isfalse.
- 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. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
- StorageEncrypted bool
- Specifies whether the Neptune cluster is encrypted. The default is falseif not specified.
- StorageType string
- Storage type associated with the cluster standard/iopt1. Default:standard
- map[string]string
- A map of tags to assign to the Neptune cluster. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- VpcSecurity []stringGroup Ids 
- List of VPC security groups to associate with the Cluster
- allowMajor BooleanVersion Upgrade 
- Specifies whether upgrades between different major versions are allowed. You must set it to truewhen providing anengine_versionparameter that uses a different major version than the DB cluster's current version. Default isfalse.
- 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.
- backupRetention IntegerPeriod 
- The days to retain backups for. Default 1
- clusterIdentifier String
- The cluster identifier. If omitted, this provider will assign a random, unique identifier.
- clusterIdentifier StringPrefix 
- Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
- 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.
- enableCloudwatch List<String>Logs Exports 
- A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports auditandslowquery.
- engine String
- The name of the database engine to be used for this Neptune cluster. Defaults to neptune.
- engineVersion String
- The database engine version.
- finalSnapshot StringIdentifier 
- The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
- globalCluster StringIdentifier 
- The global cluster identifier specified on aws.neptune.GlobalCluster.
- iamDatabase BooleanAuthentication Enabled 
- 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.
- kmsKey StringArn 
- The ARN for the KMS encryption key. When specifying kms_key_arn,storage_encryptedneeds to be set to true.
- neptuneCluster StringParameter Group Name 
- A cluster parameter group to associate with the cluster.
- neptuneInstance StringParameter Group Name 
- The name of the DB parameter group to apply to all instances of the DB cluster.
- neptuneSubnet StringGroup Name 
- A Neptune subnet group to associate with this Neptune instance.
- port Integer
- The port on which the Neptune accepts connections. Default is 8182.
- preferredBackup StringWindow 
- 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
- preferredMaintenance StringWindow 
- The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
- replicationSource StringIdentifier 
- ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
- serverlessV2Scaling ClusterConfiguration Serverless V2Scaling Configuration 
- If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
- skipFinal BooleanSnapshot 
- 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 isfalse.
- 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. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
- storageEncrypted Boolean
- Specifies whether the Neptune cluster is encrypted. The default is falseif not specified.
- storageType String
- Storage type associated with the cluster standard/iopt1. Default:standard
- Map<String,String>
- A map of tags to assign to the Neptune cluster. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- vpcSecurity List<String>Group Ids 
- List of VPC security groups to associate with the Cluster
- allowMajor booleanVersion Upgrade 
- Specifies whether upgrades between different major versions are allowed. You must set it to truewhen providing anengine_versionparameter that uses a different major version than the DB cluster's current version. Default isfalse.
- 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.
- backupRetention numberPeriod 
- The days to retain backups for. Default 1
- clusterIdentifier string
- The cluster identifier. If omitted, this provider will assign a random, unique identifier.
- clusterIdentifier stringPrefix 
- Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
- 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.
- enableCloudwatch string[]Logs Exports 
- A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports auditandslowquery.
- engine string
- The name of the database engine to be used for this Neptune cluster. Defaults to neptune.
- engineVersion string
- The database engine version.
- finalSnapshot stringIdentifier 
- The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
- globalCluster stringIdentifier 
- The global cluster identifier specified on aws.neptune.GlobalCluster.
- iamDatabase booleanAuthentication Enabled 
- 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.
- kmsKey stringArn 
- The ARN for the KMS encryption key. When specifying kms_key_arn,storage_encryptedneeds to be set to true.
- neptuneCluster stringParameter Group Name 
- A cluster parameter group to associate with the cluster.
- neptuneInstance stringParameter Group Name 
- The name of the DB parameter group to apply to all instances of the DB cluster.
- neptuneSubnet stringGroup Name 
- A Neptune subnet group to associate with this Neptune instance.
- port number
- The port on which the Neptune accepts connections. Default is 8182.
- preferredBackup stringWindow 
- 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
- preferredMaintenance stringWindow 
- The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
- replicationSource stringIdentifier 
- ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
- serverlessV2Scaling ClusterConfiguration Serverless V2Scaling Configuration 
- If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
- skipFinal booleanSnapshot 
- 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 isfalse.
- 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. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
- storageEncrypted boolean
- Specifies whether the Neptune cluster is encrypted. The default is falseif not specified.
- storageType string
- Storage type associated with the cluster standard/iopt1. Default:standard
- {[key: string]: string}
- A map of tags to assign to the Neptune cluster. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- vpcSecurity string[]Group Ids 
- List of VPC security groups to associate with the Cluster
- allow_major_ boolversion_ upgrade 
- Specifies whether upgrades between different major versions are allowed. You must set it to truewhen providing anengine_versionparameter that uses a different major version than the DB cluster's current version. Default isfalse.
- 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_ intperiod 
- 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_ strprefix 
- Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
- 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_ Sequence[str]logs_ exports 
- A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports auditandslowquery.
- 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_ stridentifier 
- The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
- global_cluster_ stridentifier 
- The global cluster identifier specified on aws.neptune.GlobalCluster.
- iam_database_ boolauthentication_ enabled 
- 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_ strarn 
- The ARN for the KMS encryption key. When specifying kms_key_arn,storage_encryptedneeds to be set to true.
- neptune_cluster_ strparameter_ group_ name 
- A cluster parameter group to associate with the cluster.
- neptune_instance_ strparameter_ group_ name 
- The name of the DB parameter group to apply to all instances of the DB cluster.
- neptune_subnet_ strgroup_ name 
- 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_ strwindow 
- 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_ strwindow 
- The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
- replication_source_ stridentifier 
- ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
- serverless_v2_ Clusterscaling_ configuration Serverless V2Scaling Configuration Args 
- If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
- skip_final_ boolsnapshot 
- 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 isfalse.
- 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. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
- storage_encrypted bool
- Specifies whether the Neptune cluster is encrypted. The default is falseif not specified.
- storage_type str
- Storage type associated with the cluster standard/iopt1. Default:standard
- Mapping[str, str]
- A map of tags to assign to the Neptune cluster. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- vpc_security_ Sequence[str]group_ ids 
- List of VPC security groups to associate with the Cluster
- allowMajor BooleanVersion Upgrade 
- Specifies whether upgrades between different major versions are allowed. You must set it to truewhen providing anengine_versionparameter that uses a different major version than the DB cluster's current version. Default isfalse.
- 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.
- backupRetention NumberPeriod 
- The days to retain backups for. Default 1
- clusterIdentifier String
- The cluster identifier. If omitted, this provider will assign a random, unique identifier.
- clusterIdentifier StringPrefix 
- Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
- 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.
- enableCloudwatch List<String>Logs Exports 
- A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports auditandslowquery.
- engine String
- The name of the database engine to be used for this Neptune cluster. Defaults to neptune.
- engineVersion String
- The database engine version.
- finalSnapshot StringIdentifier 
- The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
- globalCluster StringIdentifier 
- The global cluster identifier specified on aws.neptune.GlobalCluster.
- iamDatabase BooleanAuthentication Enabled 
- 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.
- kmsKey StringArn 
- The ARN for the KMS encryption key. When specifying kms_key_arn,storage_encryptedneeds to be set to true.
- neptuneCluster StringParameter Group Name 
- A cluster parameter group to associate with the cluster.
- neptuneInstance StringParameter Group Name 
- The name of the DB parameter group to apply to all instances of the DB cluster.
- neptuneSubnet StringGroup Name 
- A Neptune subnet group to associate with this Neptune instance.
- port Number
- The port on which the Neptune accepts connections. Default is 8182.
- preferredBackup StringWindow 
- 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
- preferredMaintenance StringWindow 
- The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
- replicationSource StringIdentifier 
- ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
- serverlessV2Scaling Property MapConfiguration 
- If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
- skipFinal BooleanSnapshot 
- 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 isfalse.
- 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. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
- storageEncrypted Boolean
- Specifies whether the Neptune cluster is encrypted. The default is falseif not specified.
- storageType String
- Storage type associated with the cluster standard/iopt1. Default:standard
- Map<String>
- A map of tags to assign to the Neptune cluster. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- vpcSecurity List<String>Group Ids 
- 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
- ClusterResource stringId 
- The Neptune Cluster Resource ID
- Endpoint string
- The DNS address of the Neptune instance
- HostedZone stringId 
- 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
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- Arn string
- The Neptune Cluster Amazon Resource Name (ARN)
- ClusterMembers []string
- List of Neptune Instances that are a part of this cluster
- ClusterResource stringId 
- The Neptune Cluster Resource ID
- Endpoint string
- The DNS address of the Neptune instance
- HostedZone stringId 
- 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
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- arn String
- The Neptune Cluster Amazon Resource Name (ARN)
- clusterMembers List<String>
- List of Neptune Instances that are a part of this cluster
- clusterResource StringId 
- The Neptune Cluster Resource ID
- endpoint String
- The DNS address of the Neptune instance
- hostedZone StringId 
- 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
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- arn string
- The Neptune Cluster Amazon Resource Name (ARN)
- clusterMembers string[]
- List of Neptune Instances that are a part of this cluster
- clusterResource stringId 
- The Neptune Cluster Resource ID
- endpoint string
- The DNS address of the Neptune instance
- hostedZone stringId 
- 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
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration 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_ strid 
- The Neptune Cluster Resource ID
- endpoint str
- The DNS address of the Neptune instance
- hosted_zone_ strid 
- 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
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- arn String
- The Neptune Cluster Amazon Resource Name (ARN)
- clusterMembers List<String>
- List of Neptune Instances that are a part of this cluster
- clusterResource StringId 
- The Neptune Cluster Resource ID
- endpoint String
- The DNS address of the Neptune instance
- hostedZone StringId 
- 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
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration 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,
        storage_type: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc_security_group_ids: Optional[Sequence[str]] = None) -> Clusterfunc 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)resources:  _:    type: aws:neptune:Cluster    get:      id: ${id}- 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.
- AllowMajor boolVersion Upgrade 
- Specifies whether upgrades between different major versions are allowed. You must set it to truewhen providing anengine_versionparameter that uses a different major version than the DB cluster's current version. Default isfalse.
- 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.
- BackupRetention intPeriod 
- The days to retain backups for. Default 1
- ClusterIdentifier string
- The cluster identifier. If omitted, this provider will assign a random, unique identifier.
- ClusterIdentifier stringPrefix 
- 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
- ClusterResource stringId 
- The Neptune Cluster Resource ID
- 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.
- EnableCloudwatch List<string>Logs Exports 
- A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports auditandslowquery.
- 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.
- FinalSnapshot stringIdentifier 
- The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
- GlobalCluster stringIdentifier 
- The global cluster identifier specified on aws.neptune.GlobalCluster.
- HostedZone stringId 
- The Route53 Hosted Zone ID of the endpoint
- IamDatabase boolAuthentication Enabled 
- 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.
- KmsKey stringArn 
- The ARN for the KMS encryption key. When specifying kms_key_arn,storage_encryptedneeds to be set to true.
- NeptuneCluster stringParameter Group Name 
- A cluster parameter group to associate with the cluster.
- NeptuneInstance stringParameter Group Name 
- The name of the DB parameter group to apply to all instances of the DB cluster.
- NeptuneSubnet stringGroup Name 
- A Neptune subnet group to associate with this Neptune instance.
- Port int
- The port on which the Neptune accepts connections. Default is 8182.
- PreferredBackup stringWindow 
- 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
- PreferredMaintenance stringWindow 
- 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
- ReplicationSource stringIdentifier 
- ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
- ServerlessV2Scaling ClusterConfiguration Serverless V2Scaling Configuration 
- If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
- SkipFinal boolSnapshot 
- 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 isfalse.
- 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. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
- StorageEncrypted bool
- Specifies whether the Neptune cluster is encrypted. The default is falseif not specified.
- StorageType string
- Storage type associated with the cluster standard/iopt1. Default:standard
- Dictionary<string, string>
- A map of tags to assign to the Neptune cluster. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- VpcSecurity List<string>Group Ids 
- List of VPC security groups to associate with the Cluster
- AllowMajor boolVersion Upgrade 
- Specifies whether upgrades between different major versions are allowed. You must set it to truewhen providing anengine_versionparameter that uses a different major version than the DB cluster's current version. Default isfalse.
- 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.
- BackupRetention intPeriod 
- The days to retain backups for. Default 1
- ClusterIdentifier string
- The cluster identifier. If omitted, this provider will assign a random, unique identifier.
- ClusterIdentifier stringPrefix 
- 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
- ClusterResource stringId 
- The Neptune Cluster Resource ID
- 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.
- EnableCloudwatch []stringLogs Exports 
- A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports auditandslowquery.
- 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.
- FinalSnapshot stringIdentifier 
- The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
- GlobalCluster stringIdentifier 
- The global cluster identifier specified on aws.neptune.GlobalCluster.
- HostedZone stringId 
- The Route53 Hosted Zone ID of the endpoint
- IamDatabase boolAuthentication Enabled 
- 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.
- KmsKey stringArn 
- The ARN for the KMS encryption key. When specifying kms_key_arn,storage_encryptedneeds to be set to true.
- NeptuneCluster stringParameter Group Name 
- A cluster parameter group to associate with the cluster.
- NeptuneInstance stringParameter Group Name 
- The name of the DB parameter group to apply to all instances of the DB cluster.
- NeptuneSubnet stringGroup Name 
- A Neptune subnet group to associate with this Neptune instance.
- Port int
- The port on which the Neptune accepts connections. Default is 8182.
- PreferredBackup stringWindow 
- 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
- PreferredMaintenance stringWindow 
- 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
- ReplicationSource stringIdentifier 
- ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
- ServerlessV2Scaling ClusterConfiguration Serverless V2Scaling Configuration Args 
- If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
- SkipFinal boolSnapshot 
- 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 isfalse.
- 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. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
- StorageEncrypted bool
- Specifies whether the Neptune cluster is encrypted. The default is falseif not specified.
- StorageType string
- Storage type associated with the cluster standard/iopt1. Default:standard
- map[string]string
- A map of tags to assign to the Neptune cluster. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- VpcSecurity []stringGroup Ids 
- List of VPC security groups to associate with the Cluster
- allowMajor BooleanVersion Upgrade 
- Specifies whether upgrades between different major versions are allowed. You must set it to truewhen providing anengine_versionparameter that uses a different major version than the DB cluster's current version. Default isfalse.
- 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.
- backupRetention IntegerPeriod 
- The days to retain backups for. Default 1
- clusterIdentifier String
- The cluster identifier. If omitted, this provider will assign a random, unique identifier.
- clusterIdentifier StringPrefix 
- 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
- clusterResource StringId 
- The Neptune Cluster Resource ID
- 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.
- enableCloudwatch List<String>Logs Exports 
- A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports auditandslowquery.
- 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.
- finalSnapshot StringIdentifier 
- The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
- globalCluster StringIdentifier 
- The global cluster identifier specified on aws.neptune.GlobalCluster.
- hostedZone StringId 
- The Route53 Hosted Zone ID of the endpoint
- iamDatabase BooleanAuthentication Enabled 
- 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.
- kmsKey StringArn 
- The ARN for the KMS encryption key. When specifying kms_key_arn,storage_encryptedneeds to be set to true.
- neptuneCluster StringParameter Group Name 
- A cluster parameter group to associate with the cluster.
- neptuneInstance StringParameter Group Name 
- The name of the DB parameter group to apply to all instances of the DB cluster.
- neptuneSubnet StringGroup Name 
- A Neptune subnet group to associate with this Neptune instance.
- port Integer
- The port on which the Neptune accepts connections. Default is 8182.
- preferredBackup StringWindow 
- 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
- preferredMaintenance StringWindow 
- 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
- replicationSource StringIdentifier 
- ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
- serverlessV2Scaling ClusterConfiguration Serverless V2Scaling Configuration 
- If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
- skipFinal BooleanSnapshot 
- 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 isfalse.
- 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. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
- storageEncrypted Boolean
- Specifies whether the Neptune cluster is encrypted. The default is falseif not specified.
- storageType String
- Storage type associated with the cluster standard/iopt1. Default:standard
- Map<String,String>
- A map of tags to assign to the Neptune cluster. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- vpcSecurity List<String>Group Ids 
- List of VPC security groups to associate with the Cluster
- allowMajor booleanVersion Upgrade 
- Specifies whether upgrades between different major versions are allowed. You must set it to truewhen providing anengine_versionparameter that uses a different major version than the DB cluster's current version. Default isfalse.
- 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.
- backupRetention numberPeriod 
- The days to retain backups for. Default 1
- clusterIdentifier string
- The cluster identifier. If omitted, this provider will assign a random, unique identifier.
- clusterIdentifier stringPrefix 
- 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
- clusterResource stringId 
- The Neptune Cluster Resource ID
- 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.
- enableCloudwatch string[]Logs Exports 
- A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports auditandslowquery.
- 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.
- finalSnapshot stringIdentifier 
- The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
- globalCluster stringIdentifier 
- The global cluster identifier specified on aws.neptune.GlobalCluster.
- hostedZone stringId 
- The Route53 Hosted Zone ID of the endpoint
- iamDatabase booleanAuthentication Enabled 
- 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.
- kmsKey stringArn 
- The ARN for the KMS encryption key. When specifying kms_key_arn,storage_encryptedneeds to be set to true.
- neptuneCluster stringParameter Group Name 
- A cluster parameter group to associate with the cluster.
- neptuneInstance stringParameter Group Name 
- The name of the DB parameter group to apply to all instances of the DB cluster.
- neptuneSubnet stringGroup Name 
- A Neptune subnet group to associate with this Neptune instance.
- port number
- The port on which the Neptune accepts connections. Default is 8182.
- preferredBackup stringWindow 
- 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
- preferredMaintenance stringWindow 
- 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
- replicationSource stringIdentifier 
- ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
- serverlessV2Scaling ClusterConfiguration Serverless V2Scaling Configuration 
- If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
- skipFinal booleanSnapshot 
- 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 isfalse.
- 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. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
- storageEncrypted boolean
- Specifies whether the Neptune cluster is encrypted. The default is falseif not specified.
- storageType string
- Storage type associated with the cluster standard/iopt1. Default:standard
- {[key: string]: string}
- A map of tags to assign to the Neptune cluster. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- vpcSecurity string[]Group Ids 
- List of VPC security groups to associate with the Cluster
- allow_major_ boolversion_ upgrade 
- Specifies whether upgrades between different major versions are allowed. You must set it to truewhen providing anengine_versionparameter that uses a different major version than the DB cluster's current version. Default isfalse.
- 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_ intperiod 
- 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_ strprefix 
- 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_ strid 
- The Neptune Cluster Resource ID
- 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_ Sequence[str]logs_ exports 
- A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports auditandslowquery.
- 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_ stridentifier 
- The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
- global_cluster_ stridentifier 
- The global cluster identifier specified on aws.neptune.GlobalCluster.
- hosted_zone_ strid 
- The Route53 Hosted Zone ID of the endpoint
- iam_database_ boolauthentication_ enabled 
- 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_ strarn 
- The ARN for the KMS encryption key. When specifying kms_key_arn,storage_encryptedneeds to be set to true.
- neptune_cluster_ strparameter_ group_ name 
- A cluster parameter group to associate with the cluster.
- neptune_instance_ strparameter_ group_ name 
- The name of the DB parameter group to apply to all instances of the DB cluster.
- neptune_subnet_ strgroup_ name 
- 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_ strwindow 
- 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_ strwindow 
- 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_ stridentifier 
- ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
- serverless_v2_ Clusterscaling_ configuration Serverless V2Scaling Configuration Args 
- If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
- skip_final_ boolsnapshot 
- 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 isfalse.
- 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. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
- storage_encrypted bool
- Specifies whether the Neptune cluster is encrypted. The default is falseif not specified.
- storage_type str
- Storage type associated with the cluster standard/iopt1. Default:standard
- Mapping[str, str]
- A map of tags to assign to the Neptune cluster. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- vpc_security_ Sequence[str]group_ ids 
- List of VPC security groups to associate with the Cluster
- allowMajor BooleanVersion Upgrade 
- Specifies whether upgrades between different major versions are allowed. You must set it to truewhen providing anengine_versionparameter that uses a different major version than the DB cluster's current version. Default isfalse.
- 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.
- backupRetention NumberPeriod 
- The days to retain backups for. Default 1
- clusterIdentifier String
- The cluster identifier. If omitted, this provider will assign a random, unique identifier.
- clusterIdentifier StringPrefix 
- 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
- clusterResource StringId 
- The Neptune Cluster Resource ID
- 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.
- enableCloudwatch List<String>Logs Exports 
- A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports auditandslowquery.
- 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.
- finalSnapshot StringIdentifier 
- The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
- globalCluster StringIdentifier 
- The global cluster identifier specified on aws.neptune.GlobalCluster.
- hostedZone StringId 
- The Route53 Hosted Zone ID of the endpoint
- iamDatabase BooleanAuthentication Enabled 
- 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.
- kmsKey StringArn 
- The ARN for the KMS encryption key. When specifying kms_key_arn,storage_encryptedneeds to be set to true.
- neptuneCluster StringParameter Group Name 
- A cluster parameter group to associate with the cluster.
- neptuneInstance StringParameter Group Name 
- The name of the DB parameter group to apply to all instances of the DB cluster.
- neptuneSubnet StringGroup Name 
- A Neptune subnet group to associate with this Neptune instance.
- port Number
- The port on which the Neptune accepts connections. Default is 8182.
- preferredBackup StringWindow 
- 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
- preferredMaintenance StringWindow 
- 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
- replicationSource StringIdentifier 
- ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
- serverlessV2Scaling Property MapConfiguration 
- If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
- skipFinal BooleanSnapshot 
- 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 isfalse.
- 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. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
- storageEncrypted Boolean
- Specifies whether the Neptune cluster is encrypted. The default is falseif not specified.
- storageType String
- Storage type associated with the cluster standard/iopt1. Default:standard
- Map<String>
- A map of tags to assign to the Neptune cluster. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- vpcSecurity List<String>Group Ids 
- List of VPC security groups to associate with the Cluster
Supporting Types
ClusterServerlessV2ScalingConfiguration, ClusterServerlessV2ScalingConfigurationArgs        
- 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
Using pulumi import, import aws_neptune_cluster using the cluster identifier. For example:
$ pulumi import aws:neptune/cluster:Cluster example my-cluster
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the awsTerraform Provider.