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:

Outputs

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

Arn string
Id string

The provider-assigned unique ID for this managed resource.

Arn string
Id string

The provider-assigned unique ID for this managed resource.

arn String
id String

The provider-assigned unique ID for this managed resource.

arn string
id string

The provider-assigned unique ID for this managed resource.

arn str
id str

The provider-assigned unique ID for this managed resource.

arn String
id String

The provider-assigned unique ID for this managed resource.

Supporting Types

ClusterBrokerLogs

ClusterBrokerNodeGroupInfo

ClusterClientAuthentication

ClusterCloudWatchLogs

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

ClusterConfigurationInfo

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

ClusterEBSStorageInfo

ClusterEncryptionAtRest

ClusterEncryptionInTransit

ClusterEncryptionInTransitClientBroker

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

ClusterEnhancedMonitoring

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

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

ClusterIam

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

ClusterJmxExporter

ClusterLoggingInfo

ClusterNodeExporter

ClusterOpenMonitoring

ClusterPrometheus

ClusterProvisionedThroughput

enabled Boolean
volumeThroughput Integer

ClusterPublicAccess

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

ClusterS3

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

ClusterScram

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

ClusterStorageInfo

ClusterStorageMode

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

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
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0