ALIYUN::ROCKETMQ5::Account

更新时间:
复制 MD 格式

The ALIYUN::ROCKETMQ5::Account resource creates an access account for an instance.

Syntax

{
  "Type": "ALIYUN::ROCKETMQ5::Account",
  "Properties": {
    "InstanceId": String,
    "Password": String,
    "Username": String,
    "AccountStatus": String
  }
}

Properties

Property

Type

Required

Update allowed

Description

Constraints

InstanceId

String

Yes

No

The instance ID.

None

Password

String

Yes

Yes

The password.

Length: 3 to 64 characters.

Username

String

Yes

No

The username.

Length: 3 to 64 characters.

Allowed characters: letters (a-z, A-Z), digits (0-9), underscores (_), and dashes (-).

AccountStatus

String

No

Yes

The account status.

Valid values:

  • DISABLE: The account is disabled.

  • ENABLE: The account is enabled.

Return values

Fn::GetAtt

  • AccountStatus: The status of the account.

  • Username: The username of the account.

  • Password: The password for the account.

Examples

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AccountStatus:
    AllowedValues:
      - DISABLE
      - ENABLE
    Description:
      en: 'The status of the account.
        Valid values:
        - DISABLE: The account is disabled.
        - ENABLE: The account is enabled.'
    Required: false
    Type: String
  InstanceId:
    Description:
      en: The instance ID.
    Required: true
    Type: String
  Password:
    Description:
      en: 'The password for the account.
        Length: 3 to 64 characters.'
    Required: true
    Type: String
  Username:
    Description:
      en: 'The username for the account.
        Length: 3 to 64 characters.
        Allowed characters: letters (a-z, A-Z), digits (0-9), underscores (_), and dashes (-).'
    Required: true
    Type: String
Resources:
  ExtensionResource:
    Properties:
      AccountStatus:
        Ref: AccountStatus
      InstanceId:
        Ref: InstanceId
      Password:
        Ref: Password
      Username:
        Ref: Username
    Type: ALIYUN::ROCKETMQ5::Account
Outputs:
  AccountStatus:
    Description: The status of the account.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - AccountStatus
  Password:
    Description: The password for the account.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Password
  Username:
    Description: The username of the account.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Username
                        
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "AccountStatus": {
      "Type": "String",
      "Description": {
        "en": "The status of the account.\nValid values:\n- DISABLE: The account is disabled.\n- ENABLE: The account is enabled."
      },
      "AllowedValues": [
        "DISABLE",
        "ENABLE"
      ],
      "Required": false
    },
    "InstanceId": {
      "Type": "String",
      "Description": {
        "en": "The instance ID."
      },
      "Required": true
    },
    "Username": {
      "Type": "String",
      "Description": {
        "en": "The username for the account.\nLength: 3 to 64 characters.\nAllowed characters: letters (a-z, A-Z), digits (0-9), underscores (_), and dashes (-)."
      },
      "Required": true
    },
    "Password": {
      "Type": "String",
      "Description": {
        "en": "The password for the account.\nLength: 3 to 64 characters."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ROCKETMQ5::Account",
      "Properties": {
        "AccountStatus": {
          "Ref": "AccountStatus"
        },
        "InstanceId": {
          "Ref": "InstanceId"
        },
        "Username": {
          "Ref": "Username"
        },
        "Password": {
          "Ref": "Password"
        }
      }
    }
  },
  "Outputs": {
    "AccountStatus": {
      "Description": "The status of the account.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "AccountStatus"
        ]
      }
    },
    "Username": {
      "Description": "The username of the account.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Username"
        ]
      }
    },
    "Password": {
      "Description": "The password for the account.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Password"
        ]
      }
    }
  }
}