@aws-cdk_aws-neptune-alpha.DatabaseClusterProps

interface DatabaseClusterProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Neptune.Alpha.DatabaseClusterProps
Gogithub.com/aws/aws-cdk-go/awscdkneptunealpha/v2#DatabaseClusterProps
Javasoftware.amazon.awscdk.services.neptune.alpha.DatabaseClusterProps
Pythonaws_cdk.aws_neptune_alpha.DatabaseClusterProps
TypeScript (source)@aws-cdk/aws-neptune-alpha ยป DatabaseClusterProps

Properties for a new database cluster.

Example

const cluster = new neptune.DatabaseCluster(this, 'Database', {
  vpc,
  instanceType: neptune.InstanceType.R5_LARGE,
  instances: 2,
});

Properties

NameTypeDescription
instanceType๐Ÿ”นInstanceTypeWhat type of instance to start for the replicas.
vpc๐Ÿ”นIVpcWhat subnets to run the Neptune instances in.
associatedRoles?๐Ÿ”นIRole[]A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services.
autoMinorVersionUpgrade?๐Ÿ”นbooleanIf set to true, Neptune will automatically update the engine of the entire cluster to the latest minor version after a stabilization window of 2 to 3 weeks.
backupRetention?๐Ÿ”นDurationHow many days to retain the backup.
cloudwatchLogsExports?๐Ÿ”นLogType[]The list of log types that need to be enabled for exporting to CloudWatch Logs.
cloudwatchLogsRetention?๐Ÿ”นRetentionDaysThe number of days log events are kept in CloudWatch Logs.
cloudwatchLogsRetentionRole?๐Ÿ”นIRoleThe IAM role for the Lambda function associated with the custom resource that sets the retention policy.
clusterParameterGroup?๐Ÿ”นIClusterParameterGroupAdditional parameters to pass to the database engine.
dbClusterName?๐Ÿ”นstringAn optional identifier for the cluster.
deletionProtection?๐Ÿ”นbooleanIndicates whether the DB cluster should have deletion protection enabled.
engineVersion?๐Ÿ”นEngineVersionWhat version of the database to start.
iamAuthentication?๐Ÿ”นbooleanMap AWS Identity and Access Management (IAM) accounts to database accounts.
instanceIdentifierBase?๐Ÿ”นstringBase identifier for instances.
instances?๐Ÿ”นnumberNumber of Neptune compute instances.
kmsKey?๐Ÿ”นIKeyThe KMS key for storage encryption.
parameterGroup?๐Ÿ”นIParameterGroupThe DB parameter group to associate with the instance.
port?๐Ÿ”นnumberThe port the Neptune cluster will listen on.
preferredBackupWindow?๐Ÿ”นstringA daily time range in 24-hours UTC format in which backups preferably execute.
preferredMaintenanceWindow?๐Ÿ”นstringA weekly time range in which maintenance should preferably execute.
removalPolicy?๐Ÿ”นRemovalPolicyThe removal policy to apply when the cluster and its instances are removed or replaced during a stack update, or when the stack is deleted.
securityGroups?๐Ÿ”นISecurityGroup[]Security group.
storageEncrypted?๐Ÿ”นbooleanWhether to enable storage encryption.
subnetGroup?๐Ÿ”นISubnetGroupExisting subnet group for the cluster.
vpcSubnets?๐Ÿ”นSubnetSelectionWhere to place the instances within the VPC.

instanceType๐Ÿ”น

Type: InstanceType

What type of instance to start for the replicas.


vpc๐Ÿ”น

Type: IVpc

What subnets to run the Neptune instances in.

Must be at least 2 subnets in two different AZs.


associatedRoles?๐Ÿ”น

Type: IRole[] (optional, default: No role is attached to the cluster.)

A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services.


autoMinorVersionUpgrade?๐Ÿ”น

Type: boolean (optional, default: false)

If set to true, Neptune will automatically update the engine of the entire cluster to the latest minor version after a stabilization window of 2 to 3 weeks.


backupRetention?๐Ÿ”น

Type: Duration (optional, default: cdk.Duration.days(1))

How many days to retain the backup.


cloudwatchLogsExports?๐Ÿ”น

Type: LogType[] (optional, default: no log exports)

The list of log types that need to be enabled for exporting to CloudWatch Logs.

See also: https://docs.aws.amazon.com/neptune/latest/userguide/auditing.html#auditing-enable


cloudwatchLogsRetention?๐Ÿ”น

Type: RetentionDays (optional, default: logs never expire)

The number of days log events are kept in CloudWatch Logs.

When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to Infinity.


cloudwatchLogsRetentionRole?๐Ÿ”น

Type: IRole (optional, default: a new role is created.)

The IAM role for the Lambda function associated with the custom resource that sets the retention policy.


clusterParameterGroup?๐Ÿ”น

Type: IClusterParameterGroup (optional, default: No parameter group.)

Additional parameters to pass to the database engine.


dbClusterName?๐Ÿ”น

Type: string (optional, default: A name is automatically generated.)

An optional identifier for the cluster.


deletionProtection?๐Ÿ”น

Type: boolean (optional, default: true if removalPolicy is RETAIN, false otherwise)

Indicates whether the DB cluster should have deletion protection enabled.


engineVersion?๐Ÿ”น

Type: EngineVersion (optional, default: The default engine version.)

What version of the database to start.


iamAuthentication?๐Ÿ”น

Type: boolean (optional, default: false)

Map AWS Identity and Access Management (IAM) accounts to database accounts.


instanceIdentifierBase?๐Ÿ”น

Type: string (optional, default: dbClusterName is used with the word "Instance" appended. If dbClusterName is not provided, the identifier is automatically generated.)

Base identifier for instances.

Every replica is named by appending the replica number to this string, 1-based.


instances?๐Ÿ”น

Type: number (optional, default: 1)

Number of Neptune compute instances.


kmsKey?๐Ÿ”น

Type: IKey (optional, default: default master key.)

The KMS key for storage encryption.


parameterGroup?๐Ÿ”น

Type: IParameterGroup (optional, default: no parameter group)

The DB parameter group to associate with the instance.


port?๐Ÿ”น

Type: number (optional, default: The default engine port)

The port the Neptune cluster will listen on.


preferredBackupWindow?๐Ÿ”น

Type: string (optional, default: a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see)

A daily time range in 24-hours UTC format in which backups preferably execute.

Must be at least 30 minutes long.

Example: '01:00-02:00'


preferredMaintenanceWindow?๐Ÿ”น

Type: string (optional, default: 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.)

A weekly time range in which maintenance should preferably execute.

Must be at least 30 minutes long.

Example: 'tue:04:17-tue:04:47'


removalPolicy?๐Ÿ”น

Type: RemovalPolicy (optional, default: Retain cluster.)

The removal policy to apply when the cluster and its instances are removed or replaced during a stack update, or when the stack is deleted.

This removal policy also applies to the implicit security group created for the cluster if one is not supplied as a parameter.


securityGroups?๐Ÿ”น

Type: ISecurityGroup[] (optional, default: a new security group is created.)

Security group.


storageEncrypted?๐Ÿ”น

Type: boolean (optional, default: true)

Whether to enable storage encryption.


subnetGroup?๐Ÿ”น

Type: ISubnetGroup (optional, default: a new subnet group will be created.)

Existing subnet group for the cluster.


vpcSubnets?๐Ÿ”น

Type: SubnetSelection (optional, default: private subnets)

Where to place the instances within the VPC.