You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::OpsWorksCM::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for AWS OpsWorks CM. To construct a client, you need to configure a :region and :credentials.

opsworkscm = Aws::OpsWorksCM::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::OpsWorksCM::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::OpsWorksCM::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#associate_node(options = {}) ⇒ Types::AssociateNodeResponse

Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode.

On a Chef server: This command is an alternative to knife bootstrap.

Example (Chef): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=CHEF_ORGANIZATION,Value=default" "Name=CHEF_NODE_PUBLIC_KEY,Value=public-key-pem"

On a Puppet server, this command is an alternative to the puppet cert sign command that signs a Puppet node CSR.

Example (Puppet): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=PUPPET_NODE_CSR,Value=csr-pem"

A node can can only be associated with servers that are in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. The AssociateNode API call can be integrated into Auto Scaling configurations, AWS Cloudformation templates, or the user data of a server's instance.

Examples:

Request syntax with placeholder values


resp = client.associate_node({
  server_name: "ServerName", # required
  node_name: "NodeName", # required
  engine_attributes: [ # required
    {
      name: "EngineAttributeName",
      value: "EngineAttributeValue",
    },
  ],
})

Response structure


resp.node_association_status_token #=> String

Options Hash (options):

  • :server_name (required, String)

    The name of the server with which to associate the node.

  • :node_name (required, String)

    The name of the node.

  • :engine_attributes (required, Array<Types::EngineAttribute>)

    Engine attributes used for associating the node.

    Attributes accepted in a AssociateNode request for Chef .title

    • CHEF_ORGANIZATION: The Chef organization with which the node is associated. By default only one organization named default can exist.

    • CHEF_NODE_PUBLIC_KEY: A PEM-formatted public key. This key is required for the chef-client agent to access the Chef API.

    Attributes accepted in a AssociateNode request for Puppet .title

    • PUPPET_NODE_CSR: A PEM-formatted certificate-signing request (CSR) that is created by the node.

    ^

Returns:

See Also:

#create_backup(options = {}) ⇒ Types::CreateBackupResponse

Creates an application-level backup of a server. While the server is in the BACKING_UP state, the server cannot be changed, and no additional backup can be created.

Backups can be created for servers in RUNNING, HEALTHY, and UNHEALTHY states. By default, you can create a maximum of 50 manual backups.

This operation is asynchronous.

A LimitExceededException is thrown when the maximum number of manual backups is reached. An InvalidStateException is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. A ResourceNotFoundException is thrown when the server is not found. A ValidationException is thrown when parameters of the request are not valid.

Examples:

Request syntax with placeholder values


