ALIYUN::ACM::Configuration is used to create a Configuration.

Syntax

{
  "Type": "ALIYUN::ACM::Configuration",
  "Properties": {
    "DataId": String,
    "Group": String,
    "AppName": String,
    "Tags": String,
    "Content": String,
    "Type": String,
    "NamespaceId": String,
    "Desc": String
  }
}

Properties

Parameter Type Required Editable Description Constraint
DataId String Yes Not supported Configuration ID It supports letters, digits, periods (.), colons (:), asterisks (*), underscores (_), and hyphens (-).

When the ID prefix is one of the following values, ACM automatically encrypts the configuration with KMS:

  • cipher-: uses KMS to encrypt and decrypt configurations. We recommend that the size of the data to be encrypted and decrypted do not exceed 4 KB and 6 KB. You may fail to decrypt special character such as and(&). Therefore, we do not recommend that you use cipher-.
  • cipher-kms-aes-128-: KMS-based envelope encryption and decryption. We recommend that you use. cipher-kms-aes-128: the size of the configuration file. Valid values: 0KB to 100 kB. cipher-kms-aes-128-the plaintext of the configuration content is not transmitted to KMS, ensuring higher security.
Group String No Released The group to which the configuration item that you want to create belongs. None
AppName String Not supported Supported The name of the application to which the configuration item that you want to create belongs. None
Tags String Not supported Supported The tags added to the configuration item. If multiple labels exist, separate them with commas (,).
Content String Yes Yes The content of the configuration item that you want to create. None
Type String Not supported Supported The content format of the configuration item. Valid values:
  • text
  • json
  • xml
  • yaml
  • text/html
  • properties
NamespaceId String Yes Not supported The ID of the namespace that was created. None
Desc String Not supported Supported Description of the configuration None

Return value

Fn::GetAtt

  • DataId: The ID of the configuration.
  • Group: The group.
  • NamespaceId: The ID of the namespace.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "Configuration": {
      "Type": "ALIYUN::ACM::Configuration",
      "Properties": {
        "DataId": {
          "Ref": "DataId"
        },
        "Group": {
          "Ref": "Group"
        },
        "Tags": {
          "Ref": "Tags"
        },
        "AppName": {
          "Ref": "AppName"
        },
        "Content": {
          "Ref": "Content"
        },
        "Type": {
          "Ref": "Type"
        },
        "NamespaceId": {
          "Ref": "NamespaceId"
        },
        "Desc": {
          "Ref": "Desc"
        }
      }
    }
  },
  "Parameters": {
    "DataId": {
      "Type": "String",
      "Description": "The ID of the configuration. Allowed characters are upper and lower case letters, numbers, decimal points (.), Colons (:), asterisks (*), underscores (_), and underscores (-). When the ID prefix is the following value, ACM will automatically use KMS service to encrypt this configuration:\nThe prefix is cipher-: the KMS service is called to encrypt and decrypt the configuration. The size of the encrypted data does not exceed 4 KB, and the maximum does not exceed 6 KB. Special symbols such as and (&) will decrypt errors and are not recommended.\nThe prefix is cipher-kms-aes-128-: using KMS's envelope encryption and decryption method, the configuration content can exceed 6 KB, up to 100 KB. The plain text data of the configuration content will not be transmitted to the KMS system, which is more secure and recommended."
    },
    "Group": {
      "Default": "DEFAULT_GROUP",
      "Type": "String",
      "Description": "Group"
    },
    "Tags": {
      "Type": "String",
      "Description": "Label configurations, such as the presence of a plurality of tags, separated by commas"
    },
    "AppName": {
      "Type": "String",
      "Description": "Configuration application name"
    },
    "Content": {
      "Type": "String",
      "Description": "The contents of the configuration"
    },
    "Type": {
      "Default": "text",
      "Type": "String",
      "Description": "Provisioning content format, optional values as follows:\ntext, json, xml, yaml, text/html, properties",
      "AllowedValues": [
        "text",
        "json",
        "xml",
        "yaml",
        "text/html",
        "properties"
      ]
    },
    "NamespaceId": {
      "Type": "String",
      "Description": "ID of namespace"
    },
    "Desc": {
      "Type": "String",
      "Description": "Configuration description explains"
    }
  },
  "Outputs": {
    "DataId": {
      "Description": "The ID of the configuration",
      "Value": {
        "Fn::GetAtt": [
          "Configuration",
          "DataId"
        ]
      }
    },
    "Group": {
      "Description": "Group",
      "Value": {
        "Fn::GetAtt": [
          "Configuration",
          "Group"
        ]
      }
    },
    "NamespaceId": {
      "Description": "ID of namespace",
      "Value": {
        "Fn::GetAtt": [
          "Configuration",
          "NamespaceId"
        ]
      }
    }
  }
}

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  Configuration:
    Type: 'ALIYUN::ACM::Configuration'
    Properties:
      DataId:
        Ref: DataId
      Group:
        Ref: Group
      Tags:
        Ref: Tags
      AppName:
        Ref: AppName
      Content:
        Ref: Content
      Type:
        Ref: Type
      NamespaceId:
        Ref: NamespaceId
      Desc:
        Ref: Desc
Parameters:
  DataId:
    Type: String
    Description: >-
      The ID of the configuration. Allowed characters are upper and lower case
      letters, numbers, decimal points (.), Colons (:), asterisks (*),
      underscores (_), and underscores (-). When the ID prefix is the following
      value, ACM will automatically use KMS service to encrypt this
      configuration:

      The prefix is cipher-: the KMS service is called to encrypt and decrypt
      the configuration. The size of the encrypted data does not exceed 4 KB,
      and the maximum does not exceed 6 KB. Special symbols such as and (&)
      will decrypt errors and are not recommended.

      The prefix is cipher-kms-aes-128-: using KMS's envelope encryption and
      decryption method, the configuration content can exceed 6 KB, up to 100
      KB. The plain text data of the configuration content will not be
      transmitted to the KMS system, which is more secure and recommended.
  Group:
    Default: DEFAULT_GROUP
    Type: String
    Description: Group
  Tags:
    Type: String
    Description: >-
      Label configurations, such as the presence of a plurality of tags,
      separated by commas
  AppName:
    Type: String
    Description: Configuration application name
  Content:
    Type: String
    Description: The contents of the configuration
  Type:
    Default: text
    Type: String
    Description: |-
      Provisioning content format, optional values as follows:
      text, json, xml, yaml, text/html, properties
    AllowedValues:
      - text
      -json
      -xml
      -yaml
      -text/html
      -properties
  NamespaceId:
    Type: String
    Description: ID of namespace
  Desc:
    Type: String
    Description: Configuration description explains
Outputs:
  DataId:
    Description: The ID of the configuration
    Value:
      'Fn::GetAtt':
        -Configuration
        -DataId
  Group:
    Description: Group
    Value:
      'Fn::GetAtt':
        -Configuration
        -Group
  NamespaceId:
    Description: ID of namespace
    Value:
      'Fn::GetAtt':
        -Configuration
        -NamespaceId