kafka

package
v3.9.0 Latest Latest
Warning

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

Go to latest
Published: Mar 9, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

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`. Default `Literal`.
	ResourcePatternTypeFilter pulumi.StringPtrOutput `pulumi:"resourcePatternTypeFilter"`
}

A resource for managing Kafka ACLs.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-kafka/sdk/v3/go/kafka"
"github.com/pulumi/pulumi/sdk/v3/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
	})
}

```

## Import

ACLs can be imported using the following pattern

```sh $ pulumi import kafka:index/acl:Acl test "acl_principal|acl_host|acl_operation|acl_permission_type|resource_type|resource_name|resource_pattern_type_filter" ``` e.g.

```sh $ pulumi import kafka:index/acl:Acl test "User:Alice|*|Write|Deny|Topic|syslog|Prefixed" ```

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`. Default `Literal`.
	ResourcePatternTypeFilter pulumi.StringPtrInput
}

The set of arguments for constructing a Acl resource.

func (AclArgs) ElementType

func (AclArgs) ElementType() reflect.Type

type AclArray

type AclArray []AclInput

func (AclArray) ElementType

func (AclArray) ElementType() reflect.Type

func (AclArray) ToAclArrayOutput

func (i AclArray) ToAclArrayOutput() AclArrayOutput

func (AclArray) ToAclArrayOutputWithContext

func (i AclArray) ToAclArrayOutputWithContext(ctx context.Context) AclArrayOutput

type AclArrayInput

type AclArrayInput interface {
	pulumi.Input

	ToAclArrayOutput() AclArrayOutput
	ToAclArrayOutputWithContext(context.Context) AclArrayOutput
}

AclArrayInput is an input type that accepts AclArray and AclArrayOutput values. You can construct a concrete instance of `AclArrayInput` via:

AclArray{ AclArgs{...} }

type AclArrayOutput

type AclArrayOutput struct{ *pulumi.OutputState }

func (AclArrayOutput) ElementType

func (AclArrayOutput) ElementType() reflect.Type

func (AclArrayOutput) Index

func (AclArrayOutput) ToAclArrayOutput

func (o AclArrayOutput) ToAclArrayOutput() AclArrayOutput

func (AclArrayOutput) ToAclArrayOutputWithContext

func (o AclArrayOutput) ToAclArrayOutputWithContext(ctx context.Context) AclArrayOutput

type AclInput

type AclInput interface {
	pulumi.Input

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

type AclMap

type AclMap map[string]AclInput

func (AclMap) ElementType

func (AclMap) ElementType() reflect.Type

func (AclMap) ToAclMapOutput

func (i AclMap) ToAclMapOutput() AclMapOutput

func (AclMap) ToAclMapOutputWithContext

func (i AclMap) ToAclMapOutputWithContext(ctx context.Context) AclMapOutput

type AclMapInput

type AclMapInput interface {
	pulumi.Input

	ToAclMapOutput() AclMapOutput
	ToAclMapOutputWithContext(context.Context) AclMapOutput
}

AclMapInput is an input type that accepts AclMap and AclMapOutput values. You can construct a concrete instance of `AclMapInput` via:

AclMap{ "key": AclArgs{...} }

type AclMapOutput

type AclMapOutput struct{ *pulumi.OutputState }

func (AclMapOutput) ElementType

func (AclMapOutput) ElementType() reflect.Type

func (AclMapOutput) MapIndex

func (o AclMapOutput) MapIndex(k pulumi.StringInput) AclOutput

func (AclMapOutput) ToAclMapOutput

func (o AclMapOutput) ToAclMapOutput() AclMapOutput

func (AclMapOutput) ToAclMapOutputWithContext

func (o AclMapOutput) ToAclMapOutputWithContext(ctx context.Context) AclMapOutput

type AclOutput

type AclOutput struct{ *pulumi.OutputState }

func (AclOutput) AclHost added in v3.4.0

func (o AclOutput) AclHost() pulumi.StringOutput

Host from which principal listed in `aclPrincipal` will have access.

func (AclOutput) AclOperation added in v3.4.0

func (o AclOutput) AclOperation() pulumi.StringOutput

Operation that is being allowed or denied. Valid values are `Unknown`, `Any`, `All`, `Read`, `Write`, `Create`, `Delete`, `Alter`, `Describe`, `ClusterAction`, `DescribeConfigs`, `AlterConfigs`, `IdempotentWrite`.

func (AclOutput) AclPermissionType added in v3.4.0

func (o AclOutput) AclPermissionType() pulumi.StringOutput

Type of permission. Valid values are `Unknown`, `Any`, `Allow`, `Deny`.

func (AclOutput) AclPrincipal added in v3.4.0

func (o AclOutput) AclPrincipal() pulumi.StringOutput

Principal that is being allowed or denied.

func (AclOutput) AclResourceName added in v3.4.0

func (o AclOutput) AclResourceName() pulumi.StringOutput

The name of the resource.

func (AclOutput) AclResourceType added in v3.4.0

func (o AclOutput) AclResourceType() pulumi.StringOutput

The type of resource. Valid values are `Unknown`, `Any`, `Topic`, `Group`, `Cluster`, `TransactionalID`.

func (AclOutput) ElementType

func (AclOutput) ElementType() reflect.Type

func (AclOutput) ResourcePatternTypeFilter added in v3.4.0

func (o AclOutput) ResourcePatternTypeFilter() pulumi.StringPtrOutput

The pattern filter. Valid values are `Prefixed`, `Any`, `Match`, `Literal`. Default `Literal`.

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`. Default `Literal`.
	ResourcePatternTypeFilter pulumi.StringPtrInput
}

