ALIYUN::CAS::PcaCertificate-Resource Orchestration Service(ROS)-阿里云帮助中心

The ALIYUN::CAS::PcaCertificate type represents certificates issued by PCA.

Syntax

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

Properties

Property name	Type	Required	Update allowed	Description	Constraints
CommonName	String	Yes	No	The common name or abbreviation of the organization.	Supports Chinese and English characters.
Locality	String	Yes	No	The name of the city where the organization is located.	Supports Chinese and English characters.
Organization	String	Yes	No	The name of the organization associated with the root CA certificate.(Corresponding to your enterprise or company)	Supports Chinese and English characters.
OrganizationUnit	String	Yes	No	The name of the department or business unit within the organization.	Supports Chinese and English characters.
State	String	Yes	No	The name of the state, province, or region where the organization is located.	Supports Chinese and English characters.
Years	Integer	Yes	No	The validity period of the root CA certificate.	Unit: years. Note A value from 5 to 10 is recommended.
Algorithm	String	No	No	The key algorithm of the root CA certificate.	The key algorithm is specified in the `<encryption algorithm>_<key length>` format. Valid values: `RSA_1024`: The corresponding signature algorithm is `Sha256WithRSA`. `RSA_2048`: The corresponding signature algorithm is `Sha256WithRSA`. `RSA_4096`: The corresponding signature algorithm is `Sha256WithRSA`. `ECC_256`: The corresponding signature algorithm is `Sha256WithECDSA`. `ECC_384`: The corresponding signature algorithm is `Sha256WithECDSA`. `ECC_512`: The corresponding signature algorithm is `Sha256WithECDSA`. `SM2_256`: The corresponding signature algorithm is `SM3WithSM2`. The encryption algorithm of the root CA certificate must match the certificate algorithm of your private root CA. For example, if you selected RSA as the certificate algorithm when you purchased your private root CA, you must set the key algorithm to `RSA_1024`, `RSA_2048`, or `RSA_4096`.
CaStatus	String	No	No	The current CA status.	Valid values: `Issue`: The CA is enabled. `Forbidden`: The CA is disabled. `Revoke`: The CA is revoked.
CountryCode	String	No	No	The code for the country or region where the organization is located.	Use a two-letter uppercase abbreviation. For example, CN represents China and US represents the United States.

Return values

Fn::GetAtt

CertificateType: The CA type.
Identifier: The certificate identifier.
Organization: The name of the organization associated with the root CA certificate.
Years: The validity period of the root CA certificate.
IssuerType: The issuing authority.
Locality: The name of the city where the organization is located.
OrganizationUnit: The name of the department or business unit within the organization.
State: The name of the state, province, or region where the organization is located.
CountryCode: The two-letter uppercase code for the country or region where the organization is located. For example, CN represents China and US represents the United States.
Algorithm: The key algorithm of the root CA certificate. The algorithm is specified in the <algorithm>_<key length> format.
CommonName: The Common Name or abbreviation of the organization.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Algorithm:
    Type: String
    Description: 'The key algorithm of the root CA certificate. The algorithm is specified in the ''<encryption 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: 'The current CA status. Valid values: Issue, Forbidden, and Revoke.'
    AllowedValues:
      - Issue
      - Forbidden
      - Revoke
    Required: false
  CommonName:
    Type: String
    Description: The Common Name or abbreviation of the organization.
    Required: true
  CountryCode:
    Type: String
    Description: The code for the country or region where the organization is located.
    Required: false
  Locality:
    Type: String
    Description: The name of the city where the organization is located.
    Required: true
  Organization:
    Type: String
    Description: The name of the organization associated with the root CA certificate.
    Required: true
  OrganizationUnit:
    Type: String
    Description: The name of the department or business unit within the organization.
    Required: true
  State:
    Type: String
    Description: The name of the state, province, or region where the organization is located.
    Required: true
  Years:
    Type: Number
    Description: 'The validity period of the root CA certificate.'
    Required: true
    MinValue: 1
    MaxValue: 10
