Class: AWSCDK::RDS::ServerlessClusterAttributes

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
rds/serverless_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, port: nil, reader_endpoint_address: nil, secret: nil, security_groups: nil) ⇒ ServerlessClusterAttributes

Returns a new instance of ServerlessClusterAttributes.

Parameters:

  • cluster_identifier (String) —

    Identifier for the cluster.

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

    Cluster endpoint address.

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



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

def initialize(cluster_identifier:, cluster_endpoint_address: 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?
  @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) 


36
37
38
 
# File 'rds/serverless_cluster_attributes.rb', line 36

def cluster_endpoint_address
  @cluster_endpoint_address
end

#cluster_identifier ⇒ String (readonly)

Identifier for the cluster.

Returns:

  • (String) 


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

def cluster_identifier
  @cluster_identifier
end

#port ⇒ Numeric? (readonly)

Note:

Default: - none

The database port.

Returns:

  • (Numeric, nil) 


41
42
43
 
# File 'rds/serverless_cluster_attributes.rb', line 41

def port
  @port
end

#reader_endpoint_address ⇒ String? (readonly)

Note:

Default: - no reader address

Reader endpoint address.

Returns:

  • (String, nil) 


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

def reader_endpoint_address
  @reader_endpoint_address
end

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

Note:

Default: - no secret

The secret attached to the database cluster.

Returns:



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

def secret
  @secret
end

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

Note:

Default: - no security groups

The security groups of the database cluster.

Returns:



56
57
58
 
# File 'rds/serverless_cluster_attributes.rb', line 56

def security_groups
  @security_groups
end

Class Method Details

.jsii_properties ⇒ Object 



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

def self.jsii_properties
  {
    :cluster_identifier => "clusterIdentifier",
    :cluster_endpoint_address => "clusterEndpointAddress",
    :port => "port",
    :reader_endpoint_address => "readerEndpointAddress",
    :secret => "secret",
    :security_groups => "securityGroups",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "clusterIdentifier" => @cluster_identifier,
    "clusterEndpointAddress" => @cluster_endpoint_address,
    "port" => @port,
    "readerEndpointAddress" => @reader_endpoint_address,
    "secret" => @secret,
    "securityGroups" => @security_groups,
  })
  result.compact
end