func (AclState) ElementType

func (AclState) ElementType() reflect.Type

type LookupTopicArgs added in v3.1.1

type LookupTopicArgs struct {
	Name string `pulumi:"name"`
}

A collection of arguments for invoking getTopic.

type LookupTopicOutputArgs added in v3.1.1

type LookupTopicOutputArgs struct {
	Name pulumi.StringInput `pulumi:"name"`
}

A collection of arguments for invoking getTopic.

func (LookupTopicOutputArgs) ElementType added in v3.1.1

func (LookupTopicOutputArgs) ElementType() reflect.Type

type LookupTopicResult added in v3.1.1

type LookupTopicResult struct {
	Config map[string]string `pulumi:"config"`
	// The provider-assigned unique ID for this managed resource.
	Id                string `pulumi:"id"`
	Name              string `pulumi:"name"`
	Partitions        int    `pulumi:"partitions"`
	ReplicationFactor int    `pulumi:"replicationFactor"`
}

A collection of values returned by getTopic.

func LookupTopic added in v3.1.1

func LookupTopic(ctx *pulumi.Context, args *LookupTopicArgs, opts ...pulumi.InvokeOption) (*LookupTopicResult, error)

type LookupTopicResultOutput added in v3.1.1

type LookupTopicResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getTopic.

func LookupTopicOutput added in v3.1.1

func LookupTopicOutput(ctx *pulumi.Context, args LookupTopicOutputArgs, opts ...pulumi.InvokeOption) LookupTopicResultOutput

func (LookupTopicResultOutput) Config added in v3.1.1

func (LookupTopicResultOutput) ElementType added in v3.1.1

func (LookupTopicResultOutput) ElementType() reflect.Type

func (LookupTopicResultOutput) Id added in v3.1.1

The provider-assigned unique ID for this managed resource.

func (LookupTopicResultOutput) Name added in v3.1.1

func (LookupTopicResultOutput) Partitions added in v3.1.1

func (o LookupTopicResultOutput) Partitions() pulumi.IntOutput

func (LookupTopicResultOutput) ReplicationFactor added in v3.1.1

func (o LookupTopicResultOutput) ReplicationFactor() pulumi.IntOutput

func (LookupTopicResultOutput) ToLookupTopicResultOutput added in v3.1.1

func (o LookupTopicResultOutput) ToLookupTopicResultOutput() LookupTopicResultOutput

func (LookupTopicResultOutput) ToLookupTopicResultOutputWithContext added in v3.1.1

func (o LookupTopicResultOutput) ToLookupTopicResultOutputWithContext(ctx context.Context) LookupTopicResultOutput

type Provider

