# 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/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE module Aws::AutoScaling class LaunchConfiguration extend Aws::Deprecations # @overload def initialize(name, options = {}) # @param [String] name # @option options [Client] :client # @overload def initialize(options = {}) # @option options [required, String] :name # @option options [Client] :client def initialize(*args) options = Hash === args.last ? args.pop.dup : {} @name = extract_name(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 name @name end alias :launch_configuration_name :name # The Amazon Resource Name (ARN) of the launch configuration. # @return [String] def launch_configuration_arn data[:launch_configuration_arn] end # The ID of the Amazon Machine Image (AMI) to use to launch your EC2 # instances. For more information, see [Finding an AMI][1] in the # *Amazon EC2 User Guide for Linux Instances*. # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html # @return [String] def image_id data[:image_id] end # The name of the key pair. # # For more information, see [Amazon EC2 Key Pairs][1] in the *Amazon EC2 # User Guide for Linux Instances*. # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html # @return [String] def key_name data[:key_name] end # A list that contains the security groups to assign to the instances in # the Auto Scaling group. For more information, see [Security Groups for # Your VPC][1] in the *Amazon Virtual Private Cloud User Guide*. # # # # [1]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html # @return [Array] def security_groups data[:security_groups] end # *EC2-Classic retires on August 15, 2022. This parameter is not # supported after that date.* # # The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances # to. # @return [String] def classic_link_vpc_id data[:classic_link_vpc_id] end # *EC2-Classic retires on August 15, 2022. This parameter is not # supported after that date.* # # The IDs of one or more security groups for the VPC specified in # `ClassicLinkVPCId`. # @return [Array] def classic_link_vpc_security_groups data[:classic_link_vpc_security_groups] end # The user data to make available to the launched EC2 instances. For # more information, see [Instance metadata and user data][1] (Linux) and # [Instance metadata and user data][2] (Windows). If you are using a # command line tool, base64-encoding is performed for you, and you can # load the text from a file. Otherwise, you must provide base64-encoded # text. User data is limited to 16 KB. # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html # [2]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html # @return [String] def user_data data[:user_data] end # The instance type for the instances. # # For information about available instance types, see [Available # Instance Types][1] in the *Amazon EC2 User Guide for Linux Instances*. # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes # @return [String] def instance_type data[:instance_type] end # The ID of the kernel associated with the AMI. # @return [String] def kernel_id data[:kernel_id] end # The ID of the RAM disk associated with the AMI. # @return [String] def ramdisk_id data[:ramdisk_id] end # A block device mapping, which specifies the block devices for the # instance. For more information, see [Block Device Mapping][1] in the # *Amazon EC2 User Guide for Linux Instances*. # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html # @return [Array] def block_device_mappings data[:block_device_mappings] end # Controls whether instances in this group are launched with detailed # (`true`) or basic (`false`) monitoring. # # For more information, see [Configure Monitoring for Auto Scaling # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*. # # # # [1]: https://docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html # @return [Types::InstanceMonitoring] def instance_monitoring data[:instance_monitoring] end # The maximum hourly price to be paid for any Spot Instance launched to # fulfill the request. Spot Instances are launched when the price you # specify exceeds the current Spot price. For more information, see # [Requesting Spot Instances][1] in the *Amazon EC2 Auto Scaling User # Guide*. # # # # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html # @return [String] def spot_price data[:spot_price] end # The name or the Amazon Resource Name (ARN) of the instance profile # associated with the IAM role for the instance. The instance profile # contains the IAM role. For more information, see [IAM role for # applications that run on Amazon EC2 instances][1] in the *Amazon EC2 # Auto Scaling User Guide*. # # # # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html # @return [String] def iam_instance_profile data[:iam_instance_profile] end # The creation date and time for the launch configuration. # @return [Time] def created_time data[:created_time] end # Specifies whether the launch configuration is optimized for EBS I/O # (`true`) or not (`false`). For more information, see [Amazon # EBS-Optimized Instances][1] in the *Amazon EC2 User Guide for Linux # Instances*. # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html # @return [Boolean] def ebs_optimized data[:ebs_optimized] end # For Auto Scaling groups that are running in a VPC, specifies whether # to assign a public IP address to the group's instances. For more # information, see [Launching Auto Scaling instances in a VPC][1] in the # *Amazon EC2 Auto Scaling User Guide*. # # # # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html # @return [Boolean] def associate_public_ip_address data[:associate_public_ip_address] end # The tenancy of the instance, either `default` or `dedicated`. An # instance with `dedicated` tenancy runs on isolated, single-tenant # hardware and can only be launched into a VPC. # # For more information, see [Configuring instance tenancy with Amazon # EC2 Auto Scaling][1] in the *Amazon EC2 Auto Scaling User Guide*. # # # # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-dedicated-instances.html # @return [String] def placement_tenancy data[:placement_tenancy] end # The metadata options for the instances. For more information, see # [Configuring the Instance Metadata Options][1] in the *Amazon EC2 Auto # Scaling User Guide*. # # # # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds # @return [Types::InstanceMetadataOptions] def metadata_options data[:metadata_options] end # @!endgroup # @return [Client] def client @client end # Loads, or reloads {#data} for the current {LaunchConfiguration}. # Returns `self` making it possible to chain methods. # # launch_configuration.reload.data # # @return [self] def load resp = @client.describe_launch_configurations(launch_configuration_names: [@name]) @data = resp.launch_configurations[0] self end alias :reload :load # @return [Types::LaunchConfiguration] # Returns the data for this {LaunchConfiguration}. Calls # {Client#describe_launch_configurations} 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::AutoScaling::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 # # launch_configuration.delete() # @param [Hash] options ({}) # @return [EmptyStructure] def delete(options = {}) options = options.merge(launch_configuration_name: @name) resp = @client.delete_launch_configuration(options) resp.data end # @deprecated # @api private def identifiers { name: @name } end deprecated(:identifiers) private def extract_name(args, options) value = args[0] || options.delete(:name) case value when String then value when nil then raise ArgumentError, "missing required option :name" else msg = "expected :name to be a String, got #{value.class}" raise ArgumentError, msg end end class Collection < Aws::Resources::Collection; end end end