Skip to content

PcaCertificate

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

Initializers

import ros_cdk_cas
ros_cdk_cas.PcaCertificate(
  scope: Construct,
  id: str,
  common_name: typing.Union[str, IResolvable],
  locality: typing.Union[str, IResolvable],
  organization: typing.Union[str, IResolvable],
  organization_unit: typing.Union[str, IResolvable],
  state: typing.Union[str, IResolvable],
  years: typing.Union[typing.Union[int, float], IResolvable],
  algorithm: typing.Union[str, IResolvable] = None,
  ca_status: typing.Union[str, IResolvable] = None,
  country_code: 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.
common_name typing.Union[str, ros_cdk_core.IResolvable] Property commonName: The common name or abbreviation of the organization.
locality typing.Union[str, ros_cdk_core.IResolvable] Property locality: Name of the city where the organization is located.
organization typing.Union[str, ros_cdk_core.IResolvable] Property organization: The name of the organization (corresponding to your enterprise or company) associated with the root CA certificate.
organization_unit typing.Union[str, ros_cdk_core.IResolvable] Property organizationUnit: The name of the department or branch under the organization.
state typing.Union[str, ros_cdk_core.IResolvable] Property state: The name of the province, municipality, or autonomous region in which the organization is located.
years typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property years: The validity period of the root CA certificate, in years.
algorithm typing.Union[str, ros_cdk_core.IResolvable] Property algorithm: The key algorithm type of the root CA certificate.
ca_status typing.Union[str, ros_cdk_core.IResolvable] Property caStatus: The current CA status.
country_code typing.Union[str, 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.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

common_nameRequired

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

Property commonName: The common name or abbreviation of the organization.

Support the use of Chinese, English characters.


localityRequired

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

Property locality: Name of the city where the organization is located.

Support the use of Chinese, English characters.


organizationRequired

  • Type: typing.Union[str, 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.


organization_unitRequired

  • Type: typing.Union[str, 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: typing.Union[str, ros_cdk_core.IResolvable]

Property state: The name of the province, municipality, or autonomous region in which the organization is located.

Support the use of Chinese, English characters. Name of the province or state where the organization is located. Support the use of Chinese, English characters. .


yearsRequired

  • Type: typing.Union[typing.Union[int, float], 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: typing.Union[str, ros_cdk_core.IResolvable]

Property algorithm: The key algorithm type of the root CA certificate.

The key algorithm is expressed using the '_< key length>' format. Value:

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


ca_statusOptional

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

Property caStatus: The current CA status.

Value:

  • Issue: Enabled.
  • Forbidden: Disabled.
  • Revoke: Revoked.

country_codeOptional

  • Type: typing.Union[str, 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.


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.
fetch_condition No description.
fetch_dependency No description.
fetch_resource_desc 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

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

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.PcaCertificate.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.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
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_algorithm typing.Union[str, ros_cdk_core.IResolvable] Attribute Algorithm: The key algorithm type of the root CA certificate.
attr_certificate_type typing.Union[str, ros_cdk_core.IResolvable] Attribute CertificateType: The type of CA.
attr_common_name typing.Union[str, ros_cdk_core.IResolvable] Attribute CommonName: The common name or abbreviation of the organization.
attr_country_code typing.Union[str, 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.
attr_identifier typing.Union[str, ros_cdk_core.IResolvable] Attribute Identifier: Certificate Identifier.
attr_issuer_type typing.Union[str, ros_cdk_core.IResolvable] Attribute IssuerType: The institution issuing the CA.
attr_locality typing.Union[str, ros_cdk_core.IResolvable] Attribute Locality: Name of the city where the organization is located.
attr_organization typing.Union[str, ros_cdk_core.IResolvable] Attribute Organization: The name of the organization (corresponding to your enterprise or company) associated with the root CA certificate.
attr_organization_unit typing.Union[str, ros_cdk_core.IResolvable] Attribute OrganizationUnit: The name of the department or branch under the organization.
attr_state typing.Union[str, ros_cdk_core.IResolvable] Attribute State: The name of the province, municipality, or autonomous region in which the organization is located.
attr_years typing.Union[str, ros_cdk_core.IResolvable] Attribute Years: The validity period of the root CA certificate, in years.
props PcaCertificateProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


envRequired

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.


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_algorithmRequired

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

Attribute Algorithm: The key algorithm type of the root CA certificate.

The key algorithm is expressed using the '_< key length>' format.


attr_certificate_typeRequired

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

Attribute CertificateType: The type of CA.


attr_common_nameRequired

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

Attribute CommonName: The common name or abbreviation of the organization.

Support the use of Chinese, English characters.


attr_country_codeRequired

attr_country_code: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


attr_identifierRequired

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

Attribute Identifier: Certificate Identifier.


attr_issuer_typeRequired

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

Attribute IssuerType: The institution issuing the CA.


attr_localityRequired

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

Attribute Locality: Name of the city where the organization is located.

Support the use of Chinese, English characters.


attr_organizationRequired

attr_organization: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


attr_organization_unitRequired

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

Attribute OrganizationUnit: The name of the department or branch under the organization.

Support the use of Chinese, English characters.


attr_stateRequired

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

Attribute State: The name of the province, municipality, or autonomous region in which the organization is located.

Support the use of Chinese, English characters.


attr_yearsRequired

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

Attribute Years: The validity period of the root CA certificate, in years.


propsRequired

props: PcaCertificateProps