type Provider struct {
	pulumi.ProviderResourceState

	// CA certificate file to validate the server's certificate.
	CaCert pulumi.StringPtrOutput `pulumi:"caCert"`
	// 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 `caCert` instead.
	CaCertFile pulumi.StringPtrOutput `pulumi:"caCertFile"`
	// The client certificate.
	ClientCert pulumi.StringPtrOutput `pulumi:"clientCert"`
	// Path to a file containing the client certificate.
	//
	// Deprecated: This parameter is now deprecated and will be removed in a later release, please use `clientCert` instead.
	ClientCertFile pulumi.StringPtrOutput `pulumi:"clientCertFile"`
	// The private key that the certificate was issued for.
	ClientKey pulumi.StringPtrOutput `pulumi:"clientKey"`
	// 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 `clientKey` instead.
	ClientKeyFile pulumi.StringPtrOutput `pulumi:"clientKeyFile"`
	// The passphrase for the private key that the certificate was issued for.
	ClientKeyPassphrase pulumi.StringPtrOutput `pulumi:"clientKeyPassphrase"`
	// The version of Kafka protocol to use in `$MAJOR.$MINOR.$PATCH` format. Some features may not be available on older
	// versions. Default is 2.7.0.
	KafkaVersion pulumi.StringPtrOutput `pulumi:"kafkaVersion"`
	// The AWS access key.
	SaslAwsAccessKey pulumi.StringPtrOutput `pulumi:"saslAwsAccessKey"`
	// Path to a file containing the AWS pod identity authorization token
	SaslAwsContainerAuthorizationTokenFile pulumi.StringPtrOutput `pulumi:"saslAwsContainerAuthorizationTokenFile"`
	// URI to retrieve AWS credentials from
	SaslAwsContainerCredentialsFullUri pulumi.StringPtrOutput `pulumi:"saslAwsContainerCredentialsFullUri"`
	// AWS profile name to use
	SaslAwsProfile pulumi.StringPtrOutput `pulumi:"saslAwsProfile"`
	// AWS region where MSK is deployed.
	SaslAwsRegion pulumi.StringPtrOutput `pulumi:"saslAwsRegion"`
	// Arn of an AWS IAM role to assume
	SaslAwsRoleArn pulumi.StringPtrOutput `pulumi:"saslAwsRoleArn"`
	// The AWS secret key.
	SaslAwsSecretKey pulumi.StringPtrOutput `pulumi:"saslAwsSecretKey"`
	// The AWS session token. Only required if you are using temporary security credentials.
	SaslAwsToken pulumi.StringPtrOutput `pulumi:"saslAwsToken"`
	// SASL mechanism, can be plain, scram-sha512, scram-sha256, aws-iam
	SaslMechanism pulumi.StringPtrOutput `pulumi:"saslMechanism"`
	// Password for SASL authentication.
	SaslPassword pulumi.StringPtrOutput `pulumi:"saslPassword"`
	// The url to retrieve oauth2 tokens from, when using sasl mechanism oauthbearer
	SaslTokenUrl pulumi.StringPtrOutput `pulumi:"saslTokenUrl"`
	// Username for SASL authentication.
	SaslUsername pulumi.StringPtrOutput `pulumi:"saslUsername"`
}

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 `caCert` 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 `clientCert` 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 `clientKey` instead.
	ClientKeyFile pulumi.StringPtrInput
	// The passphrase for the private key that the certificate was issued for.
	ClientKeyPassphrase pulumi.StringPtrInput
	// The version of Kafka protocol to use in `$MAJOR.$MINOR.$PATCH` format. Some features may not be available on older
	// versions. Default is 2.7.0.
	KafkaVersion pulumi.StringPtrInput
	// The AWS access key.
	SaslAwsAccessKey pulumi.StringPtrInput
	// Path to a file containing the AWS pod identity authorization token
	SaslAwsContainerAuthorizationTokenFile pulumi.StringPtrInput
	// URI to retrieve AWS credentials from
	SaslAwsContainerCredentialsFullUri pulumi.StringPtrInput
	// Set this to true to turn AWS credentials debug.
	SaslAwsCredsDebug pulumi.BoolPtrInput
	// AWS profile name to use
	SaslAwsProfile pulumi.StringPtrInput
	// AWS region where MSK is deployed.
	SaslAwsRegion pulumi.StringPtrInput
	// Arn of an AWS IAM role to assume
	SaslAwsRoleArn pulumi.StringPtrInput
	// The AWS secret key.
	SaslAwsSecretKey pulumi.StringPtrInput
	// The AWS session token. Only required if you are using temporary security credentials.
	SaslAwsToken pulumi.StringPtrInput
	// SASL mechanism, can be plain, scram-sha512, scram-sha256, aws-iam
	SaslMechanism pulumi.StringPtrInput
	// Password for SASL authentication.
	SaslPassword pulumi.StringPtrInput
	// The url to retrieve oauth2 tokens from, when using sasl mechanism oauthbearer
	SaslTokenUrl 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) CaCert added in v3.4.0

CA certificate file to validate the server's certificate.

func (ProviderOutput) CaCertFile deprecated added in v3.4.0

func (o ProviderOutput) CaCertFile() pulumi.StringPtrOutput

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 `caCert` instead.

func (ProviderOutput) ClientCert added in v3.4.0

func (o ProviderOutput) ClientCert() pulumi.StringPtrOutput

The client certificate.

func (ProviderOutput) ClientCertFile deprecated added in v3.4.0

func (o ProviderOutput) ClientCertFile() pulumi.StringPtrOutput

Path to a file containing the client certificate.

Deprecated: This parameter is now deprecated and will be removed in a later release, please use `clientCert` instead.

func (ProviderOutput) ClientKey added in v3.4.0

