Class: AWSCDK::RDS::DatabaseClusterAttributes

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
rds/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, cluster_resource_identifier: nil, data_api_enabled: nil, engine: nil, instance_endpoint_addresses: nil, instance_identifiers: nil, port: nil, reader_endpoint_address: nil, secret: nil, security_groups: 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.

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

    The immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP.

  • data_api_enabled (Boolean, nil) (defaults to: nil) —

    Whether the Data API for the cluster is enabled.

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

    The engine of the existing Cluster.

  • 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.

  • secret (AWSCDK::SecretsManager::ISecret, nil) (defaults to: nil) —

    The secret attached to the database cluster.

  • security_groups (Array<AWSCDK::EC2::ISecurityGroup>, nil) (defaults to: nil) —

    The security groups of the database cluster.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'rds/database_cluster_attributes.rb', line 18

def initialize(cluster_identifier:, cluster_endpoint_address: nil, cluster_resource_identifier: nil, data_api_enabled: nil, engine: nil, instance_endpoint_addresses: nil, instance_identifiers: nil, port: nil, reader_endpoint_address: nil, secret: nil, security_groups: 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?
  @cluster_resource_identifier = cluster_resource_identifier
  Jsii::Type.check_type(@cluster_resource_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clusterResourceIdentifier") unless @cluster_resource_identifier.nil?
  @data_api_enabled = data_api_enabled
  Jsii::Type.check_type(@data_api_enabled, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "dataApiEnabled") unless @data_api_enabled.nil?
  @engine = engine
  Jsii::Type.check_type(@engine, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLklDbHVzdGVyRW5naW5lIn0=")), "engine") unless @engine.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?
  @secret = secret
  Jsii::Type.check_type(@secret, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VjcmV0c21hbmFnZXIuSVNlY3JldCJ9")), "secret") unless @secret.nil?
  @security_groups = security_groups
  Jsii::Type.check_type(@security_groups, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuSVNlY3VyaXR5R3JvdXAifSwia2luZCI6ImFycmF5In19")), "securityGroups") unless @security_groups.nil?
end

Instance Attribute Details

#cluster_endpoint_address ⇒ String? (readonly)

Note:

Default: - no endpoint address

Cluster endpoint address.

Returns:

  • (String, nil) 


51
52
53
 
# File 'rds/database_cluster_attributes.rb', line 51

def cluster_endpoint_address
  @cluster_endpoint_address
end

#cluster_identifier ⇒ String (readonly)

Identifier for the cluster.

Returns:

  • (String) 


46
47
48
 
# File 'rds/database_cluster_attributes.rb', line 46

def cluster_identifier
  @cluster_identifier
end

#cluster_resource_identifier ⇒ String? (readonly)

Note:

Default: none

The immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP.

This AWS Region-unique identifier is used to grant access to the cluster.

Returns:

  • (String, nil) 


58
59
60
 
# File 'rds/database_cluster_attributes.rb', line 58

def cluster_resource_identifier
  @cluster_resource_identifier
end

#data_api_enabled ⇒ Boolean? (readonly)

Note:

Default: false

Whether the Data API for the cluster is enabled.

Returns:

  • (Boolean, nil) 


63
64
65
 
# File 'rds/database_cluster_attributes.rb', line 63

def data_api_enabled
  @data_api_enabled
end

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

Note:

Default: - the imported Cluster's engine is unknown

The engine of the existing Cluster.

Returns:



68
69
70
 
# File 'rds/database_cluster_attributes.rb', line 68

def engine
  @engine
end

#instance_endpoint_addresses ⇒ Array<String>? (readonly)

Note:

Default: - no instance endpoints

Endpoint addresses of individual instances.

Returns:

  • (Array<String>, nil) 


73
74
75
 
# File 'rds/database_cluster_attributes.rb', line 73

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) 


78
79
80
 
# File 'rds/database_cluster_attributes.rb', line 78

def instance_identifiers
  @instance_identifiers
end

#port ⇒ Numeric? (readonly)

Note:

Default: - none

The database port.

Returns:

  • (Numeric, nil) 


83
84
85
 
# File 'rds/database_cluster_attributes.rb', line 83

def port
  @port
end

#reader_endpoint_address ⇒ String? (readonly)

Note:

Default: - no reader address

Reader endpoint address.

Returns:

  • (String, nil) 


88
89
90
 
# File 'rds/database_cluster_attributes.rb', line 88

def reader_endpoint_address
  @reader_endpoint_address
end

#secret ⇒ AWSCDK::SecretsManager::ISecret? (readonly)

Note:

Default: - the imported Cluster's secret is unknown

The secret attached to the database cluster.

Returns:



93
94
95
 
# File 'rds/database_cluster_attributes.rb', line 93

def secret
  @secret
end

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

Note:

Default: - no security groups

The security groups of the database cluster.

Returns:



98
99
100
 
# File 'rds/database_cluster_attributes.rb', line 98

def security_groups
  @security_groups
end

Class Method Details

.jsii_properties ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'rds/database_cluster_attributes.rb', line 100

def self.jsii_properties
  {
    :cluster_identifier => "clusterIdentifier",
    :cluster_endpoint_address => "clusterEndpointAddress",
    :cluster_resource_identifier => "clusterResourceIdentifier",
    :data_api_enabled => "dataApiEnabled",
    :engine => "engine",
    :instance_endpoint_addresses => "instanceEndpointAddresses",
    :instance_identifiers => "instanceIdentifiers",
    :port => "port",
    :reader_endpoint_address => "readerEndpointAddress",
    :secret => "secret",
    :security_groups => "securityGroups",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'rds/database_cluster_attributes.rb', line 116

def to_jsii
  result = {}
  result.merge!({
    "clusterIdentifier" => @cluster_identifier,
    "clusterEndpointAddress" => @cluster_endpoint_address,
    "clusterResourceIdentifier" => @cluster_resource_identifier,
    "dataApiEnabled" => @data_api_enabled,
    "engine" => @engine,
    "instanceEndpointAddresses" => @instance_endpoint_addresses,
    "instanceIdentifiers" => @instance_identifiers,
    "port" => @port,
    "readerEndpointAddress" => @reader_endpoint_address,
    "secret" => @secret,
    "securityGroups" => @security_groups,
  })
  result.compact
end