Class: Aws::ACM::Types::CertificateSummary

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb

Overview

This structure is returned in the response object of ListCertificates action.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_arn ⇒ String

Amazon Resource Name (ARN) of the certificate. This is of the form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs).

Returns:

  • (String) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 446

class CertificateSummary < Struct.new(
  :certificate_arn,
  :domain_name,
  :subject_alternative_name_summaries,
  :has_additional_subject_alternative_names,
  :status,
  :type,
  :key_algorithm,
  :key_usages,
  :extended_key_usages,
  :in_use,
  :exported,
  :renewal_eligibility,
  :not_before,
  :not_after,
  :created_at,
  :issued_at,
  :imported_at,
  :revoked_at)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The time at which the certificate was requested.

Returns:

  • (Time) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 446

class CertificateSummary < Struct.new(
  :certificate_arn,
  :domain_name,
  :subject_alternative_name_summaries,
  :has_additional_subject_alternative_names,
  :status,
  :type,
  :key_algorithm,
  :key_usages,
  :extended_key_usages,
  :in_use,
  :exported,
  :renewal_eligibility,
  :not_before,
  :not_after,
  :created_at,
  :issued_at,
  :imported_at,
  :revoked_at)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.

Returns:

  • (String) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 446

class CertificateSummary < Struct.new(
  :certificate_arn,
  :domain_name,
  :subject_alternative_name_summaries,
  :has_additional_subject_alternative_names,
  :status,
  :type,
  :key_algorithm,
  :key_usages,
  :extended_key_usages,
  :in_use,
  :exported,
  :renewal_eligibility,
  :not_before,
  :not_after,
  :created_at,
  :issued_at,
  :imported_at,
  :revoked_at)
  SENSITIVE = []
  include Aws::Structure
end

#exported ⇒ Boolean

Indicates whether the certificate has been exported. This value exists only when the certificate type is PRIVATE.

Returns:

  • (Boolean) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 446

class CertificateSummary < Struct.new(
  :certificate_arn,
  :domain_name,
  :subject_alternative_name_summaries,
  :has_additional_subject_alternative_names,
  :status,
  :type,
  :key_algorithm,
  :key_usages,
  :extended_key_usages,
  :in_use,
  :exported,
  :renewal_eligibility,
  :not_before,
  :not_after,
  :created_at,
  :issued_at,
  :imported_at,
  :revoked_at)
  SENSITIVE = []
  include Aws::Structure
end

#extended_key_usages ⇒ Array<String>

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:

  • (Array<String>) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 446

class CertificateSummary < Struct.new(
  :certificate_arn,
  :domain_name,
  :subject_alternative_name_summaries,
  :has_additional_subject_alternative_names,
  :status,
  :type,
  :key_algorithm,
  :key_usages,
  :extended_key_usages,
  :in_use,
  :exported,
  :renewal_eligibility,
  :not_before,
  :not_after,
  :created_at,
  :issued_at,
  :imported_at,
  :revoked_at)
  SENSITIVE = []
  include Aws::Structure
end

#has_additional_subject_alternative_names ⇒ Boolean

When called by ListCertificates, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

Returns:

  • (Boolean) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 446

class CertificateSummary < Struct.new(
  :certificate_arn,
  :domain_name,
  :subject_alternative_name_summaries,
  :has_additional_subject_alternative_names,
  :status,
  :type,
  :key_algorithm,
  :key_usages,
  :extended_key_usages,
  :in_use,
  :exported,
  :renewal_eligibility,
  :not_before,
  :not_after,
  :created_at,
  :issued_at,
  :imported_at,
  :revoked_at)
  SENSITIVE = []
  include Aws::Structure
end

#imported_at ⇒ Time

The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED.

Returns:

  • (Time) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 446

class CertificateSummary < Struct.new(
  :certificate_arn,
  :domain_name,
  :subject_alternative_name_summaries,
  :has_additional_subject_alternative_names,
  :status,
  :type,
  :key_algorithm,
  :key_usages,
  :extended_key_usages,
  :in_use,
  :exported,
  :renewal_eligibility,
  :not_before,
  :not_after,
  :created_at,
  :issued_at,
  :imported_at,
  :revoked_at)
  SENSITIVE = []
  include Aws::Structure
end

#in_use ⇒ Boolean

Indicates whether the certificate is currently in use by any Amazon Web Services resources.

Returns:

  • (Boolean) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 446

class CertificateSummary < Struct.new(
  :certificate_arn,
  :domain_name,
  :subject_alternative_name_summaries,
  :has_additional_subject_alternative_names,
  :status,
  :type,
  :key_algorithm,
  :key_usages,
  :extended_key_usages,
  :in_use,
  :exported,
  :renewal_eligibility,
  :not_before,
  :not_after,
  :created_at,
  :issued_at,
  :imported_at,
  :revoked_at)
  SENSITIVE = []
  include Aws::Structure
end

#issued_at ⇒ Time

The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.

Returns:

  • (Time) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 446

class CertificateSummary < Struct.new(
  :certificate_arn,
  :domain_name,
  :subject_alternative_name_summaries,
  :has_additional_subject_alternative_names,
  :status,
  :type,
  :key_algorithm,
  :key_usages,
  :extended_key_usages,
  :in_use,
  :exported,
  :renewal_eligibility,
  :not_before,
  :not_after,
  :created_at,
  :issued_at,
  :imported_at,
  :revoked_at)
  SENSITIVE = []
  include Aws::Structure
