Class: AWSCDK::DocDB::DatabaseClusterAttributes

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
doc_db/database_cluster_attributes.rb

Overview

Properties that describe an existing cluster instance.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cluster_identifier:, cluster_endpoint_address: nil, instance_endpoint_addresses: nil, instance_identifiers: nil, port: nil, reader_endpoint_address: nil, security_group: nil) ⇒ DatabaseClusterAttributes

Returns a new instance of DatabaseClusterAttributes.

Parameters:

  • cluster_identifier (String) —

    Identifier for the cluster.

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

    Cluster endpoint address.

  • instance_endpoint_addresses (Array<String>, nil) (defaults to: nil) —

    Endpoint addresses of individual instances.

  • instance_identifiers (Array<String>, nil) (defaults to: nil) —

    Identifier for the instances.

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

    The database port.

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

    Reader endpoint address.

  • security_group (AWSCDK::EC2::ISecurityGroup, nil) (defaults to: nil) —

    The security group of the database cluster.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'doc_db/database_cluster_attributes.rb', line 14

def initialize(cluster_identifier:, cluster_endpoint_address: nil, instance_endpoint_addresses: nil, instance_identifiers: nil, port: nil, reader_endpoint_address: nil, security_group: nil)
  @cluster_identifier = cluster_identifier
  Jsii::Type.check_type(@cluster_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clusterIdentifier")
  @cluster_endpoint_address = cluster_endpoint_address
  Jsii::Type.check_type(@cluster_endpoint_address, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clusterEndpointAddress") unless @cluster_endpoint_address.nil?
  @instance_endpoint_addresses = instance_endpoint_addresses
  Jsii::Type.check_type(@instance_endpoint_addresses, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "instanceEndpointAddresses") unless @instance_endpoint_addresses.nil?
  @instance_identifiers = instance_identifiers
  Jsii::Type.check_type(@instance_identifiers, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "instanceIdentifiers") unless @instance_identifiers.nil?
  @port = port
  Jsii::Type.check_type(@port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "port") unless @port.nil?
  @reader_endpoint_address = reader_endpoint_address
  Jsii::Type.check_type(@reader_endpoint_address, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "readerEndpointAddress") unless @reader_endpoint_address.nil?
  @security_group = security_group
  Jsii::Type.check_type(@security_group, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLklTZWN1cml0eUdyb3VwIn0=")), "securityGroup") unless @security_group.nil?
end

Instance Attribute Details

#cluster_endpoint_address ⇒ String? (readonly)

Note:

Default: - no cluster endpoint address

Cluster endpoint address.

Returns:

  • (String, nil) 


39
40
41
 
# File 'doc_db/database_cluster_attributes.rb', line 39

def cluster_endpoint_address
  @cluster_endpoint_address
end

#cluster_identifier ⇒ String (readonly)

Identifier for the cluster.

Returns:

  • (String) 


34
35
36
 
# File 'doc_db/database_cluster_attributes.rb', line 34

def cluster_identifier
  @cluster_identifier
end

#instance_endpoint_addresses ⇒ Array<String>? (readonly)

Note:

Default: - no instance endpoint addresses

Endpoint addresses of individual instances.

Returns:

  • (Array<String>, nil) 


44
45
46
 
# File 'doc_db/database_cluster_attributes.rb', line 44

def instance_endpoint_addresses
  @instance_endpoint_addresses
end

#instance_identifiers ⇒ Array<String>? (readonly)

Note:

Default: - no instance identifiers

Identifier for the instances.

Returns:

  • (Array<String>, nil) 


49
50
51
 
# File 'doc_db/database_cluster_attributes.rb', line 49

def instance_identifiers
  @instance_identifiers
end

#port ⇒ Numeric? (readonly)

Note:

Default: - none

The database port.

Returns:

  • (Numeric, nil) 


54
55
56
 
# File 'doc_db/database_cluster_attributes.rb', line 54

def port
  @port
end

#reader_endpoint_address ⇒ String? (readonly)

Note:

Default: - no reader endpoint address

Reader endpoint address.

Returns:

  • (String, nil) 


59
60
61
 
# File 'doc_db/database_cluster_attributes.rb', line 59

def reader_endpoint_address
  @reader_endpoint_address
end

#security_group ⇒ AWSCDK::EC2::ISecurityGroup? (readonly)

Note:

Default: - no security groups

The security group of the database cluster.

Returns:



64
65
66
 
# File 'doc_db/database_cluster_attributes.rb', line 64

def security_group
  @security_group
end

Class Method Details

.jsii_properties ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
 
# File 'doc_db/database_cluster_attributes.rb', line 66

def self.jsii_properties
  {
    :cluster_identifier => "clusterIdentifier",
    :cluster_endpoint_address => "clusterEndpointAddress",
    :instance_endpoint_addresses => "instanceEndpointAddresses",
    :instance_identifiers => "instanceIdentifiers",
    :port => "port",
    :reader_endpoint_address => "readerEndpointAddress",
    :security_group => "securityGroup",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'doc_db/database_cluster_attributes.rb', line 78

def to_jsii
  result = {}
  result.merge!({
    "clusterIdentifier" => @cluster_identifier,
    "clusterEndpointAddress" => @cluster_endpoint_address,
    "instanceEndpointAddresses" => @instance_endpoint_addresses,
    "instanceIdentifiers" => @instance_identifiers,
    "port" => @port,
    "readerEndpointAddress" => @reader_endpoint_address,
    "securityGroup" => @security_group,
  })
  result.compact
end