func (o ProviderOutput) ClientKey() pulumi.StringPtrOutput

The private key that the certificate was issued for.

func (ProviderOutput) ClientKeyFile deprecated added in v3.4.0

func (o ProviderOutput) ClientKeyFile() pulumi.StringPtrOutput

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 `clientKey` instead.

func (ProviderOutput) ClientKeyPassphrase added in v3.4.0

func (o ProviderOutput) ClientKeyPassphrase() pulumi.StringPtrOutput

The passphrase for the private key that the certificate was issued for.

func (ProviderOutput) ElementType

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) KafkaVersion added in v3.7.1

func (o ProviderOutput) KafkaVersion() pulumi.StringPtrOutput

The version of Kafka protocol to use in `$MAJOR.$MINOR.$PATCH` format. Some features may not be available on older versions. Default is 2.7.0.

func (ProviderOutput) SaslAwsAccessKey added in v3.8.0

func (o ProviderOutput) SaslAwsAccessKey() pulumi.StringPtrOutput

The AWS access key.

func (ProviderOutput) SaslAwsContainerAuthorizationTokenFile added in v3.9.0

func (o ProviderOutput) SaslAwsContainerAuthorizationTokenFile() pulumi.StringPtrOutput

Path to a file containing the AWS pod identity authorization token

func (ProviderOutput) SaslAwsContainerCredentialsFullUri added in v3.9.0

func (o ProviderOutput) SaslAwsContainerCredentialsFullUri() pulumi.StringPtrOutput

URI to retrieve AWS credentials from

func (ProviderOutput) SaslAwsProfile added in v3.7.0

func (o ProviderOutput) SaslAwsProfile() pulumi.StringPtrOutput

AWS profile name to use

func (ProviderOutput) SaslAwsRegion added in v3.6.0

func (o ProviderOutput) SaslAwsRegion() pulumi.StringPtrOutput

AWS region where MSK is deployed.

func (ProviderOutput) SaslAwsRoleArn added in v3.7.0

func (o ProviderOutput) SaslAwsRoleArn() pulumi.StringPtrOutput

Arn of an AWS IAM role to assume

func (ProviderOutput) SaslAwsSecretKey added in v3.8.0

func (o ProviderOutput) SaslAwsSecretKey() pulumi.StringPtrOutput

The AWS secret key.

func (ProviderOutput) SaslAwsToken added in v3.8.0

func (o ProviderOutput) SaslAwsToken() pulumi.StringPtrOutput

The AWS session token. Only required if you are using temporary security credentials.

func (ProviderOutput) SaslMechanism added in v3.4.0

func (o ProviderOutput) SaslMechanism() pulumi.StringPtrOutput

SASL mechanism, can be plain, scram-sha512, scram-sha256, aws-iam

func (ProviderOutput) SaslPassword added in v3.4.0

func (o ProviderOutput) SaslPassword() pulumi.StringPtrOutput

Password for SASL authentication.

func (ProviderOutput) SaslTokenUrl added in v3.7.0

func (o ProviderOutput) SaslTokenUrl() pulumi.StringPtrOutput

The url to retrieve oauth2 tokens from, when using sasl mechanism oauthbearer

func (ProviderOutput) SaslUsername added in v3.4.0

func (o ProviderOutput) SaslUsername() pulumi.StringPtrOutput

Username for SASL authentication.

func (ProviderOutput) ToProviderOutput

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext

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

type Quota added in v3.2.0

type Quota struct {
	pulumi.CustomResourceState

	// A map of string k/v attributes.
	Config pulumi.StringMapOutput `pulumi:"config"`
	// The name of the entity to target.
	EntityName pulumi.StringOutput `pulumi:"entityName"`
	// The type of entity. Valid values are `client-id`, `user`, `ip`.
	EntityType pulumi.StringOutput `pulumi:"entityType"`
}

A resource for managing Kafka quotas.

## Example Usage

