PcaCertificate
- Implements: IPcaCertificate
This class encapsulates and extends the ROS resource type ALIYUN::CAS::PcaCertificate.
Initializers
import com.aliyun.ros.cdk.cas.PcaCertificate;
PcaCertificate.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.commonName(java.lang.String)
.commonName(IResolvable)
.locality(java.lang.String)
.locality(IResolvable)
.organization(java.lang.String)
.organization(IResolvable)
.organizationUnit(java.lang.String)
.organizationUnit(IResolvable)
.state(java.lang.String)
.state(IResolvable)
.years(java.lang.Number)
.years(IResolvable)
// .algorithm(java.lang.String)
// .algorithm(IResolvable)
// .caStatus(java.lang.String)
// .caStatus(IResolvable)
// .countryCode(java.lang.String)
// .countryCode(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. |
commonName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property commonName: The common name or abbreviation of the organization. |
locality | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property locality: Name of the city where the organization is located. |
organization | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property organization: The name of the organization (corresponding to your enterprise or company) associated with the root CA certificate. |
organizationUnit | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property organizationUnit: The name of the department or branch under the organization. |
state | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property state: |
years | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property years: The validity period of the root CA certificate, in years. |
algorithm | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property algorithm: The key algorithm type of the root CA certificate. |
caStatus | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property caStatus: The current CA status. |
countryCode | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property countryCode: The code of the country or region in which the organization is located, using a two-digit capital abbreviation. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
commonNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property commonName: The common name or abbreviation of the organization.
Support the use of Chinese, English characters.
localityRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property locality: Name of the city where the organization is located.
Support the use of Chinese, English characters.
organizationRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property organization: The name of the organization (corresponding to your enterprise or company) associated with the root CA certificate.
Support the use of Chinese, English characters.
organizationUnitRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property organizationUnit: The name of the department or branch under the organization.
Support the use of Chinese, English characters.
stateRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property state:
Support the use of Chinese, English characters.
yearsRequired
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property years: The validity period of the root CA certificate, in years.
It is recommended to set to 5~10 years.
algorithmOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property algorithm: The key algorithm type of the root CA certificate.
The key algorithm is expressed using the '
- 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 signature algorithm is Sha256WithECDSA.
- ECC_384: The corresponding signature algorithm is Sha256WithECDSA.
- ECC_512: The signature algorithm is Sha256WithECDSA.
- SM2_256: The corresponding signature algorithm is SM3WithSM2.
The encryption algorithm of the root CA certificate must be the same as the certificate algorithm of the private Root CA you purchased. Example: If the certificate algorithm selected when you purchase a private Root CA is RSA, the key algorithm of the root CA certificate must be RSA_1024, RSA_2048, or RSA_4096.
caStatusOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property caStatus: The current CA status.
Value:
- Issue: Enabled.
- Forbidden: Disabled.
- Revoke: Revoked.
countryCodeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property countryCode: The code of the country or region in which the organization is located, using a two-digit capital abbreviation.
For example, CN represents China and US represents the United States. For more information about the codes of different countries, see International Code in Management Company Information.
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.PcaCertificate;
PcaCertificate.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. |
attrAlgorithm | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Algorithm: The key algorithm type of the root CA certificate. |
attrCertificateType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CertificateType: The type of CA. |
attrCommonName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CommonName: The common name or abbreviation of the organization. |
attrCountryCode | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CountryCode: The code of the country or region in which the organization is located, using a two-digit capital abbreviation. |
attrIdentifier | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Identifier: Certificate Identifier. |
attrIssuerType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute IssuerType: The institution issuing the CA. |
attrLocality | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Locality: Name of the city where the organization is located. |
attrOrganization | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Organization: The name of the organization (corresponding to your enterprise or company) associated with the root CA certificate. |
attrOrganizationUnit | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute OrganizationUnit: The name of the department or branch under the organization. |
attrState | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute State: |
attrYears | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Years: The validity period of the root CA certificate, in years. |
props | PcaCertificateProps | 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
attrAlgorithmRequired
public java.lang.Object getAttrAlgorithm();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Algorithm: The key algorithm type of the root CA certificate.
The key algorithm is expressed using the '
attrCertificateTypeRequired
public java.lang.Object getAttrCertificateType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CertificateType: The type of CA.
attrCommonNameRequired
public java.lang.Object getAttrCommonName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CommonName: The common name or abbreviation of the organization.
Support the use of Chinese, English characters.
attrCountryCodeRequired
public java.lang.Object getAttrCountryCode();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CountryCode: The code of the country or region in which the organization is located, using a two-digit capital abbreviation.
For example, CN represents China and US represents the United States.
attrIdentifierRequired
public java.lang.Object getAttrIdentifier();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Identifier: Certificate Identifier.
attrIssuerTypeRequired
public java.lang.Object getAttrIssuerType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute IssuerType: The institution issuing the CA.
attrLocalityRequired
public java.lang.Object getAttrLocality();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Locality: Name of the city where the organization is located.
Support the use of Chinese, English characters.
attrOrganizationRequired
public java.lang.Object getAttrOrganization();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Organization: The name of the organization (corresponding to your enterprise or company) associated with the root CA certificate.
Support the use of Chinese, English characters.
attrOrganizationUnitRequired
public java.lang.Object getAttrOrganizationUnit();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute OrganizationUnit: The name of the department or branch under the organization.
Support the use of Chinese, English characters.
attrStateRequired
public java.lang.Object getAttrState();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute State:
Support the use of Chinese, English characters.
attrYearsRequired
public java.lang.Object getAttrYears();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Years: The validity period of the root CA certificate, in years.
propsRequired
public PcaCertificateProps getProps();
- Type: PcaCertificateProps