Package software.amazon.awscdk.services.rds

Interface CfnDBInstance.EndpointProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDBInstance.EndpointProperty.Jsii$Proxy

Enclosing class:

CfnDBInstance

@Stability(Stable)
public static interface CfnDBInstance.EndpointProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.rds.*;
 EndpointProperty endpointProperty = EndpointProperty.builder()
         .address("address")
         .hostedZoneId("hostedZoneId")
         .port("port")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-endpoint.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDBInstance.EndpointProperty.Builder	A builder for CfnDBInstance.EndpointProperty
static final class	CfnDBInstance.EndpointProperty.Jsii$Proxy	An implementation for CfnDBInstance.EndpointProperty

Method Summary

Modifier and Type	Method	Description
static CfnDBInstance.EndpointProperty.Builder	builder()
default String	getAddress()	Specifies the DNS address of the DB instance.
default String	getHostedZoneId()	Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
default String	getPort()	Specifies the port that the database engine is listening on.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAddress

@Stability(Stable)
@Nullable
default String getAddress()

Specifies the DNS address of the DB instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-endpoint.html#cfn-rds-dbinstance-endpoint-address

getHostedZoneId

@Stability(Stable)
@Nullable
default String getHostedZoneId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-endpoint.html#cfn-rds-dbinstance-endpoint-hostedzoneid

getPort

@Stability(Stable)
@Nullable
default String getPort()

Specifies the port that the database engine is listening on.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-endpoint.html#cfn-rds-dbinstance-endpoint-port

builder

@Stability(Stable)
static CfnDBInstance.EndpointProperty.Builder builder()

Returns:

a CfnDBInstance.EndpointProperty.Builder of CfnDBInstance.EndpointProperty