```go package main

import (

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

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kafka.NewQuota(ctx, "quota", &kafka.QuotaArgs{
			EntityName: pulumi.String("app_consumer"),
			EntityType: pulumi.String("client-id"),
			Config: pulumi.StringMap{
				"consumer_byte_rate": pulumi.String("5000000"),
				"producer_byte_rate": pulumi.String("2500000"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetQuota added in v3.2.0

func GetQuota(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *QuotaState, opts ...pulumi.ResourceOption) (*Quota, error)

GetQuota gets an existing Quota 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 NewQuota added in v3.2.0

func NewQuota(ctx *pulumi.Context,
	name string, args *QuotaArgs, opts ...pulumi.ResourceOption) (*Quota, error)

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

func (*Quota) ElementType added in v3.2.0

func (*Quota) ElementType() reflect.Type

func (*Quota) ToQuotaOutput added in v3.2.0

func (i *Quota) ToQuotaOutput() QuotaOutput

func (*Quota) ToQuotaOutputWithContext added in v3.2.0

func (i *Quota) ToQuotaOutputWithContext(ctx context.Context) QuotaOutput

type QuotaArgs added in v3.2.0

type QuotaArgs struct {
	// A map of string k/v attributes.
	Config pulumi.StringMapInput
	// The name of the entity to target.
	EntityName pulumi.StringInput
	// The type of entity. Valid values are `client-id`, `user`, `ip`.
	EntityType pulumi.StringInput
}

The set of arguments for constructing a Quota resource.

func (QuotaArgs) ElementType added in v3.2.0

func (QuotaArgs) ElementType() reflect.Type

type QuotaArray added in v3.2.0

type QuotaArray []QuotaInput

func (QuotaArray) ElementType added in v3.2.0

func (QuotaArray) ElementType() reflect.Type

func (QuotaArray) ToQuotaArrayOutput added in v3.2.0

func (i QuotaArray) ToQuotaArrayOutput() QuotaArrayOutput

func (QuotaArray) ToQuotaArrayOutputWithContext added in v3.2.0

func (i QuotaArray) ToQuotaArrayOutputWithContext(ctx context.Context) QuotaArrayOutput

type QuotaArrayInput added in v3.2.0

type QuotaArrayInput interface {
	pulumi.Input

	ToQuotaArrayOutput() QuotaArrayOutput
	ToQuotaArrayOutputWithContext(context.Context) QuotaArrayOutput
}

QuotaArrayInput is an input type that accepts QuotaArray and QuotaArrayOutput values. You can construct a concrete instance of `QuotaArrayInput` via:

QuotaArray{ QuotaArgs{...} }

type QuotaArrayOutput added in v3.2.0

type QuotaArrayOutput struct{ *pulumi.OutputState }

func (QuotaArrayOutput) ElementType added in v3.2.0

func (QuotaArrayOutput) ElementType() reflect.Type

func (QuotaArrayOutput) Index added in v3.2.0

func (QuotaArrayOutput) ToQuotaArrayOutput added in v3.2.0

func (o QuotaArrayOutput) ToQuotaArrayOutput() QuotaArrayOutput

func (QuotaArrayOutput) ToQuotaArrayOutputWithContext added in v3.2.0

func (o QuotaArrayOutput) ToQuotaArrayOutputWithContext(ctx context.Context) QuotaArrayOutput

type QuotaInput added in v3.2.0

type QuotaInput interface {
	pulumi.Input

	ToQuotaOutput() QuotaOutput
	ToQuotaOutputWithContext(ctx context.Context) QuotaOutput
}

type QuotaMap added in v3.2.0

type QuotaMap map[string]QuotaInput

func (QuotaMap) ElementType added in v3.2.0

func (QuotaMap) ElementType() reflect.Type

func (QuotaMap) ToQuotaMapOutput added in v3.2.0

func (i QuotaMap) ToQuotaMapOutput() QuotaMapOutput

func (QuotaMap) ToQuotaMapOutputWithContext added in v3.2.0

func (i QuotaMap) ToQuotaMapOutputWithContext(ctx context.Context) QuotaMapOutput

type QuotaMapInput added in v3.2.0

type QuotaMapInput interface {
	pulumi.Input

	ToQuotaMapOutput() QuotaMapOutput
	ToQuotaMapOutputWithContext(context.Context) QuotaMapOutput
}

QuotaMapInput is an input type that accepts QuotaMap and QuotaMapOutput values. You can construct a concrete instance of `QuotaMapInput` via:

QuotaMap{ "key": QuotaArgs{...} }

type QuotaMapOutput added in v3.2.0

type QuotaMapOutput struct{ *pulumi.OutputState }

func (QuotaMapOutput) ElementType added in v3.2.0

func (QuotaMapOutput) ElementType() reflect.Type

func (QuotaMapOutput) MapIndex added in v3.2.0

func (QuotaMapOutput) ToQuotaMapOutput added in v3.2.0

func (o QuotaMapOutput) ToQuotaMapOutput() QuotaMapOutput

func (QuotaMapOutput) ToQuotaMapOutputWithContext added in v3.2.0

func (o QuotaMapOutput) ToQuotaMapOutputWithContext(ctx context.Context) QuotaMapOutput

type QuotaOutput added in v3.2.0

type QuotaOutput struct{ *pulumi.OutputState }

func (QuotaOutput) Config added in v3.4.0

func (o QuotaOutput) Config() pulumi.StringMapOutput

A map of string k/v attributes.

func (QuotaOutput) ElementType added in v3.2.0

func (QuotaOutput) ElementType() reflect.Type

func (QuotaOutput) EntityName added in v3.4.0

func (o QuotaOutput) EntityName() pulumi.StringOutput

The name of the entity to target.

func (QuotaOutput) EntityType added in v3.4.0

func (o QuotaOutput) EntityType() pulumi.StringOutput

The type of entity. Valid values are `client-id`, `user`, `ip`.

func (QuotaOutput) ToQuotaOutput added in v3.2.0

func (o QuotaOutput) ToQuotaOutput() QuotaOutput

func (QuotaOutput) ToQuotaOutputWithContext added in v3.2.0

func (o QuotaOutput) ToQuotaOutputWithContext(ctx context.Context) QuotaOutput

type QuotaState added in v3.2.0

type QuotaState struct {
	// A map of string k/v attributes.
	Config pulumi.StringMapInput
	// The name of the entity to target.
	EntityName pulumi.StringPtrInput
	// The type of entity. Valid values are `client-id`, `user`, `ip`.
	EntityType pulumi.StringPtrInput
}

func (QuotaState) ElementType added in v3.2.0

func (QuotaState) ElementType() reflect.Type

type Topic

type Topic struct {
	pulumi.CustomResourceState

	// A map of string k/v attributes.
	Config pulumi.StringMapOutput `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/v3/go/kafka"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kafka.NewTopic(ctx, "logs", &kafka.TopicArgs{
			Name:              pulumi.String("systemd_logs"),
			ReplicationFactor: pulumi.Int(2),
			Partitions:        pulumi.Int(100),
			Config: pulumi.StringMap{
				"segment.ms":     pulumi.String("20000"),
				"cleanup.policy": pulumi.String("compact"),
			},
		})
		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.StringMapInput
	// 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 TopicArray

