ALIYUN::CAS::PcaCertificate-资源编排(ROS)-阿里云帮助中心

ALIYUN::CAS::PcaCertificate类型用于PCA 签发的证书。

语法

{
  "Type": "ALIYUN::CAS::PcaCertificate",
  "Properties": {
    "CommonName": String,
    "Locality": String,
    "Organization": String,
    "OrganizationUnit": String,
    "State": String,
    "Years": Integer,
    "Algorithm": String,
    "CountryCode": String,
    "CaStatus": String
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
CommonName	String	是	否	组织的通用名称或缩写。	支持使用中文、英文字符。
Locality	String	是	否	组织所在城市名称。	支持使用中文、英文字符。
Organization	String	是	否	与根 CA 证书关联的组织名称（对应您的企业或公司）。	支持使用中文、英文字符。
OrganizationUnit	String	是	否	组织下的部门或分支机构名称。	支持使用中文、英文字符。
State	String	是	否	组织所在省份、直辖市或自治区的名称。	支持使用中文、英文字符。组织所在省份或州的名称，支持使用中文、英文字符。
Years	Integer	是	否	根 CA 证书的有效期。	单位：年。说明建议设置为 5~10 年。
Algorithm	String	否	否	根 CA 证书的密钥算法类型。	密钥算法格式为《<加密算法>_<密钥长度>》，可选值： RSA_1024：对应签名算法为 Sha256WithRSA。 RSA_2048：对应签名算法为 Sha256WithRSA。 RSA_4096：对应签名算法为 Sha256WithRSA。 ECC_256：对应签名算法为 Sha256WithECDSA。 ECC_384：对应签名算法为 Sha256WithECDSA。 ECC_512：对应签名算法为 Sha256WithECDSA。 SM2_256：对应签名算法为 SM3WithSM2。根 CA 证书的加密算法必须与您购买的私有根 CA 的证书算法一致。示例：若购买私有根 CA 时选择的证书算法为 RSA，则根 CA 证书的密钥算法必须为 RSA_1024、RSA_2048 或 RSA_4096。
CaStatus	String	否	否	当前 CA 状态。	可选值： Issue：已启用。 Forbidden：已禁用。 Revoke：已吊销。
CountryCode	String	否	否	组织所在国家或地区的代码。	使用两位大写字母缩写。例如，CN 代表中国，US 代表美国。

返回值

Fn::GetAtt

CertificateType：CA 类型。
Identifier：证书标识符。
Organization：与根 CA 证书关联的组织名称（对应您的企业或公司），支持使用中文、英文字符。
Years：根 CA 证书的有效期，单位：年。
IssuerType：CA 颁发机构。
Locality：组织所在城市名称，支持使用中文、英文字符。
OrganizationUnit：组织下的部门或分支机构名称，支持使用中文、英文字符。
State： 组织所在省份、直辖市或自治区的名称，支持使用中文、英文字符。
CountryCode：组织所在国家或地区的代码，使用两位大写字母缩写。例如，**CN** 代表中国，**US** 代表美国。
Algorithm：根 CA 证书的密钥算法类型，密钥算法格式为《<加密算法>_<密钥长度>》。
CommonName：组织的通用名称或缩写，支持使用中文、英文字符。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Algorithm:
    AllowedValues:
      - RSA_1024
      - RSA_2048
      - RSA_4096
      - ECC_256
      - ECC_384
      - ECC_512
      - SM2_256
    Description:
      en: 'The key algorithm type of the root CA certificate. The key algorithm is
        expressed using the '<algorithm>_< key length>' format.'
    Required: false
    Type: String
  CaStatus:
    AllowedValues:
      - Issue
      - Forbidden
      - Revoke
    Description:
      en: 'The current CA status. Value:

        - Issue: Enabled.

        - Forbidden: Disabled.

        - Revoke: Revoked.'
    Required: false
    Type: String
  CommonName:
    Description:
      en: The common name or abbreviation of the organization. Support the use of
        Chinese, English characters.
    Required: true
    Type: String
  CountryCode:
    Description:
      en: The code of the country or region in which the organization is located,
        using a two-digit capital abbreviation.
    Required: false
    Type: String
  Locality:
    Description:
      en: Name of the city where the organization is located. Support the use of Chinese,
        English characters.
    Required: true
    Type: String
  Organization:
    Description:
      en: The name of the organization (corresponding to your enterprise or company)
        associated with the root CA certificate. Support the use of Chinese, English
        characters.
    Required: true
    Type: String
  OrganizationUnit:
    Description:
      en: The name of the department or branch under the organization. Support the
        use of Chinese, English characters.
    Required: true
    Type: String
  State:
    Description:
      en: ' The name of the province, municipality, or autonomous
        region in which the organization is located. Support the use of Chinese, English
        characters. 

         Name of the province or state where the organization is located.
        Support the use of Chinese, English characters.'
    Required: true
    Type: String
  Years:
    Description:
      en: 'The validity period of the root CA certificate, in years.'
    MaxValue: 10
    MinValue: 1
    Required: true
    Type: Number
Resources:
  ExtensionResource:
    Properties:
      Algorithm:
        Ref: Algorithm
      CaStatus:
        Ref: CaStatus
      CommonName:
        Ref: CommonName
      CountryCode:
        Ref: CountryCode
      Locality:
        Ref: Locality
      Organization:
        Ref: Organization
      OrganizationUnit:
        Ref: OrganizationUnit
      State:
        Ref: State
      Years:
        Ref: Years
    Type: ALIYUN::CAS::PcaCertificate
Outputs:
  Algorithm:
    Description: The key algorithm type of the root CA certificate. The key algorithm
      is expressed using the '<algorithm>_< key length>' format.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Algorithm
  CertificateType:
    Description: The type of CA.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CertificateType
  CommonName:
    Description: The common name or abbreviation of the organization. Support the
      use of Chinese, English characters.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CommonName
  CountryCode:
    Description: The code of the country or region in which the organization is located,
      using a two-digit capital abbreviation. For example, **CN** represents China
      and **US** represents the United States.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CountryCode
  Identifier:
    Description: Certificate Identifier.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Identifier
  IssuerType:
    Description: The institution issuing the CA.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IssuerType
  Locality:
    Description: Name of the city where the organization is located. Support the use
      of Chinese, English characters.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Locality
  Organization:
    Description: The name of the organization (corresponding to your enterprise or
      company) associated with the root CA certificate. Support the use of Chinese,
      English characters.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Organization
  OrganizationUnit:
    Description: The name of the department or branch under the organization. Support
      the use of Chinese, English characters.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - OrganizationUnit
  State:
    Description: The name of the province, municipality, or autonomous
      region in which the organization is located. Support the use of Chinese, English
      characters.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - State
  Years:
    Description: The validity period of the root CA certificate, in years.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Years

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Organization": {
      "Type": "String",
      "Description": {
        "en": "The name of the organization (corresponding to your enterprise or company) associated with the root CA certificate. Support the use of Chinese, English characters."
      },
      "Required": true
    },
    "Years": {
      "Type": "Number",
      "Description": {
        "en": "The validity period of the root CA certificate, in years."
      },
      "Required": true,
      "MinValue": 1,
      "MaxValue": 10
    },
    "Locality": {
      "Type": "String",
      "Description": {
        "en": "Name of the city where the organization is located. Support the use of Chinese, English characters."
      },
      "Required": true
    },
    "State": {
      "Type": "String",
      "Description": {
        "en": " The name of the province, municipality, or autonomous region in which the organization is located. Support the use of Chinese, English characters. \n Name of the province or state where the organization is located. Support the use of Chinese, English characters. ."
      },
      "Required": true
    },
    "OrganizationUnit": {
      "Type": "String",
      "Description": {
        "en": "The name of the department or branch under the organization. Support the use of Chinese, English characters."
      },
      "Required": true
    },
    "CountryCode": {
      "Type": "String",
      "Description": {
        "en": "The code of the country or region in which the organization is located, using a two-digit capital abbreviation. For example, **CN** represents China and **US** represents the United States."
      },
      "Required": false
    },
    "Algorithm": {
      "Type": "String",
      "Description": {
        "en": "The key algorithm type of the root CA certificate. The key algorithm is expressed using the '<algorithm>_< key length>' format."
      },
      "AllowedValues": [
        "RSA_1024",
        "RSA_2048",
        "RSA_4096",
        "ECC_256",
        "ECC_384",
        "ECC_512",
        "SM2_256"
      ],
      "Required": false
    },
    "CaStatus": {
      "Type": "String",
      "Description": {
        "en": "The current CA status. Value:\n- Issue: Enabled.\n- Forbidden: Disabled.\n- Revoke: Revoked."
      },
      "AllowedValues": [
        "Issue",
        "Forbidden",
        "Revoke"
      ],
      "Required": false
    },
    "CommonName": {
      "Type": "String",
      "Description": {
        "en": "The common name or abbreviation of the organization. Support the use of Chinese, English characters."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::CAS::PcaCertificate",
      "Properties": {
        "Organization": {
          "Ref": "Organization"
        },
        "Years": {
          "Ref": "Years"
        },
        "Locality": {
          "Ref": "Locality"
        },
        "State": {
          "Ref": "State"
        },
        "OrganizationUnit": {
          "Ref": "OrganizationUnit"
        },
        "CountryCode": {
          "Ref": "CountryCode"
        },
        "Algorithm": {
          "Ref": "Algorithm"
        },
        "CaStatus": {
          "Ref": "CaStatus"
        },
        "CommonName": {
          "Ref": "CommonName"
        }
      }
    }
  },
  "Outputs": {
    "CertificateType": {
      "Description": "The type of CA.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CertificateType"
        ]
      }
    },
    "Identifier": {
      "Description": "Certificate Identifier.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Identifier"
        ]
      }
    },
    "Organization": {
      "Description": "The name of the organization (corresponding to your enterprise or company) associated with the root CA certificate. Support the use of Chinese, English characters.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Organization"
        ]
      }
    },
    "Years": {
      "Description": "The validity period of the root CA certificate, in years.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Years"
        ]
      }
    },
    "IssuerType": {
      "Description": "The institution issuing the CA.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IssuerType"
        ]
      }
    },
    "Locality": {
      "Description": "Name of the city where the organization is located. Support the use of Chinese, English characters.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Locality"
        ]
      }
    },
    "OrganizationUnit": {
      "Description": "The name of the department or branch under the organization. Support the use of Chinese, English characters.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "OrganizationUnit"
        ]
      }
    },
    "State": {
      "Description": " The name of the province, municipality, or autonomous region in which the organization is located. Support the use of Chinese, English characters.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "State"
        ]
      }
    },
    "CountryCode": {
      "Description": "The code of the country or region in which the organization is located, using a two-digit capital abbreviation."
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CountryCode"
        ]
      }
    },
    "Algorithm": {
      "Description": "The key algorithm type of the root CA certificate. The key algorithm is expressed using the '<algorithm>_< key length>' format.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Algorithm"
        ]
      }
    },
    "CommonName": {
      "Description": "The common name or abbreviation of the organization. Support the use of Chinese, English characters.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CommonName"
        ]
      }
    }
  }
}