Class: MintPress::Aws::Lightsail::KeyPair

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

Properties (Read/Write)

  • #arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::KeyPair"
    • orig_name ⇒ 'arn'
    

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

property :arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).', source: "MintPress::Aws::Lightsail::KeyPair", orig_name: 'arn', type: [String]
  • #created_at ⇒ [Time]
    'The timestamp when the key pair was created (e.g., 1479816991.349).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::KeyPair"
    • orig_name ⇒ 'created_at'
    

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

property :created_at, disposition: :attribute, description: 'The timestamp when the key pair was created (e.g., 1479816991.349).', source: "MintPress::Aws::Lightsail::KeyPair", orig_name: 'created_at', type: [Time]
  • #fingerprint ⇒ [String]
    'The RSA fingerprint of the key pair.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::KeyPair"
    • orig_name ⇒ 'fingerprint'
    

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

property :fingerprint, disposition: :attribute, description: 'The RSA fingerprint of the key pair.', source: "MintPress::Aws::Lightsail::KeyPair", orig_name: 'fingerprint', type: [String]
  • #location ⇒ [MintPress::Aws::Lightsail::ResourceLocation] (Default Value: MintPress::Aws::Lightsail::ResourceLocation.new)
    'The region name and Availability Zone where the key pair was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::KeyPair"
    • orig_name ⇒ 'location'
    • default ⇒ MintPress::Aws::Lightsail::ResourceLocation.new
    

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

property :location, disposition: :attribute, description: 'The region name and Availability Zone where the key pair was created.', source: "MintPress::Aws::Lightsail::KeyPair", orig_name: 'location', type: [MintPress::Aws::Lightsail::ResourceLocation], default: MintPress::Aws::Lightsail::ResourceLocation.new
  • #name ⇒ [String]
    'The friendly name of the SSH key pair.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::KeyPair"
    • orig_name ⇒ 'name'
    

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

property :name, disposition: :attribute, description: 'The friendly name of the SSH key pair.', source: "MintPress::Aws::Lightsail::KeyPair", orig_name: 'name', type: [String]
  • #resource_type ⇒ [String]
    'The resource type (usually KeyPair).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::KeyPair"
    • orig_name ⇒ 'resource_type'
    

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

property :resource_type, disposition: :attribute, description: 'The resource type (usually KeyPair).', source: "MintPress::Aws::Lightsail::KeyPair", orig_name: 'resource_type', type: [String]
  • #support_code ⇒ [String]
    'The support code.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::KeyPair"
    • orig_name ⇒ 'support_code'
    

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

property :support_code, disposition: :attribute, description: 'The support code.', source: "MintPress::Aws::Lightsail::KeyPair", 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::KeyPair"
    • orig_name ⇒ 'tags'
    • create_key_pair_prop ⇒ 'tags'
    • read_only ⇒ false
    

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

property :tags, disposition: :attribute, description: 'The tag keys and optional values for the resource.', source: "MintPress::Aws::Lightsail::KeyPair", orig_name: 'tags', type: [MintPress::Aws::Lightsail::Tag], array: false, create_key_pair_prop: 'tags', read_only: false, hash: true
  • #key_pair_name ⇒ [String]
    'The name of the key pair for which you are requesting information.'
    Property Attributes
    • create_key_pair_prop ⇒ 'key_pair_name'
    • read_only ⇒ false
    • source ⇒ "get_key_pair"
    • delete_key_pair_prop ⇒ 'key_pair_name'
    • get_key_pair_prop ⇒ 'key_pair_name'
    

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

property :key_pair_name, create_key_pair_prop: 'key_pair_name', type: [String], read_only: false, source: "get_key_pair", description: 'The name of the key pair for which you are requesting information.', delete_key_pair_prop: 'key_pair_name', get_key_pair_prop: 'key_pair_name'
  • #page_token ⇒ [String]
    'The token to advance to the next page of results from your request. To get a page token, perform an initial GetKeyPairs request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.'
    Property Attributes
    • get_key_pairs_prop ⇒ 'page_token'
    • read_only ⇒ false
    • source ⇒ "get_key_pairs"
    

32
33
34
35
36
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/key_pair.rb', line 32

property :page_token, get_key_pairs_prop: 'page_token', type: [String], read_only: false, source: "get_key_pairs", description: 'The token to advance to the next page of results from your request.

To get a page token, perform an initial GetKeyPairs request. If your
results are paginated, the response will return a next page token that
you can specify as the page token in a subsequent request.'
  • #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 
    

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

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
    

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

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 = {}) ⇒ KeyPair

Returns a new instance of KeyPair.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#get ⇒ Object