Class ClientUser
Provides a Sag ClientUser resource. This topic describes how to manage accounts as an administrator. After you configure the network, you can create multiple accounts and distribute them to end users so that clients can access Alibaba Cloud.
For information about Sag ClientUser and how to use it, see What is Sag ClientUser.
NOTE: Available in 1.65.0+
NOTE: Only the following regions support. [
cn-shanghai,cn-shanghai-finance-1,cn-hongkong,ap-southeast-1,ap-southeast-2,ap-southeast-3,ap-southeast-5,ap-northeast-1,eu-central-1]
Example Usage
using Pulumi;
using AliCloud = Pulumi.AliCloud;
class MyStack : Stack
{
public MyStack()
{
var @default = new AliCloud.RocketMQ.ClientUser("default", new AliCloud.RocketMQ.ClientUserArgs
{
Bandwidth = "20",
ClientIp = "192.1.10.0",
Password = "xxxxxxx",
SagId = "sag-xxxxx",
UserMail = "tftest-xxxxx@test.com",
UserName = "th-username-xxxxx",
});
}
}
Inherited Members
Namespace: Pulumi.AliCloud.RocketMQ
Assembly: Pulumi.AliCloud.dll
Syntax
public class ClientUser : CustomResource
Constructors
View SourceClientUser(String, ClientUserArgs, CustomResourceOptions)
Create a ClientUser resource with the given unique name, arguments, and options.
Declaration
public ClientUser(string name, ClientUserArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| ClientUserArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceBandwidth
The SAG APP bandwidth that the user can use. Unit: Kbit/s. Maximum value: 2000 Kbit/s.
Declaration
public Output<int> Bandwidth { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Int32> |
ClientIp
The IP address of the SAG APP. If you specify this parameter, the current account always uses the specified IP address.Note The IP address must be in the private CIDR block of the SAG client.If you do not specify this parameter, the system automatically allocates an IP address from the private CIDR block of the SAG client. In this case, each re-connection uses a different IP address.
Declaration
public Output<string> ClientIp { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
KmsEncryptedPassword
Declaration
public Output<string> KmsEncryptedPassword { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
KmsEncryptionContext
Declaration
public Output<ImmutableDictionary<string, object>> KmsEncryptionContext { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>> |
Password
The password used to log on to the SAG APP.Both the user name and the password must be specified. If you specify the user name, the password must be specified, too.
Declaration
public Output<string> Password { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
SagId
The ID of the SAG instance created for the SAG APP.
Declaration
public Output<string> SagId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
UserMail
The email address of the user. The administrator uses this address to send the account information for logging on to the APP to the user.
Declaration
public Output<string> UserMail { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
UserName
The user name. User names in the same SAG APP must be unique.Both the user name and the password must be specified. If you specify the user name, the password must be specified, too.
Declaration
public Output<string> UserName { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Methods
View SourceGet(String, Input<String>, ClientUserState, CustomResourceOptions)
Get an existing ClientUser resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static ClientUser Get(string name, Input<string> id, ClientUserState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| ClientUserState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| ClientUser |