Resources:
  ExtensionResource:
    Type: ALIYUN::CAS::PcaCertificate
    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
Outputs:
  CertificateType:
    Description: The CA type.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CertificateType
  Identifier:
    Description: The certificate identifier.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Identifier
  Organization:
    Description: The name of the organization associated with the root CA certificate.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Organization
  Years:
    Description: The validity period of the root CA certificate.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Years
  IssuerType:
    Description: The issuing authority.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IssuerType
  Locality:
    Description: The name of the city where the organization is located.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Locality
  OrganizationUnit:
    Description: The name of the department or business unit within the organization.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - OrganizationUnit
  State:
    Description: The name of the state, province, or region where the organization is located.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - State
  CountryCode:
    Description: The two-letter uppercase code for the country or region where the organization is located. For example, CN represents China and US represents the United States.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CountryCode
  Algorithm:
    Description: The key algorithm of the root CA certificate. The algorithm is specified in the '<encryption algorithm>_<key length>' format.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Algorithm
  CommonName:
    Description: The Common Name or abbreviation of the organization.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CommonName

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Algorithm": {
      "Type": "String",
      "Description": "The key algorithm of the root CA certificate. The algorithm is specified in the '_' format.",
      "AllowedValues": [
        "RSA_1024",
        "RSA_2048",
        "RSA_4096",
        "ECC_256",
        "ECC_384",
        "ECC_512",
        "SM2_256"
      ],
      "Required": false
    },
    "CaStatus": {
      "Type": "String",
      "Description": "The current CA status. Valid values: Issue, Forbidden, and Revoke.",
      "AllowedValues": [
        "Issue",
        "Forbidden",
        "Revoke"
      ],
      "Required": false
    },
    "CommonName": {
      "Type": "String",
      "Description": "The Common Name or abbreviation of the organization.",
      "Required": true
    },
    "CountryCode": {
      "Type": "String",
      "Description": "The code for the country or region where the organization is located.",
      "Required": false
    },
    "Locality": {
      "Type": "String",
      "Description": "The name of the city where the organization is located.",
      "Required": true
    },
    "Organization": {
      "Type": "String",
      "Description": "The name of the organization associated with the root CA certificate.",
      "Required": true
    },
    "OrganizationUnit": {
      "Type": "String",
      "Description": "The name of the department or business unit within the organization.",
      "Required": true
    },
    "State": {
      "Type": "String",
      "Description": "The name of the state, province, or region where the organization is located.",
      "Required": true
    },
    "Years": {
      "Type": "Number",
      "Description": "The validity period of the root CA certificate.",
      "Required": true,
      "MinValue": 1,
      "MaxValue": 10
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::CAS::PcaCertificate",
      "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"
        }
      }
    }
  },
  "Outputs": {
    "CertificateType": {
      "Description": "The CA type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CertificateType"
        ]
      }
    },
    "Identifier": {
      "Description": "The certificate identifier.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Identifier"
        ]
      }
    },
    "Organization": {
      "Description": "The name of the organization associated with the root CA certificate.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Organization"
        ]
      }
    },
    "Years": {
      "Description": "The validity period of the root CA certificate.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Years"
        ]
      }
    },
    "IssuerType": {
      "Description": "The issuing authority.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IssuerType"
        ]
      }
    },
    "Locality": {
      "Description": "The name of the city where the organization is located.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Locality"
        ]
      }
    },
    "OrganizationUnit": {
      "Description": "The name of the department or business unit within the organization.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "OrganizationUnit"
        ]
      }
    },
    "State": {
      "Description": "The name of the state, province, or region where the organization is located.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "State"
        ]
      }
    },
    "CountryCode": {
      "Description": "The two-letter uppercase code for the country or region where the organization is located. For example, CN represents China and US represents the United States.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CountryCode"
        ]
      }
    },
    "Algorithm": {
      "Description": "The key algorithm of the root CA certificate. The algorithm is specified in the '_' format.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Algorithm"
        ]
      }
    },
    "CommonName": {
      "Description": "The Common Name or abbreviation of the organization.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CommonName"
        ]
      }
    }
  }
}