type TopicArray []TopicInput

func (TopicArray) ElementType

func (TopicArray) ElementType() reflect.Type

func (TopicArray) ToTopicArrayOutput

func (i TopicArray) ToTopicArrayOutput() TopicArrayOutput

func (TopicArray) ToTopicArrayOutputWithContext

func (i TopicArray) ToTopicArrayOutputWithContext(ctx context.Context) TopicArrayOutput

type TopicArrayInput

type TopicArrayInput interface {
	pulumi.Input

	ToTopicArrayOutput() TopicArrayOutput
	ToTopicArrayOutputWithContext(context.Context) TopicArrayOutput
}

TopicArrayInput is an input type that accepts TopicArray and TopicArrayOutput values. You can construct a concrete instance of `TopicArrayInput` via:

TopicArray{ TopicArgs{...} }

type TopicArrayOutput

type TopicArrayOutput struct{ *pulumi.OutputState }

func (TopicArrayOutput) ElementType

func (TopicArrayOutput) ElementType() reflect.Type

func (TopicArrayOutput) Index

func (TopicArrayOutput) ToTopicArrayOutput

func (o TopicArrayOutput) ToTopicArrayOutput() TopicArrayOutput

func (TopicArrayOutput) ToTopicArrayOutputWithContext

func (o TopicArrayOutput) ToTopicArrayOutputWithContext(ctx context.Context) TopicArrayOutput

type TopicInput

