Experimental
@aws-cdk/aws-neptune-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
DatabaseClusterProps Struct
Properties for a new database cluster.
| Stability | Experimental |
|---|---|
| Source | lib/cluster.ts |
Example
const cluster = new neptune.DatabaseCluster(this, 'ServerlessDatabase', {
vpc,
instanceType: neptune.InstanceType.SERVERLESS,
serverlessScalingConfiguration: {
minCapacity: 1,
maxCapacity: 5,
},
});
cluster = neptune.DatabaseCluster(self, "ServerlessDatabase",
vpc=vpc,
instance_type=neptune.InstanceType.SERVERLESS,
serverless_scaling_configuration=neptune.ServerlessScalingConfiguration(
min_capacity=1,
max_capacity=5
)
)
DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "ServerlessDatabase")
.vpc(vpc)
.instanceType(InstanceType.SERVERLESS)
.serverlessScalingConfiguration(ServerlessScalingConfiguration.builder()
.minCapacity(1)
.maxCapacity(5)
.build())
.build();
// Install: dotnet add package Amazon.CDK.AWS.Neptune.Alpha
var cluster = new DatabaseCluster(this, "ServerlessDatabase", new DatabaseClusterProps {
Vpc = vpc,
InstanceType = InstanceType.SERVERLESS,
ServerlessScalingConfiguration = new ServerlessScalingConfiguration {
MinCapacity = 1,
MaxCapacity = 5
}
});
// Install: go get github.com/aws/aws-cdk-go/awscdkneptunealpha/v2
cluster := neptune.NewDatabaseCluster(this, jsii.String("ServerlessDatabase"), &DatabaseClusterProps{
Vpc: Vpc,
InstanceType: neptune.InstanceType_SERVERLESS(),
ServerlessScalingConfiguration: &ServerlessScalingConfiguration{
MinCapacity: jsii.Number(1),
MaxCapacity: jsii.Number(5),
},
})
Properties
associatedRolesoptionalIRole[]associated_rolesoptionaltyping.List[IRole]associatedRolesoptionalList<IRole>AssociatedRolesoptionalIRole[]AssociatedRolesoptional*[]IRole #Default: No role is attached to the cluster.
autoMinorVersionUpgradeoptionalbooleanauto_minor_version_upgradeoptionalboolautoMinorVersionUpgradeoptionalBooleanAutoMinorVersionUpgradeoptionalboolAutoMinorVersionUpgradeoptional*bool = false #backupRetentionoptionalDurationbackup_retentionoptionalDurationbackupRetentionoptionalDurationBackupRetentionoptionalDurationBackupRetentionoptionalDuration = cdk.Duration.days(1) #cloudwatchLogsExportsoptionalLogType[]cloudwatch_logs_exportsoptionaltyping.List[LogType]cloudwatchLogsExportsoptionalList<LogType>CloudwatchLogsExportsoptionalLogType[]CloudwatchLogsExportsoptional*[]LogType #Default: no log exports
cloudwatchLogsRetentionoptionalRetentionDayscloudwatch_logs_retentionoptionalRetentionDayscloudwatchLogsRetentionoptionalRetentionDaysCloudwatchLogsRetentionoptionalRetentionDaysCloudwatchLogsRetentionoptionalRetentionDays #Default: logs never expire
When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to Infinity.
cloudwatchLogsRetentionRoleoptionalIRolecloudwatch_logs_retention_roleoptionalIRolecloudwatchLogsRetentionRoleoptionalIRoleCloudwatchLogsRetentionRoleoptionalIRoleCloudwatchLogsRetentionRoleoptionalIRole #Default: a new role is created.
clusterParameterGroupoptionalIClusterParameterGroupcluster_parameter_groupoptionalIClusterParameterGroupclusterParameterGroupoptionalIClusterParameterGroupClusterParameterGroupoptionalIClusterParameterGroupClusterParameterGroupoptionalIClusterParameterGroup #Default: No parameter group.
copyTagsToSnapshotoptionalbooleancopy_tags_to_snapshotoptionalboolcopyTagsToSnapshotoptionalBooleanCopyTagsToSnapshotoptionalboolCopyTagsToSnapshotoptional*bool = false #dbClusterNameoptionalstringdb_cluster_nameoptionalstrdbClusterNameoptionalStringDbClusterNameoptionalstringDbClusterNameoptional*string #Default: A name is automatically generated.
deletionProtectionoptionalbooleandeletion_protectionoptionalbooldeletionProtectionoptionalBooleanDeletionProtectionoptionalboolDeletionProtectionoptional*bool #Default: true if removalPolicy is RETAIN, false otherwise
engineVersionoptionalEngineVersionengine_versionoptionalEngineVersionengineVersionoptionalEngineVersionEngineVersionoptionalEngineVersionEngineVersionoptionalEngineVersion #Default: The default engine version.
iamAuthenticationoptionalbooleaniam_authenticationoptionalbooliamAuthenticationoptionalBooleanIamAuthenticationoptionalboolIamAuthenticationoptional*bool = `false` #instanceIdentifierBaseoptionalstringinstance_identifier_baseoptionalstrinstanceIdentifierBaseoptionalStringInstanceIdentifierBaseoptionalstringInstanceIdentifierBaseoptional*string #Default: dbClusterName is used with the word "Instance" appended. If dbClusterName is not provided, the identifier is automatically generated.
Every replica is named by appending the replica number to this string, 1-based.
instancesoptionalnumberinstancesoptionalint | floatinstancesoptionalNumberInstancesoptionaldoubleInstancesoptional*float64 = 1 #instanceTypeInstanceTypeinstance_typeInstanceTypeinstanceTypeInstanceTypeInstanceTypeInstanceTypeInstanceTypeInstanceType required #kmsKeyoptionalIKeyRefkms_keyoptionalIKeyRefkmsKeyoptionalIKeyRefKmsKeyoptionalIKeyRefKmsKeyoptionalIKeyRef #Default: default master key.
parameterGroupoptionalIParameterGroupparameter_groupoptionalIParameterGroupparameterGroupoptionalIParameterGroupParameterGroupoptionalIParameterGroupParameterGroupoptionalIParameterGroup #Default: no parameter group
portoptionalnumberportoptionalint | floatportoptionalNumberPortoptionaldoublePortoptional*float64 = 8182 #preferredBackupWindowoptionalstringpreferred_backup_windowoptionalstrpreferredBackupWindowoptionalStringPreferredBackupWindowoptionalstringPreferredBackupWindowoptional*string #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
Must be at least 30 minutes long.
Example: '01:00-02:00'
preferredMaintenanceWindowoptionalstringpreferred_maintenance_windowoptionalstrpreferredMaintenanceWindowoptionalStringPreferredMaintenanceWindowoptionalstringPreferredMaintenanceWindowoptional*string #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.
Must be at least 30 minutes long.
Example: 'tue:04:17-tue:04:47'
removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy #Default: Retain cluster.
This removal policy also applies to the implicit security group created for the cluster if one is not supplied as a parameter.
securityGroupsoptionalISecurityGroup[]security_groupsoptionaltyping.List[ISecurityGroup]securityGroupsoptionalList<ISecurityGroup>SecurityGroupsoptionalISecurityGroup[]SecurityGroupsoptional*[]ISecurityGroup #Default: a new security group is created.
serverlessScalingConfigurationoptionalServerlessScalingConfigurationserverless_scaling_configurationoptionalServerlessScalingConfigurationserverlessScalingConfigurationoptionalServerlessScalingConfigurationServerlessScalingConfigurationoptionalServerlessScalingConfigurationServerlessScalingConfigurationoptionalServerlessScalingConfiguration #Default: required if instanceType is db.serverless
See https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-capacity-scaling.html
storageEncryptedoptionalbooleanstorage_encryptedoptionalboolstorageEncryptedoptionalBooleanStorageEncryptedoptionalboolStorageEncryptedoptional*bool = true #subnetGroupoptionalISubnetGroupsubnet_groupoptionalISubnetGroupsubnetGroupoptionalISubnetGroupSubnetGroupoptionalISubnetGroupSubnetGroupoptionalISubnetGroup #Default: a new subnet group will be created.
Must be at least 2 subnets in two different AZs.
vpcSubnetsoptionalSubnetSelectionvpc_subnetsoptionalSubnetSelectionvpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelection #Default: private subnets