ACM PCA
4 resource kinds. Generated from the operator's CRD schemas.
API Group:
aws.konfig.io/v1alpha1
ACMPCACertificate # CLOUD CONTROL · AWS::ACMPCA::Certificate
ACMPCACertificate manages AWS::ACMPCA::Certificate through the AWS Cloud Control API.
kubectl get acmpcacertificates · example on GitHub
Example
# ACMPCACertificate — ACM PCA
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/acmpca.html#acmpcacertificate
apiVersion: aws.konfig.io/v1alpha1
kind: ACMPCACertificate
metadata:
name: example-acmpcacertificate
namespace: default
spec:
apiPassthrough:
extensions:
certificatePolicies:
- certPolicyId: example-id
policyQualifiers:
- policyQualifierId: example-id
qualifier:
cpsUri: example
customExtensions:
- critical: false
objectIdentifier: example
value: example
extendedKeyUsage:
- extendedKeyUsageObjectIdentifier: example
extendedKeyUsageType: example
keyUsage:
crlSign: false
dataEncipherment: false
decipherOnly: false
digitalSignature: false
encipherOnly: false
keyAgreement: false
keyCertSign: false
keyEncipherment: false
nonRepudiation: false
subjectAlternativeNames:
- dnsName: example-acmpcacertificate
ipAddress: example
rfc822Name: example-acmpcacertificate
uniformResourceIdentifier: example
subject:
commonName: example-acmpcacertificate
country: example
customAttributes:
- objectIdentifier: example
value: example
distinguishedNameQualifier: example
generationQualifier: example
givenName: example-acmpcacertificate
initials: example
locality: example
organization: example
organizationalUnit: example
pseudonym: example
serialNumber: example
state: example
surname: example-acmpcacertificate
title: example
certificateAuthorityArn: arn:aws:iam::123456789012:role/example-role
certificateSigningRequest: example
providerRef:
name: example-acmpcacertificate
region: us-east-1
signingAlgorithm: example
templateArn: arn:aws:iam::123456789012:role/example-role
validity:
type: example
value: 1
validityNotBefore:
type: example
value: 1
Spec
| Field | Type | Required | Description |
|---|---|---|---|
apiPassthrough | object | — | Specifies X.509 certificate information to be included in the issued certificate. |
apiPassthrough.extensions | object | — | Specifies X.509 extension information for a certificate. |
apiPassthrough.extensions.certificatePolicies | array<object> | — | Contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers. |
apiPassthrough.extensions.certificatePolicies[].certPolicyId | string | yes | Specifies the object identifier (OID) of the certificate policy under which the certificate was issued. |
apiPassthrough.extensions.certificatePolicies[].policyQualifiers | array<object> | — | Modifies the given ``CertPolicyId`` with a qualifier. |
apiPassthrough.extensions.certificatePolicies[].policyQualifiers[].policyQualifierId | string | yes | Identifies the qualifier modifying a ``CertPolicyId``. |
apiPassthrough.extensions.certificatePolicies[].policyQualifiers[].qualifier | object | yes | Defines the qualifier type. |
apiPassthrough.extensions.certificatePolicies[].policyQualifiers[].qualifier.cpsUri | string | yes | Contains a pointer to a certification practice statement (CPS) published by the CA. |
apiPassthrough.extensions.customExtensions | array<object> | — | Contains a sequence of one or more X.509 extensions, each of which consists of an object identifier (OID), a base64-encoded value, and the critical flag. |
apiPassthrough.extensions.customExtensions[].critical | boolean | — | Specifies the critical flag of the X.509 extension. |
apiPassthrough.extensions.customExtensions[].objectIdentifier | string | yes | Specifies the object identifier (OID) of the X.509 extension. |
apiPassthrough.extensions.customExtensions[].value | string | yes | Specifies the base64-encoded value of the X.509 extension. |
apiPassthrough.extensions.extendedKeyUsage | array<object> | — | Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the ``KeyUsage`` extension. |
apiPassthrough.extensions.extendedKeyUsage[].extendedKeyUsageObjectIdentifier | string | — | Specifies a custom ``ExtendedKeyUsage`` with an object identifier (OID). |
apiPassthrough.extensions.extendedKeyUsage[].extendedKeyUsageType | string | — | Specifies a standard ``ExtendedKeyUsage`` as defined as in [RFC 5280](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12). |
apiPassthrough.extensions.keyUsage | object | — | Defines one or more purposes for which the key contained in the certificate can be used. |
apiPassthrough.extensions.keyUsage.crlSign | boolean | — | Key can be used to sign CRLs. |
apiPassthrough.extensions.keyUsage.dataEncipherment | boolean | — | Key can be used to decipher data. |
apiPassthrough.extensions.keyUsage.decipherOnly | boolean | — | Key can be used only to decipher data. |
apiPassthrough.extensions.keyUsage.digitalSignature | boolean | — | Key can be used for digital signing. |
apiPassthrough.extensions.keyUsage.encipherOnly | boolean | — | Key can be used only to encipher data. |
apiPassthrough.extensions.keyUsage.keyAgreement | boolean | — | Key can be used in a key-agreement protocol. |
apiPassthrough.extensions.keyUsage.keyCertSign | boolean | — | Key can be used to sign certificates. |
apiPassthrough.extensions.keyUsage.keyEncipherment | boolean | — | Key can be used to encipher data. |
apiPassthrough.extensions.keyUsage.nonRepudiation | boolean | — | Key can be used for non-repudiation. |
apiPassthrough.extensions.subjectAlternativeNames | array<object> | — | The subject alternative name extension allows identities to be bound to the subject of the certificate. |
apiPassthrough.extensions.subjectAlternativeNames[].directoryName | object | — | Contains information about the certificate subject. |
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.commonName | string | — | For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit. |
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.country | string | — | Two-digit code that specifies the country in which the certificate subject located. |
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.customAttributes | array<object> | — | Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. |
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.customAttributes[].objectIdentifier | string | yes | Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN). |
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.customAttributes[].value | string | yes | Specifies the attribute value of relative distinguished name (RDN). |
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.distinguishedNameQualifier | string | — | Disambiguating information for the certificate subject. |
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.generationQualifier | string | — | Typically a qualifier appended to the name of an individual. |
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.givenName | string | — | First name. |
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.initials | string | — | Concatenation that typically contains the first letter of the *GivenName*, the first letter of the middle name if one exists, and the first letter of the *Surname*. |
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.locality | string | — | The locality (such as a city or town) in which the certificate subject is located. |
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.organization | string | — | Legal name of the organization with which the certificate subject is affiliated. |
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.organizationalUnit | string | — | A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated. |
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.pseudonym | string | — | Typically a shortened version of a longer *GivenName*. |
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.serialNumber | string | — | The certificate serial number. |
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.state | string | — | State in which the subject of the certificate is located. |
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.surname | string | — | Family name. |
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.title | string | — | A title such as Mr. |
apiPassthrough.extensions.subjectAlternativeNames[].dnsName | string | — | Represents ``GeneralName`` as a DNS name. |
apiPassthrough.extensions.subjectAlternativeNames[].ediPartyName | object | — | Represents ``GeneralName`` as an ``EdiPartyName`` object. |
apiPassthrough.extensions.subjectAlternativeNames[].ediPartyName.nameAssigner | string | yes | Specifies the name assigner. |
apiPassthrough.extensions.subjectAlternativeNames[].ediPartyName.partyName | string | yes | Specifies the party name. |
apiPassthrough.extensions.subjectAlternativeNames[].ipAddress | string | — | Represents ``GeneralName`` as an IPv4 or IPv6 address. |
apiPassthrough.extensions.subjectAlternativeNames[].otherName | object | — | Represents ``GeneralName`` using an ``OtherName`` object. |
apiPassthrough.extensions.subjectAlternativeNames[].otherName.typeId | string | yes | Specifies an OID. |
apiPassthrough.extensions.subjectAlternativeNames[].otherName.value | string | yes | Specifies an OID value. |
apiPassthrough.extensions.subjectAlternativeNames[].registeredId | string | — | Represents ``GeneralName`` as an object identifier (OID). |
apiPassthrough.extensions.subjectAlternativeNames[].rfc822Name | string | — | Represents ``GeneralName`` as an [RFC 822](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc822) email address. |
apiPassthrough.extensions.subjectAlternativeNames[].uniformResourceIdentifier | string | — | Represents ``GeneralName`` as a URI. |
apiPassthrough.subject | object | — | Contains information about the certificate subject. |
apiPassthrough.subject.commonName | string | — | For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit. |
apiPassthrough.subject.country | string | — | Two-digit code that specifies the country in which the certificate subject located. |
apiPassthrough.subject.customAttributes | array<object> | — | Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. |
apiPassthrough.subject.customAttributes[].objectIdentifier | string | yes | Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN). |
apiPassthrough.subject.customAttributes[].value | string | yes | Specifies the attribute value of relative distinguished name (RDN). |
apiPassthrough.subject.distinguishedNameQualifier | string | — | Disambiguating information for the certificate subject. |
apiPassthrough.subject.generationQualifier | string | — | Typically a qualifier appended to the name of an individual. |
apiPassthrough.subject.givenName | string | — | First name. |
apiPassthrough.subject.initials | string | — | Concatenation that typically contains the first letter of the *GivenName*, the first letter of the middle name if one exists, and the first letter of the *Surname*. |
apiPassthrough.subject.locality | string | — | The locality (such as a city or town) in which the certificate subject is located. |
apiPassthrough.subject.organization | string | — | Legal name of the organization with which the certificate subject is affiliated. |
apiPassthrough.subject.organizationalUnit | string | — | A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated. |
apiPassthrough.subject.pseudonym | string | — | Typically a shortened version of a longer *GivenName*. |
apiPassthrough.subject.serialNumber | string | — | The certificate serial number. |
apiPassthrough.subject.state | string | — | State in which the subject of the certificate is located. |
apiPassthrough.subject.surname | string | — | Family name. |
apiPassthrough.subject.title | string | — | A title such as Mr. |
certificateAuthorityArn | string | yes | The Amazon Resource Name (ARN) for the private CA issues the certificate. |
certificateSigningRequest | string | yes | The certificate signing request (CSR) for the certificate. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
signingAlgorithm | string | yes | The name of the algorithm that will be used to sign the certificate to be issued. |
templateArn | string | — | Specifies a custom configuration template to use when issuing a certificate. |
validity | object | yes | The period of time during which the certificate will be valid. |
validity.type | string | yes | Specifies whether the ``Value`` parameter represents days, months, or years. |
validity.value | number | yes | A long integer interpreted according to the value of ``Type``, below. |
validityNotBefore | object | — | Information describing the start of the validity period of the certificate. |
validityNotBefore.type | string | yes | Specifies whether the ``Value`` parameter represents days, months, or years. |
validityNotBefore.value | number | yes | A long integer interpreted according to the value of ``Type``, below. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | Read-only: reported by AWS after creation. |
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
certificate | string | — | Read-only: reported by AWS after creation. |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
ACMPCAPermission # CLOUD CONTROL · AWS::ACMPCA::Permission
ACMPCAPermission manages AWS::ACMPCA::Permission through the AWS Cloud Control API.
kubectl get acmpcapermissions · example on GitHub
Example
# ACMPCAPermission — ACM PCA
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/acmpca.html#acmpcapermission
apiVersion: aws.konfig.io/v1alpha1
kind: ACMPCAPermission
metadata:
name: example-acmpcapermission
namespace: default
spec:
actions:
- example
certificateAuthorityArn: arn:aws:iam::123456789012:role/example-role
principal: example
providerRef:
name: example-acmpcapermission
region: us-east-1
sourceAccount: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
actions | array<string> | yes | The actions that the specified AWS service principal can use. |
certificateAuthorityArn | string | yes | The Amazon Resource Name (ARN) of the Private Certificate Authority that grants the permission. |
principal | string | yes | The AWS service or identity that receives the permission. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
sourceAccount | string | — | The ID of the calling account. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
PrivateCA # GA
PrivateCA is the Schema for managing AWS Private Certificate Authorities.
kubectl get privatecas · example on GitHub
Example
# PrivateCA — ACM PCA
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/acmpca.html#privateca
apiVersion: aws.konfig.io/v1alpha1
kind: PrivateCA
metadata:
name: example-privateca
namespace: default
spec:
keyAlgorithm: RSA_2048
permanentDeletionTimeInDays: 7
providerRef:
name: example-privateca
region: us-east-1
revocationConfiguration:
crl:
enabled: true
expirationInDays: 1
s3BucketName: example-privateca
signingAlgorithm: SHA256WITHRSA
subject:
commonName: example-privateca
country: example
locality: example
organization: example
organizationalUnit: example
state: example
tags:
environment: dev
team: platform
type: ROOT
usageMode: GENERAL_PURPOSE
Spec
| Field | Type | Required | Description |
|---|---|---|---|
keyAlgorithm | enum | yes | KeyAlgorithm for the CA key pair. Allowed: RSA_2048, RSA_4096, EC_prime256v1, EC_secp384r1 |
permanentDeletionTimeInDays | integer | — | PermanentDeletionTimeInDays is the restore window applied when the CA is deleted (7-30 days). |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
revocationConfiguration | object | — | RevocationConfiguration configures CRL support. |
revocationConfiguration.crl | object | — | Crl configures certificate revocation list publication. |
revocationConfiguration.crl.enabled | boolean | yes | Enabled turns on certificate revocation list publication. |
revocationConfiguration.crl.expirationInDays | integer | — | ExpirationInDays is the CRL validity period. |
revocationConfiguration.crl.s3BucketName | string | — | S3BucketName is the bucket CRLs are published to. |
signingAlgorithm | enum | yes | SigningAlgorithm the CA uses to sign certificate requests. Allowed: SHA256WITHRSA, SHA384WITHRSA, SHA512WITHRSA, SHA256WITHECDSA, SHA384WITHECDSA, SHA512WITHECDSA |
subject | object | yes | Subject is the X.500 distinguished name of the CA. |
subject.commonName | string | — | CommonName (CN) of the CA. |
subject.country | string | — | Country is the two-letter country code (C). |
subject.locality | string | — | Locality such as a city or town (L). |
subject.organization | string | — | Organization (O) the CA belongs to. |
subject.organizationalUnit | string | — | OrganizationalUnit (OU) within the organization. |
subject.state | string | — | State or province (ST). |
tags | map<string> | — | Tags are AWS resource tags to apply. |
type | enum | yes | Type of the certificate authority. Allowed: ROOT, SUBORDINATE |
usageMode | enum | — | UsageMode of the CA. Allowed: GENERAL_PURPOSE, SHORT_LIVED_CERTIFICATE |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | ARN of the certificate authority. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
lastSyncTime | string | — | LastSyncTime is when the resource was last successfully reconciled. |
observedGeneration | integer | — | ObservedGeneration is the most recent .metadata.generation reconciled. |
status | string | — | Status is the current CA status (e.g. |