AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ElasticBeanstalk::Waiters::EnvironmentTerminated

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/waiters.rb

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ EnvironmentTerminated

Returns a new instance of EnvironmentTerminated.

Parameters:

  • options (Hash)

Options Hash (options):

  • :client (required, Client)
  • :max_attempts (Integer) — default: 20
  • :delay (Integer) — default: 20
  • :before_attempt (Proc)
  • :before_wait (Proc)


130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/waiters.rb', line 130

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 20,
    delay: 20,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_environments,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "pathAll",
          "argument" => "environments[].status",
          "expected" => "Terminated"
        },
        {
          "state" => "retry",
          "matcher" => "pathAll",
          "argument" => "environments[].status",
          "expected" => "Terminating"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

#wait(params = {}) ⇒ Types::EnvironmentDescriptionsMessage

Returns a response object which responds to the following methods:

Parameters:

  • params (Hash) (defaults to: {})

    a customizable set of options

Options Hash (params):

  • :application_name (String)

    If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

  • :version_label (String)

    If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

  • :environment_ids (Array<String>)

    If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

  • :environment_names (Array<String>)

    If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

  • :include_deleted (Boolean)

    Indicates whether to include deleted environments:

    true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

    false: Do not include deleted environments.

  • :included_deleted_back_to (Time, DateTime, Date, Integer, String)

    If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

  • :max_records (Integer)

    For a paginated request. Specify a maximum number of environments to include in each response.

    If no MaxRecords is specified, all available environments are retrieved in a single response.

  • :next_token (String)

    For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

    If no NextToken is specified, the first page is retrieved.

Returns:



157
158
159
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/waiters.rb', line 157

def wait(params = {})
  @waiter.wait(client: @client, params: params)
end