Documentation

Overview

A Pulumi package for creating and managing Kafka.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Acl

type Acl struct {
	pulumi.CustomResourceState

	// Host from which principal listed in `aclPrincipal`
	// will have access.
	AclHost pulumi.StringOutput `pulumi:"aclHost"`
	// Operation that is being allowed or denied. Valid
	// values are `Unknown`, `Any`, `All`, `Read`, `Write`, `Create`, `Delete`, `Alter`,
	// `Describe`, `ClusterAction`, `DescribeConfigs`, `AlterConfigs`, `IdempotentWrite`.
	AclOperation pulumi.StringOutput `pulumi:"aclOperation"`
	// Type of permission. Valid values are `Unknown`,
	// `Any`, `Allow`, `Deny`.
	AclPermissionType pulumi.StringOutput `pulumi:"aclPermissionType"`
	// Principal that is being allowed or denied.
	AclPrincipal pulumi.StringOutput `pulumi:"aclPrincipal"`
	// The name of the resource.
	AclResourceName pulumi.StringOutput `pulumi:"aclResourceName"`
	// The type of resource. Valid values are `Unknown`,
	// `Any`, `Topic`, `Group`, `Cluster`, `TransactionalID`.
	AclResourceType pulumi.StringOutput `pulumi:"aclResourceType"`
	// The pattern filter. Valid values
	// are `Prefixed`, `Any`, `Match`, `Literal`.
	ResourcePatternTypeFilter pulumi.StringPtrOutput `pulumi:"resourcePatternTypeFilter"`
}

A resource for managing Kafka ACLs.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-kafka/sdk/v2/go/kafka"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

)

