aws-native.msk.Cluster
Resource Type definition for AWS::MSK::Cluster
Example Usage
Example
using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;
return await Deployment.RunAsync(() =>
{
var testCluster = new AwsNative.MSK.Cluster("testCluster", new()
{
ClusterName = "ClusterWithRequiredProperties",
KafkaVersion = "2.2.1",
NumberOfBrokerNodes = 3,
BrokerNodeGroupInfo = new AwsNative.MSK.Inputs.ClusterBrokerNodeGroupInfoArgs
{
InstanceType = "kafka.m5.large",
ClientSubnets = new[]
{
"ReplaceWithSubnetId1",
"ReplaceWithSubnetId2",
"ReplaceWithSubnetId3",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws-native/sdk/go/aws/msk"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := msk.NewCluster(ctx, "testCluster", &msk.ClusterArgs{
ClusterName: pulumi.String("ClusterWithRequiredProperties"),
KafkaVersion: pulumi.String("2.2.1"),
NumberOfBrokerNodes: pulumi.Int(3),
BrokerNodeGroupInfo: &msk.ClusterBrokerNodeGroupInfoArgs{
InstanceType: pulumi.String("kafka.m5.large"),
ClientSubnets: pulumi.StringArray{
pulumi.String("ReplaceWithSubnetId1"),
pulumi.String("ReplaceWithSubnetId2"),
pulumi.String("ReplaceWithSubnetId3"),
},
},
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_aws_native as aws_native
test_cluster = aws_native.msk.Cluster("testCluster",
cluster_name="ClusterWithRequiredProperties",
kafka_version="2.2.1",
number_of_broker_nodes=3,
broker_node_group_info=aws_native.msk.ClusterBrokerNodeGroupInfoArgs(
instance_type="kafka.m5.large",
client_subnets=[
"ReplaceWithSubnetId1",
"ReplaceWithSubnetId2",
"ReplaceWithSubnetId3",
],
))
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";
const testCluster = new aws_native.msk.Cluster("testCluster", {
clusterName: "ClusterWithRequiredProperties",
kafkaVersion: "2.2.1",
numberOfBrokerNodes: 3,
brokerNodeGroupInfo: {
instanceType: "kafka.m5.large",
clientSubnets: [
"ReplaceWithSubnetId1",
"ReplaceWithSubnetId2",
"ReplaceWithSubnetId3",
],
},
});
Coming soon!
Example
using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;
return await Deployment.RunAsync(() =>
{
var testCluster = new AwsNative.MSK.Cluster("testCluster", new()
{
ClusterName = "ClusterWithRequiredProperties",
KafkaVersion = "2.2.1",
NumberOfBrokerNodes = 3,
BrokerNodeGroupInfo = new AwsNative.MSK.Inputs.ClusterBrokerNodeGroupInfoArgs
{
InstanceType = "kafka.m5.large",
ClientSubnets = new[]
{
"ReplaceWithSubnetId1",
"ReplaceWithSubnetId2",
"ReplaceWithSubnetId3",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws-native/sdk/go/aws/msk"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := msk.NewCluster(ctx, "testCluster", &msk.ClusterArgs{
ClusterName: pulumi.String("ClusterWithRequiredProperties"),
KafkaVersion: pulumi.String("2.2.1"),
NumberOfBrokerNodes: pulumi.Int(3),
BrokerNodeGroupInfo: &msk.ClusterBrokerNodeGroupInfoArgs{
InstanceType: pulumi.String("kafka.m5.large"),
ClientSubnets: pulumi.StringArray{
pulumi.String("ReplaceWithSubnetId1"),
pulumi.String("ReplaceWithSubnetId2"),
pulumi.String("ReplaceWithSubnetId3"),
},
},
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_aws_native as aws_native
test_cluster = aws_native.msk.Cluster("testCluster",
cluster_name="ClusterWithRequiredProperties",
kafka_version="2.2.1",
number_of_broker_nodes=3,
broker_node_group_info=aws_native.msk.ClusterBrokerNodeGroupInfoArgs(
instance_type="kafka.m5.large",
client_subnets=[
"ReplaceWithSubnetId1",
"ReplaceWithSubnetId2",
"ReplaceWithSubnetId3",
],
))
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";
const testCluster = new aws_native.msk.Cluster("testCluster", {
clusterName: "ClusterWithRequiredProperties",
kafkaVersion: "2.2.1",
numberOfBrokerNodes: 3,
brokerNodeGroupInfo: {
instanceType: "kafka.m5.large",
clientSubnets: [
"ReplaceWithSubnetId1",
"ReplaceWithSubnetId2",
"ReplaceWithSubnetId3",
],
},
});
Coming soon!
Create Cluster Resource
new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
broker_node_group_info: Optional[ClusterBrokerNodeGroupInfoArgs] = None,
client_authentication: Optional[ClusterClientAuthenticationArgs] = None,
cluster_name: Optional[str] = None,
configuration_info: Optional[ClusterConfigurationInfoArgs] = None,
current_version: Optional[str] = None,
encryption_info: Optional[ClusterEncryptionInfoArgs] = None,
enhanced_monitoring: Optional[ClusterEnhancedMonitoring] = None,
kafka_version: Optional[str] = None,
logging_info: Optional[ClusterLoggingInfoArgs] = None,
number_of_broker_nodes: Optional[int] = None,
open_monitoring: Optional[ClusterOpenMonitoringArgs] = None,
storage_mode: Optional[ClusterStorageMode] = None,
tags: Optional[Any] = None)
@overload
def Cluster(resource_name: str,
args: ClusterArgs,
opts: Optional[ResourceOptions] = 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.
- 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
The Cluster resource accepts the following input properties:
- Broker
Node Pulumi.Group Info Aws Native. MSK. Inputs. Cluster Broker Node Group Info Args - Kafka
Version string - Number
Of intBroker Nodes - Client
Authentication Pulumi.Aws Native. MSK. Inputs. Cluster Client Authentication Args - Cluster
Name string - Configuration
Info Pulumi.Aws Native. MSK. Inputs. Cluster Configuration Info Args - Current
Version string The current version of the MSK cluster
- Encryption
Info Pulumi.Aws Native. MSK. Inputs. Cluster Encryption Info Args - Enhanced
Monitoring Pulumi.Aws Native. MSK. Cluster Enhanced Monitoring - Logging
Info Pulumi.Aws Native. MSK. Inputs. Cluster Logging Info Args - Open
Monitoring Pulumi.Aws Native. MSK. Inputs. Cluster Open Monitoring Args - Storage
Mode Pulumi.Aws Native. MSK. Cluster Storage Mode - object
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 - interface{}
A key-value pair to associate with a resource.
- broker
Node ClusterGroup Info Broker Node Group Info Args - kafka
Version String - number
Of IntegerBroker 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 - Object
A key-value pair to associate with a resource.
- broker
Node ClusterGroup Info Broker Node Group Info Args - kafka
Version string - number
Of numberBroker 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 - any
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 - Any
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" - Any
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
ClusterBrokerNodeGroupInfo
- Client
Subnets []string - Instance
Type string - Broker
AZDistribution string - Connectivity
Info ClusterConnectivity Info - Security
Groups []string - Storage
Info ClusterStorage Info
- client
Subnets List<String> - instance
Type String - broker
AZDistribution String - connectivity
Info ClusterConnectivity Info - security
Groups List<String> - storage
Info ClusterStorage Info
- client
Subnets string[] - instance
Type string - broker
AZDistribution string - connectivity
Info ClusterConnectivity Info - security
Groups string[] - storage
Info ClusterStorage Info
- client_
subnets Sequence[str] - instance_
type str - broker_
az_ strdistribution - connectivity_
info ClusterConnectivity Info - security_
groups Sequence[str] - storage_
info ClusterStorage Info
- client
Subnets List<String> - instance
Type String - broker
AZDistribution String - connectivity
Info Property Map - security
Groups List<String> - storage
Info Property Map
ClusterClientAuthentication
ClusterCloudWatchLogs
ClusterConfigurationInfo
ClusterConnectivityInfo
ClusterEBSStorageInfo
ClusterEncryptionAtRest
- Data
Volume stringKMSKey Id
- Data
Volume stringKMSKey Id
- data
Volume StringKMSKey Id
- data
Volume stringKMSKey Id
- data
Volume StringKMSKey Id
ClusterEncryptionInTransit
ClusterEncryptionInTransitClientBroker
- 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
ClusterEnhancedMonitoring
- 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
- 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
- Enabled bool
- Enabled bool
- enabled Boolean
- enabled boolean
- enabled bool
- enabled Boolean
ClusterJmxExporter
- Enabled
In boolBroker
- Enabled
In boolBroker
- enabled
In BooleanBroker
- enabled
In booleanBroker
- enabled_
in_ boolbroker
- enabled
In BooleanBroker
ClusterLoggingInfo
ClusterNodeExporter
- Enabled
In boolBroker
- Enabled
In boolBroker
- enabled
In BooleanBroker
- enabled
In booleanBroker
- enabled_
in_ boolbroker
- enabled
In BooleanBroker
ClusterOpenMonitoring
ClusterPrometheus
ClusterProvisionedThroughput
- 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
- Type string
- Type string
- type String
- type string
- type str
- type String
ClusterS3
ClusterSasl
ClusterScram
- Enabled bool
- Enabled bool
- enabled Boolean
- enabled boolean
- enabled bool
- enabled Boolean
ClusterStorageInfo
ClusterStorageMode
- 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
- List<string>
- Enabled bool
- []string
- Enabled bool
- List<String>
- enabled Boolean
- string[]
- enabled boolean
- Sequence[str]
- enabled bool
- List<String>
- enabled Boolean
ClusterUnauthenticated
- Enabled bool
- Enabled bool
- enabled Boolean
- enabled boolean
- enabled bool
- enabled Boolean
ClusterVpcConnectivity
ClusterVpcConnectivityClientAuthentication
ClusterVpcConnectivityIam
- Enabled bool
- Enabled bool
- enabled Boolean
- enabled boolean
- enabled bool
- enabled Boolean
ClusterVpcConnectivitySasl
ClusterVpcConnectivityScram
- Enabled bool
- Enabled bool
- enabled Boolean
- enabled boolean
- enabled bool
- enabled Boolean
ClusterVpcConnectivityTls
- 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