Class: Aws::Kafka::Types::ProvisionedRequest

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 ProvisionedRequest 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: {
        provisioned_throughput: {
          enabled: false,
          volume_throughput: 1,
        },
        volume_size: 1,
      },
    },
    connectivity_info: {
      public_access: {
        type: "__string",
      },
    },
  },
  client_authentication: {
    sasl: {
      scram: {
        enabled: false,
      },
      iam: {
        enabled: false,
      },
    },
    tls: {
      certificate_authority_arn_list: ["__string"],
      enabled: false,
    },
    unauthenticated: {
      enabled: false,
    },
  },
  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
  open_monitoring: {
    prometheus: { # required
      jmx_exporter: {
        enabled_in_broker: false, # required
      },
      node_exporter: {
        enabled_in_broker: false, # required
      },
    },
  },
  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
}

Creates a provisioned cluster.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#broker_node_group_infoTypes::BrokerNodeGroupInfo

Information about the brokers.



2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2191

class ProvisionedRequest < Struct.new(
  :broker_node_group_info,
  :client_authentication,
  :configuration_info,
  :encryption_info,
  :enhanced_monitoring,
  :open_monitoring,
  :kafka_version,
  :logging_info,
  :number_of_broker_nodes)
  SENSITIVE = []
  include Aws::Structure
end

#client_authenticationTypes::ClientAuthentication

Includes all client authentication related information.



2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2191

class ProvisionedRequest < Struct.new(
  :broker_node_group_info,
  :client_authentication,
  :configuration_info,
  :encryption_info,
  :enhanced_monitoring,
  :open_monitoring,
  :kafka_version,
  :logging_info,
  :number_of_broker_nodes)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_infoTypes::ConfigurationInfo

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



2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2191

class ProvisionedRequest < Struct.new(
  :broker_node_group_info,
  :client_authentication,
  :configuration_info,
  :encryption_info,
  :enhanced_monitoring,
  :open_monitoring,
  :kafka_version,
  :logging_info,
  :number_of_broker_nodes)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_infoTypes::EncryptionInfo

Includes all encryption-related information.



2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2191

class ProvisionedRequest < Struct.new(
  :broker_node_group_info,
  :client_authentication,
  :configuration_info,
  :encryption_info,
  :enhanced_monitoring,
  :open_monitoring,
  :kafka_version,
  :logging_info,
  :number_of_broker_nodes)
  SENSITIVE = []
  include Aws::Structure
end

#enhanced_monitoringString

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.

Returns:

  • (String)


2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2191

class ProvisionedRequest < Struct.new(
  :broker_node_group_info,
  :client_authentication,
  :configuration_info,
  :encryption_info,
  :enhanced_monitoring,
  :open_monitoring,
  :kafka_version,
  :logging_info,
  :number_of_broker_nodes)
  SENSITIVE = []
  include Aws::Structure
end

#kafka_versionString

The Apache Kafka version that you want for the cluster.

Returns:

  • (String)


2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2191

class ProvisionedRequest < Struct.new(
  :broker_node_group_info,
  :client_authentication,
  :configuration_info,
  :encryption_info,
  :enhanced_monitoring,
  :open_monitoring,
  :kafka_version,
  :logging_info,
  :number_of_broker_nodes)
  SENSITIVE = []
  include Aws::Structure
end

#logging_infoTypes::LoggingInfo

LoggingInfo details.

Returns:



2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2191

class ProvisionedRequest < Struct.new(
  :broker_node_group_info,
  :client_authentication,
  :configuration_info,
  :encryption_info,
  :enhanced_monitoring,
  :open_monitoring,
  :kafka_version,
  :logging_info,
  :number_of_broker_nodes)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_broker_nodesInteger

The number of brokers in the cluster.

Returns:

  • (Integer)


2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2191

class ProvisionedRequest < Struct.new(
  :broker_node_group_info,
  :client_authentication,
  :configuration_info,
  :encryption_info,
  :enhanced_monitoring,
  :open_monitoring,
  :kafka_version,
  :logging_info,
  :number_of_broker_nodes)
  SENSITIVE = []
  include Aws::Structure
end

#open_monitoringTypes::OpenMonitoringInfo

The settings for open monitoring.



2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2191

class ProvisionedRequest < Struct.new(
  :broker_node_group_info,
  :client_authentication,
  :configuration_info,
  :encryption_info,
  :enhanced_monitoring,
  :open_monitoring,
  :kafka_version,
  :logging_info,
  :number_of_broker_nodes)
  SENSITIVE = []
  include Aws::Structure
end