msk

package
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 6, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

nolint: lll Package msk exports types, functions, subpackages for provisioning msk resources.

> This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-aws) > distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature, > first check the [`pulumi/pulumi-aws` repo](https://github.com/pulumi/pulumi-aws/issues); however, if that doesn't turn up anything, > please consult the source [`terraform-providers/terraform-provider-aws` repo](https://github.com/terraform-providers/terraform-provider-aws/issues).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Cluster

type Cluster struct {
	// contains filtered or unexported fields
}

Manages AWS Managed Streaming for Kafka cluster

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/msk_cluster.html.markdown.

func GetCluster

func GetCluster(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ClusterState, opts ...pulumi.ResourceOpt) (*Cluster, error)

GetCluster gets an existing Cluster resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCluster

func NewCluster(ctx *pulumi.Context,
	name string, args *ClusterArgs, opts ...pulumi.ResourceOpt) (*Cluster, error)

NewCluster registers a new resource with the given unique name, arguments, and options.

func (*Cluster) Arn

func (r *Cluster) Arn() *pulumi.StringOutput

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

func (*Cluster) BootstrapBrokers

func (r *Cluster) BootstrapBrokers() *pulumi.StringOutput

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 `clientBroker` encryption in transit is set to `PLAINTEXT` or `TLS_PLAINTEXT`.

func (*Cluster) BootstrapBrokersTls added in v0.18.8

func (r *Cluster) BootstrapBrokersTls() *pulumi.StringOutput

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 `clientBroker` encryption in transit is set to `TLS_PLAINTEXT` or `TLS`.

func (*Cluster) BrokerNodeGroupInfo

func (r *Cluster) BrokerNodeGroupInfo() *pulumi.Output

Configuration block for the broker nodes of the Kafka cluster.

func (*Cluster) ClientAuthentication added in v0.18.8

func (r *Cluster) ClientAuthentication() *pulumi.Output

Configuration block for specifying a client authentication. See below.

func (*Cluster) ClusterName

func (r *Cluster) ClusterName() *pulumi.StringOutput

Name of the MSK cluster.

func (*Cluster) ConfigurationInfo added in v0.18.8

func (r *Cluster) ConfigurationInfo() *pulumi.Output

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

func (*Cluster) CurrentVersion added in v0.18.8

func (r *Cluster) CurrentVersion() *pulumi.StringOutput

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.

func (*Cluster) EncryptionInfo

func (r *Cluster) EncryptionInfo() *pulumi.Output

Configuration block for specifying encryption. See below.

func (*Cluster) EnhancedMonitoring

func (r *Cluster) EnhancedMonitoring() *pulumi.StringOutput

Specify the desired enhanced MSK CloudWatch monitoring level. See [Monitoring Amazon MSK with Amazon CloudWatch](https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html)

func (*Cluster) ID

func (r *Cluster) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Cluster) KafkaVersion

func (r *Cluster) KafkaVersion() *pulumi.StringOutput

Specify the desired Kafka software version.

func (*Cluster) NumberOfBrokerNodes

func (r *Cluster) NumberOfBrokerNodes() *pulumi.IntOutput

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

func (*Cluster) Tags

func (r *Cluster) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource

func (*Cluster) URN

func (r *Cluster) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*Cluster) ZookeeperConnectString

func (r *Cluster) ZookeeperConnectString() *pulumi.StringOutput

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

type ClusterArgs

type ClusterArgs struct {
	// Configuration block for the broker nodes of the Kafka cluster.
	BrokerNodeGroupInfo interface{}
	// Configuration block for specifying a client authentication. See below.
	ClientAuthentication interface{}
	// Name of the MSK cluster.
	ClusterName interface{}
	// Configuration block for specifying a MSK Configuration to attach to Kafka brokers. See below.
	ConfigurationInfo interface{}
	// Configuration block for specifying encryption. See below.
	EncryptionInfo interface{}
	// Specify the desired enhanced MSK CloudWatch monitoring level.  See [Monitoring Amazon MSK with Amazon CloudWatch](https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html)
	EnhancedMonitoring interface{}
	// Specify the desired Kafka software version.
	KafkaVersion interface{}
	// The desired total number of broker nodes in the kafka cluster.  It must be a multiple of the number of specified client subnets.
	NumberOfBrokerNodes interface{}
	// A mapping of tags to assign to the resource
	Tags interface{}
}

The set of arguments for constructing a Cluster resource.

type ClusterState

type ClusterState struct {
	// Amazon Resource Name (ARN) of the MSK Configuration to use in the cluster.
	Arn interface{}
	// 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 `clientBroker` encryption in transit is set to `PLAINTEXT` or `TLS_PLAINTEXT`.
	BootstrapBrokers interface{}
	// 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 `clientBroker` encryption in transit is set to `TLS_PLAINTEXT` or `TLS`.
	BootstrapBrokersTls interface{}
	// Configuration block for the broker nodes of the Kafka cluster.
	BrokerNodeGroupInfo interface{}
	// Configuration block for specifying a client authentication. See below.
	ClientAuthentication interface{}
	// Name of the MSK cluster.
	ClusterName interface{}
	// Configuration block for specifying a MSK Configuration to attach to Kafka brokers. See below.
	ConfigurationInfo interface{}
	// 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.
	CurrentVersion interface{}
	// Configuration block for specifying encryption. See below.
	EncryptionInfo interface{}
	// Specify the desired enhanced MSK CloudWatch monitoring level.  See [Monitoring Amazon MSK with Amazon CloudWatch](https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html)
	EnhancedMonitoring interface{}
	// Specify the desired Kafka software version.
	KafkaVersion interface{}
	// The desired total number of broker nodes in the kafka cluster.  It must be a multiple of the number of specified client subnets.
	NumberOfBrokerNodes interface{}
	// A mapping of tags to assign to the resource
	Tags interface{}
	// A comma separated list of one or more IP:port pairs to use to connect to the Apache Zookeeper cluster.
	ZookeeperConnectString interface{}
}

