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

FieldTypeRequiredDescription
apiPassthroughobject—Specifies X.509 certificate information to be included in the issued certificate.
apiPassthrough.extensionsobject—Specifies X.509 extension information for a certificate.
apiPassthrough.extensions.certificatePoliciesarray<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[].certPolicyIdstringyesSpecifies the object identifier (OID) of the certificate policy under which the certificate was issued.
apiPassthrough.extensions.certificatePolicies[].policyQualifiersarray<object>—Modifies the given ``CertPolicyId`` with a qualifier.
apiPassthrough.extensions.certificatePolicies[].policyQualifiers[].policyQualifierIdstringyesIdentifies the qualifier modifying a ``CertPolicyId``.
apiPassthrough.extensions.certificatePolicies[].policyQualifiers[].qualifierobjectyesDefines the qualifier type.
apiPassthrough.extensions.certificatePolicies[].policyQualifiers[].qualifier.cpsUristringyesContains a pointer to a certification practice statement (CPS) published by the CA.
apiPassthrough.extensions.customExtensionsarray<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[].criticalboolean—Specifies the critical flag of the X.509 extension.
apiPassthrough.extensions.customExtensions[].objectIdentifierstringyesSpecifies the object identifier (OID) of the X.509 extension.
apiPassthrough.extensions.customExtensions[].valuestringyesSpecifies the base64-encoded value of the X.509 extension.
apiPassthrough.extensions.extendedKeyUsagearray<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[].extendedKeyUsageObjectIdentifierstring—Specifies a custom ``ExtendedKeyUsage`` with an object identifier (OID).
apiPassthrough.extensions.extendedKeyUsage[].extendedKeyUsageTypestring—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.keyUsageobject—Defines one or more purposes for which the key contained in the certificate can be used.
apiPassthrough.extensions.keyUsage.crlSignboolean—Key can be used to sign CRLs.
apiPassthrough.extensions.keyUsage.dataEnciphermentboolean—Key can be used to decipher data.
apiPassthrough.extensions.keyUsage.decipherOnlyboolean—Key can be used only to decipher data.
apiPassthrough.extensions.keyUsage.digitalSignatureboolean—Key can be used for digital signing.
apiPassthrough.extensions.keyUsage.encipherOnlyboolean—Key can be used only to encipher data.
apiPassthrough.extensions.keyUsage.keyAgreementboolean—Key can be used in a key-agreement protocol.
apiPassthrough.extensions.keyUsage.keyCertSignboolean—Key can be used to sign certificates.
apiPassthrough.extensions.keyUsage.keyEnciphermentboolean—Key can be used to encipher data.
apiPassthrough.extensions.keyUsage.nonRepudiationboolean—Key can be used for non-repudiation.
apiPassthrough.extensions.subjectAlternativeNamesarray<object>—The subject alternative name extension allows identities to be bound to the subject of the certificate.
apiPassthrough.extensions.subjectAlternativeNames[].directoryNameobject—Contains information about the certificate subject.
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.commonNamestring—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.countrystring—Two-digit code that specifies the country in which the certificate subject located.
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.customAttributesarray<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[].objectIdentifierstringyesSpecifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.customAttributes[].valuestringyesSpecifies the attribute value of relative distinguished name (RDN).
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.distinguishedNameQualifierstring—Disambiguating information for the certificate subject.
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.generationQualifierstring—Typically a qualifier appended to the name of an individual.
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.givenNamestring—First name.
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.initialsstring—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.localitystring—The locality (such as a city or town) in which the certificate subject is located.
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.organizationstring—Legal name of the organization with which the certificate subject is affiliated.
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.organizationalUnitstring—A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.pseudonymstring—Typically a shortened version of a longer *GivenName*.
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.serialNumberstring—The certificate serial number.
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.statestring—State in which the subject of the certificate is located.
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.surnamestring—Family name.
apiPassthrough.extensions.subjectAlternativeNames[].directoryName.titlestring—A title such as Mr.
apiPassthrough.extensions.subjectAlternativeNames[].dnsNamestring—Represents ``GeneralName`` as a DNS name.
apiPassthrough.extensions.subjectAlternativeNames[].ediPartyNameobject—Represents ``GeneralName`` as an ``EdiPartyName`` object.
apiPassthrough.extensions.subjectAlternativeNames[].ediPartyName.nameAssignerstringyesSpecifies the name assigner.
apiPassthrough.extensions.subjectAlternativeNames[].ediPartyName.partyNamestringyesSpecifies the party name.
apiPassthrough.extensions.subjectAlternativeNames[].ipAddressstring—Represents ``GeneralName`` as an IPv4 or IPv6 address.
apiPassthrough.extensions.subjectAlternativeNames[].otherNameobject—Represents ``GeneralName`` using an ``OtherName`` object.
apiPassthrough.extensions.subjectAlternativeNames[].otherName.typeIdstringyesSpecifies an OID.
apiPassthrough.extensions.subjectAlternativeNames[].otherName.valuestringyesSpecifies an OID value.
apiPassthrough.extensions.subjectAlternativeNames[].registeredIdstring—Represents ``GeneralName`` as an object identifier (OID).
apiPassthrough.extensions.subjectAlternativeNames[].rfc822Namestring—Represents ``GeneralName`` as an [RFC 822](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc822) email address.
apiPassthrough.extensions.subjectAlternativeNames[].uniformResourceIdentifierstring—Represents ``GeneralName`` as a URI.
apiPassthrough.subjectobject—Contains information about the certificate subject.
apiPassthrough.subject.commonNamestring—For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.
apiPassthrough.subject.countrystring—Two-digit code that specifies the country in which the certificate subject located.
apiPassthrough.subject.customAttributesarray<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[].objectIdentifierstringyesSpecifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).
apiPassthrough.subject.customAttributes[].valuestringyesSpecifies the attribute value of relative distinguished name (RDN).
apiPassthrough.subject.distinguishedNameQualifierstring—Disambiguating information for the certificate subject.
apiPassthrough.subject.generationQualifierstring—Typically a qualifier appended to the name of an individual.
apiPassthrough.subject.givenNamestring—First name.
apiPassthrough.subject.initialsstring—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.localitystring—The locality (such as a city or town) in which the certificate subject is located.
apiPassthrough.subject.organizationstring—Legal name of the organization with which the certificate subject is affiliated.
apiPassthrough.subject.organizationalUnitstring—A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
apiPassthrough.subject.pseudonymstring—Typically a shortened version of a longer *GivenName*.
apiPassthrough.subject.serialNumberstring—The certificate serial number.
apiPassthrough.subject.statestring—State in which the subject of the certificate is located.
apiPassthrough.subject.surnamestring—Family name.
apiPassthrough.subject.titlestring—A title such as Mr.
certificateAuthorityArnstringyesThe Amazon Resource Name (ARN) for the private CA issues the certificate.
certificateSigningRequeststringyesThe certificate signing request (CSR) for the certificate.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
signingAlgorithmstringyesThe name of the algorithm that will be used to sign the certificate to be issued.
templateArnstring—Specifies a custom configuration template to use when issuing a certificate.
validityobjectyesThe period of time during which the certificate will be valid.
validity.typestringyesSpecifies whether the ``Value`` parameter represents days, months, or years.
validity.valuenumberyesA long integer interpreted according to the value of ``Type``, below.
validityNotBeforeobject—Information describing the start of the validity period of the certificate.
validityNotBefore.typestringyesSpecifies whether the ``Value`` parameter represents days, months, or years.
validityNotBefore.valuenumberyesA long integer interpreted according to the value of ``Type``, below.

