@huaweicloudos/pulumi
Version:
A Pulumi package for creating and managing Huaweicloud cloud resources.
160 lines (159 loc) • 5.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a DMS kafka user resource within HuaweiCloud.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pulumi from "@huaweicloudos/pulumi";
*
* const config = new pulumi.Config();
* const kafkaInstanceId = config.requireObject("kafkaInstanceId");
* const userPassword = config.requireObject("userPassword");
* const user = new huaweicloud.dms.KafkaUser("user", {
* instanceId: kafkaInstanceId,
* password: userPassword,
* description: "test_description",
* });
* ```
*
* ## Import
*
* DMS kafka users can be imported using the kafka instance ID and user name separated by a slash, e.g. bash
*
* ```sh
* $ pulumi import huaweicloud:Dms/kafkaUser:KafkaUser user c8057fe5-23a8-46ef-ad83-c0055b4e0c5c/user_1
* ```
*/
export declare class KafkaUser extends pulumi.CustomResource {
/**
* Get an existing KafkaUser resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: KafkaUserState, opts?: pulumi.CustomResourceOptions): KafkaUser;
/**
* Returns true if the given object is an instance of KafkaUser. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is KafkaUser;
/**
* Indicates the create time.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Indicates whether the application is the default application.
*/
readonly defaultApp: pulumi.Output<boolean>;
/**
* Specifies the description of the user.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Specifies the ID of the DMS kafka instance to which the user belongs.
* Changing this creates a new resource.
*/
readonly instanceId: pulumi.Output<string>;
/**
* Specifies the name of the user. Changing this creates a new resource.
*/
readonly name: pulumi.Output<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.
*/
readonly password: pulumi.Output<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.
*/
readonly region: pulumi.Output<string>;
/**
* Indicates the user role.
*/
readonly role: pulumi.Output<string>;
/**
* Create a KafkaUser resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: KafkaUserArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering KafkaUser resources.
*/
export interface KafkaUserState {
/**
* Indicates the create time.
*/
createdAt?: pulumi.Input<string>;
/**
* Indicates whether the application is the default application.
*/
defaultApp?: pulumi.Input<boolean>;
/**
* Specifies the description of the user.
*/
description?: pulumi.Input<string>;
/**
* Specifies the ID of the DMS kafka instance to which the user belongs.
* Changing this creates a new resource.
*/
instanceId?: pulumi.Input<string>;
/**
* Specifies the name of the user. Changing this creates a new resource.
*/
name?: pulumi.Input<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.
*/
password?: pulumi.Input<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.
*/
region?: pulumi.Input<string>;
/**
* Indicates the user role.
*/
role?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a KafkaUser resource.
*/
export interface KafkaUserArgs {
/**
* Specifies the description of the user.
*/
description?: pulumi.Input<string>;
/**
* Specifies the ID of the DMS kafka instance to which the user belongs.
* Changing this creates a new resource.
*/
instanceId: pulumi.Input<string>;
/**
* Specifies the name of the user. Changing this creates a new resource.
*/
name?: pulumi.Input<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.
*/
password: pulumi.Input<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.
*/
region?: pulumi.Input<string>;
}