type TopicInput interface {
	pulumi.Input

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

type TopicMap

type TopicMap map[string]TopicInput

func (TopicMap) ElementType

func (TopicMap) ElementType() reflect.Type

func (TopicMap) ToTopicMapOutput

func (i TopicMap) ToTopicMapOutput() TopicMapOutput

func (TopicMap) ToTopicMapOutputWithContext

func (i TopicMap) ToTopicMapOutputWithContext(ctx context.Context) TopicMapOutput

type TopicMapInput

type TopicMapInput interface {
	pulumi.Input

	ToTopicMapOutput() TopicMapOutput
	ToTopicMapOutputWithContext(context.Context) TopicMapOutput
}

TopicMapInput is an input type that accepts TopicMap and TopicMapOutput values. You can construct a concrete instance of `TopicMapInput` via:

TopicMap{ "key": TopicArgs{...} }

type TopicMapOutput

type TopicMapOutput struct{ *pulumi.OutputState }

func (TopicMapOutput) ElementType

func (TopicMapOutput) ElementType() reflect.Type

func (TopicMapOutput) MapIndex

func (TopicMapOutput) ToTopicMapOutput

func (o TopicMapOutput) ToTopicMapOutput() TopicMapOutput

func (TopicMapOutput) ToTopicMapOutputWithContext

func (o TopicMapOutput) ToTopicMapOutputWithContext(ctx context.Context) TopicMapOutput

type TopicOutput

type TopicOutput struct{ *pulumi.OutputState }

func (TopicOutput) Config added in v3.4.0

func (o TopicOutput) Config() pulumi.StringMapOutput

A map of string k/v attributes.

func (TopicOutput) ElementType

func (TopicOutput) ElementType() reflect.Type

func (TopicOutput) Name added in v3.4.0

func (o TopicOutput) Name() pulumi.StringOutput

The name of the topic.

func (TopicOutput) Partitions added in v3.4.0

func (o TopicOutput) Partitions() pulumi.IntOutput

The number of partitions the topic should have.

func (TopicOutput) ReplicationFactor added in v3.4.0

func (o TopicOutput) ReplicationFactor() pulumi.IntOutput

The number of replicas the topic should have.

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.StringMapInput
	// 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

type UserScramCredential added in v3.5.0

type UserScramCredential struct {
	pulumi.CustomResourceState

	// The password of the credential
	Password pulumi.StringOutput `pulumi:"password"`
	// The number of SCRAM iterations used when generating the credential
	ScramIterations pulumi.IntPtrOutput `pulumi:"scramIterations"`
	// The SCRAM mechanism used to generate the credential (SCRAM-SHA-256, SCRAM-SHA-512)
	ScramMechanism pulumi.StringOutput `pulumi:"scramMechanism"`
	// The name of the credential
	Username pulumi.StringOutput `pulumi:"username"`
}

func GetUserScramCredential added in v3.5.0

func GetUserScramCredential(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *UserScramCredentialState, opts ...pulumi.ResourceOption) (*UserScramCredential, error)

GetUserScramCredential gets an existing UserScramCredential 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 NewUserScramCredential added in v3.5.0

func NewUserScramCredential(ctx *pulumi.Context,
	name string, args *UserScramCredentialArgs, opts ...pulumi.ResourceOption) (*UserScramCredential, error)

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

func (*UserScramCredential) ElementType added in v3.5.0

func (*UserScramCredential) ElementType() reflect.Type

func (*UserScramCredential) ToUserScramCredentialOutput added in v3.5.0

func (i *UserScramCredential) ToUserScramCredentialOutput() UserScramCredentialOutput

func (*UserScramCredential) ToUserScramCredentialOutputWithContext added in v3.5.0

func (i *UserScramCredential) ToUserScramCredentialOutputWithContext(ctx context.Context) UserScramCredentialOutput

type UserScramCredentialArgs added in v3.5.0

type UserScramCredentialArgs struct {
	// The password of the credential
	Password pulumi.StringInput
	// The number of SCRAM iterations used when generating the credential
	ScramIterations pulumi.IntPtrInput
	// The SCRAM mechanism used to generate the credential (SCRAM-SHA-256, SCRAM-SHA-512)
	ScramMechanism pulumi.StringInput
	// The name of the credential
	Username pulumi.StringInput
}

The set of arguments for constructing a UserScramCredential resource.

func (UserScramCredentialArgs) ElementType added in v3.5.0

func (UserScramCredentialArgs) ElementType() reflect.Type

type UserScramCredentialArray added in v3.5.0

type UserScramCredentialArray []UserScramCredentialInput

func (UserScramCredentialArray) ElementType added in v3.5.0

func (UserScramCredentialArray) ElementType() reflect.Type

func (UserScramCredentialArray) ToUserScramCredentialArrayOutput added in v3.5.0

func (i UserScramCredentialArray) ToUserScramCredentialArrayOutput() UserScramCredentialArrayOutput

func (UserScramCredentialArray) ToUserScramCredentialArrayOutputWithContext added in v3.5.0

func (i UserScramCredentialArray) ToUserScramCredentialArrayOutputWithContext(ctx context.Context) UserScramCredentialArrayOutput

type UserScramCredentialArrayInput added in v3.5.0

type UserScramCredentialArrayInput interface {
	pulumi.Input

	ToUserScramCredentialArrayOutput() UserScramCredentialArrayOutput
	ToUserScramCredentialArrayOutputWithContext(context.Context) UserScramCredentialArrayOutput
}

UserScramCredentialArrayInput is an input type that accepts UserScramCredentialArray and UserScramCredentialArrayOutput values. You can construct a concrete instance of `UserScramCredentialArrayInput` via:

UserScramCredentialArray{ UserScramCredentialArgs{...} }

type UserScramCredentialArrayOutput added in v3.5.0

type UserScramCredentialArrayOutput struct{ *pulumi.OutputState }

func (UserScramCredentialArrayOutput) ElementType added in v3.5.0

func (UserScramCredentialArrayOutput) Index added in v3.5.0

func (UserScramCredentialArrayOutput) ToUserScramCredentialArrayOutput added in v3.5.0

func (o UserScramCredentialArrayOutput) ToUserScramCredentialArrayOutput() UserScramCredentialArrayOutput

func (UserScramCredentialArrayOutput) ToUserScramCredentialArrayOutputWithContext added in v3.5.0

func (o UserScramCredentialArrayOutput) ToUserScramCredentialArrayOutputWithContext(ctx context.Context) UserScramCredentialArrayOutput

type UserScramCredentialInput added in v3.5.0

type UserScramCredentialInput interface {
	pulumi.Input

	ToUserScramCredentialOutput() UserScramCredentialOutput
	ToUserScramCredentialOutputWithContext(ctx context.Context) UserScramCredentialOutput
}

type UserScramCredentialMap added in v3.5.0

type UserScramCredentialMap map[string]UserScramCredentialInput

func (UserScramCredentialMap) ElementType added in v3.5.0

func (UserScramCredentialMap) ElementType() reflect.Type

func (UserScramCredentialMap) ToUserScramCredentialMapOutput added in v3.5.0

func (i UserScramCredentialMap) ToUserScramCredentialMapOutput() UserScramCredentialMapOutput

func (UserScramCredentialMap) ToUserScramCredentialMapOutputWithContext added in v3.5.0

func (i UserScramCredentialMap) ToUserScramCredentialMapOutputWithContext(ctx context.Context) UserScramCredentialMapOutput

type UserScramCredentialMapInput added in v3.5.0

type UserScramCredentialMapInput interface {
	pulumi.Input

	ToUserScramCredentialMapOutput() UserScramCredentialMapOutput
	ToUserScramCredentialMapOutputWithContext(context.Context) UserScramCredentialMapOutput
}

UserScramCredentialMapInput is an input type that accepts UserScramCredentialMap and UserScramCredentialMapOutput values. You can construct a concrete instance of `UserScramCredentialMapInput` via:

UserScramCredentialMap{ "key": UserScramCredentialArgs{...} }

type UserScramCredentialMapOutput added in v3.5.0

type UserScramCredentialMapOutput struct{ *pulumi.OutputState }

func (UserScramCredentialMapOutput) ElementType added in v3.5.0

func (UserScramCredentialMapOutput) MapIndex added in v3.5.0

func (UserScramCredentialMapOutput) ToUserScramCredentialMapOutput added in v3.5.0

func (o UserScramCredentialMapOutput) ToUserScramCredentialMapOutput() UserScramCredentialMapOutput

func (UserScramCredentialMapOutput) ToUserScramCredentialMapOutputWithContext added in v3.5.0

func (o UserScramCredentialMapOutput) ToUserScramCredentialMapOutputWithContext(ctx context.Context) UserScramCredentialMapOutput

type UserScramCredentialOutput added in v3.5.0

type UserScramCredentialOutput struct{ *pulumi.OutputState }

func (UserScramCredentialOutput) ElementType added in v3.5.0

func (UserScramCredentialOutput) ElementType() reflect.Type

func (UserScramCredentialOutput) Password added in v3.5.0

The password of the credential

func (UserScramCredentialOutput) ScramIterations added in v3.5.0

func (o UserScramCredentialOutput) ScramIterations() pulumi.IntPtrOutput

The number of SCRAM iterations used when generating the credential

func (UserScramCredentialOutput) ScramMechanism added in v3.5.0

func (o UserScramCredentialOutput) ScramMechanism() pulumi.StringOutput

The SCRAM mechanism used to generate the credential (SCRAM-SHA-256, SCRAM-SHA-512)

func (UserScramCredentialOutput) ToUserScramCredentialOutput added in v3.5.0

func (o UserScramCredentialOutput) ToUserScramCredentialOutput() UserScramCredentialOutput

func (UserScramCredentialOutput) ToUserScramCredentialOutputWithContext added in v3.5.0

func (o UserScramCredentialOutput) ToUserScramCredentialOutputWithContext(ctx context.Context) UserScramCredentialOutput

func (UserScramCredentialOutput) Username added in v3.5.0

The name of the credential

type UserScramCredentialState added in v3.5.0

type UserScramCredentialState struct {
	// The password of the credential
	Password pulumi.StringPtrInput
	// The number of SCRAM iterations used when generating the credential
	ScramIterations pulumi.IntPtrInput
	// The SCRAM mechanism used to generate the credential (SCRAM-SHA-256, SCRAM-SHA-512)
	ScramMechanism pulumi.StringPtrInput
	// The name of the credential
	Username pulumi.StringPtrInput
}

func (UserScramCredentialState) ElementType added in v3.5.0

func (UserScramCredentialState) ElementType() reflect.Type

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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