DatabaseClusterAttributes

class aws_cdk.aws_docdb.DatabaseClusterAttributes(*, cluster_identifier, cluster_endpoint_address=None, instance_endpoint_addresses=None, instance_identifiers=None, port=None, reader_endpoint_address=None, security_group=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 cluster endpoint address

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

  • 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 endpoint address

  • security_group (Optional[ISecurityGroup]) – The security group 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.
import aws_cdk.aws_docdb as docdb
import aws_cdk.aws_ec2 as ec2

# security_group: ec2.SecurityGroup

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

    # the properties below are optional
    cluster_endpoint_address="clusterEndpointAddress",
    instance_endpoint_addresses=["instanceEndpointAddresses"],
    instance_identifiers=["instanceIdentifiers"],
    port=123,
    reader_endpoint_address="readerEndpointAddress",
    security_group=security_group
)

Attributes

cluster_endpoint_address

Cluster endpoint address.

Default
  • no cluster endpoint address

Return type

Optional[str]

cluster_identifier

Identifier for the cluster.

Return type

str

instance_endpoint_addresses

Endpoint addresses of individual instances.

Default
  • no instance endpoint addresses

Return type

Optional[List[str]]

instance_identifiers

Identifier for the instances.

Default
  • no instance identifiers

Return type

Optional[List[str]]

port

The database port.

Default
  • none

Return type

Union[int, float, None]

reader_endpoint_address

Reader endpoint address.

Default
  • no reader endpoint address

Return type

Optional[str]

security_group

The security group of the database cluster.

Default
  • no security groups

Return type

Optional[ISecurityGroup]