Class: AWSCDK::RDS::CfnDBInstance::EndpointProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::RDS::CfnDBInstance::EndpointProperty

Defined in:

rds/cfn_db_instance.rb

Overview

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 .

See Also:

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

Instance Attribute Summary

• #address ⇒ String^? readonly

  Specifies the DNS address of the DB instance.

• #hosted_zone_id ⇒ String^? readonly

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

• #port ⇒ String^? readonly

  Specifies the port that the database engine is listening on.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(address: nil, hosted_zone_id: nil, port: nil) ⇒ EndpointProperty constructor

  A new instance of EndpointProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(address: nil, hosted_zone_id: nil, port: nil) ⇒ EndpointProperty

Returns a new instance of EndpointProperty.

Parameters:

• address (String, nil) (defaults to: nil) —

  Specifies the DNS address of the DB instance.

• hosted_zone_id (String, nil) (defaults to: nil) —

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

• port (String, nil) (defaults to: nil) —

  Specifies the port that the database engine is listening on.

# File 'rds/cfn_db_instance.rb', line 2115

def initialize(address: nil, hosted_zone_id: nil, port: nil)
  @address = address
  Jsii::Type.check_type(@address, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "address") unless @address.nil?
  @hosted_zone_id = hosted_zone_id
  Jsii::Type.check_type(@hosted_zone_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hostedZoneId") unless @hosted_zone_id.nil?
  @port = port
  Jsii::Type.check_type(@port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "port") unless @port.nil?
end

Instance Attribute Details

#address ⇒ String^? (readonly)

Specifies the DNS address of the DB instance.

Returns:

• (String, nil)

See Also:

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

# File 'rds/cfn_db_instance.rb', line 2128

def address
  @address
end

#hosted_zone_id ⇒ String^? (readonly)

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

Returns:

• (String, nil)

See Also:

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

# File 'rds/cfn_db_instance.rb', line 2133

def hosted_zone_id
  @hosted_zone_id
end

#port ⇒ String^? (readonly)

Specifies the port that the database engine is listening on.

Returns:

• (String, nil)

See Also:

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

# File 'rds/cfn_db_instance.rb', line 2138

def port
  @port
end

Class Method Details

.jsii_properties ⇒ Object

# File 'rds/cfn_db_instance.rb', line 2140

def self.jsii_properties
  {
    :address => "address",
    :hosted_zone_id => "hostedZoneId",
    :port => "port",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'rds/cfn_db_instance.rb', line 2148

def to_jsii
  result = {}
  result.merge!({
    "address" => @address,
    "hostedZoneId" => @hosted_zone_id,
    "port" => @port,
  })
  result.compact
end