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

ClusterArgs

data class ClusterArgs(val allowMajorVersionUpgrade: Output<Boolean>? = null, val applyImmediately: Output<Boolean>? = null, val availabilityZones: Output<List<String>>? = null, val backupRetentionPeriod: Output<Int>? = null, val clusterIdentifier: Output<String>? = null, val clusterIdentifierPrefix: Output<String>? = null, val copyTagsToSnapshot: Output<Boolean>? = null, val deletionProtection: Output<Boolean>? = null, val enableCloudwatchLogsExports: Output<List<String>>? = null, val engine: Output<String>? = null, val engineVersion: Output<String>? = null, val finalSnapshotIdentifier: Output<String>? = null, val globalClusterIdentifier: Output<String>? = null, val iamDatabaseAuthenticationEnabled: Output<Boolean>? = null, val iamRoles: Output<List<String>>? = null, val kmsKeyArn: Output<String>? = null, val neptuneClusterParameterGroupName: Output<String>? = null, val neptuneInstanceParameterGroupName: Output<String>? = null, val neptuneSubnetGroupName: Output<String>? = null, val port: Output<Int>? = null, val preferredBackupWindow: Output<String>? = null, val preferredMaintenanceWindow: Output<String>? = null, val replicationSourceIdentifier: Output<String>? = null, val serverlessV2ScalingConfiguration: Output<ClusterServerlessV2ScalingConfigurationArgs>? = null, val skipFinalSnapshot: Output<Boolean>? = null, val snapshotIdentifier: Output<String>? = null, val storageEncrypted: Output<Boolean>? = null, val tags: Output<Map<String, String>>? = null, val vpcSecurityGroupIds: Output<List<String>>? = null) : ConvertibleToJava<ClusterArgs>

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

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());
    }
}
Content copied to clipboard

Import

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

$ pulumi import aws:neptune/cluster:Cluster example my-cluster
Content copied to clipboard

Constructors

Link copied to clipboard
fun ClusterArgs(allowMajorVersionUpgrade: Output<Boolean>? = null, applyImmediately: Output<Boolean>? = null, availabilityZones: Output<List<String>>? = null, backupRetentionPeriod: Output<Int>? = null, clusterIdentifier: Output<String>? = null, clusterIdentifierPrefix: Output<String>? = null, copyTagsToSnapshot: Output<Boolean>? = null, deletionProtection: Output<Boolean>? = null, enableCloudwatchLogsExports: Output<List<String>>? = null, engine: Output<String>? = null, engineVersion: Output<String>? = null, finalSnapshotIdentifier: Output<String>? = null, globalClusterIdentifier: Output<String>? = null, iamDatabaseAuthenticationEnabled: Output<Boolean>? = null, iamRoles: Output<List<String>>? = null, kmsKeyArn: Output<String>? = null, neptuneClusterParameterGroupName: Output<String>? = null, neptuneInstanceParameterGroupName: Output<String>? = null, neptuneSubnetGroupName: Output<String>? = null, port: Output<Int>? = null, preferredBackupWindow: Output<String>? = null, preferredMaintenanceWindow: Output<String>? = null, replicationSourceIdentifier: Output<String>? = null, serverlessV2ScalingConfiguration: Output<ClusterServerlessV2ScalingConfigurationArgs>? = null, skipFinalSnapshot: Output<Boolean>? = null, snapshotIdentifier: Output<String>? = null, storageEncrypted: Output<Boolean>? = null, tags: Output<Map<String, String>>? = null, vpcSecurityGroupIds: Output<List<String>>? = null)

Functions

Link copied to clipboard
open override fun toJava(): ClusterArgs

Properties

Link copied to clipboard
val allowMajorVersionUpgrade: Output<Boolean>? = null

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.

Link copied to clipboard
val applyImmediately: Output<Boolean>? = null

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

Link copied to clipboard
val availabilityZones: Output<List<String>>? = null

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

Link copied to clipboard
val backupRetentionPeriod: Output<Int>? = null

The days to retain backups for. Default 1

Link copied to clipboard
val clusterIdentifier: Output<String>? = null

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

Link copied to clipboard
val clusterIdentifierPrefix: Output<String>? = null

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

Link copied to clipboard
val copyTagsToSnapshot: Output<Boolean>? = null

If set to true, tags are copied to any snapshot of the DB cluster that is created.

Link copied to clipboard
val deletionProtection: Output<Boolean>? = null

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.

Link copied to clipboard
val enableCloudwatchLogsExports: Output<List<String>>? = null

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

Link copied to clipboard
val engine: Output<String>? = null

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

Link copied to clipboard
val engineVersion: Output<String>? = null

The database engine version.

Link copied to clipboard
val finalSnapshotIdentifier: Output<String>? = null

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

Link copied to clipboard
val globalClusterIdentifier: Output<String>? = null

The global cluster identifier specified on aws.neptune.GlobalCluster.

Link copied to clipboard
val iamDatabaseAuthenticationEnabled: Output<Boolean>? = null

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

Link copied to clipboard
val iamRoles: Output<List<String>>? = null

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

Link copied to clipboard
val kmsKeyArn: Output<String>? = null

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

Link copied to clipboard
val neptuneClusterParameterGroupName: Output<String>? = null

A cluster parameter group to associate with the cluster.

Link copied to clipboard
val neptuneInstanceParameterGroupName: Output<String>? = null

The name of the DB parameter group to apply to all instances of the DB cluster.

Link copied to clipboard
val neptuneSubnetGroupName: Output<String>? = null

A Neptune subnet group to associate with this Neptune instance.

Link copied to clipboard
val port: Output<Int>? = null

The port on which the Neptune accepts connections. Default is 8182.

Link copied to clipboard
val preferredBackupWindow: Output<String>? = null

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

Link copied to clipboard
val preferredMaintenanceWindow: Output<String>? = null

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

Link copied to clipboard
val replicationSourceIdentifier: Output<String>? = null

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

Link copied to clipboard
val serverlessV2ScalingConfiguration: Output<ClusterServerlessV2ScalingConfigurationArgs>? = null

If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.

Link copied to clipboard
val skipFinalSnapshot: Output<Boolean>? = null

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.

Link copied to clipboard
val snapshotIdentifier: Output<String>? = null

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.

Link copied to clipboard
val storageEncrypted: Output<Boolean>? = null

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

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

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.

Link copied to clipboard
val vpcSecurityGroupIds: Output<List<String>>? = null

List of VPC security groups to associate with the Cluster