Class: MintPress::Aws::EC2::Address

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

Properties (Read/Write)

  • #carrier_ip ⇒ [String]
    'The carrier IP address associated.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Address"
    • orig_name ⇒ 'carrier_ip'
    

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

property :carrier_ip, disposition: :attribute, description: 'The carrier IP address associated.', source: "MintPress::Aws::EC2::Address", orig_name: 'carrier_ip', type: [String]
  • #customer_owned_ip ⇒ [String]
    'The customer-owned IP address.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Address"
    • orig_name ⇒ 'customer_owned_ip'
    

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

property :customer_owned_ip, disposition: :attribute, description: 'The customer-owned IP address.', source: "MintPress::Aws::EC2::Address", orig_name: 'customer_owned_ip', type: [String]
  • #customer_owned_ipv_4_pool ⇒ [String]
    'The ID of the customer-owned address pool.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Address"
    • orig_name ⇒ 'customer_owned_ipv_4_pool'
    

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

property :customer_owned_ipv_4_pool, disposition: :attribute, description: 'The ID of the customer-owned address pool.', source: "MintPress::Aws::EC2::Address", orig_name: 'customer_owned_ipv_4_pool', type: [String]
  • #domain ⇒ [String]
    'Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Address"
    • orig_name ⇒ 'domain'
    

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

property :domain, disposition: :attribute, description: 'Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).', source: "MintPress::Aws::EC2::Address", orig_name: 'domain', type: [String]
  • #network_border_group ⇒ [String]
    'The set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. If you provide an incorrect network border group, you will receive an InvalidAddress.NotFound error. For more information, see Error Codes. You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.'
    Property Attributes
    • source ⇒ "release_address"
    • orig_name ⇒ 'network_border_group'
    • release_address_prop ⇒ 'network_border_group'
    • read_only ⇒ false
    

27
28
29
30
31
32
33
34
35
36
37
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/address.rb', line 27

property :network_border_group, description: 'The set of Availability Zones, Local Zones, or Wavelength Zones from
which AWS advertises IP addresses.

If you provide an incorrect network border group, you will receive an
InvalidAddress.NotFound error. For more information, see Error
Codes.

 You cannot use a network border group with EC2 Classic. If you attempt
this operation on EC2 classic, you will receive an
InvalidParameterCombination error. For more information, see Error
Codes.', source: "release_address", orig_name: 'network_border_group', type: [String], release_address_prop: 'network_border_group', read_only: false
  • #private_ip_address ⇒ [String]
    'The private IP address associated with the Elastic IP address.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Address"
    • orig_name ⇒ 'private_ip_address'
    

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

property :private_ip_address, disposition: :attribute, description: 'The private IP address associated with the Elastic IP address.', source: "MintPress::Aws::EC2::Address", orig_name: 'private_ip_address', type: [String]
  • #public_ip ⇒ [String]
    '[EC2-Classic] The Elastic IP address. Required for EC2-Classic.'
    Property Attributes
    • source ⇒ "release_address"
    • orig_name ⇒ 'public_ip'
    • release_address_prop ⇒ 'public_ip'
    • read_only ⇒ false
    

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

property :public_ip, description: '[EC2-Classic] The Elastic IP address. Required for EC2-Classic.', source: "release_address", orig_name: 'public_ip', type: [String], release_address_prop: 'public_ip', read_only: false
  • #public_ipv_4_pool ⇒ [String]
    'The ID of an address pool.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Address"
    • orig_name ⇒ 'public_ipv_4_pool'
    

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

property :public_ipv_4_pool, disposition: :attribute, description: 'The ID of an address pool.', source: "MintPress::Aws::EC2::Address", orig_name: 'public_ipv_4_pool', type: [String]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'Any tags assigned to the Elastic IP address.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Address"
    • orig_name ⇒ 'tags'
    

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

property :tags, disposition: :attribute, description: 'Any tags assigned to the Elastic IP address.', source: "MintPress::Aws::EC2::Address", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, hash: true
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. Filter names and values are case-sensitive. allocation-id - [EC2-VPC] The allocation ID for the address. association-id - [EC2-VPC] The association ID for the address. domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc). instance-id - The ID of the instance the address is associated with, if any. network-border-group - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where AWS advertises IP addresses. network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any. network-interface-owner-id - The AWS account ID of the owner. private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address. public-ip - The Elastic IP address, or the carrier IP address. 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. 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.'
    Property Attributes
    • describe_addresses_prop ⇒ 'filters'
    • source ⇒ "describe_addresses"
    

