DatabaseInstanceAttributes

class aws_cdk.aws_rds.DatabaseInstanceAttributes(*, engine=None, instance_endpoint_address, instance_identifier, port, security_groups)

Bases: object

Properties that describe an existing instance.

Parameters
  • engine (Optional[IInstanceEngine]) – The engine of the existing database Instance. Default: - the imported Instance’s engine is unknown

  • instance_endpoint_address (str) – The endpoint address.

  • instance_identifier (str) – The instance identifier.

  • port (Union[int, float]) – The database port.

  • security_groups (Sequence[ISecurityGroup]) – The security groups of the instance.

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_rds as rds

# instance_engine is of type IInstanceEngine
# security_group is of type SecurityGroup

database_instance_attributes = rds.DatabaseInstanceAttributes(
    instance_endpoint_address="instanceEndpointAddress",
    instance_identifier="instanceIdentifier",
    port=123,
    security_groups=[security_group],

    # the properties below are optional
    engine=instance_engine
)

Attributes

engine

The engine of the existing database Instance.

Default
  • the imported Instance’s engine is unknown

Return type

Optional[IInstanceEngine]

instance_endpoint_address

The endpoint address.

Return type

str

instance_identifier

The instance identifier.

Return type

str

port

The database port.

Return type

Union[int, float]

security_groups

The security groups of the instance.

Return type

List[ISecurityGroup]