interface DatabaseClusterProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Neptune.Alpha.DatabaseClusterProps |
![]() | github.com/aws/aws-cdk-go/awscdkneptunealpha/v2#DatabaseClusterProps |
![]() | software.amazon.awscdk.services.neptune.alpha.DatabaseClusterProps |
![]() | aws_cdk.aws_neptune_alpha.DatabaseClusterProps |
![]() | @aws-cdk/aws-neptune-alpha ยป DatabaseClusterProps |
Properties for a new database cluster.
Example
const cluster = new neptune.DatabaseCluster(this, 'ServerlessDatabase', {
vpc,
instanceType: neptune.InstanceType.SERVERLESS,
serverlessScalingConfiguration: {
minCapacity: 1,
maxCapacity: 5,
},
});
Properties
Name | Type | Description |
---|---|---|
instance | Instance | What type of instance to start for the replicas. |
vpc | IVpc | What subnets to run the Neptune instances in. |
associated | IRole [] | A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services. |
auto | boolean | 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. |
backup | Duration | How many days to retain the backup. |
cloudwatch | Log [] | The list of log types that need to be enabled for exporting to CloudWatch Logs. |
cloudwatch | Retention | The number of days log events are kept in CloudWatch Logs. |
cloudwatch | IRole | The IAM role for the Lambda function associated with the custom resource that sets the retention policy. |
cluster | ICluster | Additional parameters to pass to the database engine. |
copy | boolean | Whether to copy tags to the snapshot when a snapshot is created. |
db | string | An optional identifier for the cluster. |
deletion | boolean | Indicates whether the DB cluster should have deletion protection enabled. |
engine | Engine | What version of the database to start. |
iam | boolean | Map AWS Identity and Access Management (IAM) accounts to database accounts. |
instance | string | Base identifier for instances. |
instances? | number | Number of Neptune compute instances. |
kms | IKey | The KMS key for storage encryption. |
parameter | IParameter | The DB parameter group to associate with the instance. |
port? | number | The port number on which the DB instances in the DB cluster accept connections. |
preferred | string | A daily time range in 24-hours UTC format in which backups preferably execute. |
preferred | string | A weekly time range in which maintenance should preferably execute. |
removal | Removal | 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. |
security | ISecurity [] | Security group. |
serverless | Serverless | Specify minimum and maximum NCUs capacity for a serverless cluster. |
storage | boolean | Whether to enable storage encryption. |
subnet | ISubnet | Existing subnet group for the cluster. |
vpc | Subnet | Where to place the instances within the VPC. |
instanceType
Type:
Instance
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:
Log
[]
(optional, default: no log exports)
The list of log types that need to be enabled for exporting to CloudWatch Logs.
cloudwatchLogsRetention?
Type:
Retention
(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:
ICluster
(optional, default: No parameter group.)
Additional parameters to pass to the database engine.
copyTagsToSnapshot?
Type:
boolean
(optional, default: false)
Whether to copy tags to the snapshot when a snapshot is created.
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:
Engine
(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:
IParameter
(optional, default: no parameter group)
The DB parameter group to associate with the instance.
port?
Type:
number
(optional, default: 8182)
The port number on which the DB instances in the DB cluster accept connections.
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:
Removal
(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:
ISecurity
[]
(optional, default: a new security group is created.)
Security group.
serverlessScalingConfiguration?
Type:
Serverless
(optional, default: required if instanceType is db.serverless)
Specify minimum and maximum NCUs capacity for a serverless cluster.
storageEncrypted?
Type:
boolean
(optional, default: true)
Whether to enable storage encryption.
subnetGroup?
Type:
ISubnet
(optional, default: a new subnet group will be created.)
Existing subnet group for the cluster.
vpcSubnets?
Type:
Subnet
(optional, default: private subnets)
Where to place the instances within the VPC.