DatabaseClusterBase¶
-
class
aws_cdk.aws_neptune.
DatabaseClusterBase
(scope, id, *, account=None, environment_from_arn=None, physical_name=None, region=None)¶ Bases:
aws_cdk.core.Resource
(experimental) A new or imported database cluster.
- Stability
experimental
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ec2 as ec2 import aws_cdk.aws_neptune as neptune # security_group: ec2.SecurityGroup database_cluster_base = neptune.DatabaseClusterBase.from_database_cluster_attributes(self, "MyDatabaseClusterBase", cluster_endpoint_address="clusterEndpointAddress", cluster_identifier="clusterIdentifier", cluster_resource_identifier="clusterResourceIdentifier", port=123, reader_endpoint_address="readerEndpointAddress", security_group=security_group )
- Parameters
scope (
Construct
) –id (
str
) –account (
Optional
[str
]) – The AWS account ID this resource belongs to. Default: - the resource is in the same account as the stack it belongs toenvironment_from_arn (
Optional
[str
]) – ARN to deduce region and account from. 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 eitheraccount
orregion
. Default: - take environment fromaccount
,region
parameters, or use Stack environment.physical_name (
Optional
[str
]) – The value passed in by users to the physical name prop of the resource. -undefined
implies that a physical name will be allocated by CloudFormation during deployment. - a concrete value implies a specific physical name -PhysicalName.GENERATE_IF_NEEDED
is 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 timeregion (
Optional
[str
]) – The AWS region this resource belongs to. Default: - the resource is in the same region as the stack it belongs to
Methods
-
apply_removal_policy
(policy)¶ Apply the given removal policy to this resource.
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
).- Parameters
policy (
RemovalPolicy
) –- Return type
None
-
grant_connect
(grantee)¶ (experimental) Grant the given identity connection access to the database.
- Parameters
grantee (
IGrantable
) –- Stability
experimental
- Return type
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
Attributes
-
cluster_endpoint
¶ (experimental) The endpoint to use for read/write operations.
- Stability
experimental
- Return type
-
cluster_identifier
¶ (experimental) Identifier of the cluster.
- Stability
experimental
- Return type
str
-
cluster_read_endpoint
¶ (experimental) Endpoint to use for load-balanced read-only operations.
- Stability
experimental
- Return type
-
cluster_resource_identifier
¶ (experimental) Resource identifier of the cluster.
- Stability
experimental
- Return type
str
-
connections
¶ (experimental) The connections object to implement IConnectable.
- Stability
experimental
- Return type
-
env
¶ The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- Return type
-
node
¶ The construct tree node associated with this construct.
- Return type
Static Methods
-
classmethod
from_database_cluster_attributes
(scope, id, *, cluster_endpoint_address, cluster_identifier, cluster_resource_identifier, port, reader_endpoint_address, security_group)¶ (experimental) Import an existing DatabaseCluster from properties.
- Parameters
scope (
Construct
) –id (
str
) –cluster_endpoint_address (
str
) – (experimental) Cluster endpoint address.cluster_identifier (
str
) – (experimental) Identifier for the cluster.cluster_resource_identifier (
str
) – (experimental) Resource Identifier for the cluster.port (
Union
[int
,float
]) – (experimental) The database port.reader_endpoint_address (
str
) – (experimental) Reader endpoint address.security_group (
ISecurityGroup
) – (experimental) The security group of the database cluster.
- Stability
experimental
- Return type
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
-
classmethod
is_resource
(construct)¶ Check whether the given construct is a Resource.
- Parameters
construct (
IConstruct
) –- Return type
bool