func main() {

pulumi.Run(func(ctx *pulumi.Context) error {
	_, err := kafka.NewAcl(ctx, "test", &kafka.AclArgs{
		AclResourceName:   pulumi.String("syslog"),
		AclResourceType:   pulumi.String("Topic"),
		AclPrincipal:      pulumi.String("User:Alice"),
		AclHost:           pulumi.String("*"),
		AclOperation:      pulumi.String("Write"),
		AclPermissionType: pulumi.String("Deny"),
	})
	if err != nil {
		return err
	}
	return nil
})

} ```

func GetAcl

func GetAcl(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AclState, opts ...pulumi.ResourceOption) (*Acl, error)

GetAcl gets an existing Acl 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 NewAcl

func NewAcl(ctx *pulumi.Context,
	name string, args *AclArgs, opts ...pulumi.ResourceOption) (*Acl, error)

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

func (Acl) ElementType

func (Acl) ElementType() reflect.Type

func (Acl) ToAclOutput

func (i Acl) ToAclOutput() AclOutput

func (Acl) ToAclOutputWithContext

func (i Acl) ToAclOutputWithContext(ctx context.Context) AclOutput

type AclArgs

type AclArgs struct {
	// Host from which principal listed in `aclPrincipal`
	// will have access.
	AclHost pulumi.StringInput
	// Operation that is being allowed or denied. Valid
	// values are `Unknown`, `Any`, `All`, `Read`, `Write`, `Create`, `Delete`, `Alter`,
	// `Describe`, `ClusterAction`, `DescribeConfigs`, `AlterConfigs`, `IdempotentWrite`.
	AclOperation pulumi.StringInput
	// Type of permission. Valid values are `Unknown`,
	// `Any`, `Allow`, `Deny`.
	AclPermissionType pulumi.StringInput
	// Principal that is being allowed or denied.
	AclPrincipal pulumi.StringInput
	// The name of the resource.
	AclResourceName pulumi.StringInput
	// The type of resource. Valid values are `Unknown`,
	// `Any`, `Topic`, `Group`, `Cluster`, `TransactionalID`.
	AclResourceType pulumi.StringInput
	// The pattern filter. Valid values
	// are `Prefixed`, `Any`, `Match`, `Literal`.
	ResourcePatternTypeFilter pulumi.StringPtrInput
}

The set of arguments for constructing a Acl resource.

func (AclArgs) ElementType

func (AclArgs) ElementType() reflect.Type

type AclInput

type AclInput interface {
	pulumi.Input

	ToAclOutput() AclOutput
	ToAclOutputWithContext(ctx context.Context) AclOutput
}

type AclOutput

type AclOutput struct {
	*pulumi.OutputState
}

func (AclOutput) ElementType

func (AclOutput) ElementType() reflect.Type

func (AclOutput) ToAclOutput

func (o AclOutput) ToAclOutput() AclOutput

func (AclOutput) ToAclOutputWithContext

func (o AclOutput) ToAclOutputWithContext(ctx context.Context) AclOutput

type AclState

type AclState struct {
	// Host from which principal listed in `aclPrincipal`
	// will have access.
	AclHost pulumi.StringPtrInput
	// Operation that is being allowed or denied. Valid
	// values are `Unknown`, `Any`, `All`, `Read`, `Write`, `Create`, `Delete`, `Alter`,
	// `Describe`, `ClusterAction`, `DescribeConfigs`, `AlterConfigs`, `IdempotentWrite`.
	AclOperation pulumi.StringPtrInput
	// Type of permission. Valid values are `Unknown`,
	// `Any`, `Allow`, `Deny`.
	AclPermissionType pulumi.StringPtrInput
	// Principal that is being allowed or denied.
	AclPrincipal pulumi.StringPtrInput
	// The name of the resource.
	AclResourceName pulumi.StringPtrInput
	// The type of resource. Valid values are `Unknown`,
	// `Any`, `Topic`, `Group`, `Cluster`, `TransactionalID`.
	AclResourceType pulumi.StringPtrInput
	// The pattern filter. Valid values
	// are `Prefixed`, `Any`, `Match`, `Literal`.
	ResourcePatternTypeFilter pulumi.StringPtrInput
}

func (AclState) ElementType

func (AclState) ElementType() reflect.Type

type Provider

type Provider struct {
	pulumi.ProviderResourceState
}

The provider type for the kafka package. By default, resources use package-wide configuration settings, however an explicit `Provider` instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.

func NewProvider

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

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

func (Provider) ElementType

func (Provider) ElementType() reflect.Type

func (Provider) ToProviderOutput

func (i Provider) ToProviderOutput() ProviderOutput

func (Provider) ToProviderOutputWithContext

func (i Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type ProviderArgs

type ProviderArgs struct {
	// A list of kafka brokers
	BootstrapServers pulumi.StringArrayInput
	// CA certificate file to validate the server's certificate.
	CaCert pulumi.StringPtrInput
	// Path to a CA certificate file to validate the server's certificate.
	//
	// Deprecated: This parameter is now deprecated and will be removed in a later release, please use `ca_cert` instead.
	CaCertFile pulumi.StringPtrInput
	// The client certificate.
	ClientCert pulumi.StringPtrInput
	// Path to a file containing the client certificate.
	//
	// Deprecated: This parameter is now deprecated and will be removed in a later release, please use `client_cert` instead.
	ClientCertFile pulumi.StringPtrInput
	// The private key that the certificate was issued for.
	ClientKey pulumi.StringPtrInput
	// Path to a file containing the private key that the certificate was issued for.
	//
	// Deprecated: This parameter is now deprecated and will be removed in a later release, please use `client_key` instead.
	ClientKeyFile pulumi.StringPtrInput
	// The passphrase for the private key that the certificate was issued for.
	ClientKeyPassphrase pulumi.StringPtrInput
	// SASL mechanism, can be plain, scram-sha512, scram-sha256
	SaslMechanism pulumi.StringPtrInput
	// Password for SASL authentication.
	SaslPassword pulumi.StringPtrInput
	// Username for SASL authentication.
	SaslUsername pulumi.StringPtrInput
	// Set this to true only if the target Kafka server is an insecure development instance.
	SkipTlsVerify pulumi.BoolPtrInput
	// Timeout in seconds
	Timeout pulumi.IntPtrInput
	// Enable communication with the Kafka Cluster over TLS.
	TlsEnabled pulumi.BoolPtrInput
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType

func (ProviderArgs) ElementType() reflect.Type

type ProviderInput

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput

type ProviderOutput struct {
	*pulumi.OutputState
}

func (ProviderOutput) ElementType

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) ToProviderOutput

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type Topic

type Topic struct {
	pulumi.CustomResourceState

	// A map of string k/v attributes.
	Config pulumi.MapOutput `pulumi:"config"`
	// The name of the topic.
	Name pulumi.StringOutput `pulumi:"name"`
	// The number of partitions the topic should have.
	Partitions pulumi.IntOutput `pulumi:"partitions"`
	// The number of replicas the topic should have.
	ReplicationFactor pulumi.IntOutput `pulumi:"replicationFactor"`
}

A resource for managing Kafka topics. Increases partition count without destroying the topic.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-kafka/sdk/v2/go/kafka"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

)

func main() {

pulumi.Run(func(ctx *pulumi.Context) error {
	_, err := kafka.NewTopic(ctx, "logs", &kafka.TopicArgs{
		Config: pulumi.StringMap{
			"cleanup.policy": pulumi.String("compact"),
			"segment.ms":     pulumi.String("20000"),
		},
		Partitions:        pulumi.Int(100),
		ReplicationFactor: pulumi.Int(2),
	})
	if err != nil {
		return err
	}
	return nil
})

} ```