end

#key_algorithm ⇒ String

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

Returns:

  • (String) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 446

class CertificateSummary < Struct.new(
  :certificate_arn,
  :domain_name,
  :subject_alternative_name_summaries,
  :has_additional_subject_alternative_names,
  :status,
  :type,
  :key_algorithm,
  :key_usages,
  :extended_key_usages,
  :in_use,
  :exported,
  :renewal_eligibility,
  :not_before,
  :not_after,
  :created_at,
  :issued_at,
  :imported_at,
  :revoked_at)
  SENSITIVE = []
  include Aws::Structure
end

#key_usages ⇒ Array<String>

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.

Returns:

  • (Array<String>) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 446

class CertificateSummary < Struct.new(
  :certificate_arn,
  :domain_name,
  :subject_alternative_name_summaries,
  :has_additional_subject_alternative_names,
  :status,
  :type,
  :key_algorithm,
  :key_usages,
  :extended_key_usages,
  :in_use,
  :exported,
  :renewal_eligibility,
  :not_before,
  :not_after,
  :created_at,
  :issued_at,
  :imported_at,
  :revoked_at)
  SENSITIVE = []
  include Aws::Structure
end

#not_after ⇒ Time

The time after which the certificate is not valid.

Returns:

  • (Time) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 446

class CertificateSummary < Struct.new(
  :certificate_arn,
  :domain_name,
  :subject_alternative_name_summaries,
  :has_additional_subject_alternative_names,
  :status,
  :type,
  :key_algorithm,
  :key_usages,
  :extended_key_usages,
  :in_use,
  :exported,
  :renewal_eligibility,
  :not_before,
  :not_after,
  :created_at,
  :issued_at,
  :imported_at,
  :revoked_at)
  SENSITIVE = []
  include Aws::Structure
end

#not_before ⇒ Time

The time before which the certificate is not valid.

Returns:

  • (Time) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 446

class CertificateSummary < Struct.new(
  :certificate_arn,
  :domain_name,
  :subject_alternative_name_summaries,
  :has_additional_subject_alternative_names,
  :status,
  :type,
  :key_algorithm,
  :key_usages,
  :extended_key_usages,
  :in_use,
  :exported,
  :renewal_eligibility,
  :not_before,
  :not_after,
  :created_at,
  :issued_at,
  :imported_at,
  :revoked_at)
  SENSITIVE = []
  include Aws::Structure
end

#renewal_eligibility ⇒ String

Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.

Returns:

  • (String) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 446

class CertificateSummary < Struct.new(
  :certificate_arn,
  :domain_name,
  :subject_alternative_name_summaries,
  :has_additional_subject_alternative_names,
  :status,
  :type,
  :key_algorithm,
  :key_usages,
  :extended_key_usages,
  :in_use,
  :exported,
  :renewal_eligibility,
  :not_before,
  :not_after,
  :created_at,
  :issued_at,
  :imported_at,
  :revoked_at)
  SENSITIVE = []
  include Aws::Structure
end

#revoked_at ⇒ Time

The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.

Returns:

  • (Time) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 446

class CertificateSummary < Struct.new(
  :certificate_arn,
  :domain_name,
  :subject_alternative_name_summaries,
  :has_additional_subject_alternative_names,
  :status,
  :type,
  :key_algorithm,
  :key_usages,
  :extended_key_usages,
  :in_use,
  :exported,
  :renewal_eligibility,
  :not_before,
  :not_after,
  :created_at,
  :issued_at,
  :imported_at,
  :revoked_at)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the certificate.

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. 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 or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.

Returns:

  • (String) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 446

class CertificateSummary < Struct.new(
  :certificate_arn,
  :domain_name,
  :subject_alternative_name_summaries,
  :has_additional_subject_alternative_names,
  :status,
  :type,
  :key_algorithm,
  :key_usages,
  :extended_key_usages,
  :in_use,
  :exported,
  :renewal_eligibility,
  :not_before,
  :not_after,
  :created_at,
  :issued_at,
  :imported_at,
  :revoked_at)
  SENSITIVE = []
  include Aws::Structure
end

#subject_alternative_name_summaries ⇒ 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.

When called by ListCertificates, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

Returns:

  • (Array<String>) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 446

class CertificateSummary < Struct.new(
  :certificate_arn,
  :domain_name,
  :subject_alternative_name_summaries,
  :has_additional_subject_alternative_names,
  :status,
  :type,
  :key_algorithm,
  :key_usages,
  :extended_key_usages,
  :in_use,
  :exported,
  :renewal_eligibility,
  :not_before,
  :not_after,
  :created_at,
  :issued_at,
  :imported_at,
  :revoked_at)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

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 for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the Certificate Manager User Guide.

Returns:

  • (String) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 446

class CertificateSummary < Struct.new(
  :certificate_arn,
  :domain_name,
  :subject_alternative_name_summaries,
  :has_additional_subject_alternative_names,
  :status,
  :type,
  :key_algorithm,
  :key_usages,
  :extended_key_usages,
  :in_use,
  :exported,
  :renewal_eligibility,
  :not_before,
  :not_after,
  :created_at,
  :issued_at,
  :imported_at,
  :revoked_at)
  SENSITIVE = []
  include Aws::Structure
end