resp = client.create_backup({
  server_name: "ServerName", # required
  description: "String",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.backup.backup_arn #=> String
resp.backup.backup_id #=> String
resp.backup.backup_type #=> String, one of "AUTOMATED", "MANUAL"
resp.backup.created_at #=> Time
resp.backup.description #=> String
resp.backup.engine #=> String
resp.backup.engine_model #=> String
resp.backup.engine_version #=> String
resp.backup.instance_profile_arn #=> String
resp.backup.instance_type #=> String
resp.backup.key_pair #=> String
resp.backup.preferred_backup_window #=> String
resp.backup.preferred_maintenance_window #=> String
resp.backup.s3_data_size #=> Integer
resp.backup.s3_data_url #=> String
resp.backup.s3_log_url #=> String
resp.backup.security_group_ids #=> Array
resp.backup.security_group_ids[0] #=> String
resp.backup.server_name #=> String
resp.backup.service_role_arn #=> String
resp.backup.status #=> String, one of "IN_PROGRESS", "OK", "FAILED", "DELETING"
resp.backup.status_description #=> String
resp.backup.subnet_ids #=> Array
resp.backup.subnet_ids[0] #=> String
resp.backup.tools_version #=> String
resp.backup.user_arn #=> String

Options Hash (options):

  • :server_name (required, String)

    The name of the server that you want to back up.

  • :description (String)

    A user-defined description of the backup.

  • :tags (Array<Types::Tag>)

    A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM server backup.

    • The key cannot be empty.

    • The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

    • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

    • Leading and trailing white spaces are trimmed from both the key and value.

    • A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.

Returns:

See Also:

#create_server(options = {}) ⇒ Types::CreateServerResponse

Creates and immedately starts a new server. The server is ready to use when it is in the HEALTHY state. By default, you can create a maximum of 10 servers.

This operation is asynchronous.

A LimitExceededException is thrown when you have created the maximum number of servers (10). A ResourceAlreadyExistsException is thrown when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. A ValidationException is thrown when parameters of the request are not valid.

If you do not specify a security group by adding the SecurityGroupIds parameter, AWS OpsWorks creates a new security group.

Chef Automate: The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.

Puppet Enterprise: The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.

By default, your server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console.

To specify your own domain for a server, and provide your own self-signed or CA-signed certificate and private key, specify values for CustomDomain, CustomCertificate, and CustomPrivateKey.

Examples:

Request syntax with placeholder values


resp = client.create_server({
  associate_public_ip_address: false,
  custom_domain: "CustomDomain",
  custom_certificate: "CustomCertificate",
  custom_private_key: "CustomPrivateKey",
  disable_automated_backup: false,
  engine: "String", # required
  engine_model: "String",
  engine_version: "String",
  engine_attributes: [
    {
      name: "EngineAttributeName",
      value: "EngineAttributeValue",
    },
  ],
  backup_retention_count: 1,
  server_name: "ServerName", # required
  instance_profile_arn: "InstanceProfileArn", # required
  instance_type: "String", # required
  key_pair: "KeyPair",
  preferred_maintenance_window: "TimeWindowDefinition",
  preferred_backup_window: "TimeWindowDefinition",
  security_group_ids: ["String"],
  service_role_arn: "ServiceRoleArn", # required
  subnet_ids: ["String"],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  backup_id: "BackupId",
})

Response structure


resp.server.associate_public_ip_address #=> true/false
resp.server.backup_retention_count #=> Integer
resp.server.server_name #=> String
resp.server.created_at #=> Time
resp.server.cloud_formation_stack_arn #=> String
resp.server.custom_domain #=> String
resp.server.disable_automated_backup #=> true/false
resp.server.endpoint #=> String
resp.server.engine #=> String
resp.server.engine_model #=> String
resp.server.engine_attributes #=> Array
resp.server.engine_attributes[0].name #=> String
resp.server.engine_attributes[0].value #=> String
resp.server.engine_version #=> String
resp.server.instance_profile_arn #=> String
resp.server.instance_type #=> String
resp.server.key_pair #=> String
resp.server.maintenance_status #=> String, one of "SUCCESS", "FAILED"
resp.server.preferred_maintenance_window #=> String
resp.server.preferred_backup_window #=> String
resp.server.security_group_ids #=> Array
resp.server.security_group_ids[0] #=> String
resp.server.service_role_arn #=> String
resp.server.status #=> String, one of "BACKING_UP", "CONNECTION_LOST", "CREATING", "DELETING", "MODIFYING", "FAILED", "HEALTHY", "RUNNING", "RESTORING", "SETUP", "UNDER_MAINTENANCE", "UNHEALTHY", "TERMINATED"
resp.server.status_reason #=> String
resp.server.subnet_ids #=> Array
resp.server.subnet_ids[0] #=> String
resp.server.server_arn #=> String

Options Hash (options):

  • :associate_public_ip_address (Boolean)

    Associate a public IP address with a server that you are launching. Valid values are true or false. The default value is true.

  • :custom_domain (String)

    An optional public endpoint of a server, such as https://aws.my-company.com. To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated Endpoint value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate and CustomPrivateKey.

  • :custom_certificate (String)

    A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for CustomDomain and CustomPrivateKey. The following are requirements for the CustomCertificate value:

    • You can provide either a self-signed, custom certificate, or the full certificate chain.

    • The certificate must be a valid X509 certificate, or a certificate chain in PEM format.

    • The certificate must be valid at the time of upload. A certificate can\'t be used before its validity period begins (the certificate\'s NotBefore date), or after it expires (the certificate\'s NotAfter date).

    • The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain.

    • The certificate must match the value of CustomPrivateKey.

  • :custom_private_key (String)

    A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for CustomDomain and CustomCertificate.

  • :disable_automated_backup (Boolean)

    Enable or disable scheduled backups. Valid values are true or false. The default value is true.

  • :engine (required, String)

    The configuration management engine to use. Valid values include ChefAutomate and Puppet.

  • :engine_model (String)

    The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

  • :engine_version (String)

    The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, the valid value is 2017.

  • :engine_attributes (Array<Types::EngineAttribute>)

    Optional engine attributes on a specified server.

    Attributes accepted in a Chef createServer request: .title

    • CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the response.

    • CHEF_AUTOMATE_ADMIN_PASSWORD: The password for the administrative user in the Chef Automate web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.

    Attributes accepted in a Puppet createServer request: .title

    • PUPPET_ADMIN_PASSWORD: To work with the Puppet Enterprise console, a password must use ASCII characters.

    • PUPPET_R10K_REMOTE: The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.

    • PUPPET_R10K_PRIVATE_KEY: If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.

  • :backup_retention_count (Integer)

    The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1.

  • :server_name (required, String)

    The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.

  • :instance_profile_arn (required, String)

    The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console typically creates the instance profile for you, if you are using API commands instead, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the instance profile you need.

  • :instance_type (required, String)

    The Amazon EC2 instance type to use. For example, m5.large.

  • :key_pair (String)

    The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH.

  • :preferred_maintenance_window (String)

    The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. Valid values must be specified in the following format: DDD:HH:MM. MM must be specified as 00. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.

    Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

  • :preferred_backup_window (String)

    The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats:

    • HH:MM for daily backups

    • DDD:HH:MM for weekly backups

    MM must be specified as 00. The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.

    Example: 08:00, which represents a daily start time of 08:00 UTC.

    Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

  • :security_group_ids (Array<String>)

    A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified security groups must be within the VPC that is specified by SubnetIds.

    If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).

  • :service_role_arn (required, String)

    The service role that the AWS OpsWorks CM service backend uses to work with your account. Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role and instance profile that you need.

  • :subnet_ids (Array<String>)

    The IDs of subnets in which to launch the server EC2 instance.

    Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have \"Auto Assign Public IP\" enabled.

    EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have \"Auto Assign Public IP\" enabled.

    For more information about supported Amazon EC2 platforms, see Supported Platforms.

  • :tags (Array<Types::Tag>)

    A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server.

    • The key cannot be empty.

    • The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @

    • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @

    • Leading and trailing white spaces are trimmed from both the key and value.

    • A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.

  • :backup_id (String)

    If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.

Returns:

See Also:

#delete_backup(options = {}) ⇒ Struct

Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous.

An InvalidStateException is thrown when a backup deletion is already in progress. A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is thrown when parameters of the request are not valid.

Examples:

Request syntax with placeholder values


resp = client.delete_backup({
  backup_id: "BackupId", # required
})

Options Hash (options):

  • :backup_id (required, String)

    The ID of the backup to delete. Run the DescribeBackups command to get a list of backup IDs. Backup IDs are in the format ServerName-yyyyMMddHHmmssSSS.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_server(options = {}) ⇒ Struct

Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance). When you run this command, the server state is updated to DELETING. After the server is deleted, it is no longer returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.

