SslCertificate
- Implements: ISslCertificate
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 content of the certificate signing request (CSR) file that is manually generated by using OpenSSL or Keytool for the domain name. |
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 email address of the applicant. |
phone | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property phone: The contact phone number of the applicant. |
productCode | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property productCode: The specifications of the certificate that you want to apply for. |
username | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property username: The name of the applicant. |
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 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.
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 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.
phoneOptional
- Type: java.lang.String OR com.aliyun.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.
productCodeOptional
- Type: java.lang.String OR com.aliyun.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.
usernameOptional
- Type: java.lang.String OR com.aliyun.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.
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- 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.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CertificateId: The ID of the certificate issued to you. |
attrOrderId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute OrderId: The ID of the certificate order. |
props | SslCertificateProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.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.
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 java.lang.Object getAttrCertificateId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CertificateId: The ID of the certificate issued to you.
attrOrderIdRequired
public java.lang.Object getAttrOrderId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute OrderId: The ID of the certificate order.
propsRequired
public SslCertificateProps getProps();
- Type: SslCertificateProps