DatabaseClusterAttributes

class aws_cdk.aws_rds.DatabaseClusterAttributes(*, cluster_identifier, cluster_endpoint_address=None, cluster_resource_identifier=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
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:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2
from aws_cdk import aws_rds as rds
from aws_cdk import aws_secretsmanager as secretsmanager

# cluster_engine: rds.IClusterEngine
# secret: secretsmanager.Secret
# security_group: ec2.SecurityGroup

database_cluster_attributes = rds.DatabaseClusterAttributes(
    cluster_identifier="clusterIdentifier",

    # the properties below are optional
    cluster_endpoint_address="clusterEndpointAddress",
    cluster_resource_identifier="clusterResourceIdentifier",
    engine=cluster_engine,
    instance_endpoint_addresses=["instanceEndpointAddresses"],
    instance_identifiers=["instanceIdentifiers"],
    port=123,
    reader_endpoint_address="readerEndpointAddress",
    secret=secret,
    security_groups=[security_group]
)

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

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