Experimental
@aws-cdk/aws-neptune-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
DatabaseCluster L2 construct
Create a clustered database with a given number of instances.
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),
},
})
Initializer
new DatabaseCluster(scope: Construct, id: string, props: DatabaseClusterProps)
DatabaseCluster(scope: Construct, id: str, props: DatabaseClusterProps)
new DatabaseCluster(Construct scope, String id, DatabaseClusterProps props)
new DatabaseCluster(Construct scope, string id, DatabaseClusterProps props)
NewDatabaseCluster(Scope Construct, Id *string, Props DatabaseClusterProps)
Construct Props
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_typeInstanceTypeinstanceTypeInstanceTypeInstanceTypeInstanceTypeInstanceTypeInstanceTyperequired#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
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
Properties
clusterEndpointEndpointcluster_endpointEndpointclusterEndpointEndpointClusterEndpointEndpointClusterEndpointEndpoint#clusterIdentifierstringcluster_identifierstrclusterIdentifierStringClusterIdentifierstringClusterIdentifier*string#clusterReadEndpointEndpointcluster_read_endpointEndpointclusterReadEndpointEndpointClusterReadEndpointEndpointClusterReadEndpointEndpoint#clusterResourceIdentifierstringcluster_resource_identifierstrclusterResourceIdentifierStringClusterResourceIdentifierstringClusterResourceIdentifier*string#for example: cluster-ABCD1234EFGH5678IJKL90MNOP. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnections#DEFAULT_NUM_INSTANCESnumberdefault_num_instancesint | floatDEFAULT_NUM_INSTANCESNumberDEFAULT_NUM_INSTANCESdoubleDEFAULT_NUM_INSTANCES*float64static#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
instanceEndpointsEndpoint[]instance_endpointstyping.List[Endpoint]instanceEndpointsList<Endpoint>InstanceEndpointsEndpoint[]InstanceEndpoints*[]Endpoint#instanceIdentifiersstring[]instance_identifierstyping.List[str]instanceIdentifiersList<String>InstanceIdentifiersstring[]InstanceIdentifiers*[]*string#PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#subnetGroupISubnetGroupsubnet_groupISubnetGroupsubnetGroupISubnetGroupSubnetGroupISubnetGroupSubnetGroupISubnetGroup#vpcSubnetsSubnetSelectionvpc_subnetsSubnetSelectionvpcSubnetsSubnetSelectionVpcSubnetsSubnetSelectionVpcSubnetsSubnetSelection#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
fromDatabaseClusterAttributes(scope: Construct, id: string, attrs: DatabaseClusterAttributes): IDatabaseCluster@staticmethod def from_database_cluster_attributes(scope: Construct, id: str, attrs: DatabaseClusterAttributes) -> IDatabaseClusterpublic static IDatabaseCluster fromDatabaseClusterAttributes(Construct scope, String id, DatabaseClusterAttributes attrs)public static IDatabaseCluster FromDatabaseClusterAttributes(Construct scope, string id, DatabaseClusterAttributes attrs)func FromDatabaseClusterAttributes(Scope Construct, Id *string, Attrs DatabaseClusterAttributes) IDatabaseClusterstatic#grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#grantConnect(grantee: IGrantable): Grantdef grant_connect(self, grantee: IGrantable) -> Grantpublic Grant grantConnect(IGrantable grantee)public Grant GrantConnect(IGrantable grantee)func GrantConnect(Grantee IGrantable) Grant#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#metric(metricName: string, props?: MetricOptions): Metricdef metric(self, metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, MetricOptions props)public Metric Metric(string metricName, MetricOptions? props = null)func Metric(MetricName *string, Props MetricOptions) Metric#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.