All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::DLF::Catalog

Last Updated:Aug 12, 2024

ALIYUN::DLF::Catalog is used to create a catalog in Data Lake Formation (DLF).

Syntax

{
  "Type": "ALIYUN::DLF::Catalog",
  "Properties": {
    "Owner": String,
    "LocationUri": String,
    "Description": String,
    "CatalogId": String
  }
}

Properties

PropertyTypeRequiredEditableDescriptionConstraint
OwnerStringNoYesThe information about the user. None.
LocationUriStringNoYesThe location Uniform Resource Identifier (URI) of the database. Example: /hdfs/hivedb/data.
DescriptionStringNoYesThe description of the catalog. None.
CatalogIdStringYesNoThe ID of the catalog. By default, your Alibaba Cloud account ID is used.

Return values

Fn::GetAtt

CatalogId: the ID of the catalog.

Examples

  • JSON format

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "CatalogId": {
          "Type": "String",
          "Description": "Catalog ID",
          "AllowedPattern": "^[a-zA-Z][a-zA-Z0-9_]{1,255}"
        }
      },
      "Resources": {
        "Catalog": {
          "Type": "ALIYUN::DLF::Catalog",
          "Properties": {
            "CatalogId": {
              "Ref": "CatalogId"
            }
          }
        }
      },
      "Outputs": {
        "CatalogId": {
          "Description": "Catalog ID",
          "Value": {
            "Fn::GetAtt": [
              "Catalog",
              "CatalogId"
            ]
          }
        }
      }
    }
  • YAML format

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      CatalogId:
        AllowedPattern: ^[a-zA-Z][a-zA-Z0-9_]{1,255}
        Description: Catalog ID
        Type: String
    Resources:
      Catalog:
        Properties:
          CatalogId:
            Ref: CatalogId
        Type: ALIYUN::DLF::Catalog
    Outputs:
      CatalogId:
        Description: Catalog ID
        Value:
          Fn::GetAtt:
          - Catalog
          - CatalogId