ALIYUN::ESA::SiteOriginClientCertificate - Resource Orchestration Service

Syntax

{
  "Type": "ALIYUN::ESA::SiteOriginClientCertificate",
  "Properties": {
    "Certificate": String,
    "PrivateKey": String,
    "SiteId": Integer,
    "SiteOriginClientCertificateName": String,
    "ValidityDays": Integer
  }
}

Properties

Parameter	Type	Required	Updatable	Description	Constraints
Certificate	String	Yes	No	The certificate content.	None
PrivateKey	String	Yes	No	The private key of the certificate.	None
SiteId	Integer	Yes	No	The site ID.	None
SiteOriginClientCertificateName	String	No	No	The certificate name.	None
ValidityDays	Integer	No	No	The validity period of the certificate, in days.	None

Return values

Passing the logical ID of this resource to the intrinsic Fn::GetAtt function returns the following attributes:

SAN: The subject alternative name (SAN) of the certificate.
SiteId: The site ID.
FingerprintSha256: The SHA-256 fingerprint of the certificate.
SiteOriginClientCertificateId: The certificate ID in Edge Security Accelerator (ESA).
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.
Type: The certificate type.
SerialNumber: The serial number of the certificate.
UpdateTime: The time when the certificate was last updated.
SiteOriginClientCertificateName: The certificate name.
NotBefore: The time when the certificate becomes valid.
Certificate: The certificate content.
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
  SiteOriginClientCertificateName:
    Type: String
    Description:
      en: The certificate name.
    Required: false
  ValidityDays:
    Type: Number
    Description:
      en: 'The validity period of the certificate, in days.'
    Required: false
  Certificate:
    Type: String
    Description:
      en: The certificate content.
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::ESA::SiteOriginClientCertificate
    Properties:
      SiteId:
        Ref: SiteId
      PrivateKey:
        Ref: PrivateKey
      SiteOriginClientCertificateName:
        Ref: SiteOriginClientCertificateName
      ValidityDays:
        Ref: ValidityDays
      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
  SiteOriginClientCertificateId:
    Description: The certificate ID in Edge Security Accelerator (ESA).
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SiteOriginClientCertificateId
  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
  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 last updated.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - UpdateTime
  SiteOriginClientCertificateName:
    Description: The certificate name.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SiteOriginClientCertificateName
  NotBefore:
    Description: The time when the certificate becomes valid.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - NotBefore
  Certificate:
    Description: The certificate content.
    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
    },
    "SiteOriginClientCertificateName": {
      "Type": "String",
      "Description": {
        "en": "The certificate name."
      },
      "Required": false
    },
    "ValidityDays": {
      "Type": "Number",
      "Description": {
        "en": "The validity period of the certificate, in days."
      },
      "Required": false
    },
    "Certificate": {
      "Type": "String",
      "Description": {
        "en": "The certificate content."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ESA::SiteOriginClientCertificate",
      "Properties": {
        "SiteId": {
          "Ref": "SiteId"
        },
        "PrivateKey": {
          "Ref": "PrivateKey"
        },
        "SiteOriginClientCertificateName": {
          "Ref": "SiteOriginClientCertificateName"
        },
        "ValidityDays": {
          "Ref": "ValidityDays"
        },
        "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"
        ]
      }
    },
    "SiteOriginClientCertificateId": {
      "Description": "The certificate ID in Edge Security Accelerator (ESA).",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SiteOriginClientCertificateId"
        ]
      }
    },
    "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"
        ]
      }
    },
    "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 last updated.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "UpdateTime"
        ]
      }
    },
    "SiteOriginClientCertificateName": {
      "Description": "The certificate name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SiteOriginClientCertificateName"
        ]
      }
    },
    "NotBefore": {
      "Description": "The time when the certificate becomes valid.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "NotBefore"
        ]
      }
    },
    "Certificate": {
      "Description": "The certificate content.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Certificate"
        ]
      }
    },
    "CommonName": {
      "Description": "The Common Name of the certificate.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CommonName"
        ]
      }
    }
  }
}