Class: AWSCDK::Elasticache::CfnGlobalReplicationGroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
elasticache/cfn_global_replication_group_props.rb

Overview

Properties for defining a CfnGlobalReplicationGroup.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(members:, automatic_failover_enabled: nil, cache_node_type: nil, cache_parameter_group_name: nil, engine: nil, engine_version: nil, global_node_group_count: nil, global_replication_group_description: nil, global_replication_group_id_suffix: nil, regional_configurations: nil) ⇒ CfnGlobalReplicationGroupProps

Returns a new instance of CfnGlobalReplicationGroupProps.

Parameters:

  • members (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Elasticache::CfnGlobalReplicationGroup::GlobalReplicationGroupMemberProperty>) —

    The replication groups that comprise the Global datastore.

  • automatic_failover_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

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

    The cache node type of the Global datastore.

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

    The name of the cache parameter group to use with the Global datastore.

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

    The ElastiCache engine.

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

    The Elasticache Valkey or Redis OSS engine version.

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

    The number of node groups that comprise the Global Datastore.

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

    The optional description of the Global datastore.

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

    The suffix name of a Global Datastore.

  • regional_configurations (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Elasticache::CfnGlobalReplicationGroup::RegionalConfigurationProperty>, nil) (defaults to: nil) —

    The Regions that comprise the Global Datastore.



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

def initialize(members:, automatic_failover_enabled: nil, cache_node_type: nil, cache_parameter_group_name: nil, engine: nil, engine_version: nil, global_node_group_count: nil, global_replication_group_description: nil, global_replication_group_id_suffix: nil, regional_configurations: nil)
  @members = members
  Jsii::Type.check_type(@members, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2FjaGUuQ2ZuR2xvYmFsUmVwbGljYXRpb25Hcm91cC5HbG9iYWxSZXBsaWNhdGlvbkdyb3VwTWVtYmVyUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "members")
  @automatic_failover_enabled = automatic_failover_enabled
  Jsii::Type.check_type(@automatic_failover_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "automaticFailoverEnabled") unless @automatic_failover_enabled.nil?
  @cache_node_type = cache_node_type
  Jsii::Type.check_type(@cache_node_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cacheNodeType") unless @cache_node_type.nil?
  @cache_parameter_group_name = cache_parameter_group_name
  Jsii::Type.check_type(@cache_parameter_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cacheParameterGroupName") unless @cache_parameter_group_name.nil?
  @engine = engine
  Jsii::Type.check_type(@engine, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engine") unless @engine.nil?
  @engine_version = engine_version
  Jsii::Type.check_type(@engine_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineVersion") unless @engine_version.nil?
  @global_node_group_count = global_node_group_count
  Jsii::Type.check_type(@global_node_group_count, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "globalNodeGroupCount") unless @global_node_group_count.nil?
  @global_replication_group_description = global_replication_group_description
  Jsii::Type.check_type(@global_replication_group_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "globalReplicationGroupDescription") unless @global_replication_group_description.nil?
  @global_replication_group_id_suffix = global_replication_group_id_suffix
  Jsii::Type.check_type(@global_replication_group_id_suffix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "globalReplicationGroupIdSuffix") unless @global_replication_group_id_suffix.nil?
  @regional_configurations = regional_configurations
  Jsii::Type.check_type(@regional_configurations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2FjaGUuQ2ZuR2xvYmFsUmVwbGljYXRpb25Hcm91cC5SZWdpb25hbENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "regionalConfigurations") unless @regional_configurations.nil?
end

Instance Attribute Details

#automatic_failover_enabled ⇒ Boolean, ... (readonly)

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

AutomaticFailoverEnabled must be enabled for Valkey or Redis OSS (cluster mode enabled) replication groups.

Returns:

See Also:



53
54
55
 
# File 'elasticache/cfn_global_replication_group_props.rb', line 53

def automatic_failover_enabled
  @automatic_failover_enabled
end

#cache_node_type ⇒ String? (readonly)

The cache node type of the Global datastore.

Returns:

  • (String, nil)

See Also:



58
59
60
 
# File 'elasticache/cfn_global_replication_group_props.rb', line 58

def cache_node_type
  @cache_node_type
end

#cache_parameter_group_name ⇒ String? (readonly)

The name of the cache parameter group to use with the Global datastore.

It must be compatible with the major engine version used by the Global datastore.

Returns:

  • (String, nil)

See Also:



65
66
67
 
# File 'elasticache/cfn_global_replication_group_props.rb', line 65

def cache_parameter_group_name
  @cache_parameter_group_name
end

#engine ⇒ String? (readonly)

The ElastiCache engine.

For Valkey or Redis OSS only.

Returns:

  • (String, nil)

See Also:



72
73
74
 
# File 'elasticache/cfn_global_replication_group_props.rb', line 72

def engine
  @engine
end

#engine_version ⇒ String? (readonly)

The Elasticache Valkey or Redis OSS engine version.

Returns:

  • (String, nil)

See Also:



77
78
79
 
# File 'elasticache/cfn_global_replication_group_props.rb', line 77

def engine_version
  @engine_version
end

#global_node_group_count ⇒ Numeric? (readonly)

The number of node groups that comprise the Global Datastore.

Returns:

  • (Numeric, nil)

See Also:



82
83
84
 
# File 'elasticache/cfn_global_replication_group_props.rb', line 82

def global_node_group_count
  @global_node_group_count
end

#global_replication_group_description ⇒ String? (readonly)

The optional description of the Global datastore.

Returns:

  • (String, nil)

See Also:



87
88
89
 
# File 'elasticache/cfn_global_replication_group_props.rb', line 87

def global_replication_group_description
  @global_replication_group_description
end

#global_replication_group_id_suffix ⇒ String? (readonly)

The suffix name of a Global Datastore.

The suffix guarantees uniqueness of the Global Datastore name across multiple regions.

Returns:

  • (String, nil)

See Also:



94
95
96
 
# File 'elasticache/cfn_global_replication_group_props.rb', line 94

def global_replication_group_id_suffix
  @global_replication_group_id_suffix
end

#members ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Elasticache::CfnGlobalReplicationGroup::GlobalReplicationGroupMemberProperty> (readonly)

The replication groups that comprise the Global datastore.

Returns:

See Also:



46
47
48
 
# File 'elasticache/cfn_global_replication_group_props.rb', line 46

def members
  @members
end

#regional_configurations ⇒ AWSCDK::IResolvable, ... (readonly)

The Regions that comprise the Global Datastore.

Returns:

See Also:



99
100
101
 
# File 'elasticache/cfn_global_replication_group_props.rb', line 99

def regional_configurations
  @regional_configurations
end

Class Method Details

.jsii_properties ⇒ Object 



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

def self.jsii_properties
  {
    :members => "members",
    :automatic_failover_enabled => "automaticFailoverEnabled",
    :cache_node_type => "cacheNodeType",
    :cache_parameter_group_name => "cacheParameterGroupName",
    :engine => "engine",
    :engine_version => "engineVersion",
    :global_node_group_count => "globalNodeGroupCount",
    :global_replication_group_description => "globalReplicationGroupDescription",
    :global_replication_group_id_suffix => "globalReplicationGroupIdSuffix",
    :regional_configurations => "regionalConfigurations",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "members" => @members,
    "automaticFailoverEnabled" => @automatic_failover_enabled,
    "cacheNodeType" => @cache_node_type,
    "cacheParameterGroupName" => @cache_parameter_group_name,
    "engine" => @engine,
    "engineVersion" => @engine_version,
    "globalNodeGroupCount" => @global_node_group_count,
    "globalReplicationGroupDescription" => @global_replication_group_description,
    "globalReplicationGroupIdSuffix" => @global_replication_group_id_suffix,
    "regionalConfigurations" => @regional_configurations,
  })
  result.compact
end