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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateClusterRequest as input to an Aws::Client method, you can use a vanilla 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: {
    sasl: {
      scram: {
        enabled: false,
      },
    },
    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, PER_TOPIC_PER_PARTITION
  kafka_version: "__stringMin1Max128", # required
  logging_info: {
    broker_logs: { # required
      cloud_watch_logs: {
        enabled: false, # required
        log_group: "__string",
      },
      firehose: {
        delivery_stream: "__string",
        enabled: false, # required
      },
      s3: {
        bucket: "__string",
        enabled: false, # required
        prefix: "__string",
      },
    },
  },
  number_of_broker_nodes: 1, # required
  open_monitoring: {
    prometheus: { # required
      jmx_exporter: {
        enabled_in_broker: false, # required
      },
      node_exporter: {
        enabled_in_broker: false, # required
      },
    },
  },
  tags: {
    "__string" => "__string",
  },
}

Creates a cluster.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#broker_node_group_info ⇒ Types::BrokerNodeGroupInfo

Information about the broker nodes in the cluster.

Returns:

#client_authentication ⇒ Types::ClientAuthentication

Includes all client authentication related information.

Returns:

#cluster_name ⇒ String

The name of the cluster.

Returns:

  • (String) —

    The name of the cluster.

#configuration_info ⇒ Types::ConfigurationInfo

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

Returns:

#encryption_info ⇒ Types::EncryptionInfo

Includes all encryption-related information.

Returns:

#enhanced_monitoring ⇒ String

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

Possible values:

  • DEFAULT
  • PER_BROKER
  • PER_TOPIC_PER_BROKER
  • PER_TOPIC_PER_PARTITION

Returns:

  • (String) —

    Specifies the level of monitoring for the MSK cluster.

#kafka_version ⇒ String

The version of Apache Kafka.

Returns:

  • (String) —

    The version of Apache Kafka.

#logging_info ⇒ Types::LoggingInfo

LoggingInfo details.

Returns:

#number_of_broker_nodes ⇒ Integer

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

Returns:

  • (Integer) —

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

#open_monitoring ⇒ Types::OpenMonitoringInfo

The settings for open monitoring.

Returns:

#tags ⇒ Hash<String,String>

Create tags when creating the cluster.

Returns:

  • (Hash<String,String>) —

    Create tags when creating the cluster.