Class: Aws::Kafka::Types::BrokerNodeGroupInfo

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 BrokerNodeGroupInfo data as a hash:

{
  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",
    },
  },
}

Describes the setup to be used for Apache Kafka broker nodes in the cluster.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#broker_az_distribution ⇒ String

The distribution of broker nodes across Availability Zones.

Returns:

  • (String) 


221
222
223
224
225
226
227
228
229
230
 
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 221

class BrokerNodeGroupInfo < Struct.new(
  :broker_az_distribution,
  :client_subnets,
  :instance_type,
  :security_groups,
  :storage_info,
  :connectivity_info)
  SENSITIVE = []
  include Aws::Structure
end

#client_subnets ⇒ Array<String>

The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't occupy the Availability Zone with ID use use1-az3.

Returns:

  • (Array<String>) 


221
222
223
224
225
226
227
228
229
230
 
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 221

class BrokerNodeGroupInfo < Struct.new(
  :broker_az_distribution,
  :client_subnets,
  :instance_type,
  :security_groups,
  :storage_info,
  :connectivity_info)
  SENSITIVE = []
  include Aws::Structure
end

#connectivity_info ⇒ Types::ConnectivityInfo

Information about the broker access configuration.

Returns:



221
222
223
224
225
226
227
228
229
230
 
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 221

class BrokerNodeGroupInfo < Struct.new(
  :broker_az_distribution,
  :client_subnets,
  :instance_type,
  :security_groups,
  :storage_info,
  :connectivity_info)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ String

The type of broker used in the Amazon MSK cluster.

Returns:

  • (String) 


221
222
223
224
225
226
227
228
229
230
 
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 221

class BrokerNodeGroupInfo < Struct.new(
  :broker_az_distribution,
  :client_subnets,
  :instance_type,
  :security_groups,
  :storage_info,
  :connectivity_info)
  SENSITIVE = []
  include Aws::Structure
end

#security_groups ⇒ Array<String>

The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC. If you specify security groups that were shared with you, you must ensure that you have permissions to them. Specifically, you need the ec2:DescribeSecurityGroups permission.

Returns:

  • (Array<String>) 


221
222
223
224
225
226
227
228
229
230
 
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 221

class BrokerNodeGroupInfo < Struct.new(
  :broker_az_distribution,
  :client_subnets,
  :instance_type,
  :security_groups,
  :storage_info,
  :connectivity_info)
  SENSITIVE = []
  include Aws::Structure
end

#storage_info ⇒ Types::StorageInfo

Contains information about storage volumes attached to MSK broker nodes.

Returns:



221
222
223
224
225
226
227
228
229
230
 
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 221

class BrokerNodeGroupInfo < Struct.new(
  :broker_az_distribution,
  :client_subnets,
  :instance_type,
  :security_groups,
  :storage_info,
  :connectivity_info)
  SENSITIVE = []
  include Aws::Structure
end