aws-sdk-opsworkscm 1.0.0.rc2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/lib/aws-sdk-opsworkscm.rb +47 -0
- data/lib/aws-sdk-opsworkscm/client.rb +1026 -0
- data/lib/aws-sdk-opsworkscm/client_api.rb +469 -0
- data/lib/aws-sdk-opsworkscm/customizations.rb +0 -0
- data/lib/aws-sdk-opsworkscm/errors.rb +23 -0
- data/lib/aws-sdk-opsworkscm/resource.rb +25 -0
- data/lib/aws-sdk-opsworkscm/types.rb +1069 -0
- metadata +80 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 7375ff3b8aa48778cb047037618f3d627067d528
|
4
|
+
data.tar.gz: 09c13eeca64172176a03cd302cde350911e8e5ed
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 318e25964d9ea2b5e453dce020a87fd273af629a3bfe050f03f58149e6eab01d47cdaea2430b8f35847888152e62193bf73ca237cfe622d975df31054a9fedb2
|
7
|
+
data.tar.gz: 2d866dfd13511176b1f5482212c6cc5fda03277b59b9d323290cae1b799dce72b253c8d0173ab55e5e5b47deb6187b8b80fc669da01697f463316baf7eefc8c2
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-opsworkscm/types'
|
12
|
+
require_relative 'aws-sdk-opsworkscm/client_api'
|
13
|
+
require_relative 'aws-sdk-opsworkscm/client'
|
14
|
+
require_relative 'aws-sdk-opsworkscm/errors'
|
15
|
+
require_relative 'aws-sdk-opsworkscm/resource'
|
16
|
+
require_relative 'aws-sdk-opsworkscm/customizations'
|
17
|
+
|
18
|
+
# This module provides support for AWS OpsWorks for Chef Automate. This module is available in the
|
19
|
+
# `aws-sdk-opsworkscm` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from AWS OpsWorks for Chef Automate all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::OpsWorksCM::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::OpsWorksCM
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0.rc2'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,1026 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
22
|
+
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
23
|
+
|
24
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:opsworkscm)
|
25
|
+
|
26
|
+
module Aws
|
27
|
+
module OpsWorksCM
|
28
|
+
class Client < Seahorse::Client::Base
|
29
|
+
|
30
|
+
include Aws::ClientStubs
|
31
|
+
|
32
|
+
@identifier = :opsworkscm
|
33
|
+
|
34
|
+
set_api(ClientApi::API)
|
35
|
+
|
36
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
37
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
38
|
+
add_plugin(Aws::Plugins::Logging)
|
39
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
40
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
41
|
+
add_plugin(Aws::Plugins::UserAgent)
|
42
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
43
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
44
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
45
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
46
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
47
|
+
add_plugin(Aws::Plugins::StubResponses)
|
48
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
49
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
50
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
51
|
+
|
52
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
53
|
+
# Your AWS credentials. This can be an instance of any one of the
|
54
|
+
# following classes:
|
55
|
+
#
|
56
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
57
|
+
# credentials.
|
58
|
+
#
|
59
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
60
|
+
# from an EC2 IMDS on an EC2 instance.
|
61
|
+
#
|
62
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
63
|
+
# shared file, such as `~/.aws/config`.
|
64
|
+
#
|
65
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
66
|
+
#
|
67
|
+
# When `:credentials` are not configured directly, the following
|
68
|
+
# locations will be searched for credentials:
|
69
|
+
#
|
70
|
+
# * `Aws.config[:credentials]`
|
71
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
72
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
73
|
+
# * `~/.aws/credentials`
|
74
|
+
# * `~/.aws/config`
|
75
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
76
|
+
# very aggressive. Construct and pass an instance of
|
77
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
78
|
+
# timeouts.
|
79
|
+
# @option options [required, String] :region
|
80
|
+
# The AWS region to connect to. The configured `:region` is
|
81
|
+
# used to determine the service `:endpoint`. When not passed,
|
82
|
+
# a default `:region` is search for in the following locations:
|
83
|
+
#
|
84
|
+
# * `Aws.config[:region]`
|
85
|
+
# * `ENV['AWS_REGION']`
|
86
|
+
# * `ENV['AMAZON_REGION']`
|
87
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
88
|
+
# * `~/.aws/credentials`
|
89
|
+
# * `~/.aws/config`
|
90
|
+
# @option options [String] :access_key_id
|
91
|
+
# @option options [Boolean] :convert_params (true)
|
92
|
+
# When `true`, an attempt is made to coerce request parameters into
|
93
|
+
# the required types.
|
94
|
+
# @option options [String] :endpoint
|
95
|
+
# The client endpoint is normally constructed from the `:region`
|
96
|
+
# option. You should only configure an `:endpoint` when connecting
|
97
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
98
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
99
|
+
# The log formatter.
|
100
|
+
# @option options [Symbol] :log_level (:info)
|
101
|
+
# The log level to send messages to the `:logger` at.
|
102
|
+
# @option options [Logger] :logger
|
103
|
+
# The Logger instance to send log messages to. If this option
|
104
|
+
# is not set, logging will be disabled.
|
105
|
+
# @option options [String] :profile ("default")
|
106
|
+
# Used when loading credentials from the shared credentials file
|
107
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
108
|
+
# @option options [Integer] :retry_limit (3)
|
109
|
+
# The maximum number of times to retry failed requests. Only
|
110
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
111
|
+
# are retried. Generally, these are throttling errors, data
|
112
|
+
# checksum errors, networking errors, timeout errors and auth
|
113
|
+
# errors from expired credentials.
|
114
|
+
# @option options [String] :secret_access_key
|
115
|
+
# @option options [String] :session_token
|
116
|
+
# @option options [Boolean] :simple_json (false)
|
117
|
+
# Disables request parameter conversion, validation, and formatting.
|
118
|
+
# Also disable response data type conversions. This option is useful
|
119
|
+
# when you want to ensure the highest level of performance by
|
120
|
+
# avoiding overhead of walking request parameters and response data
|
121
|
+
# structures.
|
122
|
+
#
|
123
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
124
|
+
# be formatted exactly as the DynamoDB API expects.
|
125
|
+
# @option options [Boolean] :stub_responses (false)
|
126
|
+
# Causes the client to return stubbed responses. By default
|
127
|
+
# fake responses are generated and returned. You can specify
|
128
|
+
# the response data to return or errors to raise by calling
|
129
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
130
|
+
#
|
131
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
132
|
+
# requests are made, and retries are disabled.
|
133
|
+
# @option options [Boolean] :validate_params (true)
|
134
|
+
# When `true`, request parameters are validated before
|
135
|
+
# sending the request.
|
136
|
+
def initialize(*args)
|
137
|
+
super
|
138
|
+
end
|
139
|
+
|
140
|
+
# @!group API Operations
|
141
|
+
|
142
|
+
# @option params [required, String] :server_name
|
143
|
+
# @option params [required, String] :node_name
|
144
|
+
# @option params [Array<Types::EngineAttribute>] :engine_attributes
|
145
|
+
# @return [Types::AssociateNodeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
146
|
+
#
|
147
|
+
# * {Types::AssociateNodeResponse#node_association_status_token #NodeAssociationStatusToken} => String
|
148
|
+
#
|
149
|
+
# @example Request syntax with placeholder values
|
150
|
+
# resp = client.associate_node({
|
151
|
+
# server_name: "ServerName", # required
|
152
|
+
# node_name: "NodeName", # required
|
153
|
+
# engine_attributes: [
|
154
|
+
# {
|
155
|
+
# name: "String",
|
156
|
+
# value: "String",
|
157
|
+
# },
|
158
|
+
# ],
|
159
|
+
# })
|
160
|
+
#
|
161
|
+
# @example Response structure
|
162
|
+
# resp.node_association_status_token #=> String
|
163
|
+
# @overload associate_node(params = {})
|
164
|
+
# @param [Hash] params ({})
|
165
|
+
def associate_node(params = {}, options = {})
|
166
|
+
req = build_request(:associate_node, params)
|
167
|
+
req.send_request(options)
|
168
|
+
end
|
169
|
+
|
170
|
+
# Creates an application-level backup of a server. While the server is
|
171
|
+
# `BACKING_UP`, the server can not be modified and no additional backup
|
172
|
+
# can be created.
|
173
|
+
#
|
174
|
+
# Backups can be created for `RUNNING`, `HEALTHY` and `UNHEALTHY`
|
175
|
+
# servers.
|
176
|
+
#
|
177
|
+
# This operation is asnychronous.
|
178
|
+
#
|
179
|
+
# By default 50 manual backups can be created.
|
180
|
+
#
|
181
|
+
# A `LimitExceededException` is thrown then the maximum number of manual
|
182
|
+
# backup is reached. A `InvalidStateException` is thrown when the server
|
183
|
+
# is not in any of RUNNING, HEALTHY, UNHEALTHY. A
|
184
|
+
# `ResourceNotFoundException` is thrown when the server is not found. A
|
185
|
+
# `ValidationException` is thrown when parameters of the request are not
|
186
|
+
# valid.
|
187
|
+
# @option params [required, String] :server_name
|
188
|
+
# The name of the server that you want to back up.
|
189
|
+
# @option params [String] :description
|
190
|
+
# A user-defined description of the backup.
|
191
|
+
# @return [Types::CreateBackupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
192
|
+
#
|
193
|
+
# * {Types::CreateBackupResponse#backup #Backup} => Types::Backup
|
194
|
+
#
|
195
|
+
# @example Request syntax with placeholder values
|
196
|
+
# resp = client.create_backup({
|
197
|
+
# server_name: "ServerName", # required
|
198
|
+
# description: "String",
|
199
|
+
# })
|
200
|
+
#
|
201
|
+
# @example Response structure
|
202
|
+
# resp.backup.backup_arn #=> String
|
203
|
+
# resp.backup.backup_id #=> String
|
204
|
+
# resp.backup.backup_type #=> String, one of "AUTOMATED", "MANUAL"
|
205
|
+
# resp.backup.created_at #=> Time
|
206
|
+
# resp.backup.description #=> String
|
207
|
+
# resp.backup.engine #=> String
|
208
|
+
# resp.backup.engine_model #=> String
|
209
|
+
# resp.backup.engine_version #=> String
|
210
|
+
# resp.backup.instance_profile_arn #=> String
|
211
|
+
# resp.backup.instance_type #=> String
|
212
|
+
# resp.backup.key_pair #=> String
|
213
|
+
# resp.backup.preferred_backup_window #=> String
|
214
|
+
# resp.backup.preferred_maintenance_window #=> String
|
215
|
+
# resp.backup.s3_data_size #=> Integer
|
216
|
+
# resp.backup.s3_data_url #=> String
|
217
|
+
# resp.backup.s3_log_url #=> String
|
218
|
+
# resp.backup.security_group_ids #=> Array
|
219
|
+
# resp.backup.security_group_ids[0] #=> String
|
220
|
+
# resp.backup.server_name #=> String
|
221
|
+
# resp.backup.service_role_arn #=> String
|
222
|
+
# resp.backup.status #=> String, one of "IN_PROGRESS", "OK", "FAILED", "DELETING"
|
223
|
+
# resp.backup.status_description #=> String
|
224
|
+
# resp.backup.subnet_ids #=> Array
|
225
|
+
# resp.backup.subnet_ids[0] #=> String
|
226
|
+
# resp.backup.tools_version #=> String
|
227
|
+
# resp.backup.user_arn #=> String
|
228
|
+
# @overload create_backup(params = {})
|
229
|
+
# @param [Hash] params ({})
|
230
|
+
def create_backup(params = {}, options = {})
|
231
|
+
req = build_request(:create_backup, params)
|
232
|
+
req.send_request(options)
|
233
|
+
end
|
234
|
+
|
235
|
+
# Creates and immedately starts a new Server. The server can be used
|
236
|
+
# once it has reached the `HEALTHY` state.
|
237
|
+
#
|
238
|
+
# This operation is asnychronous.
|
239
|
+
#
|
240
|
+
# A `LimitExceededException` is thrown then the maximum number of server
|
241
|
+
# backup is reached. A `ResourceAlreadyExistsException` is raise when a
|
242
|
+
# server with the same name already exists in the account. A
|
243
|
+
# `ResourceNotFoundException` is thrown when a backupId is passed, but
|
244
|
+
# the backup does not exist. A `ValidationException` is thrown when
|
245
|
+
# parameters of the request are not valid.
|
246
|
+
#
|
247
|
+
# By default 10 servers can be created. A `LimitExceededException` is
|
248
|
+
# raised when the limit is exceeded.
|
249
|
+
#
|
250
|
+
# When no security groups are provided by using `SecurityGroupIds`, AWS
|
251
|
+
# OpsWorks creates a new security group. This security group opens the
|
252
|
+
# Chef server to the world on TCP port 443. If a KeyName is present, SSH
|
253
|
+
# access is enabled. SSH is also open to the world on TCP port 22.
|
254
|
+
#
|
255
|
+
# By default, the Chef Server is accessible from any IP address. We
|
256
|
+
# recommend that you update your security group rules to allow access
|
257
|
+
# from known IP addresses and address ranges only. To edit security
|
258
|
+
# group rules, open Security Groups in the navigation pane of the EC2
|
259
|
+
# management console.
|
260
|
+
# @option params [Boolean] :disable_automated_backup
|
261
|
+
# Enable or disable scheduled backups. Valid values are `true` or
|
262
|
+
# `false`. The default value is `true`.
|
263
|
+
# @option params [String] :engine
|
264
|
+
# The configuration management engine to use. Valid values include
|
265
|
+
# `Chef`.
|
266
|
+
# @option params [String] :engine_model
|
267
|
+
# The engine model, or option. Valid values include `Single`.
|
268
|
+
# @option params [String] :engine_version
|
269
|
+
# The major release version of the engine that you want to use. Values
|
270
|
+
# depend on the engine that you choose.
|
271
|
+
# @option params [Array<Types::EngineAttribute>] :engine_attributes
|
272
|
+
# Engine attributes on a specified server.
|
273
|
+
#
|
274
|
+
# **Attributes accepted in a createServer request:**
|
275
|
+
#
|
276
|
+
# * `CHEF_PIVOTAL_KEY`\: A base64-encoded RSA private key that is not
|
277
|
+
# stored by AWS OpsWorks for Chef Automate. This private key is
|
278
|
+
# required to access the Chef API.
|
279
|
+
#
|
280
|
+
# ^
|
281
|
+
# @option params [Integer] :backup_retention_count
|
282
|
+
# The number of automated backups that you want to keep. Whenever a new
|
283
|
+
# backup is created, AWS OpsWorks for Chef Automate deletes the oldest
|
284
|
+
# backups if this number is exceeded. The default value is `1`.
|
285
|
+
# @option params [required, String] :server_name
|
286
|
+
# The name of the server. The server name must be unique within your AWS
|
287
|
+
# account, within each region. Server names must start with a letter;
|
288
|
+
# then letters, numbers, or hyphens (-) are allowed, up to a maximum of
|
289
|
+
# 32 characters.
|
290
|
+
# @option params [required, String] :instance_profile_arn
|
291
|
+
# The ARN of the instance profile that your Amazon EC2 instances use.
|
292
|
+
# Although the AWS OpsWorks console typically creates the instance
|
293
|
+
# profile for you, in this release of AWS OpsWorks for Chef Automate,
|
294
|
+
# run the service-role-creation.yaml AWS CloudFormation template,
|
295
|
+
# located at
|
296
|
+
# https://s3.amazonaws.com/opsworks-stuff/latest/service-role-creation.yaml.
|
297
|
+
# This template creates a stack that includes the instance profile you
|
298
|
+
# need.
|
299
|
+
# @option params [String] :instance_type
|
300
|
+
# The Amazon EC2 instance type to use. Valid values must be specified in
|
301
|
+
# the following format: `^([cm][34]|t2).*` For example, `c3.large`.
|
302
|
+
# @option params [String] :key_pair
|
303
|
+
# The Amazon EC2 key pair to set for the instance. You may specify this
|
304
|
+
# parameter to connect to your instances by using SSH.
|
305
|
+
# @option params [String] :preferred_maintenance_window
|
306
|
+
# The start time for a one-hour period each week during which AWS
|
307
|
+
# OpsWorks for Chef Automate performs maintenance on the instance. Valid
|
308
|
+
# values must be specified in the following format: `DDD:HH:MM`. The
|
309
|
+
# specified time is in coordinated universal time (UTC). The default
|
310
|
+
# value is a random one-hour period on Tuesday, Wednesday, or Friday.
|
311
|
+
# See `TimeWindowDefinition` for more information.
|
312
|
+
#
|
313
|
+
# **Example:** `Mon:08:00`, which represents a start time of every
|
314
|
+
# Monday at 08:00 UTC. (8:00 a.m.)
|
315
|
+
# @option params [String] :preferred_backup_window
|
316
|
+
# The start time for a one-hour period during which AWS OpsWorks for
|
317
|
+
# Chef Automate backs up application-level data on your server if
|
318
|
+
# backups are enabled. Valid values must be specified in one of the
|
319
|
+
# following formats:
|
320
|
+
#
|
321
|
+
# * `HH:MM` for daily backups
|
322
|
+
#
|
323
|
+
# * `DDD:HH:MM` for weekly backups
|
324
|
+
#
|
325
|
+
# The specified time is in coordinated universal time (UTC). The default
|
326
|
+
# value is a random, daily start time.
|
327
|
+
#
|
328
|
+
# **Example:** `08:00`, which represents a daily start time of 08:00
|
329
|
+
# UTC.
|
330
|
+
#
|
331
|
+
# **Example:** `Mon:08:00`, which represents a start time of every
|
332
|
+
# Monday at 08:00 UTC. (8:00 a.m.)
|
333
|
+
# @option params [Array<String>] :security_group_ids
|
334
|
+
# A list of security group IDs to attach to the Amazon EC2 instance. If
|
335
|
+
# you add this parameter, the specified security groups must be within
|
336
|
+
# the VPC that is specified by `SubnetIds`.
|
337
|
+
#
|
338
|
+
# If you do not specify this parameter, AWS OpsWorks for Chef Automate
|
339
|
+
# creates one new security group that uses TCP ports 22 and 443, open to
|
340
|
+
# 0.0.0.0/0 (everyone).
|
341
|
+
# @option params [required, String] :service_role_arn
|
342
|
+
# The service role that the AWS OpsWorks for Chef Automate service
|
343
|
+
# backend uses to work with your account. Although the AWS OpsWorks
|
344
|
+
# console typically creates the service role for you, in this release of
|
345
|
+
# AWS OpsWorks for Chef Automate, run the service-role-creation.yaml AWS
|
346
|
+
# CloudFormation template, located at
|
347
|
+
# https://s3.amazonaws.com/opsworks-stuff/latest/service-role-creation.yaml.
|
348
|
+
# This template creates a stack that includes the service role that you
|
349
|
+
# need.
|
350
|
+
# @option params [Array<String>] :subnet_ids
|
351
|
+
# The IDs of subnets in which to launch the server EC2 instance.
|
352
|
+
#
|
353
|
+
# Amazon EC2-Classic customers: This field is required. All servers must
|
354
|
+
# run within a VPC. The VPC must have "Auto Assign Public IP" enabled.
|
355
|
+
#
|
356
|
+
# EC2-VPC customers: This field is optional. If you do not specify
|
357
|
+
# subnet IDs, your EC2 instances are created in a default subnet that is
|
358
|
+
# selected by Amazon EC2. If you specify subnet IDs, the VPC must have
|
359
|
+
# "Auto Assign Public IP" enabled.
|
360
|
+
#
|
361
|
+
# For more information about supported Amazon EC2 platforms, see
|
362
|
+
# [Supported Platforms][1].
|
363
|
+
#
|
364
|
+
#
|
365
|
+
#
|
366
|
+
# [1]: http://docs.aws.amazon.com/https:/docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html
|
367
|
+
# @option params [String] :backup_id
|
368
|
+
# If you specify this field, AWS OpsWorks for Chef Automate creates the
|
369
|
+
# server by using the backup represented by BackupId.
|
370
|
+
# @return [Types::CreateServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
371
|
+
#
|
372
|
+
# * {Types::CreateServerResponse#server #Server} => Types::Server
|
373
|
+
#
|
374
|
+
# @example Request syntax with placeholder values
|
375
|
+
# resp = client.create_server({
|
376
|
+
# disable_automated_backup: false,
|
377
|
+
# engine: "String",
|
378
|
+
# engine_model: "String",
|
379
|
+
# engine_version: "String",
|
380
|
+
# engine_attributes: [
|
381
|
+
# {
|
382
|
+
# name: "String",
|
383
|
+
# value: "String",
|
384
|
+
# },
|
385
|
+
# ],
|
386
|
+
# backup_retention_count: 1,
|
387
|
+
# server_name: "ServerName", # required
|
388
|
+
# instance_profile_arn: "InstanceProfileArn", # required
|
389
|
+
# instance_type: "String",
|
390
|
+
# key_pair: "KeyPair",
|
391
|
+
# preferred_maintenance_window: "TimeWindowDefinition",
|
392
|
+
# preferred_backup_window: "TimeWindowDefinition",
|
393
|
+
# security_group_ids: ["String"],
|
394
|
+
# service_role_arn: "ServiceRoleArn", # required
|
395
|
+
# subnet_ids: ["String"],
|
396
|
+
# backup_id: "BackupId",
|
397
|
+
# })
|
398
|
+
#
|
399
|
+
# @example Response structure
|
400
|
+
# resp.server.backup_retention_count #=> Integer
|
401
|
+
# resp.server.server_name #=> String
|
402
|
+
# resp.server.created_at #=> Time
|
403
|
+
# resp.server.disable_automated_backup #=> Boolean
|
404
|
+
# resp.server.endpoint #=> String
|
405
|
+
# resp.server.engine #=> String
|
406
|
+
# resp.server.engine_model #=> String
|
407
|
+
# resp.server.engine_attributes #=> Array
|
408
|
+
# resp.server.engine_attributes[0].name #=> String
|
409
|
+
# resp.server.engine_attributes[0].value #=> String
|
410
|
+
# resp.server.engine_version #=> String
|
411
|
+
# resp.server.instance_profile_arn #=> String
|
412
|
+
# resp.server.instance_type #=> String
|
413
|
+
# resp.server.key_pair #=> String
|
414
|
+
# resp.server.maintenance_status #=> String, one of "SUCCESS", "FAILED"
|
415
|
+
# resp.server.preferred_maintenance_window #=> String
|
416
|
+
# resp.server.preferred_backup_window #=> String
|
417
|
+
# resp.server.security_group_ids #=> Array
|
418
|
+
# resp.server.security_group_ids[0] #=> String
|
419
|
+
# resp.server.service_role_arn #=> String
|
420
|
+
# resp.server.status #=> String, one of "BACKING_UP", "CONNECTION_LOST", "CREATING", "DELETING", "MODIFYING", "FAILED", "HEALTHY", "RUNNING", "SETUP", "UNDER_MAINTENANCE", "UNHEALTHY"
|
421
|
+
# resp.server.status_reason #=> String
|
422
|
+
# resp.server.subnet_ids #=> Array
|
423
|
+
# resp.server.subnet_ids[0] #=> String
|
424
|
+
# resp.server.server_arn #=> String
|
425
|
+
# @overload create_server(params = {})
|
426
|
+
# @param [Hash] params ({})
|
427
|
+
def create_server(params = {}, options = {})
|
428
|
+
req = build_request(:create_server, params)
|
429
|
+
req.send_request(options)
|
430
|
+
end
|
431
|
+
|
432
|
+
# Deletes a backup. You can delete both manual and automated backups.
|
433
|
+
#
|
434
|
+
# This operation is asynchronous.
|
435
|
+
#
|
436
|
+
# A `InvalidStateException` is thrown then a backup is already deleting.
|
437
|
+
# A `ResourceNotFoundException` is thrown when the backup does not
|
438
|
+
# exist. A `ValidationException` is thrown when parameters of the
|
439
|
+
# request are not valid.
|
440
|
+
# @option params [required, String] :backup_id
|
441
|
+
# The ID of the backup to delete. Run the DescribeBackups command to get
|
442
|
+
# a list of backup IDs. Backup IDs are in the format
|
443
|
+
# `ServerName-yyyyMMddHHmmssSSS`.
|
444
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
445
|
+
#
|
446
|
+
# @example Request syntax with placeholder values
|
447
|
+
# resp = client.delete_backup({
|
448
|
+
# backup_id: "BackupId", # required
|
449
|
+
# })
|
450
|
+
# @overload delete_backup(params = {})
|
451
|
+
# @param [Hash] params ({})
|
452
|
+
def delete_backup(params = {}, options = {})
|
453
|
+
req = build_request(:delete_backup, params)
|
454
|
+
req.send_request(options)
|
455
|
+
end
|
456
|
+
|
457
|
+
# Deletes the server and the underlying AWS CloudFormation stack
|
458
|
+
# (including the server's EC2 instance). The server status updated to
|
459
|
+
# `DELETING`. Once the server is successfully deleted, it will no longer
|
460
|
+
# be returned by `DescribeServer` requests. If the AWS CloudFormation
|
461
|
+
# stack cannot be deleted, the server cannot be deleted.
|
462
|
+
#
|
463
|
+
# This operation is asynchronous.
|
464
|
+
#
|
465
|
+
# A `InvalidStateException` is thrown then a server is already deleting.
|
466
|
+
# A `ResourceNotFoundException` is thrown when the server does not
|
467
|
+
# exist. A `ValidationException` is raised when parameters of the
|
468
|
+
# request are invalid.
|
469
|
+
# @option params [required, String] :server_name
|
470
|
+
# The ID of the server to delete.
|
471
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
472
|
+
#
|
473
|
+
# @example Request syntax with placeholder values
|
474
|
+
# resp = client.delete_server({
|
475
|
+
# server_name: "ServerName", # required
|
476
|
+
# })
|
477
|
+
# @overload delete_server(params = {})
|
478
|
+
# @param [Hash] params ({})
|
479
|
+
def delete_server(params = {}, options = {})
|
480
|
+
req = build_request(:delete_server, params)
|
481
|
+
req.send_request(options)
|
482
|
+
end
|
483
|
+
|
484
|
+
# Describes your account attributes, and creates requests to increase
|
485
|
+
# limits before they are reached or exceeded.
|
486
|
+
#
|
487
|
+
# This operation is synchronous.
|
488
|
+
# @return [Types::DescribeAccountAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
489
|
+
#
|
490
|
+
# * {Types::DescribeAccountAttributesResponse#attributes #Attributes} => Array<Types::AccountAttribute>
|
491
|
+
#
|
492
|
+
# @example Request syntax with placeholder values
|
493
|
+
# resp = client.describe_account_attributes()
|
494
|
+
#
|
495
|
+
# @example Response structure
|
496
|
+
# resp.attributes #=> Array
|
497
|
+
# resp.attributes[0].name #=> String
|
498
|
+
# resp.attributes[0].maximum #=> Integer
|
499
|
+
# resp.attributes[0].used #=> Integer
|
500
|
+
# @overload describe_account_attributes(params = {})
|
501
|
+
# @param [Hash] params ({})
|
502
|
+
def describe_account_attributes(params = {}, options = {})
|
503
|
+
req = build_request(:describe_account_attributes, params)
|
504
|
+
req.send_request(options)
|
505
|
+
end
|
506
|
+
|
507
|
+
# Describes backups. The results are ordered by time, with newest
|
508
|
+
# backups first. If you do not specify a BackupId or ServerName, the
|
509
|
+
# command returns all backups.
|
510
|
+
#
|
511
|
+
# This operation is synchronous.
|
512
|
+
#
|
513
|
+
# A `ResourceNotFoundException` is thrown when the backup does not
|
514
|
+
# exist. A `ValidationException` is raised when parameters of the
|
515
|
+
# request are invalid.
|
516
|
+
# @option params [String] :backup_id
|
517
|
+
# Describes a single backup.
|
518
|
+
# @option params [String] :server_name
|
519
|
+
# Returns backups for the server with the specified ServerName.
|
520
|
+
# @option params [String] :next_token
|
521
|
+
# NextToken is a string that is returned in some command responses. It
|
522
|
+
# indicates that not all entries have been returned, and that you must
|
523
|
+
# run at least one more request to get remaining items. To get remaining
|
524
|
+
# results, call `DescribeBackups` again, and assign the token from the
|
525
|
+
# previous results as the value of the `nextToken` parameter. If there
|
526
|
+
# are no more results, the response object's `nextToken` parameter
|
527
|
+
# value is `null`. Setting a `nextToken` value that was not returned in
|
528
|
+
# your previous results causes an `InvalidNextTokenException` to occur.
|
529
|
+
# @option params [Integer] :max_results
|
530
|
+
# To receive a paginated response, use this parameter to specify the
|
531
|
+
# maximum number of results to be returned with a single call. If the
|
532
|
+
# number of available results exceeds this maximum, the response
|
533
|
+
# includes a `NextToken` value that you can assign to the `NextToken`
|
534
|
+
# request parameter to get the next set of results.
|
535
|
+
# @return [Types::DescribeBackupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
536
|
+
#
|
537
|
+
# * {Types::DescribeBackupsResponse#backups #Backups} => Array<Types::Backup>
|
538
|
+
# * {Types::DescribeBackupsResponse#next_token #NextToken} => String
|
539
|
+
#
|
540
|
+
# @example Request syntax with placeholder values
|
541
|
+
# resp = client.describe_backups({
|
542
|
+
# backup_id: "BackupId",
|
543
|
+
# server_name: "ServerName",
|
544
|
+
# next_token: "NextToken",
|
545
|
+
# max_results: 1,
|
546
|
+
# })
|
547
|
+
#
|
548
|
+
# @example Response structure
|
549
|
+
# resp.backups #=> Array
|
550
|
+
# resp.backups[0].backup_arn #=> String
|
551
|
+
# resp.backups[0].backup_id #=> String
|
552
|
+
# resp.backups[0].backup_type #=> String, one of "AUTOMATED", "MANUAL"
|
553
|
+
# resp.backups[0].created_at #=> Time
|
554
|
+
# resp.backups[0].description #=> String
|
555
|
+
# resp.backups[0].engine #=> String
|
556
|
+
# resp.backups[0].engine_model #=> String
|
557
|
+
# resp.backups[0].engine_version #=> String
|
558
|
+
# resp.backups[0].instance_profile_arn #=> String
|
559
|
+
# resp.backups[0].instance_type #=> String
|
560
|
+
# resp.backups[0].key_pair #=> String
|
561
|
+
# resp.backups[0].preferred_backup_window #=> String
|
562
|
+
# resp.backups[0].preferred_maintenance_window #=> String
|
563
|
+
# resp.backups[0].s3_data_size #=> Integer
|
564
|
+
# resp.backups[0].s3_data_url #=> String
|
565
|
+
# resp.backups[0].s3_log_url #=> String
|
566
|
+
# resp.backups[0].security_group_ids #=> Array
|
567
|
+
# resp.backups[0].security_group_ids[0] #=> String
|
568
|
+
# resp.backups[0].server_name #=> String
|
569
|
+
# resp.backups[0].service_role_arn #=> String
|
570
|
+
# resp.backups[0].status #=> String, one of "IN_PROGRESS", "OK", "FAILED", "DELETING"
|
571
|
+
# resp.backups[0].status_description #=> String
|
572
|
+
# resp.backups[0].subnet_ids #=> Array
|
573
|
+
# resp.backups[0].subnet_ids[0] #=> String
|
574
|
+
# resp.backups[0].tools_version #=> String
|
575
|
+
# resp.backups[0].user_arn #=> String
|
576
|
+
# resp.next_token #=> String
|
577
|
+
# @overload describe_backups(params = {})
|
578
|
+
# @param [Hash] params ({})
|
579
|
+
def describe_backups(params = {}, options = {})
|
580
|
+
req = build_request(:describe_backups, params)
|
581
|
+
req.send_request(options)
|
582
|
+
end
|
583
|
+
|
584
|
+
# Describes events for a specified server. Results are ordered by time,
|
585
|
+
# with newest events first.
|
586
|
+
#
|
587
|
+
# This operation is synchronous.
|
588
|
+
#
|
589
|
+
# A `ResourceNotFoundException` is thrown when the server does not
|
590
|
+
# exist. A `ValidationException` is raised when parameters of the
|
591
|
+
# request are invalid.
|
592
|
+
# @option params [required, String] :server_name
|
593
|
+
# The name of the server for which you want to view events.
|
594
|
+
# @option params [String] :next_token
|
595
|
+
# NextToken is a string that is returned in some command responses. It
|
596
|
+
# indicates that not all entries have been returned, and that you must
|
597
|
+
# run at least one more request to get remaining items. To get remaining
|
598
|
+
# results, call `DescribeEvents` again, and assign the token from the
|
599
|
+
# previous results as the value of the `nextToken` parameter. If there
|
600
|
+
# are no more results, the response object's `nextToken` parameter
|
601
|
+
# value is `null`. Setting a `nextToken` value that was not returned in
|
602
|
+
# your previous results causes an `InvalidNextTokenException` to occur.
|
603
|
+
# @option params [Integer] :max_results
|
604
|
+
# To receive a paginated response, use this parameter to specify the
|
605
|
+
# maximum number of results to be returned with a single call. If the
|
606
|
+
# number of available results exceeds this maximum, the response
|
607
|
+
# includes a `NextToken` value that you can assign to the `NextToken`
|
608
|
+
# request parameter to get the next set of results.
|
609
|
+
# @return [Types::DescribeEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
610
|
+
#
|
611
|
+
# * {Types::DescribeEventsResponse#server_events #ServerEvents} => Array<Types::ServerEvent>
|
612
|
+
# * {Types::DescribeEventsResponse#next_token #NextToken} => String
|
613
|
+
#
|
614
|
+
# @example Request syntax with placeholder values
|
615
|
+
# resp = client.describe_events({
|
616
|
+
# server_name: "ServerName", # required
|
617
|
+
# next_token: "NextToken",
|
618
|
+
# max_results: 1,
|
619
|
+
# })
|
620
|
+
#
|
621
|
+
# @example Response structure
|
622
|
+
# resp.server_events #=> Array
|
623
|
+
# resp.server_events[0].created_at #=> Time
|
624
|
+
# resp.server_events[0].server_name #=> String
|
625
|
+
# resp.server_events[0].message #=> String
|
626
|
+
# resp.server_events[0].log_url #=> String
|
627
|
+
# resp.next_token #=> String
|
628
|
+
# @overload describe_events(params = {})
|
629
|
+
# @param [Hash] params ({})
|
630
|
+
def describe_events(params = {}, options = {})
|
631
|
+
req = build_request(:describe_events, params)
|
632
|
+
req.send_request(options)
|
633
|
+
end
|
634
|
+
|
635
|
+
# @option params [required, String] :node_association_status_token
|
636
|
+
# @option params [required, String] :server_name
|
637
|
+
# @return [Types::DescribeNodeAssociationStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
638
|
+
#
|
639
|
+
# * {Types::DescribeNodeAssociationStatusResponse#node_association_status #NodeAssociationStatus} => String
|
640
|
+
#
|
641
|
+
# @example Request syntax with placeholder values
|
642
|
+
# resp = client.describe_node_association_status({
|
643
|
+
# node_association_status_token: "NodeAssociationStatusToken", # required
|
644
|
+
# server_name: "ServerName", # required
|
645
|
+
# })
|
646
|
+
#
|
647
|
+
# @example Response structure
|
648
|
+
# resp.node_association_status #=> String, one of "SUCCESS", "FAILED", "IN_PROGRESS"
|
649
|
+
# @overload describe_node_association_status(params = {})
|
650
|
+
# @param [Hash] params ({})
|
651
|
+
def describe_node_association_status(params = {}, options = {})
|
652
|
+
req = build_request(:describe_node_association_status, params)
|
653
|
+
req.send_request(options)
|
654
|
+
end
|
655
|
+
|
656
|
+
# Lists all configuration management servers that are identified with
|
657
|
+
# your account. Only the stored results from Amazon DynamoDB are
|
658
|
+
# returned. AWS OpsWorks for Chef Automate does not query other
|
659
|
+
# services.
|
660
|
+
#
|
661
|
+
# This operation is synchronous.
|
662
|
+
#
|
663
|
+
# A `ResourceNotFoundException` is thrown when the server does not
|
664
|
+
# exist. A `ValidationException` is raised when parameters of the
|
665
|
+
# request are invalid.
|
666
|
+
# @option params [String] :server_name
|
667
|
+
# Describes the server with the specified ServerName.
|
668
|
+
# @option params [String] :next_token
|
669
|
+
# NextToken is a string that is returned in some command responses. It
|
670
|
+
# indicates that not all entries have been returned, and that you must
|
671
|
+
# run at least one more request to get remaining items. To get remaining
|
672
|
+
# results, call `DescribeServers` again, and assign the token from the
|
673
|
+
# previous results as the value of the `nextToken` parameter. If there
|
674
|
+
# are no more results, the response object's `nextToken` parameter
|
675
|
+
# value is `null`. Setting a `nextToken` value that was not returned in
|
676
|
+
# your previous results causes an `InvalidNextTokenException` to occur.
|
677
|
+
# @option params [Integer] :max_results
|
678
|
+
# To receive a paginated response, use this parameter to specify the
|
679
|
+
# maximum number of results to be returned with a single call. If the
|
680
|
+
# number of available results exceeds this maximum, the response
|
681
|
+
# includes a `NextToken` value that you can assign to the `NextToken`
|
682
|
+
# request parameter to get the next set of results.
|
683
|
+
# @return [Types::DescribeServersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
684
|
+
#
|
685
|
+
# * {Types::DescribeServersResponse#servers #Servers} => Array<Types::Server>
|
686
|
+
# * {Types::DescribeServersResponse#next_token #NextToken} => String
|
687
|
+
#
|
688
|
+
# @example Request syntax with placeholder values
|
689
|
+
# resp = client.describe_servers({
|
690
|
+
# server_name: "ServerName",
|
691
|
+
# next_token: "NextToken",
|
692
|
+
# max_results: 1,
|
693
|
+
# })
|
694
|
+
#
|
695
|
+
# @example Response structure
|
696
|
+
# resp.servers #=> Array
|
697
|
+
# resp.servers[0].backup_retention_count #=> Integer
|
698
|
+
# resp.servers[0].server_name #=> String
|
699
|
+
# resp.servers[0].created_at #=> Time
|
700
|
+
# resp.servers[0].disable_automated_backup #=> Boolean
|
701
|
+
# resp.servers[0].endpoint #=> String
|
702
|
+
# resp.servers[0].engine #=> String
|
703
|
+
# resp.servers[0].engine_model #=> String
|
704
|
+
# resp.servers[0].engine_attributes #=> Array
|
705
|
+
# resp.servers[0].engine_attributes[0].name #=> String
|
706
|
+
# resp.servers[0].engine_attributes[0].value #=> String
|
707
|
+
# resp.servers[0].engine_version #=> String
|
708
|
+
# resp.servers[0].instance_profile_arn #=> String
|
709
|
+
# resp.servers[0].instance_type #=> String
|
710
|
+
# resp.servers[0].key_pair #=> String
|
711
|
+
# resp.servers[0].maintenance_status #=> String, one of "SUCCESS", "FAILED"
|
712
|
+
# resp.servers[0].preferred_maintenance_window #=> String
|
713
|
+
# resp.servers[0].preferred_backup_window #=> String
|
714
|
+
# resp.servers[0].security_group_ids #=> Array
|
715
|
+
# resp.servers[0].security_group_ids[0] #=> String
|
716
|
+
# resp.servers[0].service_role_arn #=> String
|
717
|
+
# resp.servers[0].status #=> String, one of "BACKING_UP", "CONNECTION_LOST", "CREATING", "DELETING", "MODIFYING", "FAILED", "HEALTHY", "RUNNING", "SETUP", "UNDER_MAINTENANCE", "UNHEALTHY"
|
718
|
+
# resp.servers[0].status_reason #=> String
|
719
|
+
# resp.servers[0].subnet_ids #=> Array
|
720
|
+
# resp.servers[0].subnet_ids[0] #=> String
|
721
|
+
# resp.servers[0].server_arn #=> String
|
722
|
+
# resp.next_token #=> String
|
723
|
+
# @overload describe_servers(params = {})
|
724
|
+
# @param [Hash] params ({})
|
725
|
+
def describe_servers(params = {}, options = {})
|
726
|
+
req = build_request(:describe_servers, params)
|
727
|
+
req.send_request(options)
|
728
|
+
end
|
729
|
+
|
730
|
+
# @option params [required, String] :server_name
|
731
|
+
# @option params [required, String] :node_name
|
732
|
+
# @option params [Array<Types::EngineAttribute>] :engine_attributes
|
733
|
+
# @return [Types::DisassociateNodeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
734
|
+
#
|
735
|
+
# * {Types::DisassociateNodeResponse#node_association_status_token #NodeAssociationStatusToken} => String
|
736
|
+
#
|
737
|
+
# @example Request syntax with placeholder values
|
738
|
+
# resp = client.disassociate_node({
|
739
|
+
# server_name: "ServerName", # required
|
740
|
+
# node_name: "NodeName", # required
|
741
|
+
# engine_attributes: [
|
742
|
+
# {
|
743
|
+
# name: "String",
|
744
|
+
# value: "String",
|
745
|
+
# },
|
746
|
+
# ],
|
747
|
+
# })
|
748
|
+
#
|
749
|
+
# @example Response structure
|
750
|
+
# resp.node_association_status_token #=> String
|
751
|
+
# @overload disassociate_node(params = {})
|
752
|
+
# @param [Hash] params ({})
|
753
|
+
def disassociate_node(params = {}, options = {})
|
754
|
+
req = build_request(:disassociate_node, params)
|
755
|
+
req.send_request(options)
|
756
|
+
end
|
757
|
+
|
758
|
+
# Restores a backup to a server that is in a `RUNNING`, `FAILED`, or
|
759
|
+
# `HEALTHY` state. When you run RestoreServer, the server's EC2
|
760
|
+
# instance is deleted, and a new EC2 instance is configured.
|
761
|
+
# RestoreServer maintains the existing server endpoint, so configuration
|
762
|
+
# management of all of the server's client devices should continue to
|
763
|
+
# work.
|
764
|
+
#
|
765
|
+
# This operation is asynchronous.
|
766
|
+
#
|
767
|
+
# A `InvalidStateException` is thrown when the server is not in a valid
|
768
|
+
# state. A `ResourceNotFoundException` is thrown when the server does
|
769
|
+
# not exist. A `ValidationException` is raised when parameters of the
|
770
|
+
# request are invalid.
|
771
|
+
# @option params [required, String] :backup_id
|
772
|
+
# The ID of the backup that you want to use to restore a server.
|
773
|
+
# @option params [required, String] :server_name
|
774
|
+
# The name of the server that you want to restore.
|
775
|
+
# @option params [String] :instance_type
|
776
|
+
# The type of the instance to create. Valid values must be specified in
|
777
|
+
# the following format: `^([cm][34]|t2).*` For example, `c3.large`. If
|
778
|
+
# you do not specify this parameter, RestoreServer uses the instance
|
779
|
+
# type from the specified backup.
|
780
|
+
# @option params [String] :key_pair
|
781
|
+
# The name of the key pair to set on the new EC2 instance. This can be
|
782
|
+
# helpful if any of the administrators who manage the server no longer
|
783
|
+
# have the SSH key.
|
784
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
785
|
+
#
|
786
|
+
# @example Request syntax with placeholder values
|
787
|
+
# resp = client.restore_server({
|
788
|
+
# backup_id: "BackupId", # required
|
789
|
+
# server_name: "ServerName", # required
|
790
|
+
# instance_type: "String",
|
791
|
+
# key_pair: "KeyPair",
|
792
|
+
# })
|
793
|
+
# @overload restore_server(params = {})
|
794
|
+
# @param [Hash] params ({})
|
795
|
+
def restore_server(params = {}, options = {})
|
796
|
+
req = build_request(:restore_server, params)
|
797
|
+
req.send_request(options)
|
798
|
+
end
|
799
|
+
|
800
|
+
# Manually starts server maintenance. This command can be useful if an
|
801
|
+
# earlier maintenance attempt failed, and the underlying cause of
|
802
|
+
# maintenance failure has been resolved. The server will switch to
|
803
|
+
# `UNDER_MAINTENANCE` state, while maintenace is in progress.
|
804
|
+
#
|
805
|
+
# Maintenace can only be started for `HEALTHY` and `UNHEALTHY` servers.
|
806
|
+
# A `InvalidStateException` is thrown otherwise. A
|
807
|
+
# `ResourceNotFoundException` is thrown when the server does not exist.
|
808
|
+
# A `ValidationException` is raised when parameters of the request are
|
809
|
+
# invalid.
|
810
|
+
# @option params [required, String] :server_name
|
811
|
+
# The name of the server on which to run maintenance.
|
812
|
+
# @return [Types::StartMaintenanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
813
|
+
#
|
814
|
+
# * {Types::StartMaintenanceResponse#server #Server} => Types::Server
|
815
|
+
#
|
816
|
+
# @example Request syntax with placeholder values
|
817
|
+
# resp = client.start_maintenance({
|
818
|
+
# server_name: "ServerName", # required
|
819
|
+
# })
|
820
|
+
#
|
821
|
+
# @example Response structure
|
822
|
+
# resp.server.backup_retention_count #=> Integer
|
823
|
+
# resp.server.server_name #=> String
|
824
|
+
# resp.server.created_at #=> Time
|
825
|
+
# resp.server.disable_automated_backup #=> Boolean
|
826
|
+
# resp.server.endpoint #=> String
|
827
|
+
# resp.server.engine #=> String
|
828
|
+
# resp.server.engine_model #=> String
|
829
|
+
# resp.server.engine_attributes #=> Array
|
830
|
+
# resp.server.engine_attributes[0].name #=> String
|
831
|
+
# resp.server.engine_attributes[0].value #=> String
|
832
|
+
# resp.server.engine_version #=> String
|
833
|
+
# resp.server.instance_profile_arn #=> String
|
834
|
+
# resp.server.instance_type #=> String
|
835
|
+
# resp.server.key_pair #=> String
|
836
|
+
# resp.server.maintenance_status #=> String, one of "SUCCESS", "FAILED"
|
837
|
+
# resp.server.preferred_maintenance_window #=> String
|
838
|
+
# resp.server.preferred_backup_window #=> String
|
839
|
+
# resp.server.security_group_ids #=> Array
|
840
|
+
# resp.server.security_group_ids[0] #=> String
|
841
|
+
# resp.server.service_role_arn #=> String
|
842
|
+
# resp.server.status #=> String, one of "BACKING_UP", "CONNECTION_LOST", "CREATING", "DELETING", "MODIFYING", "FAILED", "HEALTHY", "RUNNING", "SETUP", "UNDER_MAINTENANCE", "UNHEALTHY"
|
843
|
+
# resp.server.status_reason #=> String
|
844
|
+
# resp.server.subnet_ids #=> Array
|
845
|
+
# resp.server.subnet_ids[0] #=> String
|
846
|
+
# resp.server.server_arn #=> String
|
847
|
+
# @overload start_maintenance(params = {})
|
848
|
+
# @param [Hash] params ({})
|
849
|
+
def start_maintenance(params = {}, options = {})
|
850
|
+
req = build_request(:start_maintenance, params)
|
851
|
+
req.send_request(options)
|
852
|
+
end
|
853
|
+
|
854
|
+
# Updates settings for a server.
|
855
|
+
#
|
856
|
+
# This operation is synchronous.
|
857
|
+
# @option params [Boolean] :disable_automated_backup
|
858
|
+
# Setting DisableAutomatedBackup to `true` disables automated or
|
859
|
+
# scheduled backups. Automated backups are enabled by default.
|
860
|
+
# @option params [Integer] :backup_retention_count
|
861
|
+
# Sets the number of automated backups that you want to keep.
|
862
|
+
# @option params [required, String] :server_name
|
863
|
+
# The name of the server to update.
|
864
|
+
# @option params [String] :preferred_maintenance_window
|
865
|
+
# `DDD:HH:MM` (weekly start time) or `HH:MM` (daily start time).
|
866
|
+
#
|
867
|
+
# Time windows always use coordinated universal time (UTC).
|
868
|
+
#
|
869
|
+
# Valid strings for day of week (`DDD`) are: Mon, Tue, Wed, Thr, Fri,
|
870
|
+
# Sat, Sun.
|
871
|
+
# @option params [String] :preferred_backup_window
|
872
|
+
# `DDD:HH:MM` (weekly start time) or `HH:MM` (daily start time).
|
873
|
+
#
|
874
|
+
# Time windows always use coordinated universal time (UTC).
|
875
|
+
#
|
876
|
+
# Valid strings for day of week (`DDD`) are: Mon, Tue, Wed, Thr, Fri,
|
877
|
+
# Sat, Sun.
|
878
|
+
# @return [Types::UpdateServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
879
|
+
#
|
880
|
+
# * {Types::UpdateServerResponse#server #Server} => Types::Server
|
881
|
+
#
|
882
|
+
# @example Request syntax with placeholder values
|
883
|
+
# resp = client.update_server({
|
884
|
+
# disable_automated_backup: false,
|
885
|
+
# backup_retention_count: 1,
|
886
|
+
# server_name: "ServerName", # required
|
887
|
+
# preferred_maintenance_window: "TimeWindowDefinition",
|
888
|
+
# preferred_backup_window: "TimeWindowDefinition",
|
889
|
+
# })
|
890
|
+
#
|
891
|
+
# @example Response structure
|
892
|
+
# resp.server.backup_retention_count #=> Integer
|
893
|
+
# resp.server.server_name #=> String
|
894
|
+
# resp.server.created_at #=> Time
|
895
|
+
# resp.server.disable_automated_backup #=> Boolean
|
896
|
+
# resp.server.endpoint #=> String
|
897
|
+
# resp.server.engine #=> String
|
898
|
+
# resp.server.engine_model #=> String
|
899
|
+
# resp.server.engine_attributes #=> Array
|
900
|
+
# resp.server.engine_attributes[0].name #=> String
|
901
|
+
# resp.server.engine_attributes[0].value #=> String
|
902
|
+
# resp.server.engine_version #=> String
|
903
|
+
# resp.server.instance_profile_arn #=> String
|
904
|
+
# resp.server.instance_type #=> String
|
905
|
+
# resp.server.key_pair #=> String
|
906
|
+
# resp.server.maintenance_status #=> String, one of "SUCCESS", "FAILED"
|
907
|
+
# resp.server.preferred_maintenance_window #=> String
|
908
|
+
# resp.server.preferred_backup_window #=> String
|
909
|
+
# resp.server.security_group_ids #=> Array
|
910
|
+
# resp.server.security_group_ids[0] #=> String
|
911
|
+
# resp.server.service_role_arn #=> String
|
912
|
+
# resp.server.status #=> String, one of "BACKING_UP", "CONNECTION_LOST", "CREATING", "DELETING", "MODIFYING", "FAILED", "HEALTHY", "RUNNING", "SETUP", "UNDER_MAINTENANCE", "UNHEALTHY"
|
913
|
+
# resp.server.status_reason #=> String
|
914
|
+
# resp.server.subnet_ids #=> Array
|
915
|
+
# resp.server.subnet_ids[0] #=> String
|
916
|
+
# resp.server.server_arn #=> String
|
917
|
+
# @overload update_server(params = {})
|
918
|
+
# @param [Hash] params ({})
|
919
|
+
def update_server(params = {}, options = {})
|
920
|
+
req = build_request(:update_server, params)
|
921
|
+
req.send_request(options)
|
922
|
+
end
|
923
|
+
|
924
|
+
# Updates engine specific attributes on a specified server. Server will
|
925
|
+
# enter the `MODIFYING` state when this operation is in progress. Only
|
926
|
+
# one update can take place at a time.
|
927
|
+
#
|
928
|
+
# This operation can be use to reset Chef Server main API key
|
929
|
+
# (`CHEF_PIVOTAL_KEY`).
|
930
|
+
#
|
931
|
+
# This operation is asynchronous.
|
932
|
+
#
|
933
|
+
#
|
934
|
+
#
|
935
|
+
# This operation can only be called for `HEALTHY` and `UNHEALTHY`
|
936
|
+
# servers. Otherwise a `InvalidStateException` is raised. A
|
937
|
+
# `ResourceNotFoundException` is thrown when the server does not exist.
|
938
|
+
# A `ValidationException` is raised when parameters of the request are
|
939
|
+
# invalid.
|
940
|
+
# @option params [required, String] :server_name
|
941
|
+
# The name of the server to update.
|
942
|
+
# @option params [required, String] :attribute_name
|
943
|
+
# The name of the engine attribute to update.
|
944
|
+
# @option params [String] :attribute_value
|
945
|
+
# The value to set for the attribute.
|
946
|
+
# @return [Types::UpdateServerEngineAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
947
|
+
#
|
948
|
+
# * {Types::UpdateServerEngineAttributesResponse#server #Server} => Types::Server
|
949
|
+
#
|
950
|
+
# @example Request syntax with placeholder values
|
951
|
+
# resp = client.update_server_engine_attributes({
|
952
|
+
# server_name: "ServerName", # required
|
953
|
+
# attribute_name: "AttributeName", # required
|
954
|
+
# attribute_value: "AttributeValue",
|
955
|
+
# })
|
956
|
+
#
|
957
|
+
# @example Response structure
|
958
|
+
# resp.server.backup_retention_count #=> Integer
|
959
|
+
# resp.server.server_name #=> String
|
960
|
+
# resp.server.created_at #=> Time
|
961
|
+
# resp.server.disable_automated_backup #=> Boolean
|
962
|
+
# resp.server.endpoint #=> String
|
963
|
+
# resp.server.engine #=> String
|
964
|
+
# resp.server.engine_model #=> String
|
965
|
+
# resp.server.engine_attributes #=> Array
|
966
|
+
# resp.server.engine_attributes[0].name #=> String
|
967
|
+
# resp.server.engine_attributes[0].value #=> String
|
968
|
+
# resp.server.engine_version #=> String
|
969
|
+
# resp.server.instance_profile_arn #=> String
|
970
|
+
# resp.server.instance_type #=> String
|
971
|
+
# resp.server.key_pair #=> String
|
972
|
+
# resp.server.maintenance_status #=> String, one of "SUCCESS", "FAILED"
|
973
|
+
# resp.server.preferred_maintenance_window #=> String
|
974
|
+
# resp.server.preferred_backup_window #=> String
|
975
|
+
# resp.server.security_group_ids #=> Array
|
976
|
+
# resp.server.security_group_ids[0] #=> String
|
977
|
+
# resp.server.service_role_arn #=> String
|
978
|
+
# resp.server.status #=> String, one of "BACKING_UP", "CONNECTION_LOST", "CREATING", "DELETING", "MODIFYING", "FAILED", "HEALTHY", "RUNNING", "SETUP", "UNDER_MAINTENANCE", "UNHEALTHY"
|
979
|
+
# resp.server.status_reason #=> String
|
980
|
+
# resp.server.subnet_ids #=> Array
|
981
|
+
# resp.server.subnet_ids[0] #=> String
|
982
|
+
# resp.server.server_arn #=> String
|
983
|
+
# @overload update_server_engine_attributes(params = {})
|
984
|
+
# @param [Hash] params ({})
|
985
|
+
def update_server_engine_attributes(params = {}, options = {})
|
986
|
+
req = build_request(:update_server_engine_attributes, params)
|
987
|
+
req.send_request(options)
|
988
|
+
end
|
989
|
+
|
990
|
+
# @!endgroup
|
991
|
+
|
992
|
+
# @param params ({})
|
993
|
+
# @api private
|
994
|
+
def build_request(operation_name, params = {})
|
995
|
+
handlers = @handlers.for(operation_name)
|
996
|
+
context = Seahorse::Client::RequestContext.new(
|
997
|
+
operation_name: operation_name,
|
998
|
+
operation: config.api.operation(operation_name),
|
999
|
+
client: self,
|
1000
|
+
params: params,
|
1001
|
+
config: config)
|
1002
|
+
context[:gem_name] = 'aws-sdk-opsworkscm'
|
1003
|
+
context[:gem_version] = '1.0.0.rc2'
|
1004
|
+
Seahorse::Client::Request.new(handlers, context)
|
1005
|
+
end
|
1006
|
+
|
1007
|
+
# @api private
|
1008
|
+
# @deprecated
|
1009
|
+
def waiter_names
|
1010
|
+
[]
|
1011
|
+
end
|
1012
|
+
|
1013
|
+
class << self
|
1014
|
+
|
1015
|
+
# @api private
|
1016
|
+
attr_reader :identifier
|
1017
|
+
|
1018
|
+
# @api private
|
1019
|
+
def errors_module
|
1020
|
+
Errors
|
1021
|
+
end
|
1022
|
+
|
1023
|
+
end
|
1024
|
+
end
|
1025
|
+
end
|
1026
|
+
end
|