# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE module Aws::EC2 class ClassicAddress extend Aws::Deprecations # @overload def initialize(public_ip, options = {}) # @param [String] public_ip # @option options [Client] :client # @overload def initialize(options = {}) # @option options [required, String] :public_ip # @option options [Client] :client def initialize(*args) options = Hash === args.last ? args.pop.dup : {} @public_ip = extract_public_ip(args, options) @data = options.delete(:data) @client = options.delete(:client) || Client.new(options) @waiter_block_warned = false end # @!group Read-Only Attributes # @return [String] def public_ip @public_ip end # The ID of the instance that the address is associated with (if any). # @return [String] def instance_id data[:instance_id] end # The ID representing the allocation of the address for use with # EC2-VPC. # @return [String] def allocation_id data[:allocation_id] end # The ID representing the association of the address with an instance in # a VPC. # @return [String] def association_id data[:association_id] end # Indicates whether this Elastic IP address is for use with instances in # EC2-Classic (`standard`) or instances in a VPC (`vpc`). # @return [String] def domain data[:domain] end # The ID of the network interface. # @return [String] def network_interface_id data[:network_interface_id] end # The ID of the AWS account that owns the network interface. # @return [String] def network_interface_owner_id data[:network_interface_owner_id] end # The private IP address associated with the Elastic IP address. # @return [String] def private_ip_address data[:private_ip_address] end # Any tags assigned to the Elastic IP address. # @return [Array] def tags data[:tags] end # The ID of an address pool. # @return [String] def public_ipv_4_pool data[:public_ipv_4_pool] end # The name of the unique set of Availability Zones, Local Zones, or # Wavelength Zones from which AWS advertises IP addresses. # @return [String] def network_border_group data[:network_border_group] end # The customer-owned IP address. # @return [String] def customer_owned_ip data[:customer_owned_ip] end # The ID of the customer-owned address pool. # @return [String] def customer_owned_ipv_4_pool data[:customer_owned_ipv_4_pool] end # The carrier IP address associated. This option is only available for # network interfaces which reside in a subnet in a Wavelength Zone (for # example an EC2 instance). # @return [String] def carrier_ip data[:carrier_ip] end # @!endgroup # @return [Client] def client @client end # Loads, or reloads {#data} for the current {ClassicAddress}. # Returns `self` making it possible to chain methods. # # classic_address.reload.data # # @return [self] def load resp = @client.describe_addresses(public_ips: [@public_ip]) @data = resp.addresses[0] self end alias :reload :load # @return [Types::Address] # Returns the data for this {ClassicAddress}. Calls # {Client#describe_addresses} if {#data_loaded?} is `false`. def data load unless @data @data end # @return [Boolean] # Returns `true` if this resource is loaded. Accessing attributes or # {#data} on an unloaded resource will trigger a call to {#load}. def data_loaded? !!@data end # @deprecated Use [Aws::EC2::Client] #wait_until instead # # Waiter polls an API operation until a resource enters a desired # state. # # @note The waiting operation is performed on a copy. The original resource # remains unchanged. # # ## Basic Usage # # Waiter will polls until it is successful, it fails by # entering a terminal state, or until a maximum number of attempts # are made. # # # polls in a loop until condition is true # resource.wait_until(options) {|resource| condition} # # ## Example # # instance.wait_until(max_attempts:10, delay:5) do |instance| # instance.state.name == 'running' # end # # ## Configuration # # You can configure the maximum number of polling attempts, and the # delay (in seconds) between each polling attempt. The waiting condition is # set by passing a block to {#wait_until}: # # # poll for ~25 seconds # resource.wait_until(max_attempts:5,delay:5) {|resource|...} # # ## Callbacks # # You can be notified before each polling attempt and before each # delay. If you throw `:success` or `:failure` from these callbacks, # it will terminate the waiter. # # started_at = Time.now # # poll for 1 hour, instead of a number of attempts # proc = Proc.new do |attempts, response| # throw :failure if Time.now - started_at > 3600 # end # # # disable max attempts # instance.wait_until(before_wait:proc, max_attempts:nil) {...} # # ## Handling Errors # # When a waiter is successful, it returns the Resource. When a waiter # fails, it raises an error. # # begin # resource.wait_until(...) # rescue Aws::Waiters::Errors::WaiterFailed # # resource did not enter the desired state in time # end # # @yieldparam [Resource] resource to be used in the waiting condition. # # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter # terminates because the waiter has entered a state that it will not # transition out of, preventing success. # # yet successful. # # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is # encountered while polling for a resource that is not expected. # # @raise [NotImplementedError] Raised when the resource does not # # @option options [Integer] :max_attempts (10) Maximum number of # attempts # @option options [Integer] :delay (10) Delay between each # attempt in seconds # @option options [Proc] :before_attempt (nil) Callback # invoked before each attempt # @option options [Proc] :before_wait (nil) Callback # invoked before each wait # @return [Resource] if the waiter was successful def wait_until(options = {}, &block) self_copy = self.dup attempts = 0 options[:max_attempts] = 10 unless options.key?(:max_attempts) options[:delay] ||= 10 options[:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == options[:max_attempts] :retry end end Aws::Waiters::Waiter.new(options).wait({}) end # @!group Actions # @example Request syntax with placeholder values # # classic_address.associate({ # allocation_id: "AllocationId", # instance_id: "InstanceId", # allow_reassociation: false, # dry_run: false, # network_interface_id: "NetworkInterfaceId", # private_ip_address: "String", # }) # @param [Hash] options ({}) # @option options [String] :allocation_id # \[EC2-VPC\] The allocation ID. This is required for EC2-VPC. # @option options [String] :instance_id # The ID of the instance. The instance must have exactly one attached # network interface. For EC2-VPC, you can specify either the instance ID # or the network interface ID, but not both. For EC2-Classic, you must # specify an instance ID and the instance must be in the running state. # @option options [Boolean] :allow_reassociation # \[EC2-VPC\] For a VPC in an EC2-Classic account, specify true to allow # an Elastic IP address that is already associated with an instance or # network interface to be reassociated with the specified instance or # network interface. Otherwise, the operation fails. In a VPC in an # EC2-VPC-only account, reassociation is automatic, therefore you can # specify false to ensure the operation fails if the Elastic IP address # is already associated with another resource. # @option options [Boolean] :dry_run # 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`. # @option options [String] :network_interface_id # \[EC2-VPC\] The ID of the network interface. If the instance has more # than one network interface, you must specify a network interface ID. # # For EC2-VPC, you can specify either the instance ID or the network # interface ID, but not both. # @option options [String] :private_ip_address # \[EC2-VPC\] The primary or secondary private IP address to associate # with the Elastic IP address. If no private IP address is specified, # the Elastic IP address is associated with the primary private IP # address. # @return [Types::AssociateAddressResult] def associate(options = {}) options = options.merge(public_ip: @public_ip) resp = @client.associate_address(options) resp.data end # @example Request syntax with placeholder values # # classic_address.disassociate({ # association_id: "ElasticIpAssociationId", # dry_run: false, # }) # @param [Hash] options ({}) # @option options [String] :association_id # \[EC2-VPC\] The association ID. Required for EC2-VPC. # @option options [Boolean] :dry_run # 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`. # @return [EmptyStructure] def disassociate(options = {}) options = options.merge(public_ip: data[:public_ip]) resp = @client.disassociate_address(options) resp.data end # @example Request syntax with placeholder values # # classic_address.release({ # allocation_id: "AllocationId", # network_border_group: "String", # dry_run: false, # }) # @param [Hash] options ({}) # @option options [String] :allocation_id # \[EC2-VPC\] The allocation ID. Required for EC2-VPC. # @option options [String] :network_border_group # 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][1]. # # 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][1]. # # # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html # @option options [Boolean] :dry_run # 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`. # @return [EmptyStructure] def release(options = {}) options = options.merge(public_ip: data[:public_ip]) resp = @client.release_address(options) resp.data end # @deprecated # @api private def identifiers { public_ip: @public_ip } end deprecated(:identifiers) private def extract_public_ip(args, options) value = args[0] || options.delete(:public_ip) case value when String then value when nil then raise ArgumentError, "missing required option :public_ip" else msg = "expected :public_ip to be a String, got #{value.class}" raise ArgumentError, msg end end class Collection < Aws::Resources::Collection; end end end