SslCertificate

• Implements: ISslCertificate

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
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

cert_brand^Optional

• 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_type^Optional

• 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_name^Optional

• 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.

csr^Optional

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

Property csr: The content of the certificate signing request (CSR) file that is manually generated by using OpenSSL or Keytool for the domain name.

The key algorithm in the CSR file must be Rivest-Shamir-Adleman (RSA) or elliptic-curve cryptography (ECC), and the key length of the RSA algorithm must be greater than or equal to 2,048 characters. For more information about how to create a CSR file, see Create a CSR file. If you do not specify this parameter, Certificate Management Service automatically creates a CSR file. A CSR file contains the information about your server and company. When you apply for a certificate, you must submit the CSR file to the CA. The CA signs the CSR file by using the private key of the root certificate and generates a public key file to issue your certificate.

The CN field in CSR file specifies the domain name that is bound to the certificate. You must include the field in the parameter value.

domains^Optional

• 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_type^Optional

• 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.

email^Optional

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

Property email: The email address of the applicant.

After the CA receives your certificate application, the CA sends a verification email to the email address that you specify. You must log on to the mailbox, open the mail, and complete the verification of the domain name ownership based on the steps that are described in the email. If you do not specify this parameter, the information about the most recent contact that is added to the Information Management module is used. For more information about how to add a contact to the Information Management module, see Manage contacts.

phone^Optional

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

Property phone: The contact phone number of the applicant.

CA staff can call the phone number to confirm the information in your certificate application. If you do not specify this parameter, the information about the most recent contact that is added to the Information Management module is used. For more information about how to add a contact to the Information Management module, see Manage contacts.

product_code^Optional

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

Property productCode: The specifications of the certificate that you want to apply for.

Valid values:

• digicert-free-1-free (default): DigiCert single-domain domain validated (DV) certificate, which is free and valid for 3 months.
• symantec-free-1-free: DigiCert single-domain DV certificate, which is free and valid for 1 year.
• symantec-dv-1-starter: DigiCert wildcard DV certificate.
• symantec-ov-1-personal: DigiCert single-domain organization validated (OV) certificate.
• symantec-ov-w-personal: DigiCert wildcard OV certificate.
• geotrust-dv-1-starter: GeoTrust single-domain DV certificate.
• geotrust-dv-w-starter: GeoTrust wildcard DV certificate.
• geotrust-ov-1-personal: GeoTrust single-domain OV certificate.
• geotrust-ov-w-personal: GeoTrust wildcard OV certificate.
• globalsign-dv-1-personal: GlobalSign single-domain DV certificate.
• globalsign-dv-w-advanced: GlobalSign wildcard DV certificate.
• globalsign-ov-1-personal: GlobalSign single-domain OV certificate.
• globalsign-ov-w-advanced: GlobalSign wildcard OV certificate.
• cfca-ov-1-personal: China Financial Certification Authority (CFCA) single-domain OV certificate.
• cfca-ev-w-advanced: CFCA wildcard OV certificate.

username^Optional

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

Property username: The name of the applicant.

If you do not specify this parameter, the information about the most recent contact that is added to the Information Management module is used. For more information about how to add a contact to the Information Management module, see Manage contacts.

validate_type^Optional

• 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_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_certificate_id^Required

attr_certificate_id: typing.Union[str, IResolvable]

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

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

attr_order_id^Required

attr_order_id: typing.Union[str, IResolvable]

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

Attribute OrderId: The ID of the certificate order.

props^Required

props: SslCertificateProps

• Type: SslCertificateProps