Input properties used for looking up and filtering Cluster resources.

type Configuration

type Configuration struct {
	// contains filtered or unexported fields
}

Manages an Amazon Managed Streaming for Kafka configuration. More information can be found on the [MSK Developer Guide](https://docs.aws.amazon.com/msk/latest/developerguide/msk-configuration.html).

> **NOTE:** The API does not support deleting MSK configurations. Removing this resource will only remove the this provider state for it.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/msk_configuration.html.markdown.

func GetConfiguration

func GetConfiguration(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ConfigurationState, opts ...pulumi.ResourceOpt) (*Configuration, error)

GetConfiguration gets an existing Configuration resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewConfiguration

func NewConfiguration(ctx *pulumi.Context,
	name string, args *ConfigurationArgs, opts ...pulumi.ResourceOpt) (*Configuration, error)

NewConfiguration registers a new resource with the given unique name, arguments, and options.

func (*Configuration) Arn

func (r *Configuration) Arn() *pulumi.StringOutput

Amazon Resource Name (ARN) of the configuration.

func (*Configuration) Description

func (r *Configuration) Description() *pulumi.StringOutput

Description of the configuration.

func (*Configuration) ID

func (r *Configuration) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Configuration) KafkaVersions

func (r *Configuration) KafkaVersions() *pulumi.ArrayOutput

List of Apache Kafka versions which can use this configuration.

func (*Configuration) LatestRevision

func (r *Configuration) LatestRevision() *pulumi.IntOutput

Latest revision of the configuration.

func (*Configuration) Name

func (r *Configuration) Name() *pulumi.StringOutput

Name of the configuration.

func (*Configuration) ServerProperties

func (r *Configuration) ServerProperties() *pulumi.StringOutput

Contents of the server.properties file. Supported properties are documented in the [MSK Developer Guide](https://docs.aws.amazon.com/msk/latest/developerguide/msk-configuration-properties.html).

func (*Configuration) URN

func (r *Configuration) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type ConfigurationArgs

type ConfigurationArgs struct {
	// Description of the configuration.
	Description interface{}
	// List of Apache Kafka versions which can use this configuration.
	KafkaVersions interface{}
	// Name of the configuration.
	Name interface{}
	// Contents of the server.properties file. Supported properties are documented in the [MSK Developer Guide](https://docs.aws.amazon.com/msk/latest/developerguide/msk-configuration-properties.html).
	ServerProperties interface{}
}

The set of arguments for constructing a Configuration resource.

type ConfigurationState

type ConfigurationState struct {
	// Amazon Resource Name (ARN) of the configuration.
	Arn interface{}
	// Description of the configuration.
	Description interface{}
	// List of Apache Kafka versions which can use this configuration.
	KafkaVersions interface{}
	// Latest revision of the configuration.
	LatestRevision interface{}
	// Name of the configuration.
	Name interface{}
	// Contents of the server.properties file. Supported properties are documented in the [MSK Developer Guide](https://docs.aws.amazon.com/msk/latest/developerguide/msk-configuration-properties.html).
	ServerProperties interface{}
}

Input properties used for looking up and filtering Configuration resources.

type GetClusterArgs

type GetClusterArgs struct {
	// Name of the cluster.
	ClusterName interface{}
	Tags        interface{}
}

A collection of arguments for invoking getCluster.

type GetClusterResult

type GetClusterResult struct {
	// Amazon Resource Name (ARN) of the MSK cluster.
	Arn interface{}
	// A comma separated list of one or more hostname:port pairs of Kafka brokers suitable to boostrap connectivity to the Kafka cluster.
	BootstrapBrokers interface{}
	// 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.
	BootstrapBrokersTls interface{}
	ClusterName         interface{}
	// Apache Kafka version.
	KafkaVersion interface{}
	// Number of broker nodes in the cluster.
	NumberOfBrokerNodes interface{}
	// Map of key-value pairs assigned to the cluster.
	Tags interface{}
	// A comma separated list of one or more IP:port pairs to use to connect to the Apache Zookeeper cluster.
	ZookeeperConnectString interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getCluster.

func LookupCluster

func LookupCluster(ctx *pulumi.Context, args *GetClusterArgs) (*GetClusterResult, error)

Get information on an Amazon MSK Cluster.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/msk_cluster.html.markdown.

type GetConfigurationArgs added in v0.18.21

type GetConfigurationArgs struct {
	// Name of the configuration.
	Name interface{}
}

A collection of arguments for invoking getConfiguration.

type GetConfigurationResult added in v0.18.21

type GetConfigurationResult struct {
	// Amazon Resource Name (ARN) of the configuration.
	Arn interface{}
	// Description of the configuration.
	Description interface{}
	// List of Apache Kafka versions which can use this configuration.
	KafkaVersions interface{}
	// Latest revision of the configuration.
	LatestRevision interface{}
	Name           interface{}
	// Contents of the server.properties file.
	ServerProperties interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getConfiguration.

func LookupConfiguration added in v0.18.21

func LookupConfiguration(ctx *pulumi.Context, args *GetConfigurationArgs) (*GetConfigurationResult, error)

Get information on an Amazon MSK Configuration.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/msk_configuration.html.markdown.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL