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