ALIYUN::RDS::ADInfo

Updated at:

Configures Active Directory Domain Services (AD DS) for an ApsaraDB RDS instance.

Syntax

{
  "Type": "ALIYUN::RDS::ADInfo",
  "Properties": {
    "ADServerIpAddress": String,
    "ADDNS": String,
    "DBInstanceId": String,
    "ADPassword": String,
    "ADAccountName": String
  }
}

Properties

Property Type Required Editable Description Constraint
ADServerIpAddress String Yes No The IP address of the AD server. The AD server and the ApsaraDB RDS instance must be within the same VPC.
ADDNS String Yes No The AD domain name. None
DBInstanceId String Yes No The ID of the ApsaraDB RDS instance. None
ADPassword String Yes No The password of the AD domain account. None
ADAccountName String Yes No The account of the AD domain. None

Response parameters

Fn::GetAtt

  • ADDNS: the AD domain name.
  • DBInstanceId: the ID of the ApsaraDB RDS instance.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ADServerIpAddress": {
      "Type": "String",
      "Description": "The IP address of the AD server, it must be in the same VPC as the RDS."
    },
    "ADDNS": {
      "Type": "String",
      "Description": "Active directory domain name."
    },
    "DBInstanceId": {
      "Type": "String",
      "Description": "The ID of the instance."
    },
    "ADPassword": {
      "Type": "String",
      "Description": "Domain password. "
    },
    "ADAccountName": {
      "Type": "String",
      "Description": "Domain account name. "
    }
  },
  "Resources": {
    "AdInfo": {
      "Type": "ALIYUN::RDS::ADInfo",
      "Properties": {
        "ADServerIpAddress": {
          "Ref": "ADServerIpAddress"
        },
        "ADDNS": {
          "Ref": "ADDNS"
        },
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        },
        "ADPassword": {
          "Ref": "ADPassword"
        },
        "ADAccountName": {
          "Ref": "ADAccountName"
        }
      }
    }
  },
  "Outputs": {
    "ADDNS": {
      "Description": "Active directory domain name.",
      "Value": {
        "Fn::GetAtt": [
          "AdInfo",
          "ADDNS"
        ]
      }
    },
    "DBInstanceId": {
      "Description": "The ID of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "AdInfo",
          "DBInstanceId"
        ]
      }
    }
  }
}

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
 ADServerIpAddress:
  Type: String
  Description: 'The IP address of the AD server, it must be in the same VPC as the RDS.'
 ADDNS:
  Type: String
  Description: Active directory domain name.
 DBInstanceId:
  Type: String
  Description: The ID of the instance.
 ADPassword:
  Type: String
  Description: 'Domain password. '
 ADAccountName:
  Type: String
  Description: 'Domain account name. '
Resources:
 AdInfo:
  Type: 'ALIYUN::RDS::ADInfo'
  Properties:
   ADServerIpAddress:
    Ref: ADServerIpAddress
   ADDNS:
    Ref: ADDNS
   DBInstanceId:
    Ref: DBInstanceId
   ADPassword:
    Ref: ADPassword
   ADAccountName:
    Ref: ADAccountName
Outputs:
 ADDNS:
  Description: Active directory domain name.
  Value:
   'Fn::GetAtt':
    - AdInfo
    - ADDNS
 DBInstanceId:
  Description: The ID of the instance.
  Value:
   'Fn::GetAtt':
    - AdInfo
    - DBInstanceId