## Import

Topics can be imported using their ARN, e.g.

```sh

$ pulumi import kafka:index/topic:Topic logs systemd_logs

```

func GetTopic

func GetTopic(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *TopicState, opts ...pulumi.ResourceOption) (*Topic, error)

GetTopic gets an existing Topic 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 NewTopic

func NewTopic(ctx *pulumi.Context,
	name string, args *TopicArgs, opts ...pulumi.ResourceOption) (*Topic, error)

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

func (Topic) ElementType

func (Topic) ElementType() reflect.Type

func (Topic) ToTopicOutput

func (i Topic) ToTopicOutput() TopicOutput

func (Topic) ToTopicOutputWithContext

func (i Topic) ToTopicOutputWithContext(ctx context.Context) TopicOutput

type TopicArgs

type TopicArgs struct {
	// A map of string k/v attributes.
	Config pulumi.MapInput
	// The name of the topic.
	Name pulumi.StringPtrInput
	// The number of partitions the topic should have.
	Partitions pulumi.IntInput
	// The number of replicas the topic should have.
	ReplicationFactor pulumi.IntInput
}

The set of arguments for constructing a Topic resource.

func (TopicArgs) ElementType

func (TopicArgs) ElementType() reflect.Type

type TopicInput

type TopicInput interface {
	pulumi.Input

	ToTopicOutput() TopicOutput
	ToTopicOutputWithContext(ctx context.Context) TopicOutput
}

type TopicOutput

type TopicOutput struct {
	*pulumi.OutputState
}

func (TopicOutput) ElementType

func (TopicOutput) ElementType() reflect.Type

func (TopicOutput) ToTopicOutput

func (o TopicOutput) ToTopicOutput() TopicOutput

func (TopicOutput) ToTopicOutputWithContext

func (o TopicOutput) ToTopicOutputWithContext(ctx context.Context) TopicOutput

type TopicState

type TopicState struct {
	// A map of string k/v attributes.
	Config pulumi.MapInput
	// The name of the topic.
	Name pulumi.StringPtrInput
	// The number of partitions the topic should have.
	Partitions pulumi.IntPtrInput
	// The number of replicas the topic should have.
	ReplicationFactor pulumi.IntPtrInput
}

func (TopicState) ElementType

func (TopicState) ElementType() reflect.Type

Directories

Path Synopsis
config