Class: AWSCDK::MSK::CfnClusterProps

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

Overview

Properties for defining a CfnCluster.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(broker_node_group_info:, cluster_name:, kafka_version:, number_of_broker_nodes:, client_authentication: nil, configuration_info: nil, current_version: nil, encryption_info: nil, enhanced_monitoring: nil, logging_info: nil, open_monitoring: nil, rebalancing: nil, storage_mode: nil, tags: nil, zookeeper_access: nil) ⇒ CfnClusterProps

Returns a new instance of CfnClusterProps.

Parameters:



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'msk/cfn_cluster_props.rb', line 24

def initialize(broker_node_group_info:, cluster_name:, kafka_version:, number_of_broker_nodes:, client_authentication: nil, configuration_info: nil, current_version: nil, encryption_info: nil, enhanced_monitoring: nil, logging_info: nil, open_monitoring: nil, rebalancing: nil, storage_mode: nil, tags: nil, zookeeper_access: nil)
  @broker_node_group_info = broker_node_group_info.is_a?(Hash) ? ::AWSCDK::MSK::CfnCluster::BrokerNodeGroupInfoProperty.new(**broker_node_group_info.transform_keys(&:to_sym)) : broker_node_group_info
  Jsii::Type.check_type(@broker_node_group_info, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tc2suQ2ZuQ2x1c3Rlci5Ccm9rZXJOb2RlR3JvdXBJbmZvUHJvcGVydHkifV19fQ==")), "brokerNodeGroupInfo")
  @cluster_name = cluster_name
  Jsii::Type.check_type(@cluster_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clusterName")
  @kafka_version = kafka_version
  Jsii::Type.check_type(@kafka_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kafkaVersion")
  @number_of_broker_nodes = number_of_broker_nodes
  Jsii::Type.check_type(@number_of_broker_nodes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "numberOfBrokerNodes")
  @client_authentication = client_authentication.is_a?(Hash) ? ::AWSCDK::MSK::CfnCluster::ClientAuthenticationProperty.new(**client_authentication.transform_keys(&:to_sym)) : client_authentication
  Jsii::Type.check_type(@client_authentication, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tc2suQ2ZuQ2x1c3Rlci5DbGllbnRBdXRoZW50aWNhdGlvblByb3BlcnR5In1dfX0=")), "clientAuthentication") unless @client_authentication.nil?
  @configuration_info = configuration_info.is_a?(Hash) ? ::AWSCDK::MSK::CfnCluster::ConfigurationInfoProperty.new(**configuration_info.transform_keys(&:to_sym)) : configuration_info
  Jsii::Type.check_type(@configuration_info, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tc2suQ2ZuQ2x1c3Rlci5Db25maWd1cmF0aW9uSW5mb1Byb3BlcnR5In1dfX0=")), "configurationInfo") unless @configuration_info.nil?
  @current_version = current_version
  Jsii::Type.check_type(@current_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "currentVersion") unless @current_version.nil?
  @encryption_info = encryption_info.is_a?(Hash) ? ::AWSCDK::MSK::CfnCluster::EncryptionInfoProperty.new(**encryption_info.transform_keys(&:to_sym)) : encryption_info
  Jsii::Type.check_type(@encryption_info, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tc2suQ2ZuQ2x1c3Rlci5FbmNyeXB0aW9uSW5mb1Byb3BlcnR5In1dfX0=")), "encryptionInfo") unless @encryption_info.nil?
  @enhanced_monitoring = enhanced_monitoring
  Jsii::Type.check_type(@enhanced_monitoring, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "enhancedMonitoring") unless @enhanced_monitoring.nil?
  @logging_info = logging_info.is_a?(Hash) ? ::AWSCDK::MSK::CfnCluster::LoggingInfoProperty.new(**logging_info.transform_keys(&:to_sym)) : logging_info
  Jsii::Type.check_type(@logging_info, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tc2suQ2ZuQ2x1c3Rlci5Mb2dnaW5nSW5mb1Byb3BlcnR5In1dfX0=")), "loggingInfo") unless @logging_info.nil?
  @open_monitoring = open_monitoring.is_a?(Hash) ? ::AWSCDK::MSK::CfnCluster::OpenMonitoringProperty.new(**open_monitoring.transform_keys(&:to_sym)) : open_monitoring
  Jsii::Type.check_type(@open_monitoring, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tc2suQ2ZuQ2x1c3Rlci5PcGVuTW9uaXRvcmluZ1Byb3BlcnR5In1dfX0=")), "openMonitoring") unless @open_monitoring.nil?
  @rebalancing = rebalancing.is_a?(Hash) ? ::AWSCDK::MSK::CfnCluster::RebalancingProperty.new(**rebalancing.transform_keys(&:to_sym)) : rebalancing
  Jsii::Type.check_type(@rebalancing, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tc2suQ2ZuQ2x1c3Rlci5SZWJhbGFuY2luZ1Byb3BlcnR5In1dfX0=")), "rebalancing") unless @rebalancing.nil?
  @storage_mode = storage_mode
  Jsii::Type.check_type(@storage_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "storageMode") unless @storage_mode.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
  @zookeeper_access = zookeeper_access.is_a?(Hash) ? ::AWSCDK::MSK::CfnCluster::ZookeeperAccessProperty.new(**zookeeper_access.transform_keys(&:to_sym)) : zookeeper_access
  Jsii::Type.check_type(@zookeeper_access, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tc2suQ2ZuQ2x1c3Rlci5ab29rZWVwZXJBY2Nlc3NQcm9wZXJ0eSJ9XX19")), "zookeeperAccess") unless @zookeeper_access.nil?
end

Instance Attribute Details

#broker_node_group_info ⇒ AWSCDK::IResolvable, AWSCDK::MSK::CfnCluster::BrokerNodeGroupInfoProperty (readonly)

Information about the broker nodes in the cluster.

Returns:

See Also:



61
62
63
 
# File 'msk/cfn_cluster_props.rb', line 61

def broker_node_group_info
  @broker_node_group_info
end

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

Includes all client authentication related information.

Returns:

See Also:



83
84
85
 
# File 'msk/cfn_cluster_props.rb', line 83

def client_authentication
  @client_authentication
end

#cluster_name ⇒ String (readonly)

The name of the cluster.

Returns:

  • (String)

See Also:



66
67
68
 
# File 'msk/cfn_cluster_props.rb', line 66

def cluster_name
  @cluster_name
end

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

Represents the configuration that you want MSK to use for the cluster.

Returns:

See Also:



88
89
90
 
# File 'msk/cfn_cluster_props.rb', line 88

def configuration_info
  @configuration_info
end

#current_version ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



91
92
93
 
# File 'msk/cfn_cluster_props.rb', line 91

def current_version
  @current_version
end

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

Includes all encryption-related information.

Returns:

See Also:



96
97
98
 
# File 'msk/cfn_cluster_props.rb', line 96

def encryption_info
  @encryption_info
end

#enhanced_monitoring ⇒ String? (readonly)

Specifies the level of monitoring for the MSK cluster.

Returns:

  • (String, nil)

See Also:



101
102
103
 
# File 'msk/cfn_cluster_props.rb', line 101

def enhanced_monitoring
  @enhanced_monitoring
end

#kafka_version ⇒ String (readonly)

The version of Apache Kafka.

You can use Amazon MSK to create clusters that use supported Apache Kafka versions .

Returns:

  • (String)

See Also:



73
74
75
 
# File 'msk/cfn_cluster_props.rb', line 73

def kafka_version
  @kafka_version
end

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

Logging info details for the cluster.

Returns:

See Also:



106
107
108
 
# File 'msk/cfn_cluster_props.rb', line 106

def logging_info
  @logging_info
end

#number_of_broker_nodes ⇒ Numeric (readonly)

The number of broker nodes in the cluster.

Returns:

  • (Numeric)

See Also:



78
79
80
 
# File 'msk/cfn_cluster_props.rb', line 78

def number_of_broker_nodes
  @number_of_broker_nodes
end

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

The settings for open monitoring.

Returns:

See Also:



111
112
113
 
# File 'msk/cfn_cluster_props.rb', line 111

def open_monitoring
  @open_monitoring
end

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

Returns:

See Also:



114
115
116
 
# File 'msk/cfn_cluster_props.rb', line 114

def rebalancing
  @rebalancing
end

#storage_mode ⇒ String? (readonly)

This controls storage mode for supported storage tiers.

Returns:

  • (String, nil)

See Also:



119
120
121
 
# File 'msk/cfn_cluster_props.rb', line 119

def storage_mode
  @storage_mode
end

#tags ⇒ Hash{String => String}? (readonly)

An arbitrary set of tags (key-value pairs) for the cluster.

Returns:

  • (Hash{String => String}, nil)

See Also:



124
125
126
 
# File 'msk/cfn_cluster_props.rb', line 124

def tags
  @tags
end

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

Returns:

See Also:



127
128
129
 
# File 'msk/cfn_cluster_props.rb', line 127

def zookeeper_access
  @zookeeper_access
end

Class Method Details

.jsii_properties ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'msk/cfn_cluster_props.rb', line 129

def self.jsii_properties
  {
    :broker_node_group_info => "brokerNodeGroupInfo",
    :cluster_name => "clusterName",
    :kafka_version => "kafkaVersion",
    :number_of_broker_nodes => "numberOfBrokerNodes",
    :client_authentication => "clientAuthentication",
    :configuration_info => "configurationInfo",
    :current_version => "currentVersion",
    :encryption_info => "encryptionInfo",
    :enhanced_monitoring => "enhancedMonitoring",
    :logging_info => "loggingInfo",
    :open_monitoring => "openMonitoring",
    :rebalancing => "rebalancing",
    :storage_mode => "storageMode",
    :tags => "tags",
    :zookeeper_access => "zookeeperAccess",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'msk/cfn_cluster_props.rb', line 149

def to_jsii
  result = {}
  result.merge!({
    "brokerNodeGroupInfo" => @broker_node_group_info,
    "clusterName" => @cluster_name,
    "kafkaVersion" => @kafka_version,
    "numberOfBrokerNodes" => @number_of_broker_nodes,
    "clientAuthentication" => @client_authentication,
    "configurationInfo" => @configuration_info,
    "currentVersion" => @current_version,
    "encryptionInfo" => @encryption_info,
    "enhancedMonitoring" => @enhanced_monitoring,
    "loggingInfo" => @logging_info,
    "openMonitoring" => @open_monitoring,
    "rebalancing" => @rebalancing,
    "storageMode" => @storage_mode,
    "tags" => @tags,
    "zookeeperAccess" => @zookeeper_access,
  })
  result.compact
end