Class: AWSCDK::MSK::CfnReplicator::ConsumerGroupReplicationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
msk/cfn_replicator.rb

Overview

Details about consumer group replication.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(consumer_groups_to_replicate:, consumer_group_offset_sync_mode: nil, consumer_groups_to_exclude: nil, detect_and_copy_new_consumer_groups: nil, synchronise_consumer_group_offsets: nil) ⇒ ConsumerGroupReplicationProperty

Returns a new instance of ConsumerGroupReplicationProperty.

Parameters:

  • consumer_groups_to_replicate (Array<String>)

    List of regular expression patterns indicating the consumer groups to copy.

  • consumer_group_offset_sync_mode (String, nil) (defaults to: nil)

    The consumer group offset synchronization mode.

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

    List of regular expression patterns indicating the consumer groups that should not be replicated.

  • detect_and_copy_new_consumer_groups (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil)

    Enables synchronization of consumer groups to target cluster.

  • synchronise_consumer_group_offsets (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil)

    Enables synchronization of consumer group offsets to target cluster.



727
728
729
730
731
732
733
734
735
736
737
738
# File 'msk/cfn_replicator.rb', line 727

def initialize(consumer_groups_to_replicate:, consumer_group_offset_sync_mode: nil, consumer_groups_to_exclude: nil, detect_and_copy_new_consumer_groups: nil, synchronise_consumer_group_offsets: nil)
  @consumer_groups_to_replicate = consumer_groups_to_replicate
  Jsii::Type.check_type(@consumer_groups_to_replicate, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "consumerGroupsToReplicate")
  @consumer_group_offset_sync_mode = consumer_group_offset_sync_mode
  Jsii::Type.check_type(@consumer_group_offset_sync_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "consumerGroupOffsetSyncMode") unless @consumer_group_offset_sync_mode.nil?
  @consumer_groups_to_exclude = consumer_groups_to_exclude
  Jsii::Type.check_type(@consumer_groups_to_exclude, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "consumerGroupsToExclude") unless @consumer_groups_to_exclude.nil?
  @detect_and_copy_new_consumer_groups = detect_and_copy_new_consumer_groups
  Jsii::Type.check_type(@detect_and_copy_new_consumer_groups, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "detectAndCopyNewConsumerGroups") unless @detect_and_copy_new_consumer_groups.nil?
  @synchronise_consumer_group_offsets = synchronise_consumer_group_offsets
  Jsii::Type.check_type(@synchronise_consumer_group_offsets, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "synchroniseConsumerGroupOffsets") unless @synchronise_consumer_group_offsets.nil?
end

Instance Attribute Details

#consumer_group_offset_sync_modeString? (readonly)

The consumer group offset synchronization mode.



749
750
751
# File 'msk/cfn_replicator.rb', line 749

def consumer_group_offset_sync_mode
  @consumer_group_offset_sync_mode
end

#consumer_groups_to_excludeArray<String>? (readonly)

List of regular expression patterns indicating the consumer groups that should not be replicated.



754
755
756
# File 'msk/cfn_replicator.rb', line 754

def consumer_groups_to_exclude
  @consumer_groups_to_exclude
end

#consumer_groups_to_replicateArray<String> (readonly)

List of regular expression patterns indicating the consumer groups to copy.



744
745
746
# File 'msk/cfn_replicator.rb', line 744

def consumer_groups_to_replicate
  @consumer_groups_to_replicate
end

#detect_and_copy_new_consumer_groupsBoolean, ... (readonly)

Enables synchronization of consumer groups to target cluster.



759
760
761
# File 'msk/cfn_replicator.rb', line 759

def detect_and_copy_new_consumer_groups
  @detect_and_copy_new_consumer_groups
end

#synchronise_consumer_group_offsetsBoolean, ... (readonly)

Enables synchronization of consumer group offsets to target cluster.

The translated offsets will be written to topic __consumer_offsets.



766
767
768
# File 'msk/cfn_replicator.rb', line 766

def synchronise_consumer_group_offsets
  @synchronise_consumer_group_offsets
end

Class Method Details

.jsii_propertiesObject



768
769
770
771
772
773
774
775
776
# File 'msk/cfn_replicator.rb', line 768

def self.jsii_properties
  {
    :consumer_groups_to_replicate => "consumerGroupsToReplicate",
    :consumer_group_offset_sync_mode => "consumerGroupOffsetSyncMode",
    :consumer_groups_to_exclude => "consumerGroupsToExclude",
    :detect_and_copy_new_consumer_groups => "detectAndCopyNewConsumerGroups",
    :synchronise_consumer_group_offsets => "synchroniseConsumerGroupOffsets",
  }
end

Instance Method Details

#to_jsiiObject



778
779
780
781
782
783
784
785
786
787
788
# File 'msk/cfn_replicator.rb', line 778

def to_jsii
  result = {}
  result.merge!({
    "consumerGroupsToReplicate" => @consumer_groups_to_replicate,
    "consumerGroupOffsetSyncMode" => @consumer_group_offset_sync_mode,
    "consumerGroupsToExclude" => @consumer_groups_to_exclude,
    "detectAndCopyNewConsumerGroups" => @detect_and_copy_new_consumer_groups,
    "synchroniseConsumerGroupOffsets" => @synchronise_consumer_group_offsets,
  })
  result.compact
end