interface ClusterInstanceOptions
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.RDS.ClusterInstanceOptions |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsrds#ClusterInstanceOptions |
![]() | software.amazon.awscdk.services.rds.ClusterInstanceOptions |
![]() | aws_cdk.aws_rds.ClusterInstanceOptions |
![]() | aws-cdk-lib » aws_rds » ClusterInstanceOptions |
Common options for creating a cluster instance.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kms as kms } from 'aws-cdk-lib';
import { aws_rds as rds } from 'aws-cdk-lib';
declare const key: kms.Key;
declare const parameterGroup: rds.ParameterGroup;
const clusterInstanceOptions: rds.ClusterInstanceOptions = {
allowMajorVersionUpgrade: false,
autoMinorVersionUpgrade: false,
enablePerformanceInsights: false,
instanceIdentifier: 'instanceIdentifier',
parameterGroup: parameterGroup,
parameters: {
parametersKey: 'parameters',
},
performanceInsightEncryptionKey: key,
performanceInsightRetention: rds.PerformanceInsightRetention.DEFAULT,
publiclyAccessible: false,
};
Properties
Name | Type | Description |
---|---|---|
allow | boolean | Whether to allow upgrade of major version for the DB instance. |
auto | boolean | Whether to enable automatic upgrade of minor version for the DB instance. |
enable | boolean | Whether to enable Performance Insights for the DB instance. |
instance | string | The identifier for the database instance. |
parameter | IParameter | The DB parameter group to associate with the instance. |
parameters? | { [string]: string } | The parameters in the DBParameterGroup to create automatically. |
performance | IKey | The AWS KMS key for encryption of Performance Insights data. |
performance | Performance | The amount of time, in days, to retain Performance Insights data. |
publicly | boolean | Indicates whether the DB instance is an internet-facing instance. |
allowMajorVersionUpgrade?
Type:
boolean
(optional, default: false)
Whether to allow upgrade of major version for the DB instance.
autoMinorVersionUpgrade?
Type:
boolean
(optional, default: true)
Whether to enable automatic upgrade of minor version for the DB instance.
enablePerformanceInsights?
Type:
boolean
(optional, default: false, unless performanceInsightRentention
or performanceInsightEncryptionKey
is set.)
Whether to enable Performance Insights for the DB instance.
instanceIdentifier?
Type:
string
(optional, default: CloudFormation generated identifier)
The identifier for the database instance.
parameterGroup?
Type:
IParameter
(optional, default: the cluster parameter group is used)
The DB parameter group to associate with the instance.
This is only needed if you need to configure different parameter groups for each individual instance, otherwise you should not provide this and just use the cluster parameter group
parameters?
Type:
{ [string]: string }
(optional, default: None)
The parameters in the DBParameterGroup to create automatically.
You can only specify parameterGroup or parameters but not both. You need to use a versioned engine to auto-generate a DBParameterGroup.
performanceInsightEncryptionKey?
Type:
IKey
(optional, default: default master key)
The AWS KMS key for encryption of Performance Insights data.
performanceInsightRetention?
Type:
Performance
(optional, default: 7)
The amount of time, in days, to retain Performance Insights data.
publiclyAccessible?
Type:
boolean
(optional, default: true if the instance is placed in a public subnet)
Indicates whether the DB instance is an internet-facing instance.