Class: AWSCDK::RDS::DatabaseInstanceAttributes

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
rds/database_instance_attributes.rb

Overview

Properties that describe an existing instance.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(instance_endpoint_address:, instance_identifier:, port:, security_groups:, engine: nil, instance_resource_id: nil) ⇒ DatabaseInstanceAttributes

Returns a new instance of DatabaseInstanceAttributes.

Parameters:

  • instance_endpoint_address (String) —

    The endpoint address.

  • instance_identifier (String) —

    The instance identifier.

  • port (Numeric) —

    The database port.

  • security_groups (Array<AWSCDK::EC2::ISecurityGroup>) —

    The security groups of the instance.

  • engine (AWSCDK::RDS::IInstanceEngine, nil) (defaults to: nil) —

    The engine of the existing database Instance.

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

    The AWS Region-unique, immutable identifier for the DB instance.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'rds/database_instance_attributes.rb', line 13

def initialize(instance_endpoint_address:, instance_identifier:, port:, security_groups:, engine: nil, instance_resource_id: nil)
  @instance_endpoint_address = instance_endpoint_address
  Jsii::Type.check_type(@instance_endpoint_address, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceEndpointAddress")
  @instance_identifier = instance_identifier
  Jsii::Type.check_type(@instance_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceIdentifier")
  @port = port
  Jsii::Type.check_type(@port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "port")
  @security_groups = security_groups
  Jsii::Type.check_type(@security_groups, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuSVNlY3VyaXR5R3JvdXAifSwia2luZCI6ImFycmF5In19")), "securityGroups")
  @engine = engine
  Jsii::Type.check_type(@engine, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLklJbnN0YW5jZUVuZ2luZSJ9")), "engine") unless @engine.nil?
  @instance_resource_id = instance_resource_id
  Jsii::Type.check_type(@instance_resource_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceResourceId") unless @instance_resource_id.nil?
end

Instance Attribute Details

#engine ⇒ AWSCDK::RDS::IInstanceEngine? (readonly)

Note:

Default: - the imported Instance's engine is unknown

The engine of the existing database Instance.

Returns:



48
49
50
 
# File 'rds/database_instance_attributes.rb', line 48

def engine
  @engine
end

#instance_endpoint_address ⇒ String (readonly)

The endpoint address.

Returns:

  • (String) 


31
32
33
 
# File 'rds/database_instance_attributes.rb', line 31

def instance_endpoint_address
  @instance_endpoint_address
end

#instance_identifier ⇒ String (readonly)

The instance identifier.

Returns:

  • (String) 


35
36
37
 
# File 'rds/database_instance_attributes.rb', line 35

def instance_identifier
  @instance_identifier
end

#instance_resource_id ⇒ String? (readonly)

The AWS Region-unique, immutable identifier for the DB instance.

This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

Returns:

  • (String, nil)

See Also:



55
56
57
 
# File 'rds/database_instance_attributes.rb', line 55

def instance_resource_id
  @instance_resource_id
end

#port ⇒ Numeric (readonly)

The database port.

Returns:

  • (Numeric) 


39
40
41
 
# File 'rds/database_instance_attributes.rb', line 39

def port
  @port
end

#security_groups ⇒ Array<AWSCDK::EC2::ISecurityGroup> (readonly)

The security groups of the instance.

Returns:



43
44
45
 
# File 'rds/database_instance_attributes.rb', line 43

def security_groups
  @security_groups
end

Class Method Details

.jsii_properties ⇒ Object 



57
58
59
60
61
62
63
64
65
66
 
# File 'rds/database_instance_attributes.rb', line 57

def self.jsii_properties
  {
    :instance_endpoint_address => "instanceEndpointAddress",
    :instance_identifier => "instanceIdentifier",
    :port => "port",
    :security_groups => "securityGroups",
    :engine => "engine",
    :instance_resource_id => "instanceResourceId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'rds/database_instance_attributes.rb', line 68

def to_jsii
  result = {}
  result.merge!({
    "instanceEndpointAddress" => @instance_endpoint_address,
    "instanceIdentifier" => @instance_identifier,
    "port" => @port,
    "securityGroups" => @security_groups,
    "engine" => @engine,
    "instanceResourceId" => @instance_resource_id,
  })
  result.compact
end