Module msk

msk

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.
class pulumi_aws.msk.AwaitableGetClusterResult(arn=None, bootstrap_brokers=None, bootstrap_brokers_tls=None, cluster_name=None, kafka_version=None, number_of_broker_nodes=None, tags=None, zookeeper_connect_string=None, id=None)
class pulumi_aws.msk.AwaitableGetConfigurationResult(arn=None, description=None, kafka_versions=None, latest_revision=None, name=None, server_properties=None, id=None)
class pulumi_aws.msk.Cluster(resource_name, opts=None, broker_node_group_info=None, client_authentication=None, cluster_name=None, configuration_info=None, encryption_info=None, enhanced_monitoring=None, kafka_version=None, number_of_broker_nodes=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages AWS Managed Streaming for Kafka cluster

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • broker_node_group_info (pulumi.Input[dict]) – Configuration block for the broker nodes of the Kafka cluster.
  • client_authentication (pulumi.Input[dict]) – Configuration block for specifying a client authentication. See below.
  • cluster_name (pulumi.Input[str]) – Name of the MSK cluster.
  • configuration_info (pulumi.Input[dict]) – Configuration block for specifying a MSK Configuration to attach to Kafka brokers. See below.
  • encryption_info (pulumi.Input[dict]) – Configuration block for specifying encryption. See below.
  • enhanced_monitoring (pulumi.Input[str]) – Specify the desired enhanced MSK CloudWatch monitoring level. See Monitoring Amazon MSK with Amazon CloudWatch
  • kafka_version (pulumi.Input[str]) – Specify the desired Kafka software version.
  • number_of_broker_nodes (pulumi.Input[float]) – The desired total number of broker nodes in the kafka cluster. It must be a multiple of the number of specified client subnets.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource
arn = None

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

bootstrap_brokers = None

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.

bootstrap_brokers_tls = None

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.

broker_node_group_info = None

Configuration block for the broker nodes of the Kafka cluster.

client_authentication = None

Configuration block for specifying a client authentication. See below.

cluster_name = None

Name of the MSK cluster.

configuration_info = None

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

current_version = None

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.
encryption_info = None

Configuration block for specifying encryption. See below.

enhanced_monitoring = None

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

kafka_version = None

Specify the desired Kafka software version.

number_of_broker_nodes = None

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

tags = None

A mapping of tags to assign to the resource

zookeeper_connect_string = None

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

static get(resource_name, id, opts=None, arn=None, bootstrap_brokers=None, bootstrap_brokers_tls=None, broker_node_group_info=None, client_authentication=None, cluster_name=None, configuration_info=None, current_version=None, encryption_info=None, enhanced_monitoring=None, kafka_version=None, number_of_broker_nodes=None, tags=None, zookeeper_connect_string=None)

Get an existing Cluster resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] arn: Amazon Resource Name (ARN) of the MSK Configuration to use in the cluster. :param pulumi.Input[str] bootstrap_brokers: 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. :param pulumi.Input[str] bootstrap_brokers_tls: 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. :param pulumi.Input[dict] broker_node_group_info: Configuration block for the broker nodes of the Kafka cluster. :param pulumi.Input[dict] client_authentication: Configuration block for specifying a client authentication. See below. :param pulumi.Input[str] cluster_name: Name of the MSK cluster. :param pulumi.Input[dict] configuration_info: Configuration block for specifying a MSK Configuration to attach to Kafka brokers. See below. :param pulumi.Input[str] current_version: Current version of the MSK Cluster used for updates, e.g. K13V1IB3VIYZZH

Parameters:
  • encryption_info (pulumi.Input[dict]) – Configuration block for specifying encryption. See below.
  • enhanced_monitoring (pulumi.Input[str]) –

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

  • kafka_version (pulumi.Input[str]) – Specify the desired Kafka software version.
  • number_of_broker_nodes (pulumi.Input[float]) – The desired total number of broker nodes in the kafka cluster. It must be a multiple of the number of specified client subnets.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource
  • zookeeper_connect_string (pulumi.Input[str]) – A comma separated list of one or more IP:port pairs to use to connect to the Apache Zookeeper cluster.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.msk.Configuration(resource_name, opts=None, description=None, kafka_versions=None, name=None, server_properties=None, __props__=None, __name__=None, __opts__=None)

Manages an Amazon Managed Streaming for Kafka configuration. More information can be found on the MSK Developer Guide.

NOTE: The API does not support deleting MSK configurations. Removing this resource will only remove the this provider state for it.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – Description of the configuration.
  • kafka_versions (pulumi.Input[list]) – List of Apache Kafka versions which can use this configuration.
  • name (pulumi.Input[str]) – Name of the configuration.
  • server_properties (pulumi.Input[str]) –

    Contents of the server.properties file. Supported properties are documented in the MSK Developer Guide.

arn = None

Amazon Resource Name (ARN) of the configuration.

description = None

Description of the configuration.

kafka_versions = None

List of Apache Kafka versions which can use this configuration.

latest_revision = None

Latest revision of the configuration.

name = None

Name of the configuration.

server_properties = None

Contents of the server.properties file. Supported properties are documented in the MSK Developer Guide.

static get(resource_name, id, opts=None, arn=None, description=None, kafka_versions=None, latest_revision=None, name=None, server_properties=None)

Get an existing Configuration resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] arn: Amazon Resource Name (ARN) of the configuration. :param pulumi.Input[str] description: Description of the configuration. :param pulumi.Input[list] kafka_versions: List of Apache Kafka versions which can use this configuration. :param pulumi.Input[float] latest_revision: Latest revision of the configuration. :param pulumi.Input[str] name: Name of the configuration. :param pulumi.Input[str] server_properties: Contents of the server.properties file. Supported properties are documented in the MSK Developer Guide.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.msk.GetClusterResult(arn=None, bootstrap_brokers=None, bootstrap_brokers_tls=None, cluster_name=None, kafka_version=None, number_of_broker_nodes=None, tags=None, zookeeper_connect_string=None, id=None)

A collection of values returned by getCluster.

arn = None

Amazon Resource Name (ARN) of the MSK cluster.

bootstrap_brokers = None

A comma separated list of one or more hostname:port pairs of Kafka brokers suitable to boostrap connectivity to the Kafka cluster.

bootstrap_brokers_tls = None

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.

kafka_version = None

Apache Kafka version.

number_of_broker_nodes = None

Number of broker nodes in the cluster.

tags = None

Map of key-value pairs assigned to the cluster.

zookeeper_connect_string = None

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

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.msk.GetConfigurationResult(arn=None, description=None, kafka_versions=None, latest_revision=None, name=None, server_properties=None, id=None)

A collection of values returned by getConfiguration.

arn = None

Amazon Resource Name (ARN) of the configuration.

description = None

Description of the configuration.

kafka_versions = None

List of Apache Kafka versions which can use this configuration.

latest_revision = None

Latest revision of the configuration.

server_properties = None

Contents of the server.properties file.

id = None

id is the provider-assigned unique ID for this managed resource.

pulumi_aws.msk.get_cluster(cluster_name=None, tags=None, opts=None)

Get information on an Amazon MSK Cluster.

pulumi_aws.msk.get_configuration(name=None, opts=None)

Get information on an Amazon MSK Configuration.