You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SecurityHub::Types::AwsCertificateManagerCertificateDetails

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AwsCertificateManagerCertificateDetails as input to an Aws::Client method, you can use a vanilla Hash:

{
  certificate_authority_arn: "NonEmptyString",
  created_at: "NonEmptyString",
  domain_name: "NonEmptyString",
  domain_validation_options: [
    {
      domain_name: "NonEmptyString",
      resource_record: {
        name: "NonEmptyString",
        type: "NonEmptyString",
        value: "NonEmptyString",
      },
      validation_domain: "NonEmptyString",
      validation_emails: ["NonEmptyString"],
      validation_method: "NonEmptyString",
      validation_status: "NonEmptyString",
    },
  ],
  extended_key_usages: [
    {
      name: "NonEmptyString",
      o_id: "NonEmptyString",
    },
  ],
  failure_reason: "NonEmptyString",
  imported_at: "NonEmptyString",
  in_use_by: ["NonEmptyString"],
  issued_at: "NonEmptyString",
  issuer: "NonEmptyString",
  key_algorithm: "NonEmptyString",
  key_usages: [
    {
      name: "NonEmptyString",
    },
  ],
  not_after: "NonEmptyString",
  not_before: "NonEmptyString",
  options: {
    certificate_transparency_logging_preference: "NonEmptyString",
  },
  renewal_eligibility: "NonEmptyString",
  renewal_summary: {
    domain_validation_options: [
      {
        domain_name: "NonEmptyString",
        resource_record: {
          name: "NonEmptyString",
          type: "NonEmptyString",
          value: "NonEmptyString",
        },
        validation_domain: "NonEmptyString",
        validation_emails: ["NonEmptyString"],
        validation_method: "NonEmptyString",
        validation_status: "NonEmptyString",
      },
    ],
    renewal_status: "NonEmptyString",
    renewal_status_reason: "NonEmptyString",
    updated_at: "NonEmptyString",
  },
  serial: "NonEmptyString",
  signature_algorithm: "NonEmptyString",
  status: "NonEmptyString",
  subject: "NonEmptyString",
  subject_alternative_names: ["NonEmptyString"],
  type: "NonEmptyString",
}

Provides details about an AWS Certificate Manager certificate.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_authority_arn ⇒ String

The ARN of the private certificate authority (CA) that will be used to issue the certificate.

Returns:

  • (String) —

    The ARN of the private certificate authority (CA) that will be used to issue the certificate.

#created_at ⇒ String

Indicates when the certificate was requested.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Returns:

  • (String) —

    Indicates when the certificate was requested.

#domain_name ⇒ String

The fully qualified domain name (FQDN), such as www.example.com, that is secured by the certificate.

Returns:

  • (String) —

    The fully qualified domain name (FQDN), such as www.example.com, that is secured by the certificate.

#domain_validation_options ⇒ Array<Types::AwsCertificateManagerCertificateDomainValidationOption>

Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request.

Only provided if the certificate type is AMAZON_ISSUED.

Returns:

#extended_key_usages ⇒ Array<Types::AwsCertificateManagerCertificateExtendedKeyUsage>

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

Returns:

#failure_reason ⇒ String

For a failed certificate request, the reason for the failure.

Valid values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED | CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN | PCA_INVALID_STATE | PCA_REQUEST_FAILED | PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND | PCA_INVALID_ARGS | PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER

Returns:

  • (String) —

    For a failed certificate request, the reason for the failure.

#imported_at ⇒ String

Indicates when the certificate was imported. Provided if the certificate type is IMPORTED.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Returns:

  • (String) —

    Indicates when the certificate was imported.

#in_use_by ⇒ Array<String>

The list of ARNs for the AWS resources that use the certificate.

Returns:

  • (Array<String>) —

    The list of ARNs for the AWS resources that use the certificate.

#issued_at ⇒ String

Indicates when the certificate was issued. Provided if the certificate type is AMAZON_ISSUED.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Returns:

  • (String) —

    Indicates when the certificate was issued.

#issuer ⇒ String

The name of the certificate authority that issued and signed the certificate.

Returns:

  • (String) —

    The name of the certificate authority that issued and signed the certificate.

#key_algorithm ⇒ String

The algorithm that was used to generate the public-private key pair.

Valid values: RSA_2048 | RSA_1024 |RSA_4096 | EC_prime256v1 | EC_secp384r1 | EC_secp521r1

Returns:

  • (String) —

    The algorithm that was used to generate the public-private key pair.

#key_usages ⇒ Array<Types::AwsCertificateManagerCertificateKeyUsage>

A list of key usage X.509 v3 extension objects.

Returns:

#not_after ⇒ String

The time after which the certificate becomes invalid.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Returns:

  • (String) —

    The time after which the certificate becomes invalid.

#not_before ⇒ String

The time before which the certificate is not valid.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Returns:

  • (String) —

    The time before which the certificate is not valid.

#options ⇒ Types::AwsCertificateManagerCertificateOptions

Provides a value that specifies whether to add the certificate to a transparency log.

Returns:

#renewal_eligibility ⇒ String

Whether the certificate is eligible for renewal.

Valid values: ELIGIBLE | INELIGIBLE

Returns:

  • (String) —

    Whether the certificate is eligible for renewal.

#renewal_summary ⇒ Types::AwsCertificateManagerCertificateRenewalSummary

Information about the status of the AWS Certificate Manager managed renewal for the certificate. Provided only when the certificate type is AMAZON_ISSUED.

Returns:

#serial ⇒ String

The serial number of the certificate.

Returns:

  • (String) —

    The serial number of the certificate.

#signature_algorithm ⇒ String

The algorithm that was used to sign the certificate.

Returns:

  • (String) —

    The algorithm that was used to sign the certificate.

#status ⇒ String

The status of the certificate.

Valid values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED

Returns:

  • (String) —

    The status of the certificate.

#subject ⇒ String

The name of the entity that is associated with the public key contained in the certificate.

Returns:

  • (String) —

    The name of the entity that is associated with the public key contained in the certificate.

#subject_alternative_names ⇒ Array<String>

One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate.

The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.

Returns:

  • (Array<String>) —

    One or more domain names (subject alternative names) included in the certificate.

#type ⇒ String

The source of the certificate. For certificates that AWS Certificate Manager provides, Type is AMAZON_ISSUED. For certificates that are imported with ImportCertificate, Type is IMPORTED.

Valid values: IMPORTED | AMAZON_ISSUED | PRIVATE

Returns:

  • (String) —

    The source of the certificate.