42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/address.rb', line 42

property :filters, describe_addresses_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_addresses", description: 'One or more filters. Filter names and values are case-sensitive.


allocation-id - [EC2-VPC] The allocation ID for the address.
association-id - [EC2-VPC] The association ID for the address.
domain - Indicates whether the address is for use in EC2-Classic
(standard) or in a VPC (vpc).
instance-id - The ID of the instance the address is associated
with, if any.
network-border-group - A unique set of Availability Zones, Local
Zones, or Wavelength Zones from where AWS advertises IP addresses.
network-interface-id - [EC2-VPC] The ID of the network interface
that the address is associated with, if any.
network-interface-owner-id - The AWS account ID of the owner.
private-ip-address - [EC2-VPC] The private IP address associated
with the Elastic IP address.
public-ip - The Elastic IP address, or the carrier IP address.
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.
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.', hash: true
  • #public_ips ⇒ Array of ⇒ [String]
    'One or more Elastic IP addresses. Default: Describes all your Elastic IP addresses.'
    Property Attributes
    • describe_addresses_prop ⇒ 'public_ips'
    • source ⇒ "describe_addresses"
    

67
68
69
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/address.rb', line 67

property :public_ips, describe_addresses_prop: 'public_ips', type: [String], array: true, source: "describe_addresses", description: 'One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.'
  • #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
    • describe_addresses_prop ⇒ 'dry_run'
    • source ⇒ "release_address"
    • release_address_prop ⇒ 'dry_run'
    • read_only ⇒ false
    

70
71
72
73
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/address.rb', line 70

property :dry_run, describe_addresses_prop: 'dry_run', type: [TrueClass,FalseClass], source: "release_address", 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.', release_address_prop: 'dry_run', read_only: false
  • #allocation ⇒ [String]
    '[EC2-VPC] The allocation ID. Required for EC2-VPC.'
    Property Attributes
    • source ⇒ "release_address"
    • orig_name ⇒ 'allocation_id'
    • release_address_prop ⇒ 'allocation_id'
    • read_only ⇒ false
    

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

property :allocation, description: '[EC2-VPC] The allocation ID. Required for EC2-VPC.', source: "release_address", orig_name: 'allocation_id', type: [String], release_address_prop: 'allocation_id', read_only: false
  • #association ⇒ [String]
    'The ID representing the association of the address with an instance in a VPC.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Address"
    • orig_name ⇒ 'association_id'
    

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

property :association, disposition: :attribute, description: 'The ID representing the association of the address with an instance in a VPC.', source: "MintPress::Aws::EC2::Address", orig_name: 'association_id', type: [String]
  • #instance ⇒ [MintPress::Aws::EC2::Instance]
    'The ID of the instance that the address is associated with (if any).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Address"
    • orig_name ⇒ 'instance_id'
    • from ⇒ String
    

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

property :instance, disposition: :attribute, description: 'The ID of the instance that the address is associated with (if any).', source: "MintPress::Aws::EC2::Address", orig_name: 'instance_id', type: [MintPress::Aws::EC2::Instance], from: String
  • #network_interface ⇒ [MintPress::Aws::EC2::NetworkInterface]
    'The ID of the network interface.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Address"
    • orig_name ⇒ 'network_interface_id'
    • from ⇒ String
    

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

property :network_interface, disposition: :attribute, description: 'The ID of the network interface.', source: "MintPress::Aws::EC2::Address", orig_name: 'network_interface_id', type: [MintPress::Aws::EC2::NetworkInterface], from: String
  • #network_interface_owner ⇒ [String]
    'The ID of the AWS account that owns the network interface.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Address"
    • orig_name ⇒ 'network_interface_owner_id'
    

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

property :network_interface_owner, disposition: :attribute, description: 'The ID of the AWS account that owns the network interface.', source: "MintPress::Aws::EC2::Address", orig_name: 'network_interface_owner_id', type: [String]
  • #allocations ⇒ Array of ⇒ [String]
    '[EC2-VPC] Information about the allocation IDs.'
    Property Attributes
    • describe_addresses_prop ⇒ 'allocation_ids'
    • source ⇒ "describe_addresses"
    

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

property :allocations, describe_addresses_prop: 'allocation_ids', type: [String], array: true, source: "describe_addresses", description: '[EC2-VPC] Information about the allocation 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 
    

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

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
    

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

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

Returns a new instance of Address.

Instance Method Details

#describe ⇒ Object

#release ⇒ Object