certificate_v1alpha1.json

{
  "description": "Certificate is the Schema for the Certificates API",
  "properties": {
    "apiVersion": {
      "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
      "type": "string"
    },
    "kind": {
      "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "description": "CertificateSpec defines the desired state of Certificate.",
      "properties": {
        "certificateAuthorityARN": {
          "description": "The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the Amazon Web Services Private Certificate Authority (https://docs.aws.amazon.com/privateca/latest/userguide/PcaWelcome.html) user guide. The ARN must have the following form: \n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012",
          "type": "string"
        },
        "domainName": {
          "description": "Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com. \n In compliance with RFC 5280 (https://datatracker.ietf.org/doc/html/rfc5280), the length of the domain name (technically, the Common Name) that you provide cannot exceed 64 octets (characters), including periods. To add a longer domain name, specify it in the Subject Alternative Name field, which supports names up to 253 octets in length.",
          "type": "string"
        },
        "domainValidationOptions": {
          "description": "The domain name that you want ACM to use to send you emails so that you can validate domain ownership.",
          "items": {
            "description": "Contains information about the domain names that you want ACM to use to send you emails that enable you to validate domain ownership.",
            "properties": {
              "domainName": {
                "type": "string"
              },
              "validationDomain": {
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "keyAlgorithm": {
          "description": "Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some AWS services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the AWS service where you plan to deploy your certificate. \n Default: RSA_2048",
          "type": "string"
        },
        "options": {
          "description": "Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see Opting Out of Certificate Transparency Logging (https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency).",
          "properties": {
            "certificateTransparencyLoggingPreference": {
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "subjectAlternativeNames": {
          "description": "Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas (https://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html). \n The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples: \n - (63 octets).(63 octets).(63 octets).(61 octets) is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets. \n - (64 octets).(63 octets).(63 octets).(61 octets) is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets. \n - (63 octets).(63 octets).(63 octets).(62 octets) is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "tags": {
          "description": "One or more resource tags to associate with the certificate.",
          "items": {
            "description": "A key-value pair that identifies or specifies metadata about an ACM resource.",
            "properties": {
              "key": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        }
      },
      "required": [
        "domainName"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "description": "CertificateStatus defines the observed state of Certificate",
      "properties": {
        "ackResourceMetadata": {
          "description": "All CRs managed by ACK have a common `Status.ACKResourceMetadata` member that is used to contain resource sync state, account ownership, constructed ARN for the resource",
          "properties": {
            "arn": {
              "description": "ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \"adopted\" resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR's Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270",
              "type": "string"
            },
            "ownerAccountID": {
              "description": "OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.",
              "type": "string"
            },
            "region": {
              "description": "Region is the AWS region in which the resource exists or will exist.",
              "type": "string"
            }
          },
          "required": [
            "ownerAccountID",
            "region"
          ],
          "type": "object",
          "additionalProperties": false
        },
        "conditions": {
          "description": "All CRS managed by ACK have a common `Status.Conditions` member that contains a collection of `ackv1alpha1.Condition` objects that describe the various terminal states of the CR and its backend AWS service API resource",
          "items": {
            "description": "Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states  of the CR and its backend AWS service API resource",
            "properties": {
              "lastTransitionTime": {
                "description": "Last time the condition transitioned from one status to another.",
                "format": "date-time",
                "type": "string"
              },
              "message": {
                "description": "A human readable message indicating details about the transition.",
                "type": "string"
              },
              "reason": {
                "description": "The reason for the condition's last transition.",
                "type": "string"
              },
              "status": {
                "description": "Status of the condition, one of True, False, Unknown.",
                "type": "string"
              },
              "type": {
                "description": "Type is the type of the Condition",
                "type": "string"
              }
            },
            "required": [
              "status",
              "type"
            ],
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "createdAt": {
          "description": "The time at which the certificate was requested.",
          "format": "date-time",
          "type": "string"
        },
        "extendedKeyUsages": {
          "description": "Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).",
          "items": {
            "description": "The Extended Key Usage X.509 v3 extension defines one or more purposes for which the public key can be used. This is in addition to or in place of the basic purposes specified by the Key Usage extension.",
            "properties": {
              "name": {
                "type": "string"
              },
              "oid": {
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "failureReason": {
          "description": "The reason the certificate request failed. This value exists only when the certificate status is FAILED. For more information, see Certificate Request Failed (https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed) in the Certificate Manager User Guide.",
          "type": "string"
        },
        "importedAt": {
          "description": "The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED.",
          "format": "date-time",
          "type": "string"
        },
        "inUseBy": {
          "description": "A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services resources.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "issuedAt": {
          "description": "The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.",
          "format": "date-time",
          "type": "string"
        },
        "issuer": {
          "description": "The name of the certificate authority that issued and signed the certificate.",
          "type": "string"
        },
        "keyUsages": {
          "description": "A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.",
          "items": {
            "description": "The Key Usage X.509 v3 extension defines the purpose of the public key contained in the certificate.",
            "properties": {
              "name": {
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "notAfter": {
          "description": "The time after which the certificate is not valid.",
          "format": "date-time",
          "type": "string"
        },
        "notBefore": {
          "description": "The time before which the certificate is not valid.",
          "format": "date-time",
          "type": "string"
        },
        "renewalEligibility": {
          "description": "Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.",
          "type": "string"
        },
        "renewalSummary": {
          "description": "Contains information about the status of ACM's managed renewal (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html) for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.",
          "properties": {
            "domainValidationOptions": {
              "items": {
                "description": "Contains information about the validation of each domain name in the certificate.",
                "properties": {
                  "domainName": {
                    "type": "string"
                  },
                  "resourceRecord": {
                    "description": "Contains a DNS record value that you can use to validate ownership or control of a domain. This is used by the DescribeCertificate action.",
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "type_": {
                        "type": "string"
                      },
                      "value": {
                        "type": "string"
                      }
                    },
                    "type": "object",
                    "additionalProperties": false
                  },
                  "validationDomain": {
                    "type": "string"
                  },
                  "validationEmails": {
                    "items": {
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "validationMethod": {
                    "type": "string"
                  },
                  "validationStatus": {
                    "type": "string"
                  }
                },
                "type": "object",
                "additionalProperties": false
              },
              "type": "array"
            },
            "renewalStatus": {
              "type": "string"
            },
            "renewalStatusReason": {
              "type": "string"
            },
            "updatedAt": {
              "format": "date-time",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "revocationReason": {
          "description": "The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.",
          "type": "string"
        },
        "revokedAt": {
          "description": "The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.",
          "format": "date-time",
          "type": "string"
        },
        "serial": {
          "description": "The serial number of the certificate.",
          "type": "string"
        },
        "signatureAlgorithm": {
          "description": "The algorithm that was used to sign the certificate.",
          "type": "string"
        },
        "status": {
          "description": "The status of the certificate. \n A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails (https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html). ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation (https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html) or Email validation (https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html), and try again. If validation succeeds, the certificate enters status ISSUED.",
          "type": "string"
        },
        "subject": {
          "description": "The name of the entity that is associated with the public key contained in the certificate.",
          "type": "string"
        },
        "type_": {
          "description": "The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide managed renewal (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html) for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the Certificate Manager User Guide.",
          "type": "string"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  },
  "type": "object"
}