# 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::OpsWorks
  class Layer

    extend Aws::Deprecations

    # @overload def initialize(id, options = {})
    #   @param [String] id
    #   @option options [Client] :client
    # @overload def initialize(options = {})
    #   @option options [required, String] :id
    #   @option options [Client] :client
    def initialize(*args)
      options = Hash === args.last ? args.pop.dup : {}
      @id = extract_id(args, options)
      @data = options.delete(:data)
      @client = options.delete(:client) || Client.new(options)
    end

    # @!group Read-Only Attributes

    # @return [String]
    def id
      @id
    end

    # The Amazon Resource Number (ARN) of a layer.
    # @return [String]
    def arn
      data[:arn]
    end

    # The layer stack ID.
    # @return [String]
    def stack_id
      data[:stack_id]
    end

    # The layer ID.
    # @return [String]
    def layer_id
      data[:layer_id]
    end

    # The layer type.
    # @return [String]
    def type
      data[:type]
    end

    # The layer name.
    # @return [String]
    def name
      data[:name]
    end

    # The layer short name.
    # @return [String]
    def shortname
      data[:shortname]
    end

    # The layer attributes.
    #
    # For the `HaproxyStatsPassword`, `MysqlRootPassword`, and
    # `GangliaPassword` attributes, AWS OpsWorks Stacks returns
    # `*****FILTERED*****` instead of the actual value
    #
    # For an ECS Cluster layer, AWS OpsWorks Stacks the `EcsClusterArn`
    # attribute is set to the cluster's ARN.
    # @return [Hash<String,String>]
    def attributes
      data[:attributes]
    end

    # The Amazon CloudWatch Logs configuration settings for the layer.
    # @return [Types::CloudWatchLogsConfiguration]
    def cloud_watch_logs_configuration
      data[:cloud_watch_logs_configuration]
    end

    # The ARN of the default IAM profile to be used for the layer's EC2
    # instances. For more information about IAM ARNs, see [Using
    # Identifiers][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
    # @return [String]
    def custom_instance_profile_arn
      data[:custom_instance_profile_arn]
    end

    # A JSON formatted string containing the layer's custom stack
    # configuration and deployment attributes.
    # @return [String]
    def custom_json
      data[:custom_json]
    end

    # An array containing the layer's custom security group IDs.
    # @return [Array<String>]
    def custom_security_group_ids
      data[:custom_security_group_ids]
    end

    # An array containing the layer's security group names.
    # @return [Array<String>]
    def default_security_group_names
      data[:default_security_group_names]
    end

    # An array of `Package` objects that describe the layer's packages.
    # @return [Array<String>]
    def packages
      data[:packages]
    end

    # A `VolumeConfigurations` object that describes the layer's Amazon EBS
    # volumes.
    # @return [Array<Types::VolumeConfiguration>]
    def volume_configurations
      data[:volume_configurations]
    end

    # Whether auto healing is disabled for the layer.
    # @return [Boolean]
    def enable_auto_healing
      data[:enable_auto_healing]
    end

    # Whether to automatically assign an [Elastic IP address][1] to the
    # layer's instances. For more information, see [How to Edit a
    # Layer][2].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html
    # [2]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html
    # @return [Boolean]
    def auto_assign_elastic_ips
      data[:auto_assign_elastic_ips]
    end

    # For stacks that are running in a VPC, whether to automatically assign
    # a public IP address to the layer's instances. For more information,
    # see [How to Edit a Layer][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html
    # @return [Boolean]
    def auto_assign_public_ips
      data[:auto_assign_public_ips]
    end

    # AWS OpsWorks Stacks supports five lifecycle events: **setup**,
    # **configuration**, **deploy**, **undeploy**, and **shutdown**. For
    # each layer, AWS OpsWorks Stacks runs a set of standard recipes for
    # each event. You can also provide custom recipes for any or all layers
    # and events. AWS OpsWorks Stacks runs custom event recipes after the
    # standard recipes. `LayerCustomRecipes` specifies the custom recipes
    # for a particular layer to be run in response to each of the five
    # events.
    #
    # To specify a recipe, use the cookbook's directory name in the
    # repository followed by two colons and the recipe name, which is the
    # recipe's file name without the `.rb` extension. For example:
    # `phpapp2::dbsetup` specifies the `dbsetup.rb` recipe in the
    # repository's `phpapp2` folder.
    # @return [Types::Recipes]
    def default_recipes
      data[:default_recipes]
    end

    # A `LayerCustomRecipes` object that specifies the layer's custom
    # recipes.
    # @return [Types::Recipes]
    def custom_recipes
      data[:custom_recipes]
    end

    # Date when the layer was created.
    # @return [String]
    def created_at
      data[:created_at]
    end

    # Whether to install operating system and package updates when the
    # instance boots. The default value is `true`. If this value is set to
    # `false`, you must then update your instances manually by using
    # CreateDeployment to run the `update_dependencies` stack command or
    # manually running `yum` (Amazon Linux) or `apt-get` (Ubuntu) on the
    # instances.
    #
    # <note markdown="1"> We strongly recommend using the default value of `true`, to ensure
    # that your instances have the latest security updates.
    #
    #  </note>
    # @return [Boolean]
    def install_updates_on_boot
      data[:install_updates_on_boot]
    end

    # Whether the layer uses Amazon EBS-optimized instances.
    # @return [Boolean]
    def use_ebs_optimized_instances
      data[:use_ebs_optimized_instances]
    end

    # A `LifeCycleEventConfiguration` object that specifies the Shutdown
    # event configuration.
    # @return [Types::LifecycleEventConfiguration]
    def lifecycle_event_configuration
      data[:lifecycle_event_configuration]
    end

    # @!endgroup

    # @return [Client]
    def client
      @client
    end

    # Loads, or reloads {#data} for the current {Layer}.
    # Returns `self` making it possible to chain methods.
    #
    #     layer.reload.data
    #
    # @return [self]
    def load
      resp = @client.describe_layers(layer_ids: [@id])
      @data = resp.layers[0]
      self
    end
    alias :reload :load

    # @return [Types::Layer]
    #   Returns the data for this {Layer}. Calls
    #   {Client#describe_layers} 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::OpsWorks::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) {|instance| instance.state.name == 'running' }
    #
    # ## 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
    #
    #
    # @yield param [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
    #
    #   layer.delete()
    # @param [Hash] options ({})
    # @return [EmptyStructure]
    def delete(options = {})
      options = options.merge(layer_id: @id)
      resp = @client.delete_layer(options)
      resp.data
    end

    # @!group Associations

    # @return [Stack, nil]
    def stack
      if data[:stack_id]
        Stack.new(
          id: data[:stack_id],
          client: @client
        )
      else
        nil
      end
    end

    # @deprecated
    # @api private
    def identifiers
      { id: @id }
    end
    deprecated(:identifiers)

    private

    def extract_id(args, options)
      value = args[0] || options.delete(:id)
      case value
      when String then value
      when nil then raise ArgumentError, "missing required option :id"
      else
        msg = "expected :id to be a String, got #{value.class}"
        raise ArgumentError, msg
      end
    end

    class Collection < Aws::Resources::Collection; end
  end
end