We recommend new projects start with resources from the AWS provider.
aws-native.msk.Cluster
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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:
- Broker
Node Pulumi.Group Info Aws Native. Msk. Inputs. Cluster Broker Node Group Info - Kafka
Version string - Number
Of intBroker Nodes - Client
Authentication Pulumi.Aws Native. Msk. Inputs. Cluster Client Authentication - Cluster
Name string - Configuration
Info Pulumi.Aws Native. Msk. Inputs. Cluster Configuration Info - Current
Version string - The current version of the MSK cluster
- Encryption
Info Pulumi.Aws Native. Msk. Inputs. Cluster Encryption Info - Enhanced
Monitoring Pulumi.Aws Native. Msk. Cluster Enhanced Monitoring - Logging
Info Pulumi.Aws Native. Msk. Inputs. Cluster Logging Info - Open
Monitoring Pulumi.Aws Native. Msk. Inputs. Cluster Open Monitoring - Storage
Mode Pulumi.Aws Native. Msk. Cluster Storage Mode - Dictionary<string, string>
- A key-value pair to associate with a resource.
- Broker
Node ClusterGroup Info Broker Node Group Info Args - Kafka
Version string - Number
Of intBroker Nodes - Client
Authentication ClusterClient Authentication Args - Cluster
Name string - Configuration
Info ClusterConfiguration Info Args - Current
Version string - The current version of the MSK cluster
- Encryption
Info ClusterEncryption Info Args - Enhanced
Monitoring ClusterEnhanced Monitoring - Logging
Info ClusterLogging Info Args - Open
Monitoring ClusterOpen Monitoring Args - Storage
Mode ClusterStorage Mode - map[string]string
- A key-value pair to associate with a resource.
- broker
Node ClusterGroup Info Broker Node Group Info - kafka
Version String - number
Of IntegerBroker Nodes - client
Authentication ClusterClient Authentication - cluster
Name String - configuration
Info ClusterConfiguration Info - current
Version String - The current version of the MSK cluster
- encryption
Info ClusterEncryption Info - enhanced
Monitoring ClusterEnhanced Monitoring - logging
Info ClusterLogging Info - open
Monitoring ClusterOpen Monitoring - storage
Mode ClusterStorage Mode - Map<String,String>
- A key-value pair to associate with a resource.
- broker
Node ClusterGroup Info Broker Node Group Info - kafka
Version string - number
Of numberBroker Nodes - client
Authentication ClusterClient Authentication - cluster
Name string - configuration
Info ClusterConfiguration Info - current
Version string - The current version of the MSK cluster
- encryption
Info ClusterEncryption Info - enhanced
Monitoring ClusterEnhanced Monitoring - logging
Info ClusterLogging Info - open
Monitoring ClusterOpen Monitoring - storage
Mode ClusterStorage Mode - {[key: string]: string}
- A key-value pair to associate with a resource.
- broker_
node_ Clustergroup_ info Broker Node Group Info Args - kafka_
version str - number_
of_ intbroker_ nodes - client_
authentication ClusterClient Authentication Args - cluster_
name str - configuration_
info ClusterConfiguration Info Args - current_
version str - The current version of the MSK cluster
- encryption_
info ClusterEncryption Info Args - enhanced_
monitoring ClusterEnhanced Monitoring - logging_
info ClusterLogging Info Args - open_
monitoring ClusterOpen Monitoring Args - storage_
mode ClusterStorage Mode - Mapping[str, str]
- A key-value pair to associate with a resource.
- broker
Node Property MapGroup Info - kafka
Version String - number
Of NumberBroker Nodes - client
Authentication Property Map - cluster
Name String - configuration
Info Property Map - current
Version String - The current version of the MSK cluster
- encryption
Info Property Map - enhanced
Monitoring "DEFAULT" | "PER_BROKER" | "PER_TOPIC_PER_BROKER" | "PER_TOPIC_PER_PARTITION" - logging
Info Property Map - open
Monitoring Property Map - storage
Mode "LOCAL" | "TIERED" - 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:
Supporting Types
ClusterBrokerLogs, ClusterBrokerLogsArgs
ClusterBrokerNodeGroupInfo, ClusterBrokerNodeGroupInfoArgs
- Client
Subnets List<string> - Instance
Type 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.
- Broker
Az stringDistribution - Connectivity
Info Pulumi.Aws Native. Msk. Inputs. Cluster Connectivity Info - Security
Groups List<string> - Storage
Info Pulumi.Aws Native. Msk. Inputs. Cluster Storage Info
- Client
Subnets []string - Instance
Type 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.
- Broker
Az stringDistribution - Connectivity
Info ClusterConnectivity Info - Security
Groups []string - Storage
Info ClusterStorage Info
- client
Subnets List<String> - instance
Type 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.
- broker
Az StringDistribution - connectivity
Info ClusterConnectivity Info - security
Groups List<String> - storage
Info ClusterStorage Info
- client
Subnets string[] - instance
Type 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.
- broker
Az stringDistribution - connectivity
Info ClusterConnectivity Info - security
Groups string[] - storage
Info ClusterStorage Info
- client_
subnets Sequence[str] - 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_ strdistribution - connectivity_
info ClusterConnectivity Info - security_
groups Sequence[str] - storage_
info ClusterStorage Info
- client
Subnets List<String> - instance
Type 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.
- broker
Az StringDistribution - connectivity
Info Property Map - security
Groups List<String> - storage
Info Property Map
ClusterClientAuthentication, ClusterClientAuthenticationArgs
ClusterCloudWatchLogs, ClusterCloudWatchLogsArgs
ClusterConfigurationInfo, ClusterConfigurationInfoArgs
ClusterConnectivityInfo, ClusterConnectivityInfoArgs
ClusterEbsStorageInfo, ClusterEbsStorageInfoArgs
ClusterEncryptionAtRest, ClusterEncryptionAtRestArgs
- Data
Volume stringKms Key Id
- Data
Volume stringKms Key Id
- data
Volume StringKms Key Id
- data
Volume stringKms Key Id
- data
Volume StringKms Key Id
ClusterEncryptionInTransit, ClusterEncryptionInTransitArgs
ClusterEncryptionInTransitClientBroker, ClusterEncryptionInTransitClientBrokerArgs
- Tls
- TLS
- Tls
Plaintext - TLS_PLAINTEXT
- Plaintext
- PLAINTEXT
- Cluster
Encryption In Transit Client Broker Tls - TLS
- Cluster
Encryption In Transit Client Broker Tls Plaintext - TLS_PLAINTEXT
- Cluster
Encryption In Transit Client Broker Plaintext - PLAINTEXT
- Tls
- TLS
- Tls
Plaintext - TLS_PLAINTEXT
- Plaintext
- PLAINTEXT
- Tls
- TLS
- Tls
Plaintext - TLS_PLAINTEXT
- Plaintext
- PLAINTEXT
- TLS
- TLS
- TLS_PLAINTEXT
- TLS_PLAINTEXT
- PLAINTEXT
- PLAINTEXT
- "TLS"
- TLS
- "TLS_PLAINTEXT"
- TLS_PLAINTEXT
- "PLAINTEXT"
- PLAINTEXT
ClusterEncryptionInfo, ClusterEncryptionInfoArgs
ClusterEnhancedMonitoring, ClusterEnhancedMonitoringArgs
- Default
- DEFAULT
- Per
Broker - PER_BROKER
- Per
Topic Per Broker - PER_TOPIC_PER_BROKER
- Per
Topic Per Partition - PER_TOPIC_PER_PARTITION
- Cluster
Enhanced Monitoring Default - DEFAULT
- Cluster
Enhanced Monitoring Per Broker - PER_BROKER
- Cluster
Enhanced Monitoring Per Topic Per Broker - PER_TOPIC_PER_BROKER
- Cluster
Enhanced Monitoring 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
- 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
- "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 bool
- Delivery
Stream string
- Enabled bool
- Delivery
Stream string
- enabled Boolean
- delivery
Stream String
- enabled boolean
- delivery
Stream string
- enabled bool
- delivery_
stream str
- enabled Boolean
- delivery
Stream String
ClusterIam, ClusterIamArgs
- Enabled bool
- Enabled bool
- enabled Boolean
- enabled boolean
- enabled bool
- enabled Boolean
ClusterJmxExporter, ClusterJmxExporterArgs
- Enabled
In boolBroker
- Enabled
In boolBroker
- enabled
In BooleanBroker
- enabled
In booleanBroker
- enabled_
in_ boolbroker
- enabled
In BooleanBroker
ClusterLoggingInfo, ClusterLoggingInfoArgs
ClusterNodeExporter, ClusterNodeExporterArgs
- Enabled
In boolBroker
- Enabled
In boolBroker
- enabled
In BooleanBroker
- enabled
In booleanBroker
- enabled_
in_ boolbroker
- enabled
In BooleanBroker
ClusterOpenMonitoring, ClusterOpenMonitoringArgs
ClusterPrometheus, ClusterPrometheusArgs
ClusterProvisionedThroughput, ClusterProvisionedThroughputArgs
- Enabled bool
- Volume
Throughput int
- Enabled bool
- Volume
Throughput int
- enabled Boolean
- volume
Throughput Integer
- enabled boolean
- volume
Throughput number
- enabled bool
- volume_
throughput int
- enabled Boolean
- volume
Throughput Number
ClusterPublicAccess, ClusterPublicAccessArgs
- Type string
- Type string
- type String
- type string
- type str
- type String
ClusterS3, ClusterS3Args
ClusterSasl, ClusterSaslArgs
ClusterScram, ClusterScramArgs
- Enabled bool
- Enabled bool
- enabled Boolean
- enabled boolean
- enabled bool
- enabled Boolean
ClusterStorageInfo, ClusterStorageInfoArgs
ClusterStorageMode, ClusterStorageModeArgs
- Local
- LOCAL
- Tiered
- TIERED
- Cluster
Storage Mode Local - LOCAL
- Cluster
Storage Mode Tiered - TIERED
- Local
- LOCAL
- Tiered
- TIERED
- Local
- LOCAL
- Tiered
- TIERED
- LOCAL
- LOCAL
- TIERED
- TIERED
- "LOCAL"
- LOCAL
- "TIERED"
- TIERED
ClusterTls, ClusterTlsArgs
- List<string>
- Enabled bool
- []string
- Enabled bool
- List<String>
- enabled Boolean
- string[]
- enabled boolean
- Sequence[str]
- enabled bool
- List<String>
- enabled Boolean
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
We recommend new projects start with resources from the AWS provider.