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

ALIYUN::ESA::Certificate类型用于配置站点证书。

语法

{
  "Type": "ALIYUN::ESA::Certificate",
  "Properties": {
    "CreatedType": String,
    "Domains": List,
    "SiteId": Integer,
    "CertId": String,
    "CertName": String,
    "CasId": String,
    "Certificate": String,
    "PrivateKey": String
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
CreatedType	String	是	否	证书类型。	取值： cas：证书中心证书。 upload：自定义上传证书。 free：免费证书。
Domains	List	是	否	域名列表。	最多支持配置50个域名。
SiteId	Integer	是	否	站点 ID。	无
CertId	String	否	否	证书 ID。	不支持 free 类型（通过接口 ApplyCertificate 创建）的证书 Id，可以支持 cas 和 upload 类型的证书 Id。
CertName	String	否	是	证书名称。	CreatedType 为 upload 类型时需要输入该参数。
CasId	String	否	是	云证书 Id。	CreatedType 为 cas 的情况下需要输入该参数。
Certificate	String	否	是	证书内容。	CreatedType 为 upload 类型时需要输入该参数。
PrivateKey	String	否	否	证书私钥。	CreatedType 为 upload 类型时需要输入该参数。

返回值

Fn::GetAtt

SiteId：站点 ID。
ApplyMessage：证书申请错误信息。
FingerprintSha256：证书 sha256 指纹。
SiteName：站点名称。
IssuerCN：证书颁发机构。
Issuer：证书发行商。
CertId：证书 Id。
CreateTime：创建时间。
ApplyCode：证书申请错误码。
NotAfter：证书有效期的截止时间。
CasId：云证书 Id。
Domains：域名列表。
SigAlg：证书签名算法。
SerialNumber：证书的序列号。
DCV：DCV 信息。
UpdateTime：更新时间。
CertName：证书名称。
NotBefore：证书有效期的开始时间。
PubAlg：证书公钥算法。
Certificate：证书内容。
CommonName：证书通用名称 CN 字段。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Domains:
    AssociationPropertyMetadata:
      Parameter:
        Type: String
        Description:
          en: The domain name.
        Required: false
    AssociationProperty: List[Parameter]
    Type: Json
    Description:
      en: A list of domain names. Multiple domain names are separated by commas.
    Required: true
    MinLength: 1
    MaxLength: 50
  SiteId:
    Type: Number
    Description:
      en: The site ID, which can be obtained by calling the ListSites interface.
    Required: true
  CreatedType:
    Type: String
    Description:
      en: |-
        The certificate type.
        - cas (Certificate Center Certificate)
        - upload (custom upload certificate)
        - free( Free certificate).
    AllowedValues:
      - cas
      - upload
      - free
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::ESA::Certificate
    Properties:
      Domains:
        Ref: Domains
      SiteId:
        Ref: SiteId
      CreatedType:
        Ref: CreatedType
Outputs:
  SiteId:
    Description: The site ID, which can be obtained by calling the ListSites interface.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SiteId
  ApplyMessage:
    Description: Certificate application error message.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ApplyMessage
  FingerprintSha256:
    Description: SHA256 fingerprint of the certificate.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - FingerprintSha256
  SiteName:
    Description: Site name.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SiteName
  IssuerCN:
    Description: Common name of the certificate issuer.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IssuerCN
  Issuer:
    Description: Certificate issuer.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Issuer
  CertId:
    Description: The certificate Id.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CertId
  CreateTime:
    Description: Creation time.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreateTime
  ApplyCode:
    Description: Certificate application error code.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ApplyCode
  NotAfter:
    Description: End time of the certificate validity period.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - NotAfter
  CasId:
    Description: Cloud certificate ID.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CasId
  Domains:
    Description: A list of domain names. Multiple domain names are separated by commas.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Domains
  SigAlg:
    Description: Certificate signature algorithm.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SigAlg
  SerialNumber:
    Description: Serial number of the certificate.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SerialNumber
  DCV:
    Description: DCV information.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DCV
  UpdateTime:
    Description: Update time.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - UpdateTime
  CertName:
    Description: The certificate name.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CertName
  NotBefore:
    Description: Start time of the certificate validity period.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - NotBefore
  PubAlg:
    Description: Certificate public key algorithm.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PubAlg
  Certificate:
    Description: Certificate content.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Certificate
  CommonName:
    Description: Common Name (CN) field of the certificate.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CommonName

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Domains": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "String",
          "Description": {
            "en": "The domain name."
          },
          "Required": false
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "en": "A list of domain names. Multiple domain names are separated by commas."
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 50
    },
    "SiteId": {
      "Type": "Number",
      "Description": {
        "en": "The site ID, which can be obtained by calling the ListSites interface."
      },
      "Required": true
    },
    "CreatedType": {
      "Type": "String",
      "Description": {
        "en": "The certificate type.\n- cas (Certificate Center Certificate)\n- upload (custom upload certificate)\n- free( Free certificate)."
      },
      "AllowedValues": [
        "cas",
        "upload",
        "free"
      ],
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ESA::Certificate",
      "Properties": {
        "Domains": {
          "Ref": "Domains"
        },
        "SiteId": {
          "Ref": "SiteId"
        },
        "CreatedType": {
          "Ref": "CreatedType"
        }
      }
    }
  },
  "Outputs": {
    "SiteId": {
      "Description": "The site ID, which can be obtained by calling the ListSites interface.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SiteId"
        ]
      }
    },
    "ApplyMessage": {
      "Description": "Certificate application error message.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ApplyMessage"
        ]
      }
    },
    "FingerprintSha256": {
      "Description": "SHA256 fingerprint of the certificate.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "FingerprintSha256"
        ]
      }
    },
    "SiteName": {
      "Description": "Site name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SiteName"
        ]
      }
    },
    "IssuerCN": {
      "Description": "Common name of the certificate issuer.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IssuerCN"
        ]
      }
    },
    "Issuer": {
      "Description": "Certificate issuer.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Issuer"
        ]
      }
    },
    "CertId": {
      "Description": "The certificate Id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CertId"
        ]
      }
    },
    "CreateTime": {
      "Description": "Creation time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "ApplyCode": {
      "Description": "Certificate application error code.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ApplyCode"
        ]
      }
    },
    "NotAfter": {
      "Description": "End time of the certificate validity period.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "NotAfter"
        ]
      }
    },
    "CasId": {
      "Description": "Cloud certificate ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CasId"
        ]
      }
    },
    "Domains": {
      "Description": "A list of domain names. Multiple domain names are separated by commas.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Domains"
        ]
      }
    },
    "SigAlg": {
      "Description": "Certificate signature algorithm.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SigAlg"
        ]
      }
    },
    "SerialNumber": {
      "Description": "Serial number of the certificate.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SerialNumber"
        ]
      }
    },
    "DCV": {
      "Description": "DCV information.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DCV"
        ]
      }
    },
    "UpdateTime": {
      "Description": "Update time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "UpdateTime"
        ]
      }
    },
    "CertName": {
      "Description": "The certificate name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CertName"
        ]
      }
    },
    "NotBefore": {
      "Description": "Start time of the certificate validity period.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "NotBefore"
        ]
      }
    },
    "PubAlg": {
      "Description": "Certificate public key algorithm.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PubAlg"
        ]
      }
    },
    "Certificate": {
      "Description": "Certificate content.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Certificate"
        ]
      }
    },
    "CommonName": {
      "Description": "Common Name (CN) field of the certificate.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CommonName"
        ]
      }
    }
  }
}