Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. DmsKafkaUser
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

flexibleengine.DmsKafkaUser

Explore with Pulumi AI

flexibleengine logo
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

    Manages a DMS kafka user resource within FlexibleEngine.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as flexibleengine from "@pulumi/flexibleengine";

const config = new pulumi.Config();
const kafkaInstanceId = config.requireObject("kafkaInstanceId");
const user = new flexibleengine.DmsKafkaUser("user", {
    instanceId: kafkaInstanceId,
    password: "Test@123",
});

    import pulumi
import pulumi_flexibleengine as flexibleengine

config = pulumi.Config()
kafka_instance_id = config.require_object("kafkaInstanceId")
user = flexibleengine.DmsKafkaUser("user",
    instance_id=kafka_instance_id,
    password="Test@123")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		kafkaInstanceId := cfg.RequireObject("kafkaInstanceId")
		_, err := flexibleengine.NewDmsKafkaUser(ctx, "user", &flexibleengine.DmsKafkaUserArgs{
			InstanceId: pulumi.Any(kafkaInstanceId),
			Password:   pulumi.String("Test@123"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Flexibleengine = Pulumi.Flexibleengine;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var kafkaInstanceId = config.RequireObject<dynamic>("kafkaInstanceId");
    var user = new Flexibleengine.DmsKafkaUser("user", new()
    {
        InstanceId = kafkaInstanceId,
        Password = "Test@123",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.DmsKafkaUser;
import com.pulumi.flexibleengine.DmsKafkaUserArgs;
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 config = ctx.config();
        final var kafkaInstanceId = config.get("kafkaInstanceId");
        var user = new DmsKafkaUser("user", DmsKafkaUserArgs.builder()
            .instanceId(kafkaInstanceId)
            .password("Test@123")
            .build());

    }
}

    configuration:
  kafkaInstanceId:
    type: dynamic
resources:
  user:
    type: flexibleengine:DmsKafkaUser
    properties:
      instanceId: ${kafkaInstanceId}
      password: Test@123

    Create DmsKafkaUser Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DmsKafkaUser(name: string, args: DmsKafkaUserArgs, opts?: CustomResourceOptions);
    @overload
def DmsKafkaUser(resource_name: str,
                 args: DmsKafkaUserArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def DmsKafkaUser(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 instance_id: Optional[str] = None,
                 password: Optional[str] = None,
                 dms_kafka_user_id: Optional[str] = None,
                 name: Optional[str] = None,
                 region: Optional[str] = None)
    func NewDmsKafkaUser(ctx *Context, name string, args DmsKafkaUserArgs, opts ...ResourceOption) (*DmsKafkaUser, error)
    public DmsKafkaUser(string name, DmsKafkaUserArgs args, CustomResourceOptions? opts = null)
    public DmsKafkaUser(String name, DmsKafkaUserArgs args)
public DmsKafkaUser(String name, DmsKafkaUserArgs args, CustomResourceOptions options)

    type: flexibleengine:DmsKafkaUser
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 DmsKafkaUserArgs
    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 DmsKafkaUserArgs
    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 DmsKafkaUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DmsKafkaUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DmsKafkaUserArgs
    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 dmsKafkaUserResource = new Flexibleengine.DmsKafkaUser("dmsKafkaUserResource", new()
{
    InstanceId = "string",
    Password = "string",
    DmsKafkaUserId = "string",
    Name = "string",
    Region = "string",
});

    example, err := flexibleengine.NewDmsKafkaUser(ctx, "dmsKafkaUserResource", &flexibleengine.DmsKafkaUserArgs{
	InstanceId:     pulumi.String("string"),
	Password:       pulumi.String("string"),
	DmsKafkaUserId: pulumi.String("string"),
	Name:           pulumi.String("string"),
	Region:         pulumi.String("string"),
})

    var dmsKafkaUserResource = new DmsKafkaUser("dmsKafkaUserResource", DmsKafkaUserArgs.builder()
    .instanceId("string")
    .password("string")
    .dmsKafkaUserId("string")
    .name("string")
    .region("string")
    .build());

    dms_kafka_user_resource = flexibleengine.DmsKafkaUser("dmsKafkaUserResource",
    instance_id="string",
    password="string",
    dms_kafka_user_id="string",
    name="string",
    region="string")

    const dmsKafkaUserResource = new flexibleengine.DmsKafkaUser("dmsKafkaUserResource", {
    instanceId: "string",
    password: "string",
    dmsKafkaUserId: "string",
    name: "string",
    region: "string",
});

    type: flexibleengine:DmsKafkaUser
properties:
    dmsKafkaUserId: string
    instanceId: string
    name: string
    password: string
    region: string

    DmsKafkaUser 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 DmsKafkaUser resource accepts the following input properties:

    InstanceId string
    Specifies the ID of the DMS kafka instance to which the user belongs. Changing this creates a new resource.
    Password string
    Specifies the password of the user. The parameter must be 8 to 32 characters long and contain only letters(case-sensitive), digits, and special characters(`~!@#$%^&*()-_=+|[{}]:'",<.>/?). The value must be different from name.
    DmsKafkaUserId string
    The resource ID which is formatted <instance_id>/<user_name>.
    Name string
    Specifies the name of the user. Changing this creates a new resource.
    Region string
    The region in which to create the DMS kafka user resource. If omitted, the provider-level region will be used. Changing this creates a new resource.
    InstanceId string
    Specifies the ID of the DMS kafka instance to which the user belongs. Changing this creates a new resource.
    Password string
    Specifies the password of the user. The parameter must be 8 to 32 characters long and contain only letters(case-sensitive), digits, and special characters(`~!@#$%^&*()-_=+|[{}]:'",<.>/?). The value must be different from name.
    DmsKafkaUserId string
    The resource ID which is formatted <instance_id>/<user_name>.
    Name string
    Specifies the name of the user. Changing this creates a new resource.
    Region string
    The region in which to create the DMS kafka user resource. If omitted, the provider-level region will be used. Changing this creates a new resource.
    instanceId String
    Specifies the ID of the DMS kafka instance to which the user belongs. Changing this creates a new resource.
    password String
    Specifies the password of the user. The parameter must be 8 to 32 characters long and contain only letters(case-sensitive), digits, and special characters(`~!@#$%^&*()-_=+|[{}]:'",<.>/?). The value must be different from name.
    dmsKafkaUserId String
    The resource ID which is formatted <instance_id>/<user_name>.
    name String
    Specifies the name of the user. Changing this creates a new resource.
    region String
    The region in which to create the DMS kafka user resource. If omitted, the provider-level region will be used. Changing this creates a new resource.
    instanceId string
    Specifies the ID of the DMS kafka instance to which the user belongs. Changing this creates a new resource.
    password string
    Specifies the password of the user. The parameter must be 8 to 32 characters long and contain only letters(case-sensitive), digits, and special characters(`~!@#$%^&*()-_=+|[{}]:'",<.>/?). The value must be different from name.
    dmsKafkaUserId string
    The resource ID which is formatted <instance_id>/<user_name>.
    name string
    Specifies the name of the user. Changing this creates a new resource.
    region string
    The region in which to create the DMS kafka user resource. If omitted, the provider-level region will be used. Changing this creates a new resource.
    instance_id str
    Specifies the ID of the DMS kafka instance to which the user belongs. Changing this creates a new resource.
    password str
    Specifies the password of the user. The parameter must be 8 to 32 characters long and contain only letters(case-sensitive), digits, and special characters(`~!@#$%^&*()-_=+|[{}]:'",<.>/?). The value must be different from name.
    dms_kafka_user_id str
    The resource ID which is formatted <instance_id>/<user_name>.
    name str
    Specifies the name of the user. Changing this creates a new resource.
    region str
    The region in which to create the DMS kafka user resource. If omitted, the provider-level region will be used. Changing this creates a new resource.
    instanceId String
    Specifies the ID of the DMS kafka instance to which the user belongs. Changing this creates a new resource.
    password String
    Specifies the password of the user. The parameter must be 8 to 32 characters long and contain only letters(case-sensitive), digits, and special characters(`~!@#$%^&*()-_=+|[{}]:'",<.>/?). The value must be different from name.
    dmsKafkaUserId String
    The resource ID which is formatted <instance_id>/<user_name>.
    name String
    Specifies the name of the user. Changing this creates a new resource.
    region String
    The region in which to create the DMS kafka user resource. If omitted, the provider-level region will be used. Changing this creates a new resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DmsKafkaUser 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 DmsKafkaUser Resource

    Get an existing DmsKafkaUser 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?: DmsKafkaUserState, opts?: CustomResourceOptions): DmsKafkaUser
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dms_kafka_user_id: Optional[str] = None,
        instance_id: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        region: Optional[str] = None) -> DmsKafkaUser
    func GetDmsKafkaUser(ctx *Context, name string, id IDInput, state *DmsKafkaUserState, opts ...ResourceOption) (*DmsKafkaUser, error)
    public static DmsKafkaUser Get(string name, Input<string> id, DmsKafkaUserState? state, CustomResourceOptions? opts = null)
    public static DmsKafkaUser get(String name, Output<String> id, DmsKafkaUserState state, CustomResourceOptions options)
    resources:  _:    type: flexibleengine:DmsKafkaUser    get:      id: ${id}
    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.
    The following state arguments are supported:
    DmsKafkaUserId string
    The resource ID which is formatted <instance_id>/<user_name>.
    InstanceId string
    Specifies the ID of the DMS kafka instance to which the user belongs. Changing this creates a new resource.
    Name string
    Specifies the name of the user. Changing this creates a new resource.
    Password string
    Specifies the password of the user. The parameter must be 8 to 32 characters long and contain only letters(case-sensitive), digits, and special characters(`~!@#$%^&*()-_=+|[{}]:'",<.>/?). The value must be different from name.
    Region string
    The region in which to create the DMS kafka user resource. If omitted, the provider-level region will be used. Changing this creates a new resource.
    DmsKafkaUserId string
    The resource ID which is formatted <instance_id>/<user_name>.
    InstanceId string
    Specifies the ID of the DMS kafka instance to which the user belongs. Changing this creates a new resource.
    Name string
    Specifies the name of the user. Changing this creates a new resource.
    Password string
    Specifies the password of the user. The parameter must be 8 to 32 characters long and contain only letters(case-sensitive), digits, and special characters(`~!@#$%^&*()-_=+|[{}]:'",<.>/?). The value must be different from name.
    Region string
    The region in which to create the DMS kafka user resource. If omitted, the provider-level region will be used. Changing this creates a new resource.
    dmsKafkaUserId String
    The resource ID which is formatted <instance_id>/<user_name>.
    instanceId String
    Specifies the ID of the DMS kafka instance to which the user belongs. Changing this creates a new resource.
    name String
    Specifies the name of the user. Changing this creates a new resource.
    password String
    Specifies the password of the user. The parameter must be 8 to 32 characters long and contain only letters(case-sensitive), digits, and special characters(`~!@#$%^&*()-_=+|[{}]:'",<.>/?). The value must be different from name.
    region String
    The region in which to create the DMS kafka user resource. If omitted, the provider-level region will be used. Changing this creates a new resource.
    dmsKafkaUserId string
    The resource ID which is formatted <instance_id>/<user_name>.
    instanceId string
    Specifies the ID of the DMS kafka instance to which the user belongs. Changing this creates a new resource.
    name string
    Specifies the name of the user. Changing this creates a new resource.
    password string
    Specifies the password of the user. The parameter must be 8 to 32 characters long and contain only letters(case-sensitive), digits, and special characters(`~!@#$%^&*()-_=+|[{}]:'",<.>/?). The value must be different from name.
    region string
    The region in which to create the DMS kafka user resource. If omitted, the provider-level region will be used. Changing this creates a new resource.
    dms_kafka_user_id str
    The resource ID which is formatted <instance_id>/<user_name>.
    instance_id str
    Specifies the ID of the DMS kafka instance to which the user belongs. Changing this creates a new resource.
    name str
    Specifies the name of the user. Changing this creates a new resource.
    password str
    Specifies the password of the user. The parameter must be 8 to 32 characters long and contain only letters(case-sensitive), digits, and special characters(`~!@#$%^&*()-_=+|[{}]:'",<.>/?). The value must be different from name.
    region str
    The region in which to create the DMS kafka user resource. If omitted, the provider-level region will be used. Changing this creates a new resource.
    dmsKafkaUserId String
    The resource ID which is formatted <instance_id>/<user_name>.
    instanceId String
    Specifies the ID of the DMS kafka instance to which the user belongs. Changing this creates a new resource.
    name String
    Specifies the name of the user. Changing this creates a new resource.
    password String
    Specifies the password of the user. The parameter must be 8 to 32 characters long and contain only letters(case-sensitive), digits, and special characters(`~!@#$%^&*()-_=+|[{}]:'",<.>/?). The value must be different from name.
    region String
    The region in which to create the DMS kafka user resource. If omitted, the provider-level region will be used. Changing this creates a new resource.

    Import

    DMS kafka users can be imported using the kafka instance ID and user name separated by a slash, e.g.

    $ pulumi import flexibleengine:index/dmsKafkaUser:DmsKafkaUser user c8057fe5-23a8-46ef-ad83-c0055b4e0c5c/user_1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
    License
    Notes
    This Pulumi package is based on the flexibleengine Terraform Provider.
    flexibleengine logo
    flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
    flexibleenginecloud/terraform-provider-flexibleengine