DatabaseClusterAttributes

class aws_cdk.aws_rds.DatabaseClusterAttributes(*, cluster_identifier, cluster_endpoint_address=None, cluster_resource_identifier=None, data_api_enabled=None, engine=None, instance_endpoint_addresses=None, instance_identifiers=None, port=None, reader_endpoint_address=None, secret=None, security_groups=None)

Bases: object

Properties that describe an existing cluster instance.

Parameters:

  • cluster_identifier (str) – Identifier for the cluster.

  • cluster_endpoint_address (Optional[str]) – Cluster endpoint address. Default: - no endpoint address

  • cluster_resource_identifier (Optional[str]) – The immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP. This AWS Region-unique identifier is used to grant access to the cluster. Default: none

  • data_api_enabled (Optional[bool]) – Whether the Data API for the cluster is enabled. Default: false

  • engine (Optional[IClusterEngine]) – The engine of the existing Cluster. Default: - the imported Cluster’s engine is unknown

  • instance_endpoint_addresses (Optional[Sequence[str]]) – Endpoint addresses of individual instances. Default: - no instance endpoints

  • instance_identifiers (Optional[Sequence[str]]) – Identifier for the instances. Default: - no instance identifiers

  • port (Union[int, float, None]) – The database port. Default: - none

  • reader_endpoint_address (Optional[str]) – Reader endpoint address. Default: - no reader address

  • secret (Optional[ISecret]) – The secret attached to the database cluster. Default: - the imported Cluster’s secret is unknown

  • security_groups (Optional[Sequence[ISecurityGroup]]) – The security groups of the database cluster. Default: - no security groups

ExampleMetadata:

infused

Example:

# vpc: ec2.Vpc
# fn: lambda.Function
# secret: secretsmanager.Secret


# Create a serverless V1 cluster
serverless_v1_cluster = rds.ServerlessCluster(self, "AnotherCluster",
    engine=rds.DatabaseClusterEngine.AURORA_MYSQL,
    vpc=vpc,  # this parameter is optional for serverless Clusters
    enable_data_api=True
)
serverless_v1_cluster.grant_data_api_access(fn)

# Create an Aurora cluster
cluster = rds.DatabaseCluster(self, "Cluster",
    engine=rds.DatabaseClusterEngine.AURORA_MYSQL,
    vpc=vpc,
    enable_data_api=True
)
cluster.grant_data_api_access(fn)

# Import an Aurora cluster
imported_cluster = rds.DatabaseCluster.from_database_cluster_attributes(self, "ImportedCluster",
    cluster_identifier="clusterIdentifier",
    secret=secret,
    data_api_enabled=True
)
imported_cluster.grant_data_api_access(fn)

Attributes

cluster_endpoint_address

Cluster endpoint address.

Default:

  • no endpoint address

cluster_identifier

Identifier for the cluster.

cluster_resource_identifier

cluster-ABCD1234EFGH5678IJKL90MNOP.

This AWS Region-unique identifier is used to grant access to the cluster.

Default:

none

Type:

The immutable identifier for the cluster; for example

data_api_enabled

Whether the Data API for the cluster is enabled.

Default:

false

engine

The engine of the existing Cluster.

Default:

  • the imported Cluster’s engine is unknown

instance_endpoint_addresses

Endpoint addresses of individual instances.

Default:

  • no instance endpoints

instance_identifiers

Identifier for the instances.

Default:

  • no instance identifiers

port

The database port.

Default:

  • none

reader_endpoint_address

Reader endpoint address.

Default:

  • no reader address

secret

The secret attached to the database cluster.

Default:

  • the imported Cluster’s secret is unknown

security_groups

The security groups of the database cluster.

Default:

  • no security groups