Class: AWSCDK::DSQL::CfnCluster::MultiRegionPropertiesProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
dsql/cfn_cluster.rb

Overview

Defines the structure for multi-Region cluster configurations, containing the witness Region and peered cluster settings.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(clusters: nil, witness_region: nil) ⇒ MultiRegionPropertiesProperty

Returns a new instance of MultiRegionPropertiesProperty.

Parameters:

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

    The set of peered clusters that form the multi-Region cluster configuration.

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

    The Region that serves as the witness Region for a multi-Region cluster.



743
744
745
746
747
748
 
# File 'dsql/cfn_cluster.rb', line 743

def initialize(clusters: nil, witness_region: nil)
  @clusters = clusters
  Jsii::Type.check_type(@clusters, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "clusters") unless @clusters.nil?
  @witness_region = witness_region
  Jsii::Type.check_type(@witness_region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "witnessRegion") unless @witness_region.nil?
end

Instance Attribute Details

#clusters ⇒ Array<String>? (readonly)

The set of peered clusters that form the multi-Region cluster configuration.

Each peered cluster represents a database instance in a different Region.

Returns:

  • (Array<String>, nil)

See Also:



756
757
758
 
# File 'dsql/cfn_cluster.rb', line 756

def clusters
  @clusters
end

#witness_region ⇒ String? (readonly)

The Region that serves as the witness Region for a multi-Region cluster.

The witness Region helps maintain cluster consistency and quorum.

Returns:

  • (String, nil)

See Also:



763
764
765
 
# File 'dsql/cfn_cluster.rb', line 763

def witness_region
  @witness_region
end

Class Method Details

.jsii_properties ⇒ Object 



765
766
767
768
769
770
 
# File 'dsql/cfn_cluster.rb', line 765

def self.jsii_properties
  {
    :clusters => "clusters",
    :witness_region => "witnessRegion",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



772
773
774
775
776
777
778
779
 
# File 'dsql/cfn_cluster.rb', line 772

def to_jsii
  result = {}
  result.merge!({
    "clusters" => @clusters,
    "witnessRegion" => @witness_region,
  })
  result.compact
end