Skip to content

SslCertificate

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

Initializers 

import com.aliyun.ros.cdk.cas.SslCertificate;
SslCertificate.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .certBrand(java.lang.String)
//  .certBrand(IResolvable)
//  .certType(java.lang.String)
//  .certType(IResolvable)
//  .companyName(java.lang.String)
//  .companyName(IResolvable)
//  .csr(java.lang.String)
//  .csr(IResolvable)
//  .domains(IResolvable)
//  .domains(java.util.List<java.lang.String)
//  .domains(IResolvable>)
//  .domainType(java.lang.String)
//  .domainType(IResolvable)
//  .email(java.lang.String)
//  .email(IResolvable)
//  .phone(java.lang.String)
//  .phone(IResolvable)
//  .productCode(java.lang.String)
//  .productCode(IResolvable)
//  .username(java.lang.String)
//  .username(IResolvable)
//  .validateType(java.lang.String)
//  .validateType(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
certBrand java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property certBrand: Certificate brand.
certType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property certType: Certificate type.
companyName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property companyName: The name of the certificate application company.
csr java.lang.String OR com.aliyun.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 com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property domains: The domain to bind the certificate to.
domainType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property domainType: Domain type.
email java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property email: The applicant's email.
phone java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property phone: The applicant's mobile phone number.
productCode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property productCode: Specification of the certificate to apply for.
username java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property username: The applicant's name.
validateType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property validateType: How domain ownership is verified.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

certBrandOptional

  • Type: java.lang.String OR com.aliyun.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.

certTypeOptional

  • Type: java.lang.String OR com.aliyun.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.

companyNameOptional

  • Type: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.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: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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.

domainTypeOptional

  • Type: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property email: The applicant's email.

phoneOptional

  • Type: java.lang.String OR com.aliyun.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.

productCodeOptional

  • Type: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property username: The applicant's name.

validateTypeOptional

  • Type: java.lang.String OR com.aliyun.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.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

import com.aliyun.ros.cdk.cas.SslCertificate;
SslCertificate.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrCertificateId com.aliyun.ros.cdk.core.IResolvable Attribute CertificateId: The ID of the certificate issued to you.
attrOrderId com.aliyun.ros.cdk.core.IResolvable Attribute OrderId: The ID of the certificate order.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrCertificateIdRequired 

public IResolvable getAttrCertificateId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrOrderIdRequired 

public IResolvable getAttrOrderId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute OrderId: The ID of the certificate order.

Structs