ALIYUN::ESA::OriginClientCertificate - Resource Orchestration Service

The ALIYUN::ESA::OriginClientCertificate resource is used to upload an origin client certificate at the domain level.

Syntax

{
  "Type": "ALIYUN::ESA::OriginClientCertificate",
  "Properties": {
    "Certificate": String,
    "PrivateKey": String,
    "SiteId": Integer,
    "Hostnames": List,
    "OriginClientCertificateName": String,
    "ValidityDays": Integer
  }
}

Properties

Parameter	Type	Required	Editable	Description	Constraints
Certificate	String	Yes	No	The content of the certificate.	None
PrivateKey	String	Yes	No	The private key of the certificate.	None
SiteId	Integer	Yes	No	The site ID.	None
Hostnames	List	No	Yes	The associated domain names.	None
OriginClientCertificateName	String	No	No	The certificate name.	None
ValidityDays	Integer	No	No	The validity period of the certificate.	Unit: days.

Return values

Fn::GetAtt

SAN: The subject alternative name (SAN) of the certificate.
SiteId: The site ID.
FingerprintSha256: The SHA-256 fingerprint of the certificate.
SiteName: The site name.
Issuer: The certificate authority (CA) that issued the certificate.
PubkeyAlgorithm: The public-key algorithm of the certificate.
CreateTime: The time when the certificate was created.
SignatureAlgorithm: The signature algorithm of the certificate.
NotAfter: The time when the certificate expires.
OriginClientCertificateName: The certificate name.
Type: The certificate type.
SerialNumber: The serial number of the certificate.
UpdateTime: The time when the certificate was updated.
OriginClientCertificateId: The certificate ID.
NotBefore: The time when the certificate takes effect.
Hostnames: The associated domain names.
Certificate: The content of the certificate.
CommonName: The common name of the certificate.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  SiteId:
    Type: Number
    Description:
      en: The site ID.
    Required: true
  PrivateKey:
    Type: String
    Description:
      en: The private key of the certificate.
    Required: true
  Certificate:
    Type: String
    Description:
      en: The content of the certificate.
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::ESA::OriginClientCertificate
    Properties:
      SiteId:
        Ref: SiteId
      PrivateKey:
        Ref: PrivateKey
      Certificate:
        Ref: Certificate
Outputs:
  SAN:
    Description: The subject alternative name (SAN) of the certificate.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SAN
  SiteId:
    Description: The site ID.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SiteId
  FingerprintSha256:
    Description: The SHA-256 fingerprint of the certificate.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - FingerprintSha256
  SiteName:
    Description: The site name.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SiteName
  Issuer:
    Description: The certificate authority (CA) that issued the certificate.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Issuer
  PubkeyAlgorithm:
    Description: The public-key algorithm of the certificate.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PubkeyAlgorithm
  CreateTime:
    Description: The time when the certificate was created.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreateTime
  SignatureAlgorithm:
    Description: The signature algorithm of the certificate.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SignatureAlgorithm
  NotAfter:
    Description: The time when the certificate expires.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - NotAfter
  OriginClientCertificateName:
    Description: The certificate name.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - OriginClientCertificateName
  Type:
    Description: The certificate type.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Type
  SerialNumber:
    Description: The serial number of the certificate.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SerialNumber
  UpdateTime:
    Description: The time when the certificate was updated.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - UpdateTime
  OriginClientCertificateId:
    Description: The certificate ID.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - OriginClientCertificateId
  NotBefore:
    Description: The time when the certificate takes effect.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - NotBefore
  Hostnames:
    Description: The associated domain names.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Hostnames
  Certificate:
    Description: The content of the certificate.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Certificate
  CommonName:
    Description: The common name of the certificate.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CommonName

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SiteId": {
      "Type": "Number",
      "Description": {
        "en": "The site ID."
      },
      "Required": true
    },
    "PrivateKey": {
      "Type": "String",
      "Description": {
        "en": "The private key of the certificate."
      },
      "Required": true
    },
    "Certificate": {
      "Type": "String",
      "Description": {
        "en": "The content of the certificate."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ESA::OriginClientCertificate",
      "Properties": {
        "SiteId": {
          "Ref": "SiteId"
        },
        "PrivateKey": {
          "Ref": "PrivateKey"
        },
        "Certificate": {
          "Ref": "Certificate"
        }
      }
    }
  },
  "Outputs": {
    "SAN": {
      "Description": "The subject alternative name (SAN) of the certificate.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SAN"
        ]
      }
    },
    "SiteId": {
      "Description": "The site ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SiteId"
        ]
      }
    },
    "FingerprintSha256": {
      "Description": "The SHA-256 fingerprint of the certificate.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "FingerprintSha256"
        ]
      }
    },
    "SiteName": {
      "Description": "The site name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SiteName"
        ]
      }
    },
    "Issuer": {
      "Description": "The certificate authority (CA) that issued the certificate.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Issuer"
        ]
      }
    },
    "PubkeyAlgorithm": {
      "Description": "The public-key algorithm of the certificate.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PubkeyAlgorithm"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the certificate was created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "SignatureAlgorithm": {
      "Description": "The signature algorithm of the certificate.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SignatureAlgorithm"
        ]
      }
    },
    "NotAfter": {
      "Description": "The time when the certificate expires.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "NotAfter"
        ]
      }
    },
    "OriginClientCertificateName": {
      "Description": "The certificate name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "OriginClientCertificateName"
        ]
      }
    },
    "Type": {
      "Description": "The certificate type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Type"
        ]
      }
    },
    "SerialNumber": {
      "Description": "The serial number of the certificate.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SerialNumber"
        ]
      }
    },
    "UpdateTime": {
      "Description": "The time when the certificate was updated.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "UpdateTime"
        ]
      }
    },
    "OriginClientCertificateId": {
      "Description": "The certificate ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "OriginClientCertificateId"
        ]
      }
    },
    "NotBefore": {
      "Description": "The time when the certificate takes effect.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "NotBefore"
        ]
      }
    },
    "Hostnames": {
      "Description": "The associated domain names.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Hostnames"
        ]
      }
    },
    "Certificate": {
      "Description": "The content of the certificate.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Certificate"
        ]
      }
    },
    "CommonName": {
      "Description": "The common name of the certificate.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CommonName"
        ]
      }
    }
  }
}