Class: MintPress::Aws::EC2::KeyPair

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

Properties (Read/Write)

  • #key_name ⇒ [String]
    'A unique name for the key pair. Constraints: Up to 255 ASCII characters'
    Property Attributes
    • source ⇒ "create_key_pair"
    • orig_name ⇒ 'key_name'
    • create_key_pair_prop ⇒ 'key_name'
    • read_only ⇒ false
    • delete_key_pair_prop ⇒ 'key_name'
    

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

property :key_name, description: 'A unique name for the key pair.

Constraints: Up to 255 ASCII characters', source: "create_key_pair", orig_name: 'key_name', type: [String], create_key_pair_prop: 'key_name', read_only: false, delete_key_pair_prop: 'key_name'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags to apply to the new key pair.'
    Property Attributes
    • source ⇒ "create_key_pair"
    • orig_name ⇒ 'tags'
    • create_key_pair_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

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

property :tags, description: 'The tags to apply to the new key pair.', source: "create_key_pair", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_key_pair_prop: 'tag_specifications', read_only: false, hash: true
  • #dry_run ⇒ [TrueClass,FalseClass]
    'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
    Property Attributes
    • create_key_pair_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "create_key_pair"
    • delete_key_pair_prop ⇒ 'dry_run'
    • describe_key_pairs_prop ⇒ 'dry_run'
    

30
31
32
33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/key_pair.rb', line 30

property :dry_run, create_key_pair_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "create_key_pair", description: 'Checks whether you have the required permissions for the action,
without actually making the request, and provides an error response.
If you have the required permissions, the error response is
DryRunOperation. Otherwise, it is UnauthorizedOperation.', delete_key_pair_prop: 'dry_run', describe_key_pairs_prop: 'dry_run'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'The filters. key-pair-id - The ID of the key pair. fingerprint - The fingerprint of the key pair. key-name - The name of the key pair. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
    Property Attributes
    • describe_key_pairs_prop ⇒ 'filters'
    • source ⇒ "describe_key_pairs"
    

34
35
36
37
38
39
40
41
42
43
44
45
46
47
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/key_pair.rb', line 34

property :filters, describe_key_pairs_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_key_pairs", description: 'The filters.


key-pair-id - The ID of the key pair.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
tag-key - The key of a tag assigned to the resource. Use this
filter to find all resources assigned a tag with a specific key,
regardless of the tag value.
tag:<key> - The key/value combination of a tag assigned to
the resource. Use the tag key in the filter name and the tag value
as the filter value. For example, to find all resources that have a
tag with the key Owner and the value TeamA, specify tag:Owner
for the filter name and TeamA for the filter value.', hash: true
  • #key_names ⇒ Array of ⇒ [String]
    'The key pair names. Default: Describes all your key pairs.'
    Property Attributes
    • describe_key_pairs_prop ⇒ 'key_names'
    • source ⇒ "describe_key_pairs"
    

48
49
50
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/key_pair.rb', line 48

property :key_names, describe_key_pairs_prop: 'key_names', type: [String], array: true, source: "describe_key_pairs", description: 'The key pair names.

Default: Describes all your key pairs.'
  • #id ⇒ [String]
    'The IDs of the key pairs.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "describe_key_pairs"
    • orig_name ⇒ 'key_pair_id'
    • delete_key_pair_prop ⇒ 'key_pair_id'
    • read_only ⇒ false
    • describe_key_pairs_prop ⇒ 'key_pair_ids'
    

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

property :id, disposition: :read_only_attribute, description: 'The IDs of the key pairs.', source: "describe_key_pairs", orig_name: 'key_pair_id', type: [String], delete_key_pair_prop: 'key_pair_id', read_only: false, array: false, hash: false, describe_key_pairs_prop: 'key_pair_ids'
  • #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 
    

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

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
    

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

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

Properties (Read Only)

  • #key_fingerprint ⇒ [String]
    'The SHA-1 digest of the DER encoded private key.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "KeyPair"
    • orig_name ⇒ 'key_fingerprint'
    • read_only ⇒ true
    

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

property :key_fingerprint, disposition: :read_only_attribute, description: 'The SHA-1 digest of the DER encoded private key.', source: "KeyPair", orig_name: 'key_fingerprint', type: [String], read_only: true
  • #key_material ⇒ [String]
    'An unencrypted PEM encoded RSA private key.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "KeyPair"
    • orig_name ⇒ 'key_material'
    • read_only ⇒ true
    

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

property :key_material, disposition: :read_only_attribute, description: 'An unencrypted PEM encoded RSA private key.', source: "KeyPair", orig_name: 'key_material', type: [String], read_only: true
  • #name ⇒ [String]
    '(also: #key_name)'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "KeyPair"
    • orig_name ⇒ 'name'
    

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

property :name, read_only: true, disposition: :read_only_attribute, description: '(also: #key_name)', source: "KeyPair", orig_name: 'name', type: [String]

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

#describe ⇒ Object