You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Kafka::Types::CreateClusterRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb

Overview

Note:

When making an API call, you may pass CreateClusterRequest data as a hash:

{
  broker_node_group_info: { # required
    broker_az_distribution: "DEFAULT", # accepts DEFAULT
    client_subnets: ["__string"], # required
    instance_type: "__stringMin5Max32", # required
    security_groups: ["__string"],
    storage_info: {
      ebs_storage_info: {
        volume_size: 1,
      },
    },
  },
  client_authentication: {
    tls: {
      certificate_authority_arn_list: ["__string"],
    },
  },
  cluster_name: "__stringMin1Max64", # required
  configuration_info: {
    arn: "__string", # required
    revision: 1, # required
  },
  encryption_info: {
    encryption_at_rest: {
      data_volume_kms_key_id: "__string", # required
    },
    encryption_in_transit: {
      client_broker: "TLS", # accepts TLS, TLS_PLAINTEXT, PLAINTEXT
      in_cluster: false,
    },
  },
  enhanced_monitoring: "DEFAULT", # accepts DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER
  kafka_version: "__stringMin1Max128", # required
  number_of_broker_nodes: 1, # required
  tags: {
    "__string" => "__string",
  },
}

Creates a cluster.

Instance Attribute Summary collapse

Instance Attribute Details

#broker_node_group_infoTypes::BrokerNodeGroupInfo

Information about the broker nodes in the cluster.



535
536
537
538
539
540
541
542
543
544
545
546
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 535

class CreateClusterRequest < Struct.new(
  :broker_node_group_info,
  :client_authentication,
  :cluster_name,
  :configuration_info,
  :encryption_info,
  :enhanced_monitoring,
  :kafka_version,
  :number_of_broker_nodes,
  :tags)
  include Aws::Structure
end

#client_authenticationTypes::ClientAuthentication

Includes all client authentication related information.



535
536
537
538
539
540
541
542
543
544
545
546
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 535

class CreateClusterRequest < Struct.new(
  :broker_node_group_info,
  :client_authentication,
  :cluster_name,
  :configuration_info,
  :encryption_info,
  :enhanced_monitoring,
  :kafka_version,
  :number_of_broker_nodes,
  :tags)
  include Aws::Structure
end

#cluster_nameString

The name of the cluster.

Returns:

  • (String)


535
536
537
538
539
540
541
542
543
544
545
546
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 535

class CreateClusterRequest < Struct.new(
  :broker_node_group_info,
  :client_authentication,
  :cluster_name,
  :configuration_info,
  :encryption_info,
  :enhanced_monitoring,
  :kafka_version,
  :number_of_broker_nodes,
  :tags)
  include Aws::Structure
end

#configuration_infoTypes::ConfigurationInfo

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



535
536
537
538
539
540
541
542
543
544
545
546
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 535

class CreateClusterRequest < Struct.new(
  :broker_node_group_info,
  :client_authentication,
  :cluster_name,
  :configuration_info,
  :encryption_info,
  :enhanced_monitoring,
  :kafka_version,
  :number_of_broker_nodes,
  :tags)
  include Aws::Structure
end

#encryption_infoTypes::EncryptionInfo

Includes all encryption-related information.



535
536
537
538
539
540
541
542
543
544
545
546
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 535

class CreateClusterRequest < Struct.new(
  :broker_node_group_info,
  :client_authentication,
  :cluster_name,
  :configuration_info,
  :encryption_info,
  :enhanced_monitoring,
  :kafka_version,
  :number_of_broker_nodes,
  :tags)
  include Aws::Structure
end

#enhanced_monitoringString

Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER.

Returns:

  • (String)


535
536
537
538
539
540
541
542
543
544
545
546
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 535

class CreateClusterRequest < Struct.new(
  :broker_node_group_info,
  :client_authentication,
  :cluster_name,
  :configuration_info,
  :encryption_info,
  :enhanced_monitoring,
  :kafka_version,
  :number_of_broker_nodes,
  :tags)
  include Aws::Structure
end

#kafka_versionString

The version of Apache Kafka.

Returns:

  • (String)


535
536
537
538
539
540
541
542
543
544
545
546
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 535

class CreateClusterRequest < Struct.new(
  :broker_node_group_info,
  :client_authentication,
  :cluster_name,
  :configuration_info,
  :encryption_info,
  :enhanced_monitoring,
  :kafka_version,
  :number_of_broker_nodes,
  :tags)
  include Aws::Structure
end

#number_of_broker_nodesInteger

The number of Kafka broker nodes in the Amazon MSK cluster.

Returns:

  • (Integer)


535
536
537
538
539
540
541
542
543
544
545
546
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 535

class CreateClusterRequest < Struct.new(
  :broker_node_group_info,
  :client_authentication,
  :cluster_name,
  :configuration_info,
  :encryption_info,
  :enhanced_monitoring,
  :kafka_version,
  :number_of_broker_nodes,
  :tags)
  include Aws::Structure
end

#tagsHash<String,String>

Create tags when creating the cluster.

Returns:

  • (Hash<String,String>)


535
536
537
538
539
540
541
542
543
544
545
546
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 535

class CreateClusterRequest < Struct.new(
  :broker_node_group_info,
  :client_authentication,
  :cluster_name,
  :configuration_info,
  :encryption_info,
  :enhanced_monitoring,
  :kafka_version,
  :number_of_broker_nodes,
  :tags)
  include Aws::Structure
end