Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kafka.Types.BrokerNodeGroupInfo

Description

Documentation

data BrokerNodeGroupInfo Source #

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

See: newBrokerNodeGroupInfo smart constructor.

Constructors

BrokerNodeGroupInfo'

Fields

brokerAZDistribution :: Maybe BrokerAZDistribution
The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.
Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.
connectivityInfo :: Maybe ConnectivityInfo
Information about the broker access configuration.
securityGroups :: Maybe [Text]
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.
storageInfo :: Maybe StorageInfo
Contains information about storage volumes attached to MSK broker nodes.
clientSubnets :: [Text]
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.
instanceType :: Text
The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

Instances

Instances details

FromJSON BrokerNodeGroupInfo Source #
Instance details Defined in Amazonka.Kafka.Types.BrokerNodeGroupInfo Methods parseJSON :: Value -> Parser BrokerNodeGroupInfo # parseJSONList :: Value -> Parser [BrokerNodeGroupInfo] #
ToJSON BrokerNodeGroupInfo Source #
Instance details Defined in Amazonka.Kafka.Types.BrokerNodeGroupInfo Methods toJSON :: BrokerNodeGroupInfo -> Value # toEncoding :: BrokerNodeGroupInfo -> Encoding # toJSONList :: [BrokerNodeGroupInfo] -> Value # toEncodingList :: [BrokerNodeGroupInfo] -> Encoding #
Generic BrokerNodeGroupInfo Source #
Instance details Defined in Amazonka.Kafka.Types.BrokerNodeGroupInfo Associated Types type Rep BrokerNodeGroupInfo :: Type -> Type # Methods from :: BrokerNodeGroupInfo -> Rep BrokerNodeGroupInfo x # to :: Rep BrokerNodeGroupInfo x -> BrokerNodeGroupInfo #
Read BrokerNodeGroupInfo Source #
Instance details Defined in Amazonka.Kafka.Types.BrokerNodeGroupInfo Methods readsPrec :: Int -> ReadS BrokerNodeGroupInfo # readList :: ReadS [BrokerNodeGroupInfo] # readPrec :: ReadPrec BrokerNodeGroupInfo # readListPrec :: ReadPrec [BrokerNodeGroupInfo] #
Show BrokerNodeGroupInfo Source #
Instance details Defined in Amazonka.Kafka.Types.BrokerNodeGroupInfo Methods showsPrec :: Int -> BrokerNodeGroupInfo -> ShowS # show :: BrokerNodeGroupInfo -> String # showList :: [BrokerNodeGroupInfo] -> ShowS #
NFData BrokerNodeGroupInfo Source #
Instance details Defined in Amazonka.Kafka.Types.BrokerNodeGroupInfo Methods rnf :: BrokerNodeGroupInfo -> () #
Eq BrokerNodeGroupInfo Source #
Instance details Defined in Amazonka.Kafka.Types.BrokerNodeGroupInfo Methods (==) :: BrokerNodeGroupInfo -> BrokerNodeGroupInfo -> Bool # (/=) :: BrokerNodeGroupInfo -> BrokerNodeGroupInfo -> Bool #
Hashable BrokerNodeGroupInfo Source #
Instance details Defined in Amazonka.Kafka.Types.BrokerNodeGroupInfo Methods hashWithSalt :: Int -> BrokerNodeGroupInfo -> Int # hash :: BrokerNodeGroupInfo -> Int #
type Rep BrokerNodeGroupInfo Source #
Instance details Defined in Amazonka.Kafka.Types.BrokerNodeGroupInfo type Rep BrokerNodeGroupInfo = D1 ('MetaData "BrokerNodeGroupInfo" "Amazonka.Kafka.Types.BrokerNodeGroupInfo" "amazonka-kafka-2.0-Go9aKmtSH8zJub8xGjzkib" 'False) (C1 ('MetaCons "BrokerNodeGroupInfo'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "brokerAZDistribution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BrokerAZDistribution)) :: (S1 ('MetaSel ('Just "connectivityInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectivityInfo)) :: S1 ('MetaSel ('Just "securityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 ('MetaSel ('Just "storageInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StorageInfo)) :: (S1 ('MetaSel ('Just "clientSubnets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newBrokerNodeGroupInfo Source #

Arguments

:: Text	`$sel:instanceType:BrokerNodeGroupInfo'`
-> BrokerNodeGroupInfo

Create a value of BrokerNodeGroupInfo with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:brokerAZDistribution:BrokerNodeGroupInfo', brokerNodeGroupInfo_brokerAZDistribution - The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.

Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.

$sel:connectivityInfo:BrokerNodeGroupInfo', brokerNodeGroupInfo_connectivityInfo - Information about the broker access configuration.

$sel:securityGroups:BrokerNodeGroupInfo', brokerNodeGroupInfo_securityGroups - 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.

$sel:storageInfo:BrokerNodeGroupInfo', brokerNodeGroupInfo_storageInfo - Contains information about storage volumes attached to MSK broker nodes.

$sel:clientSubnets:BrokerNodeGroupInfo', brokerNodeGroupInfo_clientSubnets - 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.

$sel:instanceType:BrokerNodeGroupInfo', brokerNodeGroupInfo_instanceType - The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

brokerNodeGroupInfo_brokerAZDistribution :: Lens' BrokerNodeGroupInfo (Maybe BrokerAZDistribution) Source #

The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.

Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.

brokerNodeGroupInfo_connectivityInfo :: Lens' BrokerNodeGroupInfo (Maybe ConnectivityInfo) Source #

Information about the broker access configuration.

brokerNodeGroupInfo_securityGroups :: Lens' BrokerNodeGroupInfo (Maybe [Text]) Source #

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.

brokerNodeGroupInfo_storageInfo :: Lens' BrokerNodeGroupInfo (Maybe StorageInfo) Source #

Contains information about storage volumes attached to MSK broker nodes.

brokerNodeGroupInfo_clientSubnets :: Lens' BrokerNodeGroupInfo [Text] Source #

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.

brokerNodeGroupInfo_instanceType :: Lens' BrokerNodeGroupInfo Text Source #

The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.