Class: MintPress::Aws::Lightsail::Certificate

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb

Properties (Read/Write)

  • #arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the certificate.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'arn'
    

24
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 24

property :arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the certificate.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'arn', type: [String]
  • #created_at ⇒ [Time]
    'The timestamp when the certificate was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'created_at'
    

25
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 25

property :created_at, disposition: :attribute, description: 'The timestamp when the certificate was created.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'created_at', type: [Time]
  • #domain_name ⇒ [String]
    'The domain name of the certificate.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'domain_name'
    • create_certificate_prop ⇒ 'domain_name'
    • read_only ⇒ false
    

26
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 26

property :domain_name, disposition: :attribute, description: 'The domain name of the certificate.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'domain_name', type: [String], create_certificate_prop: 'domain_name', read_only: false
  • #domain_validation_records ⇒ Hash of ⇒ [MintPress::Aws::Lightsail::DomainValidationRecord]
    'An array of objects that describe the domain validation records of the certificate.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'domain_validation_records'
    

27
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 27

property :domain_validation_records, disposition: :attribute, description: 'An array of objects that describe the domain validation records of the certificate.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'domain_validation_records', type: [MintPress::Aws::Lightsail::DomainValidationRecord], array: false, hash: true
  • #eligible_to_renew ⇒ [String]
    'The renewal eligibility of the certificate.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'eligible_to_renew'
    

28
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 28

property :eligible_to_renew, disposition: :attribute, description: 'The renewal eligibility of the certificate.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'eligible_to_renew', type: [String]
  • #in_use_resource_count ⇒ [Integer]
    'The number of Lightsail resources that the certificate is attached to.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'in_use_resource_count'
    

29
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 29

property :in_use_resource_count, disposition: :attribute, description: 'The number of Lightsail resources that the certificate is attached to.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'in_use_resource_count', type: [Integer]
  • #issued_at ⇒ [Time]
    'The timestamp when the certificate was issued.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'issued_at'
    

30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 30

property :issued_at, disposition: :attribute, description: 'The timestamp when the certificate was issued.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'issued_at', type: [Time]
  • #issuer_ca ⇒ [String]
    'The certificate authority that issued the certificate.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'issuer_ca'
    

31
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 31

property :issuer_ca, disposition: :attribute, description: 'The certificate authority that issued the certificate.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'issuer_ca', type: [String]
  • #key_algorithm ⇒ [String]
    'The algorithm used to generate the key pair (the public and private key) of the certificate.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'key_algorithm'
    

32
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 32

property :key_algorithm, disposition: :attribute, description: 'The algorithm used to generate the key pair (the public and private key) of the certificate.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'key_algorithm', type: [String]
  • #name ⇒ [String]
    'The name of the certificate (e.g., my-certificate).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'name'
    

33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 33

property :name, disposition: :attribute, description: 'The name of the certificate (e.g., my-certificate).', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'name', type: [String]
  • #not_after ⇒ [Time]
    'The timestamp when the certificate expires.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'not_after'
    

34
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 34

property :not_after, disposition: :attribute, description: 'The timestamp when the certificate expires.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'not_after', type: [Time]
  • #not_before ⇒ [Time]
    'The timestamp when the certificate is first valid.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'not_before'
    

35
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 35

property :not_before, disposition: :attribute, description: 'The timestamp when the certificate is first valid.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'not_before', type: [Time]
  • #renewal_summary ⇒ [MintPress::Aws::Lightsail::RenewalSummary] (Default Value: MintPress::Aws::Lightsail::RenewalSummary.new)
    'An object that describes the status of the certificate renewal managed by Lightsail.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'renewal_summary'
    • default ⇒ MintPress::Aws::Lightsail::RenewalSummary.new
    

36
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 36

property :renewal_summary, disposition: :attribute, description: 'An object that describes the status of the certificate renewal managed by Lightsail.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'renewal_summary', type: [MintPress::Aws::Lightsail::RenewalSummary], default: MintPress::Aws::Lightsail::RenewalSummary.new
  • #request_failure_reason ⇒ [String]
    'The validation failure reason, if any, of the certificate.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'request_failure_reason'
    

37
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 37

property :request_failure_reason, disposition: :attribute, description: 'The validation failure reason, if any, of the certificate.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'request_failure_reason', type: [String]
  • #revocation_reason ⇒ [String]
    'The reason the certificate was revoked.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'revocation_reason'
    