Status

FieldTypeRequiredDescription
arnstring—Read-only: reported by AWS after creation.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
certificatestring—Read-only: reported by AWS after creation.
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

ACMPCACertificateAuthorityActivation # CLOUD CONTROL · AWS::ACMPCA::CertificateAuthorityActivation

ACMPCACertificateAuthorityActivation manages AWS::ACMPCA::CertificateAuthorityActivation through the AWS Cloud Control API.

kubectl get acmpcacertificateauthorityactivations · example on GitHub

Example

# ACMPCACertificateAuthorityActivation — 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#acmpcacertificateauthorityactivation
apiVersion: aws.konfig.io/v1alpha1
kind: ACMPCACertificateAuthorityActivation
metadata:
  name: example-acmpcacertificateauthorityactivation
  namespace: default
spec:
  certificate: example
  certificateAuthorityArn: arn:aws:iam::123456789012:role/example-role
  certificateChain: example
  providerRef:
    name: example-acmpcacertificateauthorityactivation
    region: us-east-1
  status: example

Spec

FieldTypeRequiredDescription
certificatestringyesCertificate Authority certificate that will be installed in the Certificate Authority.
certificateAuthorityArnstringyesArn of the Certificate Authority.
certificateChainstring—Certificate chain for the Certificate Authority certificate.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
statusstring—The status of the Certificate Authority.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
completeCertificateChainstring—The complete certificate chain, including the Certificate Authority certificate.
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
actionsarray<string>yesThe actions that the specified AWS service principal can use.
certificateAuthorityArnstringyesThe Amazon Resource Name (ARN) of the Private Certificate Authority that grants the permission.
principalstringyesThe AWS service or identity that receives the permission.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
sourceAccountstring—The ID of the calling account.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
keyAlgorithmenumyesKeyAlgorithm for the CA key pair. Allowed: RSA_2048, RSA_4096, EC_prime256v1, EC_secp384r1
permanentDeletionTimeInDaysinteger—PermanentDeletionTimeInDays is the restore window applied when the CA is deleted (7-30 days).
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
revocationConfigurationobject—RevocationConfiguration configures CRL support.
revocationConfiguration.crlobject—Crl configures certificate revocation list publication.
revocationConfiguration.crl.enabledbooleanyesEnabled turns on certificate revocation list publication.
revocationConfiguration.crl.expirationInDaysinteger—ExpirationInDays is the CRL validity period.
revocationConfiguration.crl.s3BucketNamestring—S3BucketName is the bucket CRLs are published to.
signingAlgorithmenumyesSigningAlgorithm the CA uses to sign certificate requests. Allowed: SHA256WITHRSA, SHA384WITHRSA, SHA512WITHRSA, SHA256WITHECDSA, SHA384WITHECDSA, SHA512WITHECDSA
subjectobjectyesSubject is the X.500 distinguished name of the CA.
subject.commonNamestring—CommonName (CN) of the CA.
subject.countrystring—Country is the two-letter country code (C).
subject.localitystring—Locality such as a city or town (L).
subject.organizationstring—Organization (O) the CA belongs to.
subject.organizationalUnitstring—OrganizationalUnit (OU) within the organization.
subject.statestring—State or province (ST).
tagsmap<string>—Tags are AWS resource tags to apply.
typeenumyesType of the certificate authority. Allowed: ROOT, SUBORDINATE
usageModeenum—UsageMode of the CA. Allowed: GENERAL_PURPOSE, SHORT_LIVED_CERTIFICATE

Status

FieldTypeRequiredDescription
arnstring—ARN of the certificate authority.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—ObservedGeneration is the most recent .metadata.generation reconciled.
statusstring—Status is the current CA status (e.g.