ServerlessClusterAttributes¶
-
class
aws_cdk.aws_rds.
ServerlessClusterAttributes
(*, cluster_identifier, cluster_endpoint_address=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 addressport (
Union
[int
,float
,None
]) – The database port. Default: - nonereader_endpoint_address (
Optional
[str
]) – Reader endpoint address. Default: - no reader addresssecret (
Optional
[ISecret
]) – The secret attached to the database cluster. Default: - no secretsecurity_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. import aws_cdk.aws_ec2 as ec2 import aws_cdk.aws_rds as rds import aws_cdk.aws_secretsmanager as secretsmanager # secret: secretsmanager.Secret # security_group: ec2.SecurityGroup serverless_cluster_attributes = rds.ServerlessClusterAttributes( cluster_identifier="clusterIdentifier", # the properties below are optional cluster_endpoint_address="clusterEndpointAddress", port=123, reader_endpoint_address="readerEndpointAddress", secret=secret, security_groups=[security_group] )
Attributes
-
cluster_endpoint_address
¶ Cluster endpoint address.
- Default
no endpoint address
- Return type
Optional
[str
]
-
cluster_identifier
¶ Identifier for the cluster.
- Return type
str
-
port
¶ The database port.
- Default
none
- Return type
Union
[int
,float
,None
]
-
reader_endpoint_address
¶ Reader endpoint address.
- Default
no reader address
- Return type
Optional
[str
]
-
secret
¶ The secret attached to the database cluster.
- Default
no secret
- Return type
Optional
[ISecret
]
-
security_groups
¶ The security groups of the database cluster.
- Default
no security groups
- Return type
Optional
[List
[ISecurityGroup
]]