Class Cluster

Manages AWS Managed Streaming for Kafka cluster

Inheritance

System.Object

Resource

CustomResource

Cluster

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Msk

Assembly: Pulumi.Aws.dll

Syntax

public class Cluster : CustomResource

Constructors

Cluster(String, ClusterArgs, CustomResourceOptions)

Create a Cluster resource with the given unique name, arguments, and options.

Declaration

public Cluster(string name, ClusterArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ClusterArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

Amazon Resource Name (ARN) of the MSK Configuration to use in the cluster.

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

BootstrapBrokers

A comma separated list of one or more hostname:port pairs of kafka brokers suitable to boostrap connectivity to the kafka cluster. Only contains value if client_broker encryption in transit is set to PLAINTEXT or TLS_PLAINTEXT.

Declaration

public Output<string> BootstrapBrokers { get; }

Property Value

Type	Description
Output<System.String>

BootstrapBrokersTls

A comma separated list of one or more DNS names (or IPs) and TLS port pairs kafka brokers suitable to boostrap connectivity to the kafka cluster. Only contains value if client_broker encryption in transit is set to TLS_PLAINTEXT or TLS.

Declaration

public Output<string> BootstrapBrokersTls { get; }

Property Value

Type	Description
Output<System.String>

BrokerNodeGroupInfo

Configuration block for the broker nodes of the Kafka cluster.

Declaration

public Output<ClusterBrokerNodeGroupInfo> BrokerNodeGroupInfo { get; }

Property Value

Type	Description
Output<ClusterBrokerNodeGroupInfo>

ClientAuthentication

Configuration block for specifying a client authentication. See below.

Declaration

public Output<ClusterClientAuthentication> ClientAuthentication { get; }

Property Value

Type	Description
Output<ClusterClientAuthentication>

ClusterName

Name of the MSK cluster.

Declaration

public Output<string> ClusterName { get; }

Property Value

Type	Description
Output<System.String>

ConfigurationInfo

Configuration block for specifying a MSK Configuration to attach to Kafka brokers. See below.

Declaration

public Output<ClusterConfigurationInfo> ConfigurationInfo { get; }

Property Value

Type	Description
Output<ClusterConfigurationInfo>

CurrentVersion

Current version of the MSK Cluster used for updates, e.g. K13V1IB3VIYZZH

• encryption_info.0.encryption_at_rest_kms_key_arn - The ARN of the KMS key used for encryption at rest of the broker data volumes.

Declaration

public Output<string> CurrentVersion { get; }

Property Value

Type	Description
Output<System.String>

EncryptionInfo

Configuration block for specifying encryption. See below.

Declaration

public Output<ClusterEncryptionInfo> EncryptionInfo { get; }

Property Value

Type	Description
Output<ClusterEncryptionInfo>

EnhancedMonitoring

Specify the desired enhanced MSK CloudWatch monitoring level. See Monitoring Amazon MSK with Amazon CloudWatch

Declaration

public Output<string> EnhancedMonitoring { get; }

Property Value

Type	Description
Output<System.String>

KafkaVersion

Specify the desired Kafka software version.

Declaration

public Output<string> KafkaVersion { get; }

Property Value

Type	Description
Output<System.String>

LoggingInfo

Configuration block for streaming broker logs to Cloudwatch/S3/Kinesis Firehose. See below.

Declaration

public Output<ClusterLoggingInfo> LoggingInfo { get; }

Property Value

Type	Description
Output<ClusterLoggingInfo>

NumberOfBrokerNodes

The desired total number of broker nodes in the kafka cluster. It must be a multiple of the number of specified client subnets.

Declaration

public Output<int> NumberOfBrokerNodes { get; }

Property Value

Type	Description
Output<System.Int32>

OpenMonitoring

Configuration block for JMX and Node monitoring for the MSK cluster. See below.

Declaration

public Output<ClusterOpenMonitoring> OpenMonitoring { get; }

Property Value

Type	Description
Output<ClusterOpenMonitoring>

Tags

A map of tags to assign to the resource

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

ZookeeperConnectString

A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster.

Declaration

public Output<string> ZookeeperConnectString { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ClusterState, CustomResourceOptions)

Get an existing Cluster resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Cluster Get(string name, Input<string> id, ClusterState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ClusterState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Cluster