38
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 38

property :revocation_reason, disposition: :attribute, description: 'The reason the certificate was revoked.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'revocation_reason', type: [String]
  • #revoked_at ⇒ [Time]
    'The timestamp when the certificate was revoked.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'revoked_at'
    

39
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 39

property :revoked_at, disposition: :attribute, description: 'The timestamp when the certificate was revoked.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'revoked_at', type: [Time]
  • #serial_number ⇒ [String]
    'The serial number of the certificate.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'serial_number'
    

40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 40

property :serial_number, disposition: :attribute, description: 'The serial number of the certificate.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'serial_number', type: [String]
  • #status ⇒ [String]
    'The validation status of the certificate.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'status'
    

41
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 41

property :status, disposition: :attribute, description: 'The validation status of the certificate.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'status', type: [String]
  • #subject_alternative_names ⇒ Array of ⇒ [String]
    'An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) of the certificate.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'subject_alternative_names'
    • create_certificate_prop ⇒ 'subject_alternative_names'
    • read_only ⇒ false
    

42
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 42

property :subject_alternative_names, disposition: :attribute, description: 'An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) of the certificate.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'subject_alternative_names', type: [String], array: true, create_certificate_prop: 'subject_alternative_names', read_only: false
  • #support_code ⇒ [String]
    'The support code.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'support_code'
    

43
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 43

property :support_code, disposition: :attribute, description: 'The support code.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'support_code', type: [String]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::Lightsail::Tag]
    'The tag keys and optional values for the resource.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Certificate"
    • orig_name ⇒ 'tags'
    • create_certificate_prop ⇒ 'tags'
    • read_only ⇒ false
    

44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 44

property :tags, disposition: :attribute, description: 'The tag keys and optional values for the resource.', source: "MintPress::Aws::Lightsail::Certificate", orig_name: 'tags', type: [MintPress::Aws::Lightsail::Tag], array: false, create_certificate_prop: 'tags', read_only: false, hash: true
  • #certificate_name ⇒ [String]
    'The name for the certificate for which to return information. When omitted, the response includes all of your certificates in the AWS Region where the request is made.'
    Property Attributes
    • create_certificate_prop ⇒ 'certificate_name'
    • read_only ⇒ false
    • source ⇒ "get_certificates"
    • delete_certificate_prop ⇒ 'certificate_name'
    • get_certificates_prop ⇒ 'certificate_name'
    

45
46
47
48
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 45

property :certificate_name, create_certificate_prop: 'certificate_name', type: [String], read_only: false, source: "get_certificates", description: 'The name for the certificate for which to return information.

When omitted, the response includes all of your certificates in the
AWS Region where the request is made.', delete_certificate_prop: 'certificate_name', get_certificates_prop: 'certificate_name'
  • #certificate_statuses ⇒ Array of ⇒ [String]
    'The status of the certificates for which to return information. For example, specify ISSUED to return only certificates with an ISSUED status. When omitted, the response includes all of your certificates in the AWS Region where the request is made, regardless of their current status.'
    Property Attributes
    • get_certificates_prop ⇒ 'certificate_statuses'
    • read_only ⇒ false
    • source ⇒ "get_certificates"
    

49
50
51
52
53
54
55
56
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 49

property :certificate_statuses, get_certificates_prop: 'certificate_statuses', type: [String], array: true, read_only: false, source: "get_certificates", description: 'The status of the certificates for which to return information.

For example, specify ISSUED to return only certificates with an
ISSUED status.

When omitted, the response includes all of your certificates in the
AWS Region where the request is made, regardless of their current
status.'
  • #include_certificate_details ⇒ [TrueClass,FalseClass]
    'Indicates whether to include detailed information about the certificates in the response. When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.'
    Property Attributes
    • get_certificates_prop ⇒ 'include_certificate_details'
    • read_only ⇒ false
    • source ⇒ "get_certificates"
    

57
58
59
60
61
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 57

property :include_certificate_details, get_certificates_prop: 'include_certificate_details', type: [TrueClass,FalseClass], read_only: false, source: "get_certificates", description: 'Indicates whether to include detailed information about the
certificates in the response.

When omitted, the response includes only the certificate names, Amazon
Resource Names (ARNs), domain names, and tags.'
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

65
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 65

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

68
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/certificate.rb', line 68

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ Certificate

Returns a new instance of Certificate.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#get ⇒ Object