Docs
Packagesaiven.KafkaUser
Explore with Pulumi AI
The Kafka User resource allows the creation and management of Aiven Kafka Users.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;
return await Deployment.RunAsync(() =>
{
var foo = new Aiven.KafkaUser("foo", new()
{
ServiceName = aiven_kafka.Bar.Service_name,
Project = "my-project",
Username = "user-1",
Password = "Test$1234",
});
});
package main
import (
"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := aiven.NewKafkaUser(ctx, "foo", &aiven.KafkaUserArgs{
ServiceName: pulumi.Any(aiven_kafka.Bar.Service_name),
Project: pulumi.String("my-project"),
Username: pulumi.String("user-1"),
Password: pulumi.String("Test$1234"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.KafkaUser;
import com.pulumi.aiven.KafkaUserArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var foo = new KafkaUser("foo", KafkaUserArgs.builder()
.serviceName(aiven_kafka.bar().service_name())
.project("my-project")
.username("user-1")
.password("Test$1234")
.build());
}
}
import pulumi
import pulumi_aiven as aiven
foo = aiven.KafkaUser("foo",
service_name=aiven_kafka["bar"]["service_name"],
project="my-project",
username="user-1",
password="Test$1234")
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";
const foo = new aiven.KafkaUser("foo", {
serviceName: aiven_kafka.bar.service_name,
project: "my-project",
username: "user-1",
password: "Test$1234",
});
resources:
foo:
type: aiven:KafkaUser
properties:
serviceName: ${aiven_kafka.bar.service_name}
project: my-project
username: user-1
password: Test$1234
Create KafkaUser Resource
new KafkaUser(name: string, args: KafkaUserArgs, opts?: CustomResourceOptions);@overload
def KafkaUser(resource_name: str,
opts: Optional[ResourceOptions] = None,
password: Optional[str] = None,
project: Optional[str] = None,
service_name: Optional[str] = None,
username: Optional[str] = None)
@overload
def KafkaUser(resource_name: str,
args: KafkaUserArgs,
opts: Optional[ResourceOptions] = None)func NewKafkaUser(ctx *Context, name string, args KafkaUserArgs, opts ...ResourceOption) (*KafkaUser, error)public KafkaUser(string name, KafkaUserArgs args, CustomResourceOptions? opts = null)
public KafkaUser(String name, KafkaUserArgs args)
public KafkaUser(String name, KafkaUserArgs args, CustomResourceOptions options)
type: aiven:KafkaUser
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KafkaUserArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args KafkaUserArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args KafkaUserArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KafkaUserArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args KafkaUserArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
KafkaUser Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The KafkaUser resource accepts the following input properties:
- Project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Service
Name string Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Username string
The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Password string
The password of the Kafka User.
- Project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Service
Name string Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Username string
The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Password string
The password of the Kafka User.
- project String
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- service
Name String Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- username String
The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- password String
The password of the Kafka User.
- project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- service
Name string Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- username string
The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- password string
The password of the Kafka User.
- project str
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- service_
name str Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- username str
The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- password str
The password of the Kafka User.
- project String
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- service
Name String Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- username String
The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- password String
The password of the Kafka User.
Outputs
All input properties are implicitly available as output properties. Additionally, the KafkaUser resource produces the following output properties:
- Access
Cert string Access certificate for the user
- Access
Key string Access certificate key for the user
- Id string
The provider-assigned unique ID for this managed resource.
- Type string
Type of the user account. Tells whether the user is the primary account or a regular account.
- Access
Cert string Access certificate for the user
- Access
Key string Access certificate key for the user
- Id string
The provider-assigned unique ID for this managed resource.
- Type string
Type of the user account. Tells whether the user is the primary account or a regular account.
- access
Cert String Access certificate for the user
- access
Key String Access certificate key for the user
- id String
The provider-assigned unique ID for this managed resource.
- type String
Type of the user account. Tells whether the user is the primary account or a regular account.
- access
Cert string Access certificate for the user
- access
Key string Access certificate key for the user
- id string
The provider-assigned unique ID for this managed resource.
- type string
Type of the user account. Tells whether the user is the primary account or a regular account.
- access_
cert str Access certificate for the user
- access_
key str Access certificate key for the user
- id str
The provider-assigned unique ID for this managed resource.
- type str
Type of the user account. Tells whether the user is the primary account or a regular account.
- access
Cert String Access certificate for the user
- access
Key String Access certificate key for the user
- id String
The provider-assigned unique ID for this managed resource.
- type String
Type of the user account. Tells whether the user is the primary account or a regular account.
Look up Existing KafkaUser Resource
Get an existing KafkaUser resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: KafkaUserState, opts?: CustomResourceOptions): KafkaUser@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
access_cert: Optional[str] = None,
access_key: Optional[str] = None,
password: Optional[str] = None,
project: Optional[str] = None,
service_name: Optional[str] = None,
type: Optional[str] = None,
username: Optional[str] = None) -> KafkaUserfunc GetKafkaUser(ctx *Context, name string, id IDInput, state *KafkaUserState, opts ...ResourceOption) (*KafkaUser, error)public static KafkaUser Get(string name, Input<string> id, KafkaUserState? state, CustomResourceOptions? opts = null)public static KafkaUser get(String name, Output<String> id, KafkaUserState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Access
Cert string Access certificate for the user
- Access
Key string Access certificate key for the user
- Password string
The password of the Kafka User.
- Project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Service
Name string Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Type string
Type of the user account. Tells whether the user is the primary account or a regular account.
- Username string
The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Access
Cert string Access certificate for the user
- Access
Key string Access certificate key for the user
- Password string
The password of the Kafka User.
- Project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Service
Name string Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Type string
Type of the user account. Tells whether the user is the primary account or a regular account.
- Username string
The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- access
Cert String Access certificate for the user
- access
Key String Access certificate key for the user
- password String
The password of the Kafka User.
- project String
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- service
Name String Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- type String
Type of the user account. Tells whether the user is the primary account or a regular account.
- username String
The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- access
Cert string Access certificate for the user
- access
Key string Access certificate key for the user
- password string
The password of the Kafka User.
- project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- service
Name string Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- type string
Type of the user account. Tells whether the user is the primary account or a regular account.
- username string
The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- access_
cert str Access certificate for the user
- access_
key str Access certificate key for the user
- password str
The password of the Kafka User.
- project str
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- service_
name str Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- type str
Type of the user account. Tells whether the user is the primary account or a regular account.
- username str
The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- access
Cert String Access certificate for the user
- access
Key String Access certificate key for the user
- password String
The password of the Kafka User.
- project String
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- service
Name String Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- type String
Type of the user account. Tells whether the user is the primary account or a regular account.
- username String
The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
Import
$ pulumi import aiven:index/kafkaUser:KafkaUser foo project/service_name/username
Package Details
- Repository
- Aiven pulumi/pulumi-aiven
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aivenTerraform Provider.