Class: AWSCDK::MSK::CfnCluster

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSMSK::IClusterRef
Defined in:
msk/cfn_cluster.rb

Overview

Creates a new MSK cluster.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnCluster

Create a new AWS::MSK::Cluster.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::MSK::CfnClusterProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'msk/cfn_cluster.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::MSK::CfnClusterProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbXNrLkNmbkNsdXN0ZXJQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_cluster(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_cluster(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19tc2suSUNsdXN0ZXJSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_msk.CfnCluster", "arnForCluster", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


194
195
196
 
# File 'msk/cfn_cluster.rb', line 194

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_msk.CfnCluster", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_cluster(x) ⇒ Boolean

Checks whether the given object is a CfnCluster.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_cluster(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_msk.CfnCluster", "isCfnCluster", [x])
end

.jsii_overridable_methods ⇒ Object 



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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'msk/cfn_cluster.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_current_version => { kind: :property, name: "attrCurrentVersion", is_optional: false },
    :cluster_ref => { kind: :property, name: "clusterRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :broker_node_group_info => { kind: :property, name: "brokerNodeGroupInfo", is_optional: false },
    :cluster_name => { kind: :property, name: "clusterName", is_optional: false },
    :kafka_version => { kind: :property, name: "kafkaVersion", is_optional: false },
    :number_of_broker_nodes => { kind: :property, name: "numberOfBrokerNodes", is_optional: false },
    :client_authentication => { kind: :property, name: "clientAuthentication", is_optional: true },
    :configuration_info => { kind: :property, name: "configurationInfo", is_optional: true },
    :current_version => { kind: :property, name: "currentVersion", is_optional: true },
    :encryption_info => { kind: :property, name: "encryptionInfo", is_optional: true },
    :enhanced_monitoring => { kind: :property, name: "enhancedMonitoring", is_optional: true },
    :logging_info => { kind: :property, name: "loggingInfo", is_optional: true },
    :open_monitoring => { kind: :property, name: "openMonitoring", is_optional: true },
    :rebalancing => { kind: :property, name: "rebalancing", is_optional: true },
    :storage_mode => { kind: :property, name: "storageMode", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :zookeeper_access => { kind: :property, name: "zookeeperAccess", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



444
445
446
447
 
# File 'msk/cfn_cluster.rb', line 444

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



456
457
458
459
 
# File 'msk/cfn_cluster.rb', line 456

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



466
467
468
469
 
# File 'msk/cfn_cluster.rb', line 466

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



477
478
479
480
481
 
# File 'msk/cfn_cluster.rb', line 477

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


534
535
536
537
538
 
# File 'msk/cfn_cluster.rb', line 534

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



544
545
546
547
 
# File 'msk/cfn_cluster.rb', line 544

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



556
557
558
559
560
 
# File 'msk/cfn_cluster.rb', line 556

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



569
570
571
572
 
# File 'msk/cfn_cluster.rb', line 569

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



591
592
593
594
595
596
 
# File 'msk/cfn_cluster.rb', line 591

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The Amazon Resource Name (ARN) of the MSK cluster.

Returns:

  • (String) 


201
202
203
 
# File 'msk/cfn_cluster.rb', line 201

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_current_version ⇒ String

The current version of the MSK cluster.

Returns:

  • (String) 


208
209
210
 
# File 'msk/cfn_cluster.rb', line 208

def attr_current_version()
  jsii_get_property("attrCurrentVersion")
end

#broker_node_group_info ⇒ AWSCDK::IResolvable, AWSCDK::MSK::CfnCluster::BrokerNodeGroupInfoProperty

Information about the broker nodes in the cluster.

Returns:



229
230
231
 
# File 'msk/cfn_cluster.rb', line 229

def broker_node_group_info()
  jsii_get_property("brokerNodeGroupInfo")
end

#broker_node_group_info=(value) ⇒ Object 



233
234
235
236
237
 
# File 'msk/cfn_cluster.rb', line 233

def broker_node_group_info=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MSK::CfnCluster::BrokerNodeGroupInfoProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tc2suQ2ZuQ2x1c3Rlci5Ccm9rZXJOb2RlR3JvdXBJbmZvUHJvcGVydHkifV19fQ==")), "brokerNodeGroupInfo")
  jsii_set_property("brokerNodeGroupInfo", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



147
148
149
 
# File 'msk/cfn_cluster.rb', line 147

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


152
153
154
 
# File 'msk/cfn_cluster.rb', line 152

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


600
601
602
603
 
# File 'msk/cfn_cluster.rb', line 600

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


157
158
159
 
# File 'msk/cfn_cluster.rb', line 157

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


164
165
166
 
# File 'msk/cfn_cluster.rb', line 164

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#client_authentication ⇒ AWSCDK::IResolvable, ...

Includes all client authentication related information.

Returns:



278
279
280
 
# File 'msk/cfn_cluster.rb', line 278

def client_authentication()
  jsii_get_property("clientAuthentication")
end

#client_authentication=(value) ⇒ Object 



282
283
284
285
286
 
# File 'msk/cfn_cluster.rb', line 282

def client_authentication=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MSK::CfnCluster::ClientAuthenticationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tc2suQ2ZuQ2x1c3Rlci5DbGllbnRBdXRoZW50aWNhdGlvblByb3BlcnR5In1dfX0=")), "clientAuthentication") unless value.nil?
  jsii_set_property("clientAuthentication", value)
end

#cluster_name ⇒ String

The name of the cluster.

Returns:

  • (String) 


242
243
244
 
# File 'msk/cfn_cluster.rb', line 242

def cluster_name()
  jsii_get_property("clusterName")
end

#cluster_name=(value) ⇒ Object 



246
247
248
249
 
# File 'msk/cfn_cluster.rb', line 246

def cluster_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clusterName")
  jsii_set_property("clusterName", value)
end

#cluster_ref ⇒ AWSCDK::Interfaces::AWSMSK::ClusterReference

A reference to a Cluster resource.

Returns:



215
216
217
 
# File 'msk/cfn_cluster.rb', line 215

def cluster_ref()
  jsii_get_property("clusterRef")
end

#configuration_info ⇒ AWSCDK::IResolvable, ...

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

Returns:



291
292
293
 
# File 'msk/cfn_cluster.rb', line 291

def configuration_info()
  jsii_get_property("configurationInfo")
end

#configuration_info=(value) ⇒ Object 



295
296
297
298
299
 
# File 'msk/cfn_cluster.rb', line 295

def configuration_info=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MSK::CfnCluster::ConfigurationInfoProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tc2suQ2ZuQ2x1c3Rlci5Db25maWd1cmF0aW9uSW5mb1Byb3BlcnR5In1dfX0=")), "configurationInfo") unless value.nil?
  jsii_set_property("configurationInfo", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


109
110
111
 
# File 'msk/cfn_cluster.rb', line 109

def creation_stack()
  jsii_get_property("creationStack")
end

#current_version ⇒ String?

Returns:

  • (String, nil) 


302
303
304
 
# File 'msk/cfn_cluster.rb', line 302

def current_version()
  jsii_get_property("currentVersion")
end

#current_version=(value) ⇒ Object 



306
307
308
309
 
# File 'msk/cfn_cluster.rb', line 306

def current_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "currentVersion") unless value.nil?
  jsii_set_property("currentVersion", value)
end

#encryption_info ⇒ AWSCDK::IResolvable, ...

Includes all encryption-related information.

Returns:



314
315
316
 
# File 'msk/cfn_cluster.rb', line 314

def encryption_info()
  jsii_get_property("encryptionInfo")
end

#encryption_info=(value) ⇒ Object 



318
319
320
321
322
 
# File 'msk/cfn_cluster.rb', line 318

def encryption_info=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MSK::CfnCluster::EncryptionInfoProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tc2suQ2ZuQ2x1c3Rlci5FbmNyeXB0aW9uSW5mb1Byb3BlcnR5In1dfX0=")), "encryptionInfo") unless value.nil?
  jsii_set_property("encryptionInfo", value)
end

#enhanced_monitoring ⇒ String?

Specifies the level of monitoring for the MSK cluster.

Returns:

  • (String, nil) 


327
328
329
 
# File 'msk/cfn_cluster.rb', line 327

def enhanced_monitoring()
  jsii_get_property("enhancedMonitoring")
end

#enhanced_monitoring=(value) ⇒ Object 



331
332
333
334
 
# File 'msk/cfn_cluster.rb', line 331

def enhanced_monitoring=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "enhancedMonitoring") unless value.nil?
  jsii_set_property("enhancedMonitoring", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



169
170
171
 
# File 'msk/cfn_cluster.rb', line 169

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



613
614
615
616
617
 
# File 'msk/cfn_cluster.rb', line 613

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



624
625
626
627
 
# File 'msk/cfn_cluster.rb', line 624

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



694
695
696
697
 
# File 'msk/cfn_cluster.rb', line 694

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#kafka_version ⇒ String

The version of Apache Kafka.

Returns:

  • (String) 


254
255
256
 
# File 'msk/cfn_cluster.rb', line 254

def kafka_version()
  jsii_get_property("kafkaVersion")
end

#kafka_version=(value) ⇒ Object 



258
259
260
261
 
# File 'msk/cfn_cluster.rb', line 258

def kafka_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kafkaVersion")
  jsii_set_property("kafkaVersion", value)
end

#logging_info ⇒ AWSCDK::IResolvable, ...

Logging info details for the cluster.

Returns:



339
340
341
 
# File 'msk/cfn_cluster.rb', line 339

def logging_info()
  jsii_get_property("loggingInfo")
end

#logging_info=(value) ⇒ Object 



343
344
345
346
347
 
# File 'msk/cfn_cluster.rb', line 343

def logging_info=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MSK::CfnCluster::LoggingInfoProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tc2suQ2ZuQ2x1c3Rlci5Mb2dnaW5nSW5mb1Byb3BlcnR5In1dfX0=")), "loggingInfo") unless value.nil?
  jsii_set_property("loggingInfo", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


121
122
123
 
# File 'msk/cfn_cluster.rb', line 121

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


104
105
106
 
# File 'msk/cfn_cluster.rb', line 104

def node()
  jsii_get_property("node")
end

#number_of_broker_nodes ⇒ Numeric

The number of broker nodes in the cluster.

Returns:

  • (Numeric) 


266
267
268
 
# File 'msk/cfn_cluster.rb', line 266

def number_of_broker_nodes()
  jsii_get_property("numberOfBrokerNodes")
end

#number_of_broker_nodes=(value) ⇒ Object 



270
271
272
273
 
# File 'msk/cfn_cluster.rb', line 270

def number_of_broker_nodes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "numberOfBrokerNodes")
  jsii_set_property("numberOfBrokerNodes", value)
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



635
636
637
 
# File 'msk/cfn_cluster.rb', line 635

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



642
643
644
 
# File 'msk/cfn_cluster.rb', line 642

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#open_monitoring ⇒ AWSCDK::IResolvable, ...

The settings for open monitoring.

Returns:



352
353
354
 
# File 'msk/cfn_cluster.rb', line 352

def open_monitoring()
  jsii_get_property("openMonitoring")
end

#open_monitoring=(value) ⇒ Object 



356
357
358
359
360
 
# File 'msk/cfn_cluster.rb', line 356

def open_monitoring=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MSK::CfnCluster::OpenMonitoringProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tc2suQ2ZuQ2x1c3Rlci5PcGVuTW9uaXRvcmluZ1Byb3BlcnR5In1dfX0=")), "openMonitoring") unless value.nil?
  jsii_set_property("openMonitoring", value)
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



435
436
437
438
 
# File 'msk/cfn_cluster.rb', line 435

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#rebalancing ⇒ AWSCDK::IResolvable, ...

Returns:



363
364
365
 
# File 'msk/cfn_cluster.rb', line 363

def rebalancing()
  jsii_get_property("rebalancing")
end

#rebalancing=(value) ⇒ Object 



367
368
369
370
371
 
# File 'msk/cfn_cluster.rb', line 367

def rebalancing=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MSK::CfnCluster::RebalancingProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tc2suQ2ZuQ2x1c3Rlci5SZWJhbGFuY2luZ1Byb3BlcnR5In1dfX0=")), "rebalancing") unless value.nil?
  jsii_set_property("rebalancing", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


140
141
142
 
# File 'msk/cfn_cluster.rb', line 140

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



653
654
655
656
 
# File 'msk/cfn_cluster.rb', line 653

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


660
661
662
663
 
# File 'msk/cfn_cluster.rb', line 660

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



670
671
672
673
674
 
# File 'msk/cfn_cluster.rb', line 670

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



679
680
681
 
# File 'msk/cfn_cluster.rb', line 679

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



130
131
132
 
# File 'msk/cfn_cluster.rb', line 130

def stack()
  jsii_get_property("stack")
end

#storage_mode ⇒ String?

This controls storage mode for supported storage tiers.

Returns:

  • (String, nil) 


376
377
378
 
# File 'msk/cfn_cluster.rb', line 376

def storage_mode()
  jsii_get_property("storageMode")
end

#storage_mode=(value) ⇒ Object 



380
381
382
383
 
# File 'msk/cfn_cluster.rb', line 380

def storage_mode=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "storageMode") unless value.nil?
  jsii_set_property("storageMode", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



222
223
224
 
# File 'msk/cfn_cluster.rb', line 222

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Hash{String => String}?

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

Returns:

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


388
389
390
 
# File 'msk/cfn_cluster.rb', line 388

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



392
393
394
395
 
# File 'msk/cfn_cluster.rb', line 392

def tags_raw=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



411
412
413
 
# File 'msk/cfn_cluster.rb', line 411

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


177
178
179
 
# File 'msk/cfn_cluster.rb', line 177

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


187
188
189
 
# File 'msk/cfn_cluster.rb', line 187

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


685
686
687
688
 
# File 'msk/cfn_cluster.rb', line 685

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


424
425
426
427
428
429
 
# File 'msk/cfn_cluster.rb', line 424

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end

#zookeeper_access ⇒ AWSCDK::IResolvable, ...

Returns:



398
399
400
 
# File 'msk/cfn_cluster.rb', line 398

def zookeeper_access()
  jsii_get_property("zookeeperAccess")
end

#zookeeper_access=(value) ⇒ Object 



402
403
404
405
406
 
# File 'msk/cfn_cluster.rb', line 402

def zookeeper_access=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MSK::CfnCluster::ZookeeperAccessProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tc2suQ2ZuQ2x1c3Rlci5ab29rZWVwZXJBY2Nlc3NQcm9wZXJ0eSJ9XX19")), "zookeeperAccess") unless value.nil?
  jsii_set_property("zookeeperAccess", value)
end