IDatabaseCluster Interface
Create a clustered database with a given number of instances.
Properties
The ARN of the database cluster.
clusterEndpointEndpointcluster_endpointEndpointclusterEndpointEndpointClusterEndpointEndpointClusterEndpointEndpointrequired#The endpoint to use for read/write operations.
clusterIdentifierstringcluster_identifierstrclusterIdentifierStringClusterIdentifierstringClusterIdentifier*stringrequired#Identifier of the cluster.
clusterReadEndpointEndpointcluster_read_endpointEndpointclusterReadEndpointEndpointClusterReadEndpointEndpointClusterReadEndpointEndpointrequired#Endpoint to use for load-balanced read-only operations.
clusterResourceIdentifierstringcluster_resource_identifierstrclusterResourceIdentifierStringClusterResourceIdentifierstringClusterResourceIdentifier*stringrequired#The immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP.
This AWS Region-unique identifier is used in things like IAM authentication policies.
connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnectionsrequired#The network connections associated with this resource.
dbClusterRefDBClusterReferencedb_cluster_refDBClusterReferencedbClusterRefDBClusterReferenceDbClusterRefDBClusterReferenceDbClusterRefDBClusterReferencerequired#A reference to a DBCluster resource.
engineIClusterEngineengineIClusterEngineengineIClusterEngineEngineIClusterEngineEngineIClusterEngine#The engine of this Cluster.
May be not known for imported Clusters if it wasn't provided explicitly.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#The environment this resource belongs to.
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*[]Endpointrequired#Endpoints which address each individual replica.
instanceIdentifiersstring[]instance_identifierstyping.List[str]instanceIdentifiersList<String>InstanceIdentifiersstring[]InstanceIdentifiers*[]*stringrequired#Identifiers of the replicas.
Methods
addProxy(id: string, options: DatabaseProxyOptions): DatabaseProxydef add_proxy(self, id: str, options: DatabaseProxyOptions) -> DatabaseProxypublic DatabaseProxy addProxy(String id, DatabaseProxyOptions options)public DatabaseProxy AddProxy(string id, DatabaseProxyOptions options)func AddProxy(Id *string, Options DatabaseProxyOptions) DatabaseProxy#Add a new db proxy to this cluster.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#Apply the given removal policy to this resource.
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).
asSecretAttachmentTarget(): SecretAttachmentTargetPropsdef as_secret_attachment_target(self, ) -> SecretAttachmentTargetPropspublic SecretAttachmentTargetProps asSecretAttachmentTarget()public SecretAttachmentTargetProps AsSecretAttachmentTarget()func AsSecretAttachmentTarget() SecretAttachmentTargetProps#Renders the target specifications.
grantConnect(grantee: IGrantable, dbUser: string): Grantdef grant_connect(self, grantee: IGrantable, db_user: str) -> Grantpublic Grant grantConnect(IGrantable grantee, String dbUser)public Grant GrantConnect(IGrantable grantee, string dbUser)func GrantConnect(Grantee IGrantable, DbUser *string) Grant#Grant the given identity connection access to the Cluster.
2 parameters
Parameters
granteegranteegranteegranteeGrantee— the Principal to grant the permissions to.dbUserdb_userdbUserdbUserDbUser— the name of the database user to allow connecting.
grantDataApiAccess(grantee: IGrantable): Grantdef grant_data_api_access(self, grantee: IGrantable) -> Grantpublic Grant grantDataApiAccess(IGrantable grantee)public Grant GrantDataApiAccess(IGrantable grantee)func GrantDataApiAccess(Grantee IGrantable) Grant#Grant the given identity to access to the Data API.
1 parameter
Parameters
granteegranteegranteegranteeGrantee— The principal to grant access to.
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#Return the given named metric for this DBCluster.
metricCPUUtilization(props?: MetricOptions): Metricdef metric_cpu_utilization(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricCPUUtilization(MetricOptions props)public Metric MetricCPUUtilization(MetricOptions? props = null)func MetricCPUUtilization(Props MetricOptions) Metric#The percentage of CPU utilization.
Average over 5 minutes
metricDatabaseConnections(props?: MetricOptions): Metricdef metric_database_connections(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricDatabaseConnections(MetricOptions props)public Metric MetricDatabaseConnections(MetricOptions? props = null)func MetricDatabaseConnections(Props MetricOptions) Metric#The number of database connections in use.
Average over 5 minutes
metricDeadlocks(props?: MetricOptions): Metricdef metric_deadlocks(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricDeadlocks(MetricOptions props)public Metric MetricDeadlocks(MetricOptions? props = null)func MetricDeadlocks(Props MetricOptions) Metric#The average number of deadlocks in the database per second.
Average over 5 minutes
metricEngineUptime(props?: MetricOptions): Metricdef metric_engine_uptime(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricEngineUptime(MetricOptions props)public Metric MetricEngineUptime(MetricOptions? props = null)func MetricEngineUptime(Props MetricOptions) Metric#The amount of time that the instance has been running, in seconds.
Average over 5 minutes
metricFreeableMemory(props?: MetricOptions): Metricdef metric_freeable_memory(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricFreeableMemory(MetricOptions props)public Metric MetricFreeableMemory(MetricOptions? props = null)func MetricFreeableMemory(Props MetricOptions) Metric#The amount of available random access memory, in bytes.
Average over 5 minutes
metricFreeLocalStorage(props?: MetricOptions): Metricdef metric_free_local_storage(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricFreeLocalStorage(MetricOptions props)public Metric MetricFreeLocalStorage(MetricOptions? props = null)func MetricFreeLocalStorage(Props MetricOptions) Metric#The amount of local storage available, in bytes.
Average over 5 minutes
metricNetworkReceiveThroughput(props?: MetricOptions): Metricdef metric_network_receive_throughput(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricNetworkReceiveThroughput(MetricOptions props)public Metric MetricNetworkReceiveThroughput(MetricOptions? props = null)func MetricNetworkReceiveThroughput(Props MetricOptions) Metric#The amount of network throughput received from clients by each instance, in bytes per second.
Average over 5 minutes
metricNetworkThroughput(props?: MetricOptions): Metricdef metric_network_throughput(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricNetworkThroughput(MetricOptions props)public Metric MetricNetworkThroughput(MetricOptions? props = null)func MetricNetworkThroughput(Props MetricOptions) Metric#The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second.
Average over 5 minutes
metricNetworkTransmitThroughput(props?: MetricOptions): Metricdef metric_network_transmit_throughput(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricNetworkTransmitThroughput(MetricOptions props)public Metric MetricNetworkTransmitThroughput(MetricOptions? props = null)func MetricNetworkTransmitThroughput(Props MetricOptions) Metric#The amount of network throughput sent to clients by each instance, in bytes per second.
Average over 5 minutes
metricSnapshotStorageUsed(props?: MetricOptions): Metricdef metric_snapshot_storage_used(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSnapshotStorageUsed(MetricOptions props)public Metric MetricSnapshotStorageUsed(MetricOptions? props = null)func MetricSnapshotStorageUsed(Props MetricOptions) Metric#The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window.
Average over 5 minutes
metricTotalBackupStorageBilled(props?: MetricOptions): Metricdef metric_total_backup_storage_billed(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricTotalBackupStorageBilled(MetricOptions props)public Metric MetricTotalBackupStorageBilled(MetricOptions? props = null)func MetricTotalBackupStorageBilled(Props MetricOptions) Metric#The total amount of backup storage in bytes for which you are billed.
Average over 5 minutes
metricVolumeBytesUsed(props?: MetricOptions): Metricdef metric_volume_bytes_used(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricVolumeBytesUsed(MetricOptions props)public Metric MetricVolumeBytesUsed(MetricOptions? props = null)func MetricVolumeBytesUsed(Props MetricOptions) Metric#The amount of storage used by your Aurora DB instance, in bytes.
Average over 5 minutes
metricVolumeReadIOPs(props?: MetricOptions): Metricdef metric_volume_read_io_ps(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricVolumeReadIOPs(MetricOptions props)public Metric MetricVolumeReadIOPs(MetricOptions? props = null)func MetricVolumeReadIOPs(Props MetricOptions) Metric#The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals.
Average over 5 minutes
metricVolumeWriteIOPs(props?: MetricOptions): Metricdef metric_volume_write_io_ps(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricVolumeWriteIOPs(MetricOptions props)public Metric MetricVolumeWriteIOPs(MetricOptions? props = null)func MetricVolumeWriteIOPs(Props MetricOptions) Metric#The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals.
Average over 5 minutes
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
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.
1 parameter · returns
Parameters
mixinsmixinsmixinsmixinsMixins— The mixins to apply.
Returns: This construct for chaining