Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. msk
  5. Cluster

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.msk.Cluster

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::MSK::Cluster

    Create Cluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
    @overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            broker_node_group_info: Optional[ClusterBrokerNodeGroupInfoArgs] = None,
            number_of_broker_nodes: Optional[int] = None,
            kafka_version: Optional[str] = None,
            configuration_info: Optional[ClusterConfigurationInfoArgs] = None,
            current_version: Optional[str] = None,
            encryption_info: Optional[ClusterEncryptionInfoArgs] = None,
            enhanced_monitoring: Optional[ClusterEnhancedMonitoring] = None,
            cluster_name: Optional[str] = None,
            logging_info: Optional[ClusterLoggingInfoArgs] = None,
            client_authentication: Optional[ClusterClientAuthenticationArgs] = None,
            open_monitoring: Optional[ClusterOpenMonitoringArgs] = None,
            storage_mode: Optional[ClusterStorageMode] = None,
            tags: Optional[Mapping[str, str]] = None)
    func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

    type: aws-native:msk:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Cluster Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Cluster resource accepts the following input properties:

    BrokerNodeGroupInfo Pulumi.AwsNative.Msk.Inputs.ClusterBrokerNodeGroupInfo
    Information about the broker nodes in the cluster.
    KafkaVersion string
    The version of Apache Kafka. You can use Amazon MSK to create clusters that use supported Apache Kafka versions .
    NumberOfBrokerNodes int
    The number of broker nodes in the cluster.
    ClientAuthentication Pulumi.AwsNative.Msk.Inputs.ClusterClientAuthentication
    Includes all client authentication related information.
    ClusterName string
    The name of the cluster.
    ConfigurationInfo Pulumi.AwsNative.Msk.Inputs.ClusterConfigurationInfo
    Represents the configuration that you want MSK to use for the cluster.
    CurrentVersion string
    The current version of the MSK cluster
    EncryptionInfo Pulumi.AwsNative.Msk.Inputs.ClusterEncryptionInfo
    Includes all encryption-related information.
    EnhancedMonitoring Pulumi.AwsNative.Msk.ClusterEnhancedMonitoring
    Specifies the level of monitoring for the MSK cluster.
    LoggingInfo Pulumi.AwsNative.Msk.Inputs.ClusterLoggingInfo
    Logging info details for the cluster.
    OpenMonitoring Pulumi.AwsNative.Msk.Inputs.ClusterOpenMonitoring
    The settings for open monitoring.
    StorageMode Pulumi.AwsNative.Msk.ClusterStorageMode
    This controls storage mode for supported storage tiers.
    Tags Dictionary<string, string>
    A key-value pair to associate with a resource.
    BrokerNodeGroupInfo ClusterBrokerNodeGroupInfoArgs
    Information about the broker nodes in the cluster.
    KafkaVersion string
    The version of Apache Kafka. You can use Amazon MSK to create clusters that use supported Apache Kafka versions .
    NumberOfBrokerNodes int
    The number of broker nodes in the cluster.
    ClientAuthentication ClusterClientAuthenticationArgs
    Includes all client authentication related information.
    ClusterName string
    The name of the cluster.
    ConfigurationInfo ClusterConfigurationInfoArgs
    Represents the configuration that you want MSK to use for the cluster.
    CurrentVersion string
    The current version of the MSK cluster
    EncryptionInfo ClusterEncryptionInfoArgs
    Includes all encryption-related information.
    EnhancedMonitoring ClusterEnhancedMonitoring
    Specifies the level of monitoring for the MSK cluster.
    LoggingInfo ClusterLoggingInfoArgs
    Logging info details for the cluster.
    OpenMonitoring ClusterOpenMonitoringArgs
    The settings for open monitoring.
    StorageMode ClusterStorageMode
    This controls storage mode for supported storage tiers.
    Tags map[string]string
    A key-value pair to associate with a resource.
    brokerNodeGroupInfo ClusterBrokerNodeGroupInfo
    Information about the broker nodes in the cluster.
    kafkaVersion String
    The version of Apache Kafka. You can use Amazon MSK to create clusters that use supported Apache Kafka versions .
    numberOfBrokerNodes Integer
    The number of broker nodes in the cluster.
    clientAuthentication ClusterClientAuthentication
    Includes all client authentication related information.
    clusterName String
    The name of the cluster.
    configurationInfo ClusterConfigurationInfo
    Represents the configuration that you want MSK to use for the cluster.
    currentVersion String
    The current version of the MSK cluster
    encryptionInfo ClusterEncryptionInfo
    Includes all encryption-related information.
    enhancedMonitoring ClusterEnhancedMonitoring
    Specifies the level of monitoring for the MSK cluster.
    loggingInfo ClusterLoggingInfo
    Logging info details for the cluster.
    openMonitoring ClusterOpenMonitoring
    The settings for open monitoring.
    storageMode ClusterStorageMode
    This controls storage mode for supported storage tiers.
    tags Map<String,String>
    A key-value pair to associate with a resource.
    brokerNodeGroupInfo ClusterBrokerNodeGroupInfo
    Information about the broker nodes in the cluster.
    kafkaVersion string
    The version of Apache Kafka. You can use Amazon MSK to create clusters that use supported Apache Kafka versions .
    numberOfBrokerNodes number
    The number of broker nodes in the cluster.
    clientAuthentication ClusterClientAuthentication
    Includes all client authentication related information.
    clusterName string
    The name of the cluster.
    configurationInfo ClusterConfigurationInfo
    Represents the configuration that you want MSK to use for the cluster.
    currentVersion string
    The current version of the MSK cluster
    encryptionInfo ClusterEncryptionInfo
    Includes all encryption-related information.
    enhancedMonitoring ClusterEnhancedMonitoring
    Specifies the level of monitoring for the MSK cluster.
    loggingInfo ClusterLoggingInfo
    Logging info details for the cluster.
    openMonitoring ClusterOpenMonitoring
    The settings for open monitoring.
    storageMode ClusterStorageMode
    This controls storage mode for supported storage tiers.
    tags {[key: string]: string}
    A key-value pair to associate with a resource.
    broker_node_group_info ClusterBrokerNodeGroupInfoArgs
    Information about the broker nodes in the cluster.
    kafka_version str
    The version of Apache Kafka. You can use Amazon MSK to create clusters that use supported Apache Kafka versions .
    number_of_broker_nodes int
    The number of broker nodes in the cluster.
    client_authentication ClusterClientAuthenticationArgs
    Includes all client authentication related information.
    cluster_name str
    The name of the cluster.
    configuration_info ClusterConfigurationInfoArgs
    Represents the configuration that you want MSK to use for the cluster.
    current_version str
    The current version of the MSK cluster
    encryption_info ClusterEncryptionInfoArgs
    Includes all encryption-related information.
    enhanced_monitoring ClusterEnhancedMonitoring
    Specifies the level of monitoring for the MSK cluster.
    logging_info ClusterLoggingInfoArgs
    Logging info details for the cluster.
    open_monitoring ClusterOpenMonitoringArgs
    The settings for open monitoring.
    storage_mode ClusterStorageMode
    This controls storage mode for supported storage tiers.
    tags Mapping[str, str]
    A key-value pair to associate with a resource.
    brokerNodeGroupInfo Property Map
    Information about the broker nodes in the cluster.
    kafkaVersion String
    The version of Apache Kafka. You can use Amazon MSK to create clusters that use supported Apache Kafka versions .
    numberOfBrokerNodes Number
    The number of broker nodes in the cluster.
    clientAuthentication Property Map
    Includes all client authentication related information.
    clusterName String
    The name of the cluster.
    configurationInfo Property Map
    Represents the configuration that you want MSK to use for the cluster.
    currentVersion String
    The current version of the MSK cluster
    encryptionInfo Property Map
    Includes all encryption-related information.
    enhancedMonitoring "DEFAULT" | "PER_BROKER" | "PER_TOPIC_PER_BROKER" | "PER_TOPIC_PER_PARTITION"
    Specifies the level of monitoring for the MSK cluster.
    loggingInfo Property Map
    Logging info details for the cluster.
    openMonitoring Property Map
    The settings for open monitoring.
    storageMode "LOCAL" | "TIERED"
    This controls storage mode for supported storage tiers.
    tags Map<String>
    A key-value pair to associate with a resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the MSK cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) of the MSK cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the MSK cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) of the MSK cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) of the MSK cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the MSK cluster.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ClusterBrokerLogs, ClusterBrokerLogsArgs

    ClusterBrokerNodeGroupInfo, ClusterBrokerNodeGroupInfoArgs

    ClientSubnets List<string>

    The list of subnets to connect to in the client virtual private cloud (VPC). Amazon creates elastic network interfaces (ENIs) inside these subnets. Client applications use ENIs 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 .

    InstanceType string
    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, kafka.m5.24xlarge, and kafka.t3.small.
    BrokerAzDistribution string
    This parameter is currently not in use.
    ConnectivityInfo Pulumi.AwsNative.Msk.Inputs.ClusterConnectivityInfo
    Information about the cluster's connectivity setting.
    SecurityGroups List<string>
    The security groups to associate with the ENIs 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.
    StorageInfo Pulumi.AwsNative.Msk.Inputs.ClusterStorageInfo
    Contains information about storage volumes attached to Amazon MSK broker nodes.
    ClientSubnets []string

    The list of subnets to connect to in the client virtual private cloud (VPC). Amazon creates elastic network interfaces (ENIs) inside these subnets. Client applications use ENIs 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 .

    InstanceType string
    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, kafka.m5.24xlarge, and kafka.t3.small.
    BrokerAzDistribution string
    This parameter is currently not in use.
    ConnectivityInfo ClusterConnectivityInfo
    Information about the cluster's connectivity setting.
    SecurityGroups []string
    The security groups to associate with the ENIs 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.
    StorageInfo ClusterStorageInfo
    Contains information about storage volumes attached to Amazon MSK broker nodes.
    clientSubnets List<String>

    The list of subnets to connect to in the client virtual private cloud (VPC). Amazon creates elastic network interfaces (ENIs) inside these subnets. Client applications use ENIs 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 .

    instanceType String
    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, kafka.m5.24xlarge, and kafka.t3.small.
    brokerAzDistribution String
    This parameter is currently not in use.
    connectivityInfo ClusterConnectivityInfo
    Information about the cluster's connectivity setting.
    securityGroups List<String>
    The security groups to associate with the ENIs 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.
    storageInfo ClusterStorageInfo
    Contains information about storage volumes attached to Amazon MSK broker nodes.
    clientSubnets string[]

    The list of subnets to connect to in the client virtual private cloud (VPC). Amazon creates elastic network interfaces (ENIs) inside these subnets. Client applications use ENIs 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 .

    instanceType string
    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, kafka.m5.24xlarge, and kafka.t3.small.
    brokerAzDistribution string
    This parameter is currently not in use.
    connectivityInfo ClusterConnectivityInfo
    Information about the cluster's connectivity setting.
    securityGroups string[]
    The security groups to associate with the ENIs 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.
    storageInfo ClusterStorageInfo
    Contains information about storage volumes attached to Amazon MSK broker nodes.
    client_subnets Sequence[str]

    The list of subnets to connect to in the client virtual private cloud (VPC). Amazon creates elastic network interfaces (ENIs) inside these subnets. Client applications use ENIs 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 .

    instance_type str
    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, kafka.m5.24xlarge, and kafka.t3.small.
    broker_az_distribution str
    This parameter is currently not in use.
    connectivity_info ClusterConnectivityInfo
    Information about the cluster's connectivity setting.
    security_groups Sequence[str]
    The security groups to associate with the ENIs 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.
    storage_info ClusterStorageInfo
    Contains information about storage volumes attached to Amazon MSK broker nodes.
    clientSubnets List<String>

    The list of subnets to connect to in the client virtual private cloud (VPC). Amazon creates elastic network interfaces (ENIs) inside these subnets. Client applications use ENIs 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 .

    instanceType String
    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, kafka.m5.24xlarge, and kafka.t3.small.
    brokerAzDistribution String
    This parameter is currently not in use.
    connectivityInfo Property Map
    Information about the cluster's connectivity setting.
    securityGroups List<String>
    The security groups to associate with the ENIs 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.
    storageInfo Property Map
    Contains information about storage volumes attached to Amazon MSK broker nodes.

    ClusterClientAuthentication, ClusterClientAuthenticationArgs

    ClusterCloudWatchLogs, ClusterCloudWatchLogsArgs

    Enabled bool
    LogGroup string
    Enabled bool
    LogGroup string
    enabled Boolean
    logGroup String
    enabled boolean
    logGroup string
    enabled Boolean
    logGroup String

    ClusterConfigurationInfo, ClusterConfigurationInfoArgs

    Arn string
    Revision int
    Arn string
    Revision int
    arn String
    revision Integer
    arn string
    revision number
    arn str
    revision int
    arn String
    revision Number

    ClusterConnectivityInfo, ClusterConnectivityInfoArgs

    ClusterEbsStorageInfo, ClusterEbsStorageInfoArgs

    ClusterEncryptionAtRest, ClusterEncryptionAtRestArgs

    ClusterEncryptionInTransit, ClusterEncryptionInTransitArgs

    ClientBroker Pulumi.AwsNative.Msk.ClusterEncryptionInTransitClientBroker

    Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values.

    • TLS : Indicates that client-broker communication is enabled with TLS only.
    • TLS_PLAINTEXT : Indicates that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
    • PLAINTEXT : Indicates that client-broker communication is enabled in plaintext only.

    The default value is TLS .

    InCluster bool

    When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

    The default value is true.

    ClientBroker ClusterEncryptionInTransitClientBroker

    Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values.

    • TLS : Indicates that client-broker communication is enabled with TLS only.
    • TLS_PLAINTEXT : Indicates that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
    • PLAINTEXT : Indicates that client-broker communication is enabled in plaintext only.

    The default value is TLS .

    InCluster bool

    When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

    The default value is true.

    clientBroker ClusterEncryptionInTransitClientBroker

    Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values.

    • TLS : Indicates that client-broker communication is enabled with TLS only.
    • TLS_PLAINTEXT : Indicates that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
    • PLAINTEXT : Indicates that client-broker communication is enabled in plaintext only.

    The default value is TLS .

    inCluster Boolean

    When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

    The default value is true.

    clientBroker ClusterEncryptionInTransitClientBroker

    Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values.

    • TLS : Indicates that client-broker communication is enabled with TLS only.
    • TLS_PLAINTEXT : Indicates that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
    • PLAINTEXT : Indicates that client-broker communication is enabled in plaintext only.

    The default value is TLS .

    inCluster boolean

    When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

    The default value is true.

    client_broker ClusterEncryptionInTransitClientBroker

    Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values.

    • TLS : Indicates that client-broker communication is enabled with TLS only.
    • TLS_PLAINTEXT : Indicates that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
    • PLAINTEXT : Indicates that client-broker communication is enabled in plaintext only.

    The default value is TLS .

    in_cluster bool

    When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

    The default value is true.

    clientBroker "TLS" | "TLS_PLAINTEXT" | "PLAINTEXT"

    Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values.

    • TLS : Indicates that client-broker communication is enabled with TLS only.
    • TLS_PLAINTEXT : Indicates that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
    • PLAINTEXT : Indicates that client-broker communication is enabled in plaintext only.

    The default value is TLS .

    inCluster Boolean

    When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

    The default value is true.

    ClusterEncryptionInTransitClientBroker, ClusterEncryptionInTransitClientBrokerArgs

    Tls
    TLS
    TlsPlaintext
    TLS_PLAINTEXT
    Plaintext
    PLAINTEXT
    ClusterEncryptionInTransitClientBrokerTls
    TLS
    ClusterEncryptionInTransitClientBrokerTlsPlaintext
    TLS_PLAINTEXT
    ClusterEncryptionInTransitClientBrokerPlaintext
    PLAINTEXT
    Tls
    TLS
    TlsPlaintext
    TLS_PLAINTEXT
    Plaintext
    PLAINTEXT
    Tls
    TLS
    TlsPlaintext
    TLS_PLAINTEXT
    Plaintext
    PLAINTEXT
    TLS
    TLS
    TLS_PLAINTEXT
    TLS_PLAINTEXT
    PLAINTEXT
    PLAINTEXT
    "TLS"
    TLS
    "TLS_PLAINTEXT"
    TLS_PLAINTEXT
    "PLAINTEXT"
    PLAINTEXT

    ClusterEncryptionInfo, ClusterEncryptionInfoArgs

    encryptionAtRest Property Map
    encryptionInTransit Property Map
    The details for encryption in transit.

    ClusterEnhancedMonitoring, ClusterEnhancedMonitoringArgs

    Default
    DEFAULT
    PerBroker
    PER_BROKER
    PerTopicPerBroker
    PER_TOPIC_PER_BROKER
    PerTopicPerPartition
    PER_TOPIC_PER_PARTITION
    ClusterEnhancedMonitoringDefault
    DEFAULT
    ClusterEnhancedMonitoringPerBroker
    PER_BROKER
    ClusterEnhancedMonitoringPerTopicPerBroker
    PER_TOPIC_PER_BROKER
    ClusterEnhancedMonitoringPerTopicPerPartition
    PER_TOPIC_PER_PARTITION
    Default
    DEFAULT
    PerBroker
    PER_BROKER
    PerTopicPerBroker
    PER_TOPIC_PER_BROKER
    PerTopicPerPartition
    PER_TOPIC_PER_PARTITION
    Default
    DEFAULT
    PerBroker
    PER_BROKER
    PerTopicPerBroker
    PER_TOPIC_PER_BROKER
    PerTopicPerPartition
    PER_TOPIC_PER_PARTITION
    DEFAULT
    DEFAULT
    PER_BROKER
    PER_BROKER
    PER_TOPIC_PER_BROKER
    PER_TOPIC_PER_BROKER
    PER_TOPIC_PER_PARTITION
    PER_TOPIC_PER_PARTITION
    "DEFAULT"
    DEFAULT
    "PER_BROKER"
    PER_BROKER
    "PER_TOPIC_PER_BROKER"
    PER_TOPIC_PER_BROKER
    "PER_TOPIC_PER_PARTITION"
    PER_TOPIC_PER_PARTITION

    ClusterFirehose, ClusterFirehoseArgs

    enabled Boolean
    deliveryStream String
    enabled boolean
    deliveryStream string
    enabled Boolean
    deliveryStream String

    ClusterIam, ClusterIamArgs

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    ClusterJmxExporter, ClusterJmxExporterArgs

    ClusterLoggingInfo, ClusterLoggingInfoArgs

    ClusterNodeExporter, ClusterNodeExporterArgs

    ClusterOpenMonitoring, ClusterOpenMonitoringArgs

    ClusterPrometheus, ClusterPrometheusArgs

    ClusterProvisionedThroughput, ClusterProvisionedThroughputArgs

    enabled Boolean
    volumeThroughput Integer

    ClusterPublicAccess, ClusterPublicAccessArgs

    Type string
    Type string
    type String
    type string
    type str
    type String

    ClusterS3, ClusterS3Args

    Enabled bool
    Bucket string
    Prefix string
    Enabled bool
    Bucket string
    Prefix string
    enabled Boolean
    bucket String
    prefix String
    enabled boolean
    bucket string
    prefix string
    enabled bool
    bucket str
    prefix str
    enabled Boolean
    bucket String
    prefix String

    ClusterSasl, ClusterSaslArgs

    ClusterScram, ClusterScramArgs

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    ClusterStorageInfo, ClusterStorageInfoArgs

    ClusterStorageMode, ClusterStorageModeArgs

    Local
    LOCAL
    Tiered
    TIERED
    ClusterStorageModeLocal
    LOCAL
    ClusterStorageModeTiered
    TIERED
    Local
    LOCAL
    Tiered
    TIERED
    Local
    LOCAL
    Tiered
    TIERED
    LOCAL
    LOCAL
    TIERED
    TIERED
    "LOCAL"
    LOCAL
    "TIERED"
    TIERED

    ClusterTls, ClusterTlsArgs

    ClusterUnauthenticated, ClusterUnauthenticatedArgs

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    ClusterVpcConnectivity, ClusterVpcConnectivityArgs

    ClusterVpcConnectivityClientAuthentication, ClusterVpcConnectivityClientAuthenticationArgs

    ClusterVpcConnectivityIam, ClusterVpcConnectivityIamArgs

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    ClusterVpcConnectivitySasl, ClusterVpcConnectivitySaslArgs

    ClusterVpcConnectivityScram, ClusterVpcConnectivityScramArgs

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    ClusterVpcConnectivityTls, ClusterVpcConnectivityTlsArgs

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native