Package software.amazon.awscdk.services.msk

Interface CfnCluster.BrokerNodeGroupInfoProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCluster.BrokerNodeGroupInfoProperty.Jsii$Proxy

Enclosing class:

CfnCluster

@Stability(Stable)
public static interface CfnCluster.BrokerNodeGroupInfoProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.msk.*;
 BrokerNodeGroupInfoProperty brokerNodeGroupInfoProperty = BrokerNodeGroupInfoProperty.builder()
         .clientSubnets(List.of("clientSubnets"))
         .instanceType("instanceType")
         // the properties below are optional
         .brokerAzDistribution("brokerAzDistribution")
         .connectivityInfo(ConnectivityInfoProperty.builder()
                 .publicAccess(PublicAccessProperty.builder()
                         .type("type")
                         .build())
                 .vpcConnectivity(VpcConnectivityProperty.builder()
                         .clientAuthentication(VpcConnectivityClientAuthenticationProperty.builder()
                                 .sasl(VpcConnectivitySaslProperty.builder()
                                         .iam(VpcConnectivityIamProperty.builder()
                                                 .enabled(false)
                                                 .build())
                                         .scram(VpcConnectivityScramProperty.builder()
                                                 .enabled(false)
                                                 .build())
                                         .build())
                                 .tls(VpcConnectivityTlsProperty.builder()
                                         .enabled(false)
                                         .build())
                                 .build())
                         .build())
                 .build())
         .securityGroups(List.of("securityGroups"))
         .storageInfo(StorageInfoProperty.builder()
                 .ebsStorageInfo(EBSStorageInfoProperty.builder()
                         .provisionedThroughput(ProvisionedThroughputProperty.builder()
                                 .enabled(false)
                                 .volumeThroughput(123)
                                 .build())
                         .volumeSize(123)
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCluster.BrokerNodeGroupInfoProperty.Builder	A builder for CfnCluster.BrokerNodeGroupInfoProperty
static final class	CfnCluster.BrokerNodeGroupInfoProperty.Jsii$Proxy	An implementation for CfnCluster.BrokerNodeGroupInfoProperty

Method Summary

Modifier and Type	Method	Description
static CfnCluster.BrokerNodeGroupInfoProperty.Builder	builder()
default String	getBrokerAzDistribution()	This parameter is currently not in use.
List<String>	getClientSubnets()	The list of subnets to connect to in the client virtual private cloud (VPC).
default Object	getConnectivityInfo()	Information about the cluster's connectivity setting.
String	getInstanceType()	The type of Amazon EC2 instances to use for brokers.
default List<String>	getSecurityGroups()	The security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster.
default Object	getStorageInfo()	Contains information about storage volumes attached to Amazon MSK broker nodes.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClientSubnets

@Stability(Stable)
@NotNull
List<String> getClientSubnets()

The list of subnets to connect to in the client virtual private cloud (VPC).

Amazon creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data.

If you use the US West (N. California) Region, specify exactly two subnets. For other Regions where Amazon MSK is available, you can specify either two or three subnets. The subnets that you specify must be in distinct Availability Zones. When you create a cluster, Amazon MSK distributes the broker nodes evenly across the subnets that you specify.

Client subnets can't occupy the Availability Zone with ID use1-az3 .

getInstanceType

@Stability(Stable)
@NotNull
String getInstanceType()

The type of Amazon EC2 instances to use for brokers.

The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.8xlarge, kafka.m5.12xlarge, kafka.m5.16xlarge, and kafka.m5.24xlarge, and kafka.t3.small.

getBrokerAzDistribution

@Stability(Stable)
@Nullable
default String getBrokerAzDistribution()

This parameter is currently not in use.

getConnectivityInfo

@Stability(Stable)
@Nullable
default Object getConnectivityInfo()

Information about the cluster's connectivity setting.

getSecurityGroups

@Stability(Stable)
@Nullable
default List<String> getSecurityGroups()

The 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.

getStorageInfo

@Stability(Stable)
@Nullable
default Object getStorageInfo()

Contains information about storage volumes attached to Amazon MSK broker nodes.

builder

@Stability(Stable)
static CfnCluster.BrokerNodeGroupInfoProperty.Builder builder()

Returns:

a CfnCluster.BrokerNodeGroupInfoProperty.Builder of CfnCluster.BrokerNodeGroupInfoProperty