All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::CloudSSO::Directory

Last Updated:Mar 20, 2024

ALIYUN::CloudSSO::Directory is used to create a directory.

Syntax

{
  "Type": "ALIYUN::CloudSSO::Directory",
  "Properties": {
    "DirectoryName": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

DirectoryName

String

No

Yes

The directory name. The name must be globally unique.

The name can contain lowercase letters, digits, and hyphens (-). It cannot start or end with a hyphen (-) and cannot contain two consecutive hyphens (-). It cannot start with d-.

The name must be 2 to 64 characters in length.

Note

If you do not specify this property, the system automatically generates a value for the property.

Return values

Fn::GetAtt

DirectoryId: the directory ID.

Examples

  • YAML format

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      DirectoryName:
        Description:
          en: 'The name of the directory. The name must be globally unique.
    
            The name can contain lowercase letters, digits, or hyphens (-). The name cannot
            start or end with a hyphen (-) and cannot contain two consecutive hyphens
            (-). The name cannot start with d-.
    
            The name must be 2 to 64 characters in length.
    
            **Note**: If you do not specify this parameter, the value of this parameter
            is automatically generated by the system.'
        Required: false
        Type: String
    Resources:
      Directory:
        Properties:
          DirectoryName:
            Ref: DirectoryName
        Type: ALIYUN::CloudSSO::Directory
    Outputs:
      DirectoryId:
        Description: The ID of the directory.
        Value:
          Fn::GetAtt:
          - Directory
          - DirectoryId
                            
  • JSON format

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "DirectoryName": {
          "Type": "String",
          "Description": {
            "en": "The name of the directory. The name must be globally unique.\nThe name can contain lowercase letters, digits, or hyphens (-). The name cannot start or end with a hyphen (-) and cannot contain two consecutive hyphens (-). The name cannot start with d-.\nThe name must be 2 to 64 characters in length.\n**Note**: If you do not specify this parameter, the value of this parameter is automatically generated by the system."
          },
          "Required": false
        }
      },
      "Resources": {
        "Directory": {
          "Type": "ALIYUN::CloudSSO::Directory",
          "Properties": {
            "DirectoryName": {
              "Ref": "DirectoryName"
            }
          }
        }
      },
      "Outputs": {
        "DirectoryId": {
          "Description": "The ID of the directory.",
          "Value": {
            "Fn::GetAtt": [
              "Directory",
              "DirectoryId"
            ]
          }
        }
      }
    }