aws-cdk-lib.aws_rds.CfnDBInstance.EndpointProperty

interface EndpointProperty

LanguageType name
.NETAmazon.CDK.AWS.RDS.CfnDBInstance.EndpointProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsrds#CfnDBInstance_EndpointProperty
Javasoftware.amazon.awscdk.services.rds.CfnDBInstance.EndpointProperty
Pythonaws_cdk.aws_rds.CfnDBInstance.EndpointProperty
TypeScript aws-cdk-lib » aws_rds » CfnDBInstance » EndpointProperty

This data type represents the information you need to connect to an Amazon RDS DB instance.

This data type is used as a response element in the following actions:

  • CreateDBInstance
  • DescribeDBInstances
  • DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_rds as rds } from 'aws-cdk-lib';
const endpointProperty: rds.CfnDBInstance.EndpointProperty = {
  address: 'address',
  hostedZoneId: 'hostedZoneId',
  port: 'port',
};

Properties

NameTypeDescription
address?stringSpecifies the DNS address of the DB instance.
hostedZoneId?stringSpecifies the ID that Amazon Route 53 assigns when you create a hosted zone.
port?stringSpecifies the port that the database engine is listening on.

address?

Type: string (optional)

Specifies the DNS address of the DB instance.


hostedZoneId?

Type: string (optional)

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.


port?

Type: string (optional)

Specifies the port that the database engine is listening on.