volcengine.kafka.SaslUser
Explore with Pulumi AI
Provides a resource to manage kafka sasl user
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;
return await Deployment.RunAsync(() =>
{
var fooZones = Volcengine.Ecs.Zones.Invoke();
var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
{
VpcName = "acc-test-vpc",
CidrBlock = "172.16.0.0/16",
});
var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
{
SubnetName = "acc-test-subnet",
CidrBlock = "172.16.0.0/24",
ZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
VpcId = fooVpc.Id,
});
var fooInstance = new Volcengine.Kafka.Instance("fooInstance", new()
{
InstanceName = "acc-test-kafka",
InstanceDescription = "tf-test",
Version = "2.2.2",
ComputeSpec = "kafka.20xrate.hw",
SubnetId = fooSubnet.Id,
UserName = "tf-user",
UserPassword = "tf-pass!@q1",
ChargeType = "PostPaid",
StorageSpace = 300,
PartitionNumber = 350,
ProjectName = "default",
Tags = new[]
{
new Volcengine.Kafka.Inputs.InstanceTagArgs
{
Key = "k1",
Value = "v1",
},
},
Parameters = new[]
{
new Volcengine.Kafka.Inputs.InstanceParameterArgs
{
ParameterName = "MessageMaxByte",
ParameterValue = "12",
},
new Volcengine.Kafka.Inputs.InstanceParameterArgs
{
ParameterName = "LogRetentionHours",
ParameterValue = "70",
},
},
});
var fooSaslUser = new Volcengine.Kafka.SaslUser("fooSaslUser", new()
{
UserName = "acc-test-user",
InstanceId = fooInstance.Id,
UserPassword = "suqsnis123!",
Description = "tf-test",
AllAuthority = true,
PasswordType = "Scram",
});
});
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/kafka"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
fooZones, err := ecs.Zones(ctx, nil, nil)
if err != nil {
return err
}
fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
VpcName: pulumi.String("acc-test-vpc"),
CidrBlock: pulumi.String("172.16.0.0/16"),
})
if err != nil {
return err
}
fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
SubnetName: pulumi.String("acc-test-subnet"),
CidrBlock: pulumi.String("172.16.0.0/24"),
ZoneId: *pulumi.String(fooZones.Zones[0].Id),
VpcId: fooVpc.ID(),
})
if err != nil {
return err
}
fooInstance, err := kafka.NewInstance(ctx, "fooInstance", &kafka.InstanceArgs{
InstanceName: pulumi.String("acc-test-kafka"),
InstanceDescription: pulumi.String("tf-test"),
Version: pulumi.String("2.2.2"),
ComputeSpec: pulumi.String("kafka.20xrate.hw"),
SubnetId: fooSubnet.ID(),
UserName: pulumi.String("tf-user"),
UserPassword: pulumi.String("tf-pass!@q1"),
ChargeType: pulumi.String("PostPaid"),
StorageSpace: pulumi.Int(300),
PartitionNumber: pulumi.Int(350),
ProjectName: pulumi.String("default"),
Tags: kafka.InstanceTagArray{
&kafka.InstanceTagArgs{
Key: pulumi.String("k1"),
Value: pulumi.String("v1"),
},
},
Parameters: kafka.InstanceParameterArray{
&kafka.InstanceParameterArgs{
ParameterName: pulumi.String("MessageMaxByte"),
ParameterValue: pulumi.String("12"),
},
&kafka.InstanceParameterArgs{
ParameterName: pulumi.String("LogRetentionHours"),
ParameterValue: pulumi.String("70"),
},
},
})
if err != nil {
return err
}
_, err = kafka.NewSaslUser(ctx, "fooSaslUser", &kafka.SaslUserArgs{
UserName: pulumi.String("acc-test-user"),
InstanceId: fooInstance.ID(),
UserPassword: pulumi.String("suqsnis123!"),
Description: pulumi.String("tf-test"),
AllAuthority: pulumi.Bool(true),
PasswordType: pulumi.String("Scram"),
})
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.volcengine.ecs.EcsFunctions;
import com.pulumi.volcengine.ecs.inputs.ZonesArgs;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.kafka.Instance;
import com.pulumi.volcengine.kafka.InstanceArgs;
import com.pulumi.volcengine.kafka.inputs.InstanceTagArgs;
import com.pulumi.volcengine.kafka.inputs.InstanceParameterArgs;
import com.pulumi.volcengine.kafka.SaslUser;
import com.pulumi.volcengine.kafka.SaslUserArgs;
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) {
final var fooZones = EcsFunctions.Zones();
var fooVpc = new Vpc("fooVpc", VpcArgs.builder()
.vpcName("acc-test-vpc")
.cidrBlock("172.16.0.0/16")
.build());
var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()
.subnetName("acc-test-subnet")
.cidrBlock("172.16.0.0/24")
.zoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
.vpcId(fooVpc.id())
.build());
var fooInstance = new Instance("fooInstance", InstanceArgs.builder()
.instanceName("acc-test-kafka")
.instanceDescription("tf-test")
.version("2.2.2")
.computeSpec("kafka.20xrate.hw")
.subnetId(fooSubnet.id())
.userName("tf-user")
.userPassword("tf-pass!@q1")
.chargeType("PostPaid")
.storageSpace(300)
.partitionNumber(350)
.projectName("default")
.tags(InstanceTagArgs.builder()
.key("k1")
.value("v1")
.build())
.parameters(
InstanceParameterArgs.builder()
.parameterName("MessageMaxByte")
.parameterValue("12")
.build(),
InstanceParameterArgs.builder()
.parameterName("LogRetentionHours")
.parameterValue("70")
.build())
.build());
var fooSaslUser = new SaslUser("fooSaslUser", SaslUserArgs.builder()
.userName("acc-test-user")
.instanceId(fooInstance.id())
.userPassword("suqsnis123!")
.description("tf-test")
.allAuthority(true)
.passwordType("Scram")
.build());
}
}
import pulumi
import pulumi_volcengine as volcengine
foo_zones = volcengine.ecs.zones()
foo_vpc = volcengine.vpc.Vpc("fooVpc",
vpc_name="acc-test-vpc",
cidr_block="172.16.0.0/16")
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
subnet_name="acc-test-subnet",
cidr_block="172.16.0.0/24",
zone_id=foo_zones.zones[0].id,
vpc_id=foo_vpc.id)
foo_instance = volcengine.kafka.Instance("fooInstance",
instance_name="acc-test-kafka",
instance_description="tf-test",
version="2.2.2",
compute_spec="kafka.20xrate.hw",
subnet_id=foo_subnet.id,
user_name="tf-user",
user_password="tf-pass!@q1",
charge_type="PostPaid",
storage_space=300,
partition_number=350,
project_name="default",
tags=[volcengine.kafka.InstanceTagArgs(
key="k1",
value="v1",
)],
parameters=[
volcengine.kafka.InstanceParameterArgs(
parameter_name="MessageMaxByte",
parameter_value="12",
),
volcengine.kafka.InstanceParameterArgs(
parameter_name="LogRetentionHours",
parameter_value="70",
),
])
foo_sasl_user = volcengine.kafka.SaslUser("fooSaslUser",
user_name="acc-test-user",
instance_id=foo_instance.id,
user_password="suqsnis123!",
description="tf-test",
all_authority=True,
password_type="Scram")
import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";
import * as volcengine from "@volcengine/pulumi";
const fooZones = volcengine.ecs.Zones({});
const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
vpcName: "acc-test-vpc",
cidrBlock: "172.16.0.0/16",
});
const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
subnetName: "acc-test-subnet",
cidrBlock: "172.16.0.0/24",
zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
vpcId: fooVpc.id,
});
const fooInstance = new volcengine.kafka.Instance("fooInstance", {
instanceName: "acc-test-kafka",
instanceDescription: "tf-test",
version: "2.2.2",
computeSpec: "kafka.20xrate.hw",
subnetId: fooSubnet.id,
userName: "tf-user",
userPassword: "tf-pass!@q1",
chargeType: "PostPaid",
storageSpace: 300,
partitionNumber: 350,
projectName: "default",
tags: [{
key: "k1",
value: "v1",
}],
parameters: [
{
parameterName: "MessageMaxByte",
parameterValue: "12",
},
{
parameterName: "LogRetentionHours",
parameterValue: "70",
},
],
});
const fooSaslUser = new volcengine.kafka.SaslUser("fooSaslUser", {
userName: "acc-test-user",
instanceId: fooInstance.id,
userPassword: "suqsnis123!",
description: "tf-test",
allAuthority: true,
passwordType: "Scram",
});
resources:
fooVpc:
type: volcengine:vpc:Vpc
properties:
vpcName: acc-test-vpc
cidrBlock: 172.16.0.0/16
fooSubnet:
type: volcengine:vpc:Subnet
properties:
subnetName: acc-test-subnet
cidrBlock: 172.16.0.0/24
zoneId: ${fooZones.zones[0].id}
vpcId: ${fooVpc.id}
fooInstance:
type: volcengine:kafka:Instance
properties:
instanceName: acc-test-kafka
instanceDescription: tf-test
version: 2.2.2
computeSpec: kafka.20xrate.hw
subnetId: ${fooSubnet.id}
userName: tf-user
userPassword: tf-pass!@q1
chargeType: PostPaid
storageSpace: 300
partitionNumber: 350
projectName: default
tags:
- key: k1
value: v1
parameters:
- parameterName: MessageMaxByte
parameterValue: '12'
- parameterName: LogRetentionHours
parameterValue: '70'
fooSaslUser:
type: volcengine:kafka:SaslUser
properties:
userName: acc-test-user
instanceId: ${fooInstance.id}
userPassword: suqsnis123!
description: tf-test
allAuthority: true
passwordType: Scram
variables:
fooZones:
fn::invoke:
Function: volcengine:ecs:Zones
Arguments: {}
Create SaslUser Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SaslUser(name: string, args: SaslUserArgs, opts?: CustomResourceOptions);
@overload
def SaslUser(resource_name: str,
args: SaslUserArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SaslUser(resource_name: str,
opts: Optional[ResourceOptions] = None,
instance_id: Optional[str] = None,
user_name: Optional[str] = None,
user_password: Optional[str] = None,
all_authority: Optional[bool] = None,
description: Optional[str] = None,
password_type: Optional[str] = None)
func NewSaslUser(ctx *Context, name string, args SaslUserArgs, opts ...ResourceOption) (*SaslUser, error)
public SaslUser(string name, SaslUserArgs args, CustomResourceOptions? opts = null)
public SaslUser(String name, SaslUserArgs args)
public SaslUser(String name, SaslUserArgs args, CustomResourceOptions options)
type: volcengine:kafka:SaslUser
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SaslUserArgs
- 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 SaslUserArgs
- 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 SaslUserArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SaslUserArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SaslUserArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var saslUserResource = new Volcengine.Kafka.SaslUser("saslUserResource", new()
{
InstanceId = "string",
UserName = "string",
UserPassword = "string",
AllAuthority = false,
Description = "string",
PasswordType = "string",
});
example, err := kafka.NewSaslUser(ctx, "saslUserResource", &kafka.SaslUserArgs{
InstanceId: pulumi.String("string"),
UserName: pulumi.String("string"),
UserPassword: pulumi.String("string"),
AllAuthority: pulumi.Bool(false),
Description: pulumi.String("string"),
PasswordType: pulumi.String("string"),
})
var saslUserResource = new SaslUser("saslUserResource", SaslUserArgs.builder()
.instanceId("string")
.userName("string")
.userPassword("string")
.allAuthority(false)
.description("string")
.passwordType("string")
.build());
sasl_user_resource = volcengine.kafka.SaslUser("saslUserResource",
instance_id="string",
user_name="string",
user_password="string",
all_authority=False,
description="string",
password_type="string")
const saslUserResource = new volcengine.kafka.SaslUser("saslUserResource", {
instanceId: "string",
userName: "string",
userPassword: "string",
allAuthority: false,
description: "string",
passwordType: "string",
});
type: volcengine:kafka:SaslUser
properties:
allAuthority: false
description: string
instanceId: string
passwordType: string
userName: string
userPassword: string
SaslUser Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SaslUser resource accepts the following input properties:
- Instance
Id string - The id of instance.
- User
Name string - The name of user.
- User
Password string - The password of user.
- bool
- Whether this user has read and write permissions for all topics. Default is true.
- Description string
- The description of user.
- Password
Type string - The type of password. Valid values are
Scram
andPlain
. Default isPlain
.
- Instance
Id string - The id of instance.
- User
Name string - The name of user.
- User
Password string - The password of user.
- bool
- Whether this user has read and write permissions for all topics. Default is true.
- Description string
- The description of user.
- Password
Type string - The type of password. Valid values are
Scram
andPlain
. Default isPlain
.
- instance
Id String - The id of instance.
- user
Name String - The name of user.
- user
Password String - The password of user.
- Boolean
- Whether this user has read and write permissions for all topics. Default is true.
- description String
- The description of user.
- password
Type String - The type of password. Valid values are
Scram
andPlain
. Default isPlain
.
- instance
Id string - The id of instance.
- user
Name string - The name of user.
- user
Password string - The password of user.
- boolean
- Whether this user has read and write permissions for all topics. Default is true.
- description string
- The description of user.
- password
Type string - The type of password. Valid values are
Scram
andPlain
. Default isPlain
.
- instance_
id str - The id of instance.
- user_
name str - The name of user.
- user_
password str - The password of user.
- bool
- Whether this user has read and write permissions for all topics. Default is true.
- description str
- The description of user.
- password_
type str - The type of password. Valid values are
Scram
andPlain
. Default isPlain
.
- instance
Id String - The id of instance.
- user
Name String - The name of user.
- user
Password String - The password of user.
- Boolean
- Whether this user has read and write permissions for all topics. Default is true.
- description String
- The description of user.
- password
Type String - The type of password. Valid values are
Scram
andPlain
. Default isPlain
.
Outputs
All input properties are implicitly available as output properties. Additionally, the SaslUser resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing SaslUser Resource
Get an existing SaslUser 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?: SaslUserState, opts?: CustomResourceOptions): SaslUser
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
all_authority: Optional[bool] = None,
description: Optional[str] = None,
instance_id: Optional[str] = None,
password_type: Optional[str] = None,
user_name: Optional[str] = None,
user_password: Optional[str] = None) -> SaslUser
func GetSaslUser(ctx *Context, name string, id IDInput, state *SaslUserState, opts ...ResourceOption) (*SaslUser, error)
public static SaslUser Get(string name, Input<string> id, SaslUserState? state, CustomResourceOptions? opts = null)
public static SaslUser get(String name, Output<String> id, SaslUserState 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.
- bool
- Whether this user has read and write permissions for all topics. Default is true.
- Description string
- The description of user.
- Instance
Id string - The id of instance.
- Password
Type string - The type of password. Valid values are
Scram
andPlain
. Default isPlain
. - User
Name string - The name of user.
- User
Password string - The password of user.
- bool
- Whether this user has read and write permissions for all topics. Default is true.
- Description string
- The description of user.
- Instance
Id string - The id of instance.
- Password
Type string - The type of password. Valid values are
Scram
andPlain
. Default isPlain
. - User
Name string - The name of user.
- User
Password string - The password of user.
- Boolean
- Whether this user has read and write permissions for all topics. Default is true.
- description String
- The description of user.
- instance
Id String - The id of instance.
- password
Type String - The type of password. Valid values are
Scram
andPlain
. Default isPlain
. - user
Name String - The name of user.
- user
Password String - The password of user.
- boolean
- Whether this user has read and write permissions for all topics. Default is true.
- description string
- The description of user.
- instance
Id string - The id of instance.
- password
Type string - The type of password. Valid values are
Scram
andPlain
. Default isPlain
. - user
Name string - The name of user.
- user
Password string - The password of user.
- bool
- Whether this user has read and write permissions for all topics. Default is true.
- description str
- The description of user.
- instance_
id str - The id of instance.
- password_
type str - The type of password. Valid values are
Scram
andPlain
. Default isPlain
. - user_
name str - The name of user.
- user_
password str - The password of user.
- Boolean
- Whether this user has read and write permissions for all topics. Default is true.
- description String
- The description of user.
- instance
Id String - The id of instance.
- password
Type String - The type of password. Valid values are
Scram
andPlain
. Default isPlain
. - user
Name String - The name of user.
- user
Password String - The password of user.
Import
KafkaSaslUser can be imported using the kafka_id:username, e.g.
$ pulumi import volcengine:kafka/saslUser:SaslUser default kafka-cnngbnntswg1****:tfuser
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- volcengine volcengine/pulumi-volcengine
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
volcengine
Terraform Provider.