Skip to content

SslCertificate

This class encapsulates and extends the ROS resource type ALIYUN::CAS::SslCertificate.

Initializers

import ros_cdk_cas
ros_cdk_cas.SslCertificate(
  scope: Construct,
  id: str,
  cert_brand: typing.Union[str, IResolvable] = None,
  cert_type: typing.Union[str, IResolvable] = None,
  company_name: typing.Union[str, IResolvable] = None,
  csr: typing.Union[str, IResolvable] = None,
  domains: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  domain_type: typing.Union[str, IResolvable] = None,
  email: typing.Union[str, IResolvable] = None,
  phone: typing.Union[str, IResolvable] = None,
  product_code: typing.Union[str, IResolvable] = None,
  username: typing.Union[str, IResolvable] = None,
  validate_type: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
cert_brand typing.Union[str, ros_cdk_core.IResolvable] Property certBrand: Certificate brand.
cert_type typing.Union[str, ros_cdk_core.IResolvable] Property certType: Certificate type.
company_name typing.Union[str, ros_cdk_core.IResolvable] Property companyName: The name of the certificate application company.
csr typing.Union[str, ros_cdk_core.IResolvable] Property csr: The contents of a manually generated CSR file for a domain name using the OpenSSL or Keytool tools.
domains typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property domains: The domain to bind the certificate to.
domain_type typing.Union[str, ros_cdk_core.IResolvable] Property domainType: Domain type.
email typing.Union[str, ros_cdk_core.IResolvable] Property email: The applicant's email.
phone typing.Union[str, ros_cdk_core.IResolvable] Property phone: The applicant's mobile phone number.
product_code typing.Union[str, ros_cdk_core.IResolvable] Property productCode: Specification of the certificate to apply for.
username typing.Union[str, ros_cdk_core.IResolvable] Property username: The applicant's name.
validate_type typing.Union[str, ros_cdk_core.IResolvable] Property validateType: How domain ownership is verified.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

cert_brandOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property certBrand: Certificate brand.

Valid values: Rapid, Globalsign, vTrus, Wosign, Digicert, Digicert pro, Geotrust, CFCA. Note: This parameter must be specified along with or without the CertType and DomainTyp parameters.


cert_typeOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property certType: Certificate type.

Valid values: DV, OV, EV. Note: This parameter must be specified along with or without the DomainType and CertBrand parameters.


company_nameOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property companyName: The name of the certificate application company.

Note: This parameter is only applicable when applying for OV certificates. When applying for OV certificate, if you set the company name here, it means that the corresponding company information in the information management module is used; If you do not set this parameter, it indicates that the latest company information added is selected from the information management module.


csrOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property csr: The contents of a manually generated CSR file for a domain name using the OpenSSL or Keytool tools.

The CSR key type must be RSA or ECC, and the RSA key length must be greater than or equal to 2048. If this parameter is not set, the CSR is automatically created for you by the SSL certificate service. A CSR (Certificate Signing Request) is a certificate signing request file that contains information about your server and your company. When you apply for a certificate, you will need to submit the CSR file of your certificate to the CA certification authority for review. After the CA center signs the CSR file with the root certificate's private key, it will generate the certificate public key file (that is, the SSL certificate issued to you).


domainsOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property domains: The domain to bind the certificate to.

The specific requirements are as follows:

  • Supports single or wildcard domains (e.g., *.aliyundoc.com).
  • Multiple domains are supported. You can set up to 5 domains.
  • If you set more than one domain name, the multiple domains can only be single domain name or wildcard domain name, not both single domain name and wildcard domain name. Note: This is required when the certificate is bound to more than one hostname. This parameter is not allowed to be empty at the same time as the Csr parameter. If you set both this parameter and the Csr parameter, take the CN field value in the Csr as the domain name for the certificate to bind to.

domain_typeOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property domainType: Domain type.

Valid values: one, all, multiple. Note: This parameter must be specified along with or without the CertType and CertBrand parameters.


emailOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property email: The applicant's email.


phoneOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property phone: The applicant's mobile phone number.

A CA official may contact you at this number to verify your certificate request.


product_codeOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property productCode: Specification of the certificate to apply for.

Value:

  • digicert-free-1-free (default) : This indicates DigiCert DV single-domain certificates (free 3-month certificates).
  • symantec-free 1-free: Stands for DigiCert DV free single-domain certificate (1-year free certificate).
  • symantec-dv-1-starter: This represents the DigiCert DV wildcard domain name certificate.
  • symantec-ov-1-personal: This stands for DigiCert OV single-domain certificate
  • symantec-ov-w-personal: This stands for DigiCert OV wildcard domain name certificate.
  • geotrust-dv-1-starter: This represents the GeoTrust DV single-domain certificate.
  • geotrust-dv-w-starter: This represents the GeoTrust DV wildcard domain name certificate.
  • geotrust-ov-1-personal: This stands for GeoTrust OV single-domain certificate.
  • geotrust-ov-w-personal: This represents the GeoTrust OV wildcard domain name certificate.
  • globalsign-dv-1-personal: This stands for GlobalSign DV single-domain certificate.
  • globalsign-dv-w-advanced: This stands for GlobalSign DV wildcard domain name certificate.
  • globalsign-ov-1-personal: This stands for GlobalSign OV single-domain certificate.
  • globalsign-ov-w-advanced: This represents the GlobalSign OV wildcard domain name certificate.
  • cfca-ov-1-personal: This stands for CFCA OV single domain certificate
  • cfca-ev-w-advanced: This stands for CFCA OV wildcard domain name certificate. Note: If you specify this parameter, you do not need to specify the DomainType, CertType, and CertBrand parameters; otherwise, this parameter will prevail.

usernameOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property username: The applicant's name.


validate_typeOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property validateType: How domain ownership is verified.

Valid values:

  • DNS: DNS validation The ownership of the domain name is verified by adding a TXT type DNS record to the domain name's DNS management platform. You need administrative permission for domain resolution to complete validation.
  • FILE: File validation Ownership of a domain name is verified by creating a specified file on the domain name server. You need administrator access to your domain name server to complete validation.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct

import ros_cdk_cas
ros_cdk_cas.SslCertificate.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_certificate_id ros_cdk_core.IResolvable Attribute CertificateId: The ID of the certificate issued to you.
attr_order_id ros_cdk_core.IResolvable Attribute OrderId: The ID of the certificate order.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


refRequired

ref: str
  • Type: str

stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


resourceOptional

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_certificate_idRequired

attr_certificate_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CertificateId: The ID of the certificate issued to you.


attr_order_idRequired

attr_order_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute OrderId: The ID of the certificate order.


Structs