This operation is asynchronous.

An InvalidStateException is thrown when a server deletion is already in progress. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Examples:

Request syntax with placeholder values


resp = client.delete_server({
  server_name: "ServerName", # required
})

Options Hash (options):

  • :server_name (required, String)

    The ID of the server to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#describe_account_attributes(options = {}) ⇒ Types::DescribeAccountAttributesResponse

Describes your OpsWorks-CM account attributes.

This operation is synchronous.

Examples:

Request syntax with placeholder values


resp = client.()

Response structure


resp.attributes #=> Array
resp.attributes[0].name #=> String
resp.attributes[0].maximum #=> Integer
resp.attributes[0].used #=> Integer

Returns:

See Also:

#describe_backups(options = {}) ⇒ Types::DescribeBackupsResponse

Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups.

This operation is synchronous.

A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is raised when parameters of the request are not valid.

Examples:

Request syntax with placeholder values


resp = client.describe_backups({
  backup_id: "BackupId",
  server_name: "ServerName",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.backups #=> Array
resp.backups[0].backup_arn #=> String
resp.backups[0].backup_id #=> String
resp.backups[0].backup_type #=> String, one of "AUTOMATED", "MANUAL"
resp.backups[0].created_at #=> Time
resp.backups[0].description #=> String
resp.backups[0].engine #=> String
resp.backups[0].engine_model #=> String
resp.backups[0].engine_version #=> String
resp.backups[0].instance_profile_arn #=> String
resp.backups[0].instance_type #=> String
resp.backups[0].key_pair #=> String
resp.backups[0].preferred_backup_window #=> String
resp.backups[0].preferred_maintenance_window #=> String
resp.backups[0].s3_data_size #=> Integer
resp.backups[0].s3_data_url #=> String
resp.backups[0].s3_log_url #=> String
resp.backups[0].security_group_ids #=> Array
resp.backups[0].security_group_ids[0] #=> String
resp.backups[0].server_name #=> String
resp.backups[0].service_role_arn #=> String
resp.backups[0].status #=> String, one of "IN_PROGRESS", "OK", "FAILED", "DELETING"
resp.backups[0].status_description #=> String
resp.backups[0].subnet_ids #=> Array
resp.backups[0].subnet_ids[0] #=> String
resp.backups[0].tools_version #=> String
resp.backups[0].user_arn #=> String
resp.next_token #=> String

Options Hash (options):

  • :backup_id (String)

    Describes a single backup.

  • :server_name (String)

    Returns backups for the server with the specified ServerName.

  • :next_token (String)

    This is not currently implemented for DescribeBackups requests.

  • :max_results (Integer)

    This is not currently implemented for DescribeBackups requests.

Returns:

See Also:

#describe_events(options = {}) ⇒ Types::DescribeEventsResponse

Describes events for a specified server. Results are ordered by time, with newest events first.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Examples:

Request syntax with placeholder values


resp = client.describe_events({
  server_name: "ServerName", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.server_events #=> Array
resp.server_events[0].created_at #=> Time
resp.server_events[0].server_name #=> String
resp.server_events[0].message #=> String
resp.server_events[0].log_url #=> String
resp.next_token #=> String

Options Hash (options):

  • :server_name (required, String)

    The name of the server for which you want to view events.

  • :next_token (String)

    NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeEvents again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object\'s nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

  • :max_results (Integer)

    To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Returns:

See Also:

#describe_node_association_status(options = {}) ⇒ Types::DescribeNodeAssociationStatusResponse

Returns the current status of an existing association or disassociation request.

A ResourceNotFoundException is thrown when no recent association or disassociation request with the specified token is found, or when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Examples:

Request syntax with placeholder values


resp = client.describe_node_association_status({
  node_association_status_token: "NodeAssociationStatusToken", # required
  server_name: "ServerName", # required
})

Response structure


resp.node_association_status #=> String, one of "SUCCESS", "FAILED", "IN_PROGRESS"
resp.engine_attributes #=> Array
resp.engine_attributes[0].name #=> String
resp.engine_attributes[0].value #=> String

Options Hash (options):

  • :node_association_status_token (required, String)

    The token returned in either the AssociateNodeResponse or the DisassociateNodeResponse.

  • :server_name (required, String)

    The name of the server from which to disassociate the node.

Returns:

See Also:

#describe_servers(options = {}) ⇒ Types::DescribeServersResponse

Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks CM does not query other services.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Examples:

Request syntax with placeholder values


resp = client.describe_servers({
  server_name: "ServerName",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.servers #=> Array
resp.servers[0].associate_public_ip_address #=> true/false
resp.servers[0].backup_retention_count #=> Integer
resp.servers[0].server_name #=> String
resp.servers[0].created_at #=> Time
resp.servers[0].cloud_formation_stack_arn #=> String
resp.servers[0].custom_domain #=> String
resp.servers[0].disable_automated_backup #=> true/false
resp.servers[0].endpoint #=> String
resp.servers[0].engine #=> String
resp.servers[0].engine_model #=> String
resp.servers[0].engine_attributes #=> Array
resp.servers[0].engine_attributes[0].name #=> String
resp.servers[0].engine_attributes[0].value #=> String
resp.servers[0].engine_version #=> String
resp.servers[0].instance_profile_arn #=> String
resp.servers[0].instance_type #=> String
resp.servers[0].key_pair #=> String
resp.servers[0].maintenance_status #=> String, one of "SUCCESS", "FAILED"
resp.servers[0].preferred_maintenance_window #=> String
resp.servers[0].preferred_backup_window #=> String
resp.servers[0].security_group_ids #=> Array
resp.servers[0].security_group_ids[0] #=> String
resp.servers[0].service_role_arn #=> String
resp.servers[0].status #=> String, one of "BACKING_UP", "CONNECTION_LOST", "CREATING", "DELETING", "MODIFYING", "FAILED", "HEALTHY", "RUNNING", "RESTORING", "SETUP", "UNDER_MAINTENANCE", "UNHEALTHY", "TERMINATED"
resp.servers[0].status_reason #=> String
resp.servers[0].subnet_ids #=> Array
resp.servers[0].subnet_ids[0] #=> String
resp.servers[0].server_arn #=> String
resp.next_token #=> String

Options Hash (options):

  • :server_name (String)

    Describes the server with the specified ServerName.

  • :next_token (String)

    This is not currently implemented for DescribeServers requests.

  • :max_results (Integer)

    This is not currently implemented for DescribeServers requests.

Returns:

See Also:

#disassociate_node(options = {}) ⇒ Types::DisassociateNodeResponse

Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the configuration manager's API. For more information about how to associate a node, see AssociateNode.

A node can can only be disassociated from a server that is in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Examples:

Request syntax with placeholder values


resp = client.disassociate_node({
  server_name: "ServerName", # required
  node_name: "NodeName", # required
  engine_attributes: [
    {
      name: "EngineAttributeName",
      value: "EngineAttributeValue",
    },
  ],
})

Response structure


resp.node_association_status_token #=> String

Options Hash (options):

  • :server_name (required, String)

    The name of the server from which to disassociate the node.

  • :node_name (required, String)

    The name of the client node.

  • :engine_attributes (Array<Types::EngineAttribute>)

    Engine attributes that are used for disassociating the node. No attributes are required for Puppet.

    Attributes required in a DisassociateNode request for Chef .title

    • CHEF_ORGANIZATION: The Chef organization with which the node was associated. By default only one organization named default can exist.

    ^

Returns:

See Also:

#export_server_engine_attribute(options = {}) ⇒ Types::ExportServerEngineAttributeResponse

Exports a specified server engine attribute as a base64-encoded string. For example, you can export user data that you can use in EC2 to associate nodes with a server.

This operation is synchronous.

A ValidationException is raised when parameters of the request are not valid. A ResourceNotFoundException is thrown when the server does not exist. An InvalidStateException is thrown when the server is in any of the following states: CREATING, TERMINATED, FAILED or DELETING.

Examples:

Request syntax with placeholder values


resp = client.export_server_engine_attribute({
  export_attribute_name: "String", # required
  server_name: "ServerName", # required
  input_attributes: [
    {
      name: "EngineAttributeName",
      value: "EngineAttributeValue",
    },
  ],
})

Response structure


resp.engine_attribute.name #=> String
resp.engine_attribute.value #=> String
resp.server_name #=> String

Options Hash (options):

  • :export_attribute_name (required, String)

    The name of the export attribute. Currently, the supported export attribute is Userdata. This exports a user data script that includes parameters and values provided in the InputAttributes list.

  • :server_name (required, String)

    The name of the server from which you are exporting the attribute.

  • :input_attributes (Array<Types::EngineAttribute>)

    The list of engine attributes. The list type is EngineAttribute. An EngineAttribute list item is a pair that includes an attribute name and its value. For the Userdata ExportAttributeName, the following are supported engine attribute names.

    • RunList In Chef, a list of roles or recipes that are run in the specified order. In Puppet, this parameter is ignored.

    • OrganizationName In Chef, an organization name. AWS OpsWorks for Chef Automate always creates the organization default. In Puppet, this parameter is ignored.

    • NodeEnvironment In Chef, a node environment (for example, development, staging, or one-box). In Puppet, this parameter is ignored.

    • NodeClientVersion In Chef, the version of the Chef engine (three numbers separated by dots, such as 13.8.5). If this attribute is empty, OpsWorks for Chef Automate uses the most current version. In Puppet, this parameter is ignored.

Returns:

See Also:

#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse

Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AWSOpsWorksCMResourceArn", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_token #=> String

Options Hash (options):

  • :resource_arn (required, String)

    The Amazon Resource Number (ARN) of an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server for which you want to show applied tags. For example, arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.

  • :next_token (String)

    NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call ListTagsForResource again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object\'s nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

  • :max_results (Integer)

    To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Returns:

See Also:

#restore_server(options = {}) ⇒ Struct

Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work.

Restoring from a backup is performed by creating a new EC2 instance. If restoration is successful, and the server is in a HEALTHY state, AWS OpsWorks CM switches traffic over to the new instance. After restoration is finished, the old EC2 instance is maintained in a Running or Stopped state, but is eventually terminated.

This operation is asynchronous.

An InvalidStateException is thrown when the server is not in a valid state. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Examples:

Request syntax with placeholder values


resp = client.restore_server({
  backup_id: "BackupId", # required
  server_name: "ServerName", # required
  instance_type: "String",
  key_pair: "KeyPair",
})

Options Hash (options):

  • :backup_id (required, String)

    The ID of the backup that you want to use to restore a server.

  • :server_name (required, String)

    The name of the server that you want to restore.

  • :instance_type (String)

    The type of instance to restore. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, m5.large. Valid values are m5.large, r5.xlarge, and r5.2xlarge. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup.

  • :key_pair (String)

    The name of the key pair to set on the new EC2 instance. This can be helpful if the administrator no longer has the SSH key.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#start_maintenance(options = {}) ⇒ Types::StartMaintenanceResponse

Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server is in an UNDER_MAINTENANCE state while maintenance is in progress.

Maintenance can only be started on servers in HEALTHY and UNHEALTHY states. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Examples:

Request syntax with placeholder values


resp = client.start_maintenance({
  server_name: "ServerName", # required
  engine_attributes: [
    {
      name: "EngineAttributeName",
      value: "EngineAttributeValue",
    },
  ],
})

Response structure


resp.server.associate_public_ip_address #=> true/false
resp.server.backup_retention_count #=> Integer
resp.server.server_name #=> String
resp.server.created_at #=> Time
resp.server.cloud_formation_stack_arn #=> String
resp.server.custom_domain #=> String
resp.server.disable_automated_backup #=> true/false
resp.server.endpoint #=> String
resp.server.engine #=> String
resp.server.engine_model #=> String
resp.server.engine_attributes #=> Array
resp.server.engine_attributes[0].name #=> String
resp.server.engine_attributes[0].value #=> String
resp.server.engine_version #=> String
resp.server.instance_profile_arn #=> String
resp.server.instance_type #=> String
resp.server.key_pair #=> String
resp.server.maintenance_status #=> String, one of "SUCCESS", "FAILED"
resp.server.preferred_maintenance_window #=> String
resp.server.preferred_backup_window #=> String
resp.server.security_group_ids #=> Array
resp.server.security_group_ids[0] #=> String
resp.server.service_role_arn #=> String
resp.server.status #=> String, one of "BACKING_UP", "CONNECTION_LOST", "CREATING", "DELETING", "MODIFYING", "FAILED", "HEALTHY", "RUNNING", "RESTORING", "SETUP", "UNDER_MAINTENANCE", "UNHEALTHY", "TERMINATED"
resp.server.status_reason #=> String
resp.server.subnet_ids #=> Array
resp.server.subnet_ids[0] #=> String
resp.server.server_arn #=> String

Options Hash (options):

  • :server_name (required, String)

    The name of the server on which to run maintenance.

  • :engine_attributes (Array<Types::EngineAttribute>)

    Engine attributes that are specific to the server on which you want to run maintenance.

    Attributes accepted in a StartMaintenance request for Chef .title

    ^

Returns:

See Also:

#tag_resource(options = {}) ⇒ Struct

Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AWSOpsWorksCMResourceArn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Options Hash (options):

  • :resource_arn (required, String)

    The Amazon Resource Number (ARN) of a resource to which you want to apply tags. For example, arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.

  • :tags (required, Array<Types::Tag>)

    A map that contains tag keys and tag values to attach to AWS OpsWorks-CM servers or backups.

    • The key cannot be empty.

    • The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

    • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

    • Leading and trailing white spaces are trimmed from both the key and value.

    • A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server or backup.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#untag_resource(options = {}) ⇒ Struct

Removes specified tags from an AWS OpsWorks-CM server or backup.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AWSOpsWorksCMResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Options Hash (options):

  • :resource_arn (required, String)

    The Amazon Resource Number (ARN) of a resource from which you want to remove tags. For example, arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.

  • :tag_keys (required, Array<String>)

    The keys of tags that you want to remove.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_server(options = {}) ⇒ Types::UpdateServerResponse

Updates settings for a server.

This operation is synchronous.

Examples:

Request syntax with placeholder values


resp = client.update_server({
  disable_automated_backup: false,
  backup_retention_count: 1,
  server_name: "ServerName", # required
  preferred_maintenance_window: "TimeWindowDefinition",
  preferred_backup_window: "TimeWindowDefinition",
})

Response structure


resp.server.associate_public_ip_address #=> true/false
resp.server.backup_retention_count #=> Integer
resp.server.server_name #=> String
resp.server.created_at #=> Time
resp.server.cloud_formation_stack_arn #=> String
resp.server.custom_domain #=> String
resp.server.disable_automated_backup #=> true/false
resp.server.endpoint #=> String
resp.server.engine #=> String
resp.server.engine_model #=> String
resp.server.engine_attributes #=> Array
resp.server.engine_attributes[0].name #=> String
resp.server.engine_attributes[0].value #=> String
resp.server.engine_version #=> String
resp.server.instance_profile_arn #=> String
resp.server.instance_type #=> String
resp.server.key_pair #=> String
resp.server.maintenance_status #=> String, one of "SUCCESS", "FAILED"
resp.server.preferred_maintenance_window #=> String
resp.server.preferred_backup_window #=> String
resp.server.security_group_ids #=> Array
resp.server.security_group_ids[0] #=> String
resp.server.service_role_arn #=> String
resp.server.status #=> String, one of "BACKING_UP", "CONNECTION_LOST", "CREATING", "DELETING", "MODIFYING", "FAILED", "HEALTHY", "RUNNING", "RESTORING", "SETUP", "UNDER_MAINTENANCE", "UNHEALTHY", "TERMINATED"
resp.server.status_reason #=> String
resp.server.subnet_ids #=> Array
resp.server.subnet_ids[0] #=> String
resp.server.server_arn #=> String

Options Hash (options):

  • :disable_automated_backup (Boolean)

    Setting DisableAutomatedBackup to true disables automated or scheduled backups. Automated backups are enabled by default.

  • :backup_retention_count (Integer)

    Sets the number of automated backups that you want to keep.

  • :server_name (required, String)

    The name of the server to update.

  • :preferred_maintenance_window (String)

    DDD:HH:MM (weekly start time) or HH:MM (daily start time).

    Time windows always use coordinated universal time (UTC). Valid strings for day of week (DDD) are: Mon, Tue, Wed, Thr, Fri, Sat, or Sun.

  • :preferred_backup_window (String)

    DDD:HH:MM (weekly start time) or HH:MM (daily start time).

    Time windows always use coordinated universal time (UTC). Valid strings for day of week (DDD) are: Mon, Tue, Wed, Thr, Fri, Sat, or Sun.

Returns:

See Also:

#update_server_engine_attributes(options = {}) ⇒ Types::UpdateServerEngineAttributesResponse

Updates engine-specific attributes on a specified server. The server enters the MODIFYING state when this operation is in progress. Only one update can occur at a time. You can use this command to reset a Chef server's public key (CHEF_PIVOTAL_KEY) or a Puppet server's admin password (PUPPET_ADMIN_PASSWORD).

This operation is asynchronous.

This operation can only be called for servers in HEALTHY or UNHEALTHY states. Otherwise, an InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Examples:

Request syntax with placeholder values


resp = client.update_server_engine_attributes({
  server_name: "ServerName", # required
  attribute_name: "AttributeName", # required
  attribute_value: "AttributeValue",
})

Response structure


resp.server.associate_public_ip_address #=> true/false
resp.server.backup_retention_count #=> Integer
resp.server.server_name #=> String
resp.server.created_at #=> Time
resp.server.cloud_formation_stack_arn #=> String
resp.server.custom_domain #=> String
resp.server.disable_automated_backup #=> true/false
resp.server.endpoint #=> String
resp.server.engine #=> String
resp.server.engine_model #=> String
resp.server.engine_attributes #=> Array
resp.server.engine_attributes[0].name #=> String
resp.server.engine_attributes[0].value #=> String
resp.server.engine_version #=> String
resp.server.instance_profile_arn #=> String
resp.server.instance_type #=> String
resp.server.key_pair #=> String
resp.server.maintenance_status #=> String, one of "SUCCESS", "FAILED"
resp.server.preferred_maintenance_window #=> String
resp.server.preferred_backup_window #=> String
resp.server.security_group_ids #=> Array
resp.server.security_group_ids[0] #=> String
resp.server.service_role_arn #=> String
resp.server.status #=> String, one of "BACKING_UP", "CONNECTION_LOST", "CREATING", "DELETING", "MODIFYING", "FAILED", "HEALTHY", "RUNNING", "RESTORING", "SETUP", "UNDER_MAINTENANCE", "UNHEALTHY", "TERMINATED"
resp.server.status_reason #=> String
resp.server.subnet_ids #=> Array
resp.server.subnet_ids[0] #=> String
resp.server.server_arn #=> String

Options Hash (options):

  • :server_name (required, String)

    The name of the server to update.

  • :attribute_name (required, String)

    The name of the engine attribute to update.

  • :attribute_value (String)

    The value to set for the attribute.

Returns:

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

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
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:
:node_associated#describe_node_association_status1515

Returns:

  • (Array<Symbol>)

    the list of supported waiters.