DatabaseClusterBase L2 construct
A new or imported clustered database.
Initializer
new DatabaseClusterBase(scope: Construct, id: string, props?: ResourceProps)
DatabaseClusterBase(scope: Construct, id: str, props: typing.Optional[ResourceProps] = None)
new DatabaseClusterBase(Construct scope, String id, ResourceProps props)
new DatabaseClusterBase(Construct scope, string id, ResourceProps? props = null)
NewDatabaseClusterBase(Scope Construct, Id *string, Props ResourceProps)
Construct Props
default
Default: the resource is in the same account as the stack it belongs to
environmentFromArnstringenvironment_from_arnstrenvironmentFromArnStringEnvironmentFromArnstringEnvironmentFromArn*string= take environment from `account`,…#The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources.
Cannot be supplied together with either account or region.
default
Default: take environment from account, region parameters, or use Stack environment.
physicalNamestringphysical_namestrphysicalNameStringPhysicalNamestringPhysicalName*string= The physical name will be alloca…#notes · default
undefinedimplies that a physical name will be allocated by CloudFormation during deployment.- a concrete value implies a specific physical name
PhysicalName.GENERATE_IF_NEEDEDis a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
Default: The physical name will be allocated by CloudFormation at deployment time
default
Default: the resource is in the same region as the stack it belongs to
Properties
clusterEndpointEndpointcluster_endpointEndpointclusterEndpointEndpointClusterEndpointEndpointClusterEndpointEndpointrequired#clusterIdentifierstringcluster_identifierstrclusterIdentifierStringClusterIdentifierstringClusterIdentifier*stringrequired#clusterReadEndpointEndpointcluster_read_endpointEndpointclusterReadEndpointEndpointClusterReadEndpointEndpointClusterReadEndpointEndpointrequired#clusterResourceIdentifierstringcluster_resource_identifierstrclusterResourceIdentifierStringClusterResourceIdentifierstringClusterResourceIdentifier*stringrequired#This AWS Region-unique identifier is used in things like IAM authentication policies.
connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnectionsrequired#dbClusterRefDBClusterReferencedb_cluster_refDBClusterReferencedbClusterRefDBClusterReferenceDbClusterRefDBClusterReferenceDbClusterRefDBClusterReferencerequired#engineIClusterEngineengineIClusterEngineengineIClusterEngineEngineIClusterEngineEngineIClusterEngine#May be not known for imported Clusters if it wasn't provided explicitly.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#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#instanceIdentifiersstring[]instance_identifierstyping.List[str]instanceIdentifiersList<String>InstanceIdentifiersstring[]InstanceIdentifiers*[]*stringrequired#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#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).
asSecretAttachmentTarget(): SecretAttachmentTargetPropsdef as_secret_attachment_target(self, ) -> SecretAttachmentTargetPropspublic SecretAttachmentTargetProps asSecretAttachmentTarget()public SecretAttachmentTargetProps AsSecretAttachmentTarget()func AsSecretAttachmentTarget() SecretAttachmentTargetProps#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#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#[disable-awslint:no-grants]
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#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#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#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#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#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#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#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#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#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#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#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#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#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#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#Average over 5 minutes
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.