aws-sdk-opsworkscm 1.0.0.rc2 → 1.0.0.rc3
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 +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
@@ -1,23 +1,14 @@
|
|
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
|
7
7
|
|
8
|
-
module Aws
|
9
|
-
module
|
10
|
-
module Errors
|
8
|
+
module Aws::OpsWorksCM
|
9
|
+
module Errors
|
11
10
|
|
12
|
-
|
11
|
+
extend Aws::Errors::DynamicErrors
|
13
12
|
|
14
|
-
# Raised when calling #load or #data on a resource class that can not be
|
15
|
-
# loaded. This can happen when:
|
16
|
-
#
|
17
|
-
# * A resource class has identifiers, but no data attributes.
|
18
|
-
# * Resource data is only available when making an API call that
|
19
|
-
# enumerates all resources of that type.
|
20
|
-
class ResourceNotLoadable < RuntimeError; end
|
21
|
-
end
|
22
13
|
end
|
23
14
|
end
|
@@ -1,25 +1,23 @@
|
|
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
|
7
7
|
|
8
|
-
module Aws
|
9
|
-
|
10
|
-
class Resource
|
8
|
+
module Aws::OpsWorksCM
|
9
|
+
class Resource
|
11
10
|
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
# @return [Client]
|
19
|
-
def client
|
20
|
-
@client
|
21
|
-
end
|
11
|
+
# @param options ({})
|
12
|
+
# @option options [Client] :client
|
13
|
+
def initialize(options = {})
|
14
|
+
@client = options[:client] || Client.new(options)
|
15
|
+
end
|
22
16
|
|
17
|
+
# @return [Client]
|
18
|
+
def client
|
19
|
+
@client
|
23
20
|
end
|
21
|
+
|
24
22
|
end
|
25
23
|
end
|
@@ -1,1069 +1,1253 @@
|
|
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
|
7
7
|
|
8
|
-
module Aws
|
9
|
-
module
|
10
|
-
module Types
|
8
|
+
module Aws::OpsWorksCM
|
9
|
+
module Types
|
11
10
|
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
# {
|
43
|
-
# server_name: "ServerName", # required
|
44
|
-
# node_name: "NodeName", # required
|
45
|
-
# engine_attributes: [
|
46
|
-
# {
|
47
|
-
# name: "String",
|
48
|
-
# value: "String",
|
49
|
-
# },
|
50
|
-
# ],
|
51
|
-
# }
|
52
|
-
# @!attribute [rw] server_name
|
53
|
-
# @return [String]
|
54
|
-
#
|
55
|
-
# @!attribute [rw] node_name
|
56
|
-
# @return [String]
|
57
|
-
#
|
58
|
-
# @!attribute [rw] engine_attributes
|
59
|
-
# @return [Array<Types::EngineAttribute>]
|
60
|
-
class AssociateNodeRequest < Struct.new(
|
61
|
-
:server_name,
|
62
|
-
:node_name,
|
63
|
-
:engine_attributes)
|
64
|
-
include Aws::Structure
|
65
|
-
end
|
11
|
+
# Stores account attributes.
|
12
|
+
#
|
13
|
+
# @!attribute [rw] name
|
14
|
+
# The attribute name. The following are supported attribute names.
|
15
|
+
#
|
16
|
+
# * *ServerLimit:* The number of current servers/maximum number of
|
17
|
+
# servers allowed. By default, you can have a maximum of 10 servers.
|
18
|
+
#
|
19
|
+
# * *ManualBackupLimit:* The number of current manual backups/maximum
|
20
|
+
# number of backups allowed. By default, you can have a maximum of
|
21
|
+
# 50 manual backups saved.
|
22
|
+
# @return [String]
|
23
|
+
#
|
24
|
+
# @!attribute [rw] maximum
|
25
|
+
# The maximum allowed value.
|
26
|
+
# @return [Integer]
|
27
|
+
#
|
28
|
+
# @!attribute [rw] used
|
29
|
+
# The current usage, such as the current number of servers that are
|
30
|
+
# associated with the account.
|
31
|
+
# @return [Integer]
|
32
|
+
#
|
33
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/AccountAttribute AWS API Documentation
|
34
|
+
#
|
35
|
+
class AccountAttribute < Struct.new(
|
36
|
+
:name,
|
37
|
+
:maximum,
|
38
|
+
:used)
|
39
|
+
include Aws::Structure
|
40
|
+
end
|
66
41
|
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
42
|
+
# @note When making an API call, you may pass AssociateNodeRequest
|
43
|
+
# data as a hash:
|
44
|
+
#
|
45
|
+
# {
|
46
|
+
# server_name: "ServerName", # required
|
47
|
+
# node_name: "NodeName", # required
|
48
|
+
# engine_attributes: [ # required
|
49
|
+
# {
|
50
|
+
# name: "EngineAttributeName",
|
51
|
+
# value: "EngineAttributeValue",
|
52
|
+
# },
|
53
|
+
# ],
|
54
|
+
# }
|
55
|
+
#
|
56
|
+
# @!attribute [rw] server_name
|
57
|
+
# The name of the server with which to associate the node.
|
58
|
+
# @return [String]
|
59
|
+
#
|
60
|
+
# @!attribute [rw] node_name
|
61
|
+
# The name of the Chef client node.
|
62
|
+
# @return [String]
|
63
|
+
#
|
64
|
+
# @!attribute [rw] engine_attributes
|
65
|
+
# Engine attributes used for associating the node.
|
66
|
+
#
|
67
|
+
# **Attributes accepted in a AssociateNode request:**
|
68
|
+
#
|
69
|
+
# * `CHEF_ORGANIZATION`\: The Chef organization with which the node is
|
70
|
+
# associated. By default only one organization named `default` can
|
71
|
+
# exist.
|
72
|
+
#
|
73
|
+
# * `CHEF_NODE_PUBLIC_KEY`\: A PEM-formatted public key. This key is
|
74
|
+
# required for the `chef-client` agent to access the Chef API.
|
75
|
+
# @return [Array<Types::EngineAttribute>]
|
76
|
+
#
|
77
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/AssociateNodeRequest AWS API Documentation
|
78
|
+
#
|
79
|
+
class AssociateNodeRequest < Struct.new(
|
80
|
+
:server_name,
|
81
|
+
:node_name,
|
82
|
+
:engine_attributes)
|
83
|
+
include Aws::Structure
|
84
|
+
end
|
73
85
|
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
# @return [String]
|
87
|
-
#
|
88
|
-
# @!attribute [rw] created_at
|
89
|
-
# The time stamp when the backup was created in the database. Example:
|
90
|
-
# `2016-07-29T13:38:47.520Z`
|
91
|
-
# @return [Time]
|
92
|
-
#
|
93
|
-
# @!attribute [rw] description
|
94
|
-
# A user-provided description for a manual backup. This field is empty
|
95
|
-
# for automated backups.
|
96
|
-
# @return [String]
|
97
|
-
#
|
98
|
-
# @!attribute [rw] engine
|
99
|
-
# The engine type that is obtained from the server when the backup is
|
100
|
-
# created.
|
101
|
-
# @return [String]
|
102
|
-
#
|
103
|
-
# @!attribute [rw] engine_model
|
104
|
-
# The engine model that is obtained from the server when the backup is
|
105
|
-
# created.
|
106
|
-
# @return [String]
|
107
|
-
#
|
108
|
-
# @!attribute [rw] engine_version
|
109
|
-
# The engine version that is obtained from the server when the backup
|
110
|
-
# is created.
|
111
|
-
# @return [String]
|
112
|
-
#
|
113
|
-
# @!attribute [rw] instance_profile_arn
|
114
|
-
# The EC2 instance profile ARN that is obtained from the server when
|
115
|
-
# the backup is created. Because this value is stored, you are not
|
116
|
-
# required to provide the InstanceProfileArn again if you restore a
|
117
|
-
# backup.
|
118
|
-
# @return [String]
|
119
|
-
#
|
120
|
-
# @!attribute [rw] instance_type
|
121
|
-
# The instance type that is obtained from the server when the backup
|
122
|
-
# is created.
|
123
|
-
# @return [String]
|
124
|
-
#
|
125
|
-
# @!attribute [rw] key_pair
|
126
|
-
# The key pair that is obtained from the server when the backup is
|
127
|
-
# created.
|
128
|
-
# @return [String]
|
129
|
-
#
|
130
|
-
# @!attribute [rw] preferred_backup_window
|
131
|
-
# The preferred backup period that is obtained from the server when
|
132
|
-
# the backup is created.
|
133
|
-
# @return [String]
|
134
|
-
#
|
135
|
-
# @!attribute [rw] preferred_maintenance_window
|
136
|
-
# The preferred maintenance period that is obtained from the server
|
137
|
-
# when the backup is created.
|
138
|
-
# @return [String]
|
139
|
-
#
|
140
|
-
# @!attribute [rw] s3_data_size
|
141
|
-
# The size of the backup, in bytes. The size is returned by the
|
142
|
-
# instance in the command results.
|
143
|
-
# @return [Integer]
|
144
|
-
#
|
145
|
-
# @!attribute [rw] s3_data_url
|
146
|
-
# The Amazon S3 URL of the backup's tar.gz file.
|
147
|
-
# @return [String]
|
148
|
-
#
|
149
|
-
# @!attribute [rw] s3_log_url
|
150
|
-
# The Amazon S3 URL of the backup's log file.
|
151
|
-
# @return [String]
|
152
|
-
#
|
153
|
-
# @!attribute [rw] security_group_ids
|
154
|
-
# The security group IDs that are obtained from the server when the
|
155
|
-
# backup is created.
|
156
|
-
# @return [Array<String>]
|
157
|
-
#
|
158
|
-
# @!attribute [rw] server_name
|
159
|
-
# The name of the server from which the backup was made.
|
160
|
-
# @return [String]
|
161
|
-
#
|
162
|
-
# @!attribute [rw] service_role_arn
|
163
|
-
# The service role ARN that is obtained from the server when the
|
164
|
-
# backup is created.
|
165
|
-
# @return [String]
|
166
|
-
#
|
167
|
-
# @!attribute [rw] status
|
168
|
-
# The status of a backup while in progress.
|
169
|
-
# @return [String]
|
170
|
-
#
|
171
|
-
# @!attribute [rw] status_description
|
172
|
-
# An informational message about backup status.
|
173
|
-
# @return [String]
|
174
|
-
#
|
175
|
-
# @!attribute [rw] subnet_ids
|
176
|
-
# The subnet IDs that are obtained from the server when the backup is
|
177
|
-
# created.
|
178
|
-
# @return [Array<String>]
|
179
|
-
#
|
180
|
-
# @!attribute [rw] tools_version
|
181
|
-
# The version of AWS OpsWorks for Chef Automate-specific tools that is
|
182
|
-
# obtained from the server when the backup is created.
|
183
|
-
# @return [String]
|
184
|
-
#
|
185
|
-
# @!attribute [rw] user_arn
|
186
|
-
# The IAM user ARN of the requester for manual backups. This field is
|
187
|
-
# empty for automated backups.
|
188
|
-
# @return [String]
|
189
|
-
class Backup < Struct.new(
|
190
|
-
:backup_arn,
|
191
|
-
:backup_id,
|
192
|
-
:backup_type,
|
193
|
-
:created_at,
|
194
|
-
:description,
|
195
|
-
:engine,
|
196
|
-
:engine_model,
|
197
|
-
:engine_version,
|
198
|
-
:instance_profile_arn,
|
199
|
-
:instance_type,
|
200
|
-
:key_pair,
|
201
|
-
:preferred_backup_window,
|
202
|
-
:preferred_maintenance_window,
|
203
|
-
:s3_data_size,
|
204
|
-
:s3_data_url,
|
205
|
-
:s3_log_url,
|
206
|
-
:security_group_ids,
|
207
|
-
:server_name,
|
208
|
-
:service_role_arn,
|
209
|
-
:status,
|
210
|
-
:status_description,
|
211
|
-
:subnet_ids,
|
212
|
-
:tools_version,
|
213
|
-
:user_arn)
|
214
|
-
include Aws::Structure
|
215
|
-
end
|
86
|
+
# @!attribute [rw] node_association_status_token
|
87
|
+
# Contains a token which can be passed to the
|
88
|
+
# `DescribeNodeAssociationStatus` API call to get the status of the
|
89
|
+
# association request.
|
90
|
+
# @return [String]
|
91
|
+
#
|
92
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/AssociateNodeResponse AWS API Documentation
|
93
|
+
#
|
94
|
+
class AssociateNodeResponse < Struct.new(
|
95
|
+
:node_association_status_token)
|
96
|
+
include Aws::Structure
|
97
|
+
end
|
216
98
|
|
217
|
-
|
218
|
-
|
219
|
-
|
220
|
-
|
221
|
-
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
99
|
+
# Describes a single backup.
|
100
|
+
#
|
101
|
+
# @!attribute [rw] backup_arn
|
102
|
+
# The ARN of the backup.
|
103
|
+
# @return [String]
|
104
|
+
#
|
105
|
+
# @!attribute [rw] backup_id
|
106
|
+
# The generated ID of the backup. Example:
|
107
|
+
# `myServerName-yyyyMMddHHmmssSSS`
|
108
|
+
# @return [String]
|
109
|
+
#
|
110
|
+
# @!attribute [rw] backup_type
|
111
|
+
# The backup type. Valid values are `automated` or `manual`.
|
112
|
+
# @return [String]
|
113
|
+
#
|
114
|
+
# @!attribute [rw] created_at
|
115
|
+
# The time stamp when the backup was created in the database. Example:
|
116
|
+
# `2016-07-29T13:38:47.520Z`
|
117
|
+
# @return [Time]
|
118
|
+
#
|
119
|
+
# @!attribute [rw] description
|
120
|
+
# A user-provided description for a manual backup. This field is empty
|
121
|
+
# for automated backups.
|
122
|
+
# @return [String]
|
123
|
+
#
|
124
|
+
# @!attribute [rw] engine
|
125
|
+
# The engine type that is obtained from the server when the backup is
|
126
|
+
# created.
|
127
|
+
# @return [String]
|
128
|
+
#
|
129
|
+
# @!attribute [rw] engine_model
|
130
|
+
# The engine model that is obtained from the server when the backup is
|
131
|
+
# created.
|
132
|
+
# @return [String]
|
133
|
+
#
|
134
|
+
# @!attribute [rw] engine_version
|
135
|
+
# The engine version that is obtained from the server when the backup
|
136
|
+
# is created.
|
137
|
+
# @return [String]
|
138
|
+
#
|
139
|
+
# @!attribute [rw] instance_profile_arn
|
140
|
+
# The EC2 instance profile ARN that is obtained from the server when
|
141
|
+
# the backup is created. Because this value is stored, you are not
|
142
|
+
# required to provide the InstanceProfileArn again if you restore a
|
143
|
+
# backup.
|
144
|
+
# @return [String]
|
145
|
+
#
|
146
|
+
# @!attribute [rw] instance_type
|
147
|
+
# The instance type that is obtained from the server when the backup
|
148
|
+
# is created.
|
149
|
+
# @return [String]
|
150
|
+
#
|
151
|
+
# @!attribute [rw] key_pair
|
152
|
+
# The key pair that is obtained from the server when the backup is
|
153
|
+
# created.
|
154
|
+
# @return [String]
|
155
|
+
#
|
156
|
+
# @!attribute [rw] preferred_backup_window
|
157
|
+
# The preferred backup period that is obtained from the server when
|
158
|
+
# the backup is created.
|
159
|
+
# @return [String]
|
160
|
+
#
|
161
|
+
# @!attribute [rw] preferred_maintenance_window
|
162
|
+
# The preferred maintenance period that is obtained from the server
|
163
|
+
# when the backup is created.
|
164
|
+
# @return [String]
|
165
|
+
#
|
166
|
+
# @!attribute [rw] s3_data_size
|
167
|
+
# This field is deprecated and is no longer used.
|
168
|
+
# @return [Integer]
|
169
|
+
#
|
170
|
+
# @!attribute [rw] s3_data_url
|
171
|
+
# This field is deprecated and is no longer used.
|
172
|
+
# @return [String]
|
173
|
+
#
|
174
|
+
# @!attribute [rw] s3_log_url
|
175
|
+
# The Amazon S3 URL of the backup's log file.
|
176
|
+
# @return [String]
|
177
|
+
#
|
178
|
+
# @!attribute [rw] security_group_ids
|
179
|
+
# The security group IDs that are obtained from the server when the
|
180
|
+
# backup is created.
|
181
|
+
# @return [Array<String>]
|
182
|
+
#
|
183
|
+
# @!attribute [rw] server_name
|
184
|
+
# The name of the server from which the backup was made.
|
185
|
+
# @return [String]
|
186
|
+
#
|
187
|
+
# @!attribute [rw] service_role_arn
|
188
|
+
# The service role ARN that is obtained from the server when the
|
189
|
+
# backup is created.
|
190
|
+
# @return [String]
|
191
|
+
#
|
192
|
+
# @!attribute [rw] status
|
193
|
+
# The status of a backup while in progress.
|
194
|
+
# @return [String]
|
195
|
+
#
|
196
|
+
# @!attribute [rw] status_description
|
197
|
+
# An informational message about backup status.
|
198
|
+
# @return [String]
|
199
|
+
#
|
200
|
+
# @!attribute [rw] subnet_ids
|
201
|
+
# The subnet IDs that are obtained from the server when the backup is
|
202
|
+
# created.
|
203
|
+
# @return [Array<String>]
|
204
|
+
#
|
205
|
+
# @!attribute [rw] tools_version
|
206
|
+
# The version of AWS OpsWorks for Chef Automate-specific tools that is
|
207
|
+
# obtained from the server when the backup is created.
|
208
|
+
# @return [String]
|
209
|
+
#
|
210
|
+
# @!attribute [rw] user_arn
|
211
|
+
# The IAM user ARN of the requester for manual backups. This field is
|
212
|
+
# empty for automated backups.
|
213
|
+
# @return [String]
|
214
|
+
#
|
215
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/Backup AWS API Documentation
|
216
|
+
#
|
217
|
+
class Backup < Struct.new(
|
218
|
+
:backup_arn,
|
219
|
+
:backup_id,
|
220
|
+
:backup_type,
|
221
|
+
:created_at,
|
222
|
+
:description,
|
223
|
+
:engine,
|
224
|
+
:engine_model,
|
225
|
+
:engine_version,
|
226
|
+
:instance_profile_arn,
|
227
|
+
:instance_type,
|
228
|
+
:key_pair,
|
229
|
+
:preferred_backup_window,
|
230
|
+
:preferred_maintenance_window,
|
231
|
+
:s3_data_size,
|
232
|
+
:s3_data_url,
|
233
|
+
:s3_log_url,
|
234
|
+
:security_group_ids,
|
235
|
+
:server_name,
|
236
|
+
:service_role_arn,
|
237
|
+
:status,
|
238
|
+
:status_description,
|
239
|
+
:subnet_ids,
|
240
|
+
:tools_version,
|
241
|
+
:user_arn)
|
242
|
+
include Aws::Structure
|
243
|
+
end
|
236
244
|
|
237
|
-
|
238
|
-
|
239
|
-
|
240
|
-
|
241
|
-
|
242
|
-
|
243
|
-
|
245
|
+
# @note When making an API call, you may pass CreateBackupRequest
|
246
|
+
# data as a hash:
|
247
|
+
#
|
248
|
+
# {
|
249
|
+
# server_name: "ServerName", # required
|
250
|
+
# description: "String",
|
251
|
+
# }
|
252
|
+
#
|
253
|
+
# @!attribute [rw] server_name
|
254
|
+
# The name of the server that you want to back up.
|
255
|
+
# @return [String]
|
256
|
+
#
|
257
|
+
# @!attribute [rw] description
|
258
|
+
# A user-defined description of the backup.
|
259
|
+
# @return [String]
|
260
|
+
#
|
261
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/CreateBackupRequest AWS API Documentation
|
262
|
+
#
|
263
|
+
class CreateBackupRequest < Struct.new(
|
264
|
+
:server_name,
|
265
|
+
:description)
|
266
|
+
include Aws::Structure
|
267
|
+
end
|
244
268
|
|
245
|
-
|
246
|
-
|
247
|
-
|
248
|
-
|
249
|
-
|
250
|
-
|
251
|
-
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
# name: "String",
|
256
|
-
# value: "String",
|
257
|
-
# },
|
258
|
-
# ],
|
259
|
-
# backup_retention_count: 1,
|
260
|
-
# server_name: "ServerName", # required
|
261
|
-
# instance_profile_arn: "InstanceProfileArn", # required
|
262
|
-
# instance_type: "String",
|
263
|
-
# key_pair: "KeyPair",
|
264
|
-
# preferred_maintenance_window: "TimeWindowDefinition",
|
265
|
-
# preferred_backup_window: "TimeWindowDefinition",
|
266
|
-
# security_group_ids: ["String"],
|
267
|
-
# service_role_arn: "ServiceRoleArn", # required
|
268
|
-
# subnet_ids: ["String"],
|
269
|
-
# backup_id: "BackupId",
|
270
|
-
# }
|
271
|
-
# @!attribute [rw] disable_automated_backup
|
272
|
-
# Enable or disable scheduled backups. Valid values are `true` or
|
273
|
-
# `false`. The default value is `true`.
|
274
|
-
# @return [Boolean]
|
275
|
-
#
|
276
|
-
# @!attribute [rw] engine
|
277
|
-
# The configuration management engine to use. Valid values include
|
278
|
-
# `Chef`.
|
279
|
-
# @return [String]
|
280
|
-
#
|
281
|
-
# @!attribute [rw] engine_model
|
282
|
-
# The engine model, or option. Valid values include `Single`.
|
283
|
-
# @return [String]
|
284
|
-
#
|
285
|
-
# @!attribute [rw] engine_version
|
286
|
-
# The major release version of the engine that you want to use. Values
|
287
|
-
# depend on the engine that you choose.
|
288
|
-
# @return [String]
|
289
|
-
#
|
290
|
-
# @!attribute [rw] engine_attributes
|
291
|
-
# Engine attributes on a specified server.
|
292
|
-
#
|
293
|
-
# **Attributes accepted in a createServer request:**
|
294
|
-
#
|
295
|
-
# * `CHEF_PIVOTAL_KEY`\: A base64-encoded RSA private key that is not
|
296
|
-
# stored by AWS OpsWorks for Chef Automate. This private key is
|
297
|
-
# required to access the Chef API.
|
298
|
-
#
|
299
|
-
# ^
|
300
|
-
# @return [Array<Types::EngineAttribute>]
|
301
|
-
#
|
302
|
-
# @!attribute [rw] backup_retention_count
|
303
|
-
# The number of automated backups that you want to keep. Whenever a
|
304
|
-
# new backup is created, AWS OpsWorks for Chef Automate deletes the
|
305
|
-
# oldest backups if this number is exceeded. The default value is `1`.
|
306
|
-
# @return [Integer]
|
307
|
-
#
|
308
|
-
# @!attribute [rw] server_name
|
309
|
-
# The name of the server. The server name must be unique within your
|
310
|
-
# AWS account, within each region. Server names must start with a
|
311
|
-
# letter; then letters, numbers, or hyphens (-) are allowed, up to a
|
312
|
-
# maximum of 32 characters.
|
313
|
-
# @return [String]
|
314
|
-
#
|
315
|
-
# @!attribute [rw] instance_profile_arn
|
316
|
-
# The ARN of the instance profile that your Amazon EC2 instances use.
|
317
|
-
# Although the AWS OpsWorks console typically creates the instance
|
318
|
-
# profile for you, in this release of AWS OpsWorks for Chef Automate,
|
319
|
-
# run the service-role-creation.yaml AWS CloudFormation template,
|
320
|
-
# located at
|
321
|
-
# https://s3.amazonaws.com/opsworks-stuff/latest/service-role-creation.yaml.
|
322
|
-
# This template creates a stack that includes the instance profile you
|
323
|
-
# need.
|
324
|
-
# @return [String]
|
325
|
-
#
|
326
|
-
# @!attribute [rw] instance_type
|
327
|
-
# The Amazon EC2 instance type to use. Valid values must be specified
|
328
|
-
# in the following format: `^([cm][34]|t2).*` For example, `c3.large`.
|
329
|
-
# @return [String]
|
330
|
-
#
|
331
|
-
# @!attribute [rw] key_pair
|
332
|
-
# The Amazon EC2 key pair to set for the instance. You may specify
|
333
|
-
# this parameter to connect to your instances by using SSH.
|
334
|
-
# @return [String]
|
335
|
-
#
|
336
|
-
# @!attribute [rw] preferred_maintenance_window
|
337
|
-
# The start time for a one-hour period each week during which AWS
|
338
|
-
# OpsWorks for Chef Automate performs maintenance on the instance.
|
339
|
-
# Valid values must be specified in the following format: `DDD:HH:MM`.
|
340
|
-
# The specified time is in coordinated universal time (UTC). The
|
341
|
-
# default value is a random one-hour period on Tuesday, Wednesday, or
|
342
|
-
# Friday. See `TimeWindowDefinition` for more information.
|
343
|
-
#
|
344
|
-
# **Example:** `Mon:08:00`, which represents a start time of every
|
345
|
-
# Monday at 08:00 UTC. (8:00 a.m.)
|
346
|
-
# @return [String]
|
347
|
-
#
|
348
|
-
# @!attribute [rw] preferred_backup_window
|
349
|
-
# The start time for a one-hour period during which AWS OpsWorks for
|
350
|
-
# Chef Automate backs up application-level data on your server if
|
351
|
-
# backups are enabled. Valid values must be specified in one of the
|
352
|
-
# following formats:
|
353
|
-
#
|
354
|
-
# * `HH:MM` for daily backups
|
355
|
-
#
|
356
|
-
# * `DDD:HH:MM` for weekly backups
|
357
|
-
#
|
358
|
-
# The specified time is in coordinated universal time (UTC). The
|
359
|
-
# default value is a random, daily start time.
|
360
|
-
#
|
361
|
-
# **Example:** `08:00`, which represents a daily start time of 08:00
|
362
|
-
# UTC.
|
363
|
-
#
|
364
|
-
# **Example:** `Mon:08:00`, which represents a start time of every
|
365
|
-
# Monday at 08:00 UTC. (8:00 a.m.)
|
366
|
-
# @return [String]
|
367
|
-
#
|
368
|
-
# @!attribute [rw] security_group_ids
|
369
|
-
# A list of security group IDs to attach to the Amazon EC2 instance.
|
370
|
-
# If you add this parameter, the specified security groups must be
|
371
|
-
# within the VPC that is specified by `SubnetIds`.
|
372
|
-
#
|
373
|
-
# If you do not specify this parameter, AWS OpsWorks for Chef Automate
|
374
|
-
# creates one new security group that uses TCP ports 22 and 443, open
|
375
|
-
# to 0.0.0.0/0 (everyone).
|
376
|
-
# @return [Array<String>]
|
377
|
-
#
|
378
|
-
# @!attribute [rw] service_role_arn
|
379
|
-
# The service role that the AWS OpsWorks for Chef Automate service
|
380
|
-
# backend uses to work with your account. Although the AWS OpsWorks
|
381
|
-
# console typically creates the service role for you, in this release
|
382
|
-
# of AWS OpsWorks for Chef Automate, run the
|
383
|
-
# service-role-creation.yaml AWS CloudFormation template, located at
|
384
|
-
# https://s3.amazonaws.com/opsworks-stuff/latest/service-role-creation.yaml.
|
385
|
-
# This template creates a stack that includes the service role that
|
386
|
-
# you need.
|
387
|
-
# @return [String]
|
388
|
-
#
|
389
|
-
# @!attribute [rw] subnet_ids
|
390
|
-
# The IDs of subnets in which to launch the server EC2 instance.
|
391
|
-
#
|
392
|
-
# Amazon EC2-Classic customers: This field is required. All servers
|
393
|
-
# must run within a VPC. The VPC must have "Auto Assign Public IP"
|
394
|
-
# enabled.
|
395
|
-
#
|
396
|
-
# EC2-VPC customers: This field is optional. If you do not specify
|
397
|
-
# subnet IDs, your EC2 instances are created in a default subnet that
|
398
|
-
# is selected by Amazon EC2. If you specify subnet IDs, the VPC must
|
399
|
-
# have "Auto Assign Public IP" enabled.
|
400
|
-
#
|
401
|
-
# For more information about supported Amazon EC2 platforms, see
|
402
|
-
# [Supported Platforms][1].
|
403
|
-
#
|
404
|
-
#
|
405
|
-
#
|
406
|
-
# [1]: http://docs.aws.amazon.com/https:/docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html
|
407
|
-
# @return [Array<String>]
|
408
|
-
#
|
409
|
-
# @!attribute [rw] backup_id
|
410
|
-
# If you specify this field, AWS OpsWorks for Chef Automate creates
|
411
|
-
# the server by using the backup represented by BackupId.
|
412
|
-
# @return [String]
|
413
|
-
class CreateServerRequest < Struct.new(
|
414
|
-
:disable_automated_backup,
|
415
|
-
:engine,
|
416
|
-
:engine_model,
|
417
|
-
:engine_version,
|
418
|
-
:engine_attributes,
|
419
|
-
:backup_retention_count,
|
420
|
-
:server_name,
|
421
|
-
:instance_profile_arn,
|
422
|
-
:instance_type,
|
423
|
-
:key_pair,
|
424
|
-
:preferred_maintenance_window,
|
425
|
-
:preferred_backup_window,
|
426
|
-
:security_group_ids,
|
427
|
-
:service_role_arn,
|
428
|
-
:subnet_ids,
|
429
|
-
:backup_id)
|
430
|
-
include Aws::Structure
|
431
|
-
end
|
269
|
+
# @!attribute [rw] backup
|
270
|
+
# Backup created by request.
|
271
|
+
# @return [Types::Backup]
|
272
|
+
#
|
273
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/CreateBackupResponse AWS API Documentation
|
274
|
+
#
|
275
|
+
class CreateBackupResponse < Struct.new(
|
276
|
+
:backup)
|
277
|
+
include Aws::Structure
|
278
|
+
end
|
432
279
|
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
280
|
+
# @note When making an API call, you may pass CreateServerRequest
|
281
|
+
# data as a hash:
|
282
|
+
#
|
283
|
+
# {
|
284
|
+
# associate_public_ip_address: false,
|
285
|
+
# disable_automated_backup: false,
|
286
|
+
# engine: "String",
|
287
|
+
# engine_model: "String",
|
288
|
+
# engine_version: "String",
|
289
|
+
# engine_attributes: [
|
290
|
+
# {
|
291
|
+
# name: "EngineAttributeName",
|
292
|
+
# value: "EngineAttributeValue",
|
293
|
+
# },
|
294
|
+
# ],
|
295
|
+
# backup_retention_count: 1,
|
296
|
+
# server_name: "ServerName", # required
|
297
|
+
# instance_profile_arn: "InstanceProfileArn", # required
|
298
|
+
# instance_type: "String", # required
|
299
|
+
# key_pair: "KeyPair",
|
300
|
+
# preferred_maintenance_window: "TimeWindowDefinition",
|
301
|
+
# preferred_backup_window: "TimeWindowDefinition",
|
302
|
+
# security_group_ids: ["String"],
|
303
|
+
# service_role_arn: "ServiceRoleArn", # required
|
304
|
+
# subnet_ids: ["String"],
|
305
|
+
# backup_id: "BackupId",
|
306
|
+
# }
|
307
|
+
#
|
308
|
+
# @!attribute [rw] associate_public_ip_address
|
309
|
+
# Associate a public IP address with a server that you are launching.
|
310
|
+
# Valid values are `true` or `false`. The default value is `true`.
|
311
|
+
# @return [Boolean]
|
312
|
+
#
|
313
|
+
# @!attribute [rw] disable_automated_backup
|
314
|
+
# Enable or disable scheduled backups. Valid values are `true` or
|
315
|
+
# `false`. The default value is `true`.
|
316
|
+
# @return [Boolean]
|
317
|
+
#
|
318
|
+
# @!attribute [rw] engine
|
319
|
+
# The configuration management engine to use. Valid values include
|
320
|
+
# `Chef`.
|
321
|
+
# @return [String]
|
322
|
+
#
|
323
|
+
# @!attribute [rw] engine_model
|
324
|
+
# The engine model, or option. Valid values include `Single`.
|
325
|
+
# @return [String]
|
326
|
+
#
|
327
|
+
# @!attribute [rw] engine_version
|
328
|
+
# The major release version of the engine that you want to use. Values
|
329
|
+
# depend on the engine that you choose.
|
330
|
+
# @return [String]
|
331
|
+
#
|
332
|
+
# @!attribute [rw] engine_attributes
|
333
|
+
# Optional engine attributes on a specified server.
|
334
|
+
#
|
335
|
+
# **Attributes accepted in a createServer request:**
|
336
|
+
#
|
337
|
+
# * `CHEF_PIVOTAL_KEY`\: A base64-encoded RSA private key that is not
|
338
|
+
# stored by AWS OpsWorks for Chef. This private key is required to
|
339
|
+
# access the Chef API. When no CHEF\_PIVOTAL\_KEY is set, one is
|
340
|
+
# generated and returned in the response.
|
341
|
+
#
|
342
|
+
# * `CHEF_DELIVERY_ADMIN_PASSWORD`\: The password for the
|
343
|
+
# administrative user in the Chef Automate GUI. The password length
|
344
|
+
# is a minimum of eight characters, and a maximum of 32. The
|
345
|
+
# password can contain letters, numbers, and special characters
|
346
|
+
# (!/@#$%^&+=\_). The password must contain at least one lower
|
347
|
+
# case letter, one upper case letter, one number, and one special
|
348
|
+
# character. When no CHEF\_DELIVERY\_ADMIN\_PASSWORD is set, one is
|
349
|
+
# generated and returned in the response.
|
350
|
+
# @return [Array<Types::EngineAttribute>]
|
351
|
+
#
|
352
|
+
# @!attribute [rw] backup_retention_count
|
353
|
+
# The number of automated backups that you want to keep. Whenever a
|
354
|
+
# new backup is created, AWS OpsWorks for Chef Automate deletes the
|
355
|
+
# oldest backups if this number is exceeded. The default value is `1`.
|
356
|
+
# @return [Integer]
|
357
|
+
#
|
358
|
+
# @!attribute [rw] server_name
|
359
|
+
# The name of the server. The server name must be unique within your
|
360
|
+
# AWS account, within each region. Server names must start with a
|
361
|
+
# letter; then letters, numbers, or hyphens (-) are allowed, up to a
|
362
|
+
# maximum of 40 characters.
|
363
|
+
# @return [String]
|
364
|
+
#
|
365
|
+
# @!attribute [rw] instance_profile_arn
|
366
|
+
# The ARN of the instance profile that your Amazon EC2 instances use.
|
367
|
+
# Although the AWS OpsWorks console typically creates the instance
|
368
|
+
# profile for you, if you are using API commands instead, run the
|
369
|
+
# service-role-creation.yaml AWS CloudFormation template, located at
|
370
|
+
# https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml.
|
371
|
+
# This template creates a CloudFormation stack that includes the
|
372
|
+
# instance profile you need.
|
373
|
+
# @return [String]
|
374
|
+
#
|
375
|
+
# @!attribute [rw] instance_type
|
376
|
+
# The Amazon EC2 instance type to use. Valid values must be specified
|
377
|
+
# in the following format: `^([cm][34]|t2).*` For example, `m4.large`.
|
378
|
+
# Valid values are `t2.medium`, `m4.large`, or `m4.2xlarge`.
|
379
|
+
# @return [String]
|
380
|
+
#
|
381
|
+
# @!attribute [rw] key_pair
|
382
|
+
# The Amazon EC2 key pair to set for the instance. This parameter is
|
383
|
+
# optional; if desired, you may specify this parameter to connect to
|
384
|
+
# your instances by using SSH.
|
385
|
+
# @return [String]
|
386
|
+
#
|
387
|
+
# @!attribute [rw] 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.
|
390
|
+
# Valid values must be specified in the following format: `DDD:HH:MM`.
|
391
|
+
# The specified time is in coordinated universal time (UTC). The
|
392
|
+
# default value is a random one-hour period on Tuesday, Wednesday, or
|
393
|
+
# Friday. 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
|
+
# @return [String]
|
398
|
+
#
|
399
|
+
# @!attribute [rw] preferred_backup_window
|
400
|
+
# The start time for a one-hour period during which AWS OpsWorks for
|
401
|
+
# Chef Automate backs up application-level data on your server if
|
402
|
+
# automated backups are enabled. Valid values must be specified in one
|
403
|
+
# of the following formats:
|
404
|
+
#
|
405
|
+
# * `HH:MM` for daily backups
|
406
|
+
#
|
407
|
+
# * `DDD:HH:MM` for weekly backups
|
408
|
+
#
|
409
|
+
# The specified time is in coordinated universal time (UTC). The
|
410
|
+
# default value is a random, daily start time.
|
411
|
+
#
|
412
|
+
# **Example:** `08:00`, which represents a daily start time of 08:00
|
413
|
+
# UTC.
|
414
|
+
#
|
415
|
+
# **Example:** `Mon:08:00`, which represents a start time of every
|
416
|
+
# Monday at 08:00 UTC. (8:00 a.m.)
|
417
|
+
# @return [String]
|
418
|
+
#
|
419
|
+
# @!attribute [rw] security_group_ids
|
420
|
+
# A list of security group IDs to attach to the Amazon EC2 instance.
|
421
|
+
# If you add this parameter, the specified security groups must be
|
422
|
+
# within the VPC that is specified by `SubnetIds`.
|
423
|
+
#
|
424
|
+
# If you do not specify this parameter, AWS OpsWorks for Chef Automate
|
425
|
+
# creates one new security group that uses TCP ports 22 and 443, open
|
426
|
+
# to 0.0.0.0/0 (everyone).
|
427
|
+
# @return [Array<String>]
|
428
|
+
#
|
429
|
+
# @!attribute [rw] service_role_arn
|
430
|
+
# The service role that the AWS OpsWorks for Chef Automate service
|
431
|
+
# backend uses to work with your account. Although the AWS OpsWorks
|
432
|
+
# management console typically creates the service role for you, if
|
433
|
+
# you are using the AWS CLI or API commands, run the
|
434
|
+
# service-role-creation.yaml AWS CloudFormation template, located at
|
435
|
+
# https://s3.amazonaws.com/opsworks-stuff/latest/service-role-creation.yaml.
|
436
|
+
# This template creates a CloudFormation stack that includes the
|
437
|
+
# service role that you need.
|
438
|
+
# @return [String]
|
439
|
+
#
|
440
|
+
# @!attribute [rw] subnet_ids
|
441
|
+
# The IDs of subnets in which to launch the server EC2 instance.
|
442
|
+
#
|
443
|
+
# Amazon EC2-Classic customers: This field is required. All servers
|
444
|
+
# must run within a VPC. The VPC must have "Auto Assign Public IP"
|
445
|
+
# enabled.
|
446
|
+
#
|
447
|
+
# EC2-VPC customers: This field is optional. If you do not specify
|
448
|
+
# subnet IDs, your EC2 instances are created in a default subnet that
|
449
|
+
# is selected by Amazon EC2. If you specify subnet IDs, the VPC must
|
450
|
+
# have "Auto Assign Public IP" enabled.
|
451
|
+
#
|
452
|
+
# For more information about supported Amazon EC2 platforms, see
|
453
|
+
# [Supported Platforms][1].
|
454
|
+
#
|
455
|
+
#
|
456
|
+
#
|
457
|
+
# [1]: http://docs.aws.amazon.com/https:/docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html
|
458
|
+
# @return [Array<String>]
|
459
|
+
#
|
460
|
+
# @!attribute [rw] backup_id
|
461
|
+
# If you specify this field, AWS OpsWorks for Chef Automate creates
|
462
|
+
# the server by using the backup represented by BackupId.
|
463
|
+
# @return [String]
|
464
|
+
#
|
465
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/CreateServerRequest AWS API Documentation
|
466
|
+
#
|
467
|
+
class CreateServerRequest < Struct.new(
|
468
|
+
:associate_public_ip_address,
|
469
|
+
:disable_automated_backup,
|
470
|
+
:engine,
|
471
|
+
:engine_model,
|
472
|
+
:engine_version,
|
473
|
+
:engine_attributes,
|
474
|
+
:backup_retention_count,
|
475
|
+
:server_name,
|
476
|
+
:instance_profile_arn,
|
477
|
+
:instance_type,
|
478
|
+
:key_pair,
|
479
|
+
:preferred_maintenance_window,
|
480
|
+
:preferred_backup_window,
|
481
|
+
:security_group_ids,
|
482
|
+
:service_role_arn,
|
483
|
+
:subnet_ids,
|
484
|
+
:backup_id)
|
485
|
+
include Aws::Structure
|
486
|
+
end
|
440
487
|
|
441
|
-
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
|
447
|
-
|
448
|
-
|
449
|
-
|
450
|
-
|
451
|
-
# @return [String]
|
452
|
-
class DeleteBackupRequest < Struct.new(
|
453
|
-
:backup_id)
|
454
|
-
include Aws::Structure
|
455
|
-
end
|
488
|
+
# @!attribute [rw] server
|
489
|
+
# The server that is created by the request.
|
490
|
+
# @return [Types::Server]
|
491
|
+
#
|
492
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/CreateServerResponse AWS API Documentation
|
493
|
+
#
|
494
|
+
class CreateServerResponse < Struct.new(
|
495
|
+
:server)
|
496
|
+
include Aws::Structure
|
497
|
+
end
|
456
498
|
|
457
|
-
|
499
|
+
# @note When making an API call, you may pass DeleteBackupRequest
|
500
|
+
# data as a hash:
|
501
|
+
#
|
502
|
+
# {
|
503
|
+
# backup_id: "BackupId", # required
|
504
|
+
# }
|
505
|
+
#
|
506
|
+
# @!attribute [rw] backup_id
|
507
|
+
# The ID of the backup to delete. Run the DescribeBackups command to
|
508
|
+
# get a list of backup IDs. Backup IDs are in the format
|
509
|
+
# `ServerName-yyyyMMddHHmmssSSS`.
|
510
|
+
# @return [String]
|
511
|
+
#
|
512
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DeleteBackupRequest AWS API Documentation
|
513
|
+
#
|
514
|
+
class DeleteBackupRequest < Struct.new(
|
515
|
+
:backup_id)
|
516
|
+
include Aws::Structure
|
517
|
+
end
|
458
518
|
|
459
|
-
|
460
|
-
|
461
|
-
|
462
|
-
# {
|
463
|
-
# server_name: "ServerName", # required
|
464
|
-
# }
|
465
|
-
# @!attribute [rw] server_name
|
466
|
-
# The ID of the server to delete.
|
467
|
-
# @return [String]
|
468
|
-
class DeleteServerRequest < Struct.new(
|
469
|
-
:server_name)
|
470
|
-
include Aws::Structure
|
471
|
-
end
|
519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DeleteBackupResponse AWS API Documentation
|
520
|
+
#
|
521
|
+
class DeleteBackupResponse < Aws::EmptyStructure; end
|
472
522
|
|
473
|
-
|
523
|
+
# @note When making an API call, you may pass DeleteServerRequest
|
524
|
+
# data as a hash:
|
525
|
+
#
|
526
|
+
# {
|
527
|
+
# server_name: "ServerName", # required
|
528
|
+
# }
|
529
|
+
#
|
530
|
+
# @!attribute [rw] server_name
|
531
|
+
# The ID of the server to delete.
|
532
|
+
# @return [String]
|
533
|
+
#
|
534
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DeleteServerRequest AWS API Documentation
|
535
|
+
#
|
536
|
+
class DeleteServerRequest < Struct.new(
|
537
|
+
:server_name)
|
538
|
+
include Aws::Structure
|
539
|
+
end
|
474
540
|
|
475
|
-
|
476
|
-
|
541
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DeleteServerResponse AWS API Documentation
|
542
|
+
#
|
543
|
+
class DeleteServerResponse < Aws::EmptyStructure; end
|
477
544
|
|
478
|
-
|
479
|
-
|
480
|
-
|
481
|
-
|
482
|
-
|
483
|
-
include Aws::Structure
|
484
|
-
end
|
545
|
+
# @api private
|
546
|
+
#
|
547
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeAccountAttributesRequest AWS API Documentation
|
548
|
+
#
|
549
|
+
class DescribeAccountAttributesRequest < Aws::EmptyStructure; end
|
485
550
|
|
486
|
-
|
487
|
-
|
488
|
-
|
489
|
-
|
490
|
-
|
491
|
-
|
492
|
-
|
493
|
-
|
494
|
-
|
495
|
-
|
496
|
-
# Describes a single backup.
|
497
|
-
# @return [String]
|
498
|
-
#
|
499
|
-
# @!attribute [rw] server_name
|
500
|
-
# Returns backups for the server with the specified ServerName.
|
501
|
-
# @return [String]
|
502
|
-
#
|
503
|
-
# @!attribute [rw] next_token
|
504
|
-
# NextToken is a string that is returned in some command responses. It
|
505
|
-
# indicates that not all entries have been returned, and that you must
|
506
|
-
# run at least one more request to get remaining items. To get
|
507
|
-
# remaining results, call `DescribeBackups` again, and assign the
|
508
|
-
# token from the previous results as the value of the `nextToken`
|
509
|
-
# parameter. If there are no more results, the response object's
|
510
|
-
# `nextToken` parameter value is `null`. Setting a `nextToken` value
|
511
|
-
# that was not returned in your previous results causes an
|
512
|
-
# `InvalidNextTokenException` to occur.
|
513
|
-
# @return [String]
|
514
|
-
#
|
515
|
-
# @!attribute [rw] max_results
|
516
|
-
# To receive a paginated response, use this parameter to specify the
|
517
|
-
# maximum number of results to be returned with a single call. If the
|
518
|
-
# number of available results exceeds this maximum, the response
|
519
|
-
# includes a `NextToken` value that you can assign to the `NextToken`
|
520
|
-
# request parameter to get the next set of results.
|
521
|
-
# @return [Integer]
|
522
|
-
class DescribeBackupsRequest < Struct.new(
|
523
|
-
:backup_id,
|
524
|
-
:server_name,
|
525
|
-
:next_token,
|
526
|
-
:max_results)
|
527
|
-
include Aws::Structure
|
528
|
-
end
|
551
|
+
# @!attribute [rw] attributes
|
552
|
+
# The attributes that are currently set for the account.
|
553
|
+
# @return [Array<Types::AccountAttribute>]
|
554
|
+
#
|
555
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeAccountAttributesResponse AWS API Documentation
|
556
|
+
#
|
557
|
+
class DescribeAccountAttributesResponse < Struct.new(
|
558
|
+
:attributes)
|
559
|
+
include Aws::Structure
|
560
|
+
end
|
529
561
|
|
530
|
-
|
531
|
-
|
532
|
-
|
533
|
-
|
534
|
-
|
535
|
-
|
536
|
-
|
537
|
-
|
538
|
-
|
539
|
-
|
540
|
-
|
541
|
-
|
542
|
-
|
543
|
-
|
544
|
-
|
545
|
-
|
546
|
-
|
547
|
-
|
548
|
-
|
549
|
-
|
562
|
+
# @note When making an API call, you may pass DescribeBackupsRequest
|
563
|
+
# data as a hash:
|
564
|
+
#
|
565
|
+
# {
|
566
|
+
# backup_id: "BackupId",
|
567
|
+
# server_name: "ServerName",
|
568
|
+
# next_token: "NextToken",
|
569
|
+
# max_results: 1,
|
570
|
+
# }
|
571
|
+
#
|
572
|
+
# @!attribute [rw] backup_id
|
573
|
+
# Describes a single backup.
|
574
|
+
# @return [String]
|
575
|
+
#
|
576
|
+
# @!attribute [rw] server_name
|
577
|
+
# Returns backups for the server with the specified ServerName.
|
578
|
+
# @return [String]
|
579
|
+
#
|
580
|
+
# @!attribute [rw] next_token
|
581
|
+
# NextToken is a string that is returned in some command responses. It
|
582
|
+
# indicates that not all entries have been returned, and that you must
|
583
|
+
# run at least one more request to get remaining items. To get
|
584
|
+
# remaining results, call `DescribeBackups` again, and assign the
|
585
|
+
# token from the previous results as the value of the `nextToken`
|
586
|
+
# parameter. If there are no more results, the response object's
|
587
|
+
# `nextToken` parameter value is `null`. Setting a `nextToken` value
|
588
|
+
# that was not returned in your previous results causes an
|
589
|
+
# `InvalidNextTokenException` to occur.
|
590
|
+
# @return [String]
|
591
|
+
#
|
592
|
+
# @!attribute [rw] max_results
|
593
|
+
# To receive a paginated response, use this parameter to specify the
|
594
|
+
# maximum number of results to be returned with a single call. If the
|
595
|
+
# number of available results exceeds this maximum, the response
|
596
|
+
# includes a `NextToken` value that you can assign to the `NextToken`
|
597
|
+
# request parameter to get the next set of results.
|
598
|
+
# @return [Integer]
|
599
|
+
#
|
600
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeBackupsRequest AWS API Documentation
|
601
|
+
#
|
602
|
+
class DescribeBackupsRequest < Struct.new(
|
603
|
+
:backup_id,
|
604
|
+
:server_name,
|
605
|
+
:next_token,
|
606
|
+
:max_results)
|
607
|
+
include Aws::Structure
|
608
|
+
end
|
550
609
|
|
551
|
-
|
552
|
-
|
553
|
-
|
554
|
-
|
555
|
-
|
556
|
-
|
557
|
-
|
558
|
-
|
559
|
-
|
560
|
-
|
561
|
-
|
562
|
-
|
563
|
-
|
564
|
-
|
565
|
-
|
566
|
-
|
567
|
-
|
568
|
-
|
569
|
-
|
570
|
-
|
571
|
-
|
572
|
-
|
573
|
-
|
574
|
-
#
|
575
|
-
# @!attribute [rw] max_results
|
576
|
-
# To receive a paginated response, use this parameter to specify the
|
577
|
-
# maximum number of results to be returned with a single call. If the
|
578
|
-
# number of available results exceeds this maximum, the response
|
579
|
-
# includes a `NextToken` value that you can assign to the `NextToken`
|
580
|
-
# request parameter to get the next set of results.
|
581
|
-
# @return [Integer]
|
582
|
-
class DescribeEventsRequest < Struct.new(
|
583
|
-
:server_name,
|
584
|
-
:next_token,
|
585
|
-
:max_results)
|
586
|
-
include Aws::Structure
|
587
|
-
end
|
610
|
+
# @!attribute [rw] backups
|
611
|
+
# Contains the response to a `DescribeBackups` request.
|
612
|
+
# @return [Array<Types::Backup>]
|
613
|
+
#
|
614
|
+
# @!attribute [rw] next_token
|
615
|
+
# NextToken is a string that is returned in some command responses. It
|
616
|
+
# indicates that not all entries have been returned, and that you must
|
617
|
+
# run at least one more request to get remaining items. To get
|
618
|
+
# remaining results, call `DescribeBackups` again, and assign the
|
619
|
+
# token from the previous results as the value of the `nextToken`
|
620
|
+
# parameter. If there are no more results, the response object's
|
621
|
+
# `nextToken` parameter value is `null`. Setting a `nextToken` value
|
622
|
+
# that was not returned in your previous results causes an
|
623
|
+
# `InvalidNextTokenException` to occur.
|
624
|
+
# @return [String]
|
625
|
+
#
|
626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeBackupsResponse AWS API Documentation
|
627
|
+
#
|
628
|
+
class DescribeBackupsResponse < Struct.new(
|
629
|
+
:backups,
|
630
|
+
:next_token)
|
631
|
+
include Aws::Structure
|
632
|
+
end
|
588
633
|
|
589
|
-
|
590
|
-
|
591
|
-
|
592
|
-
|
593
|
-
|
594
|
-
|
595
|
-
|
596
|
-
|
597
|
-
|
598
|
-
|
599
|
-
|
600
|
-
|
601
|
-
|
602
|
-
|
603
|
-
|
604
|
-
|
605
|
-
|
606
|
-
|
607
|
-
|
608
|
-
|
634
|
+
# @note When making an API call, you may pass DescribeEventsRequest
|
635
|
+
# data as a hash:
|
636
|
+
#
|
637
|
+
# {
|
638
|
+
# server_name: "ServerName", # required
|
639
|
+
# next_token: "NextToken",
|
640
|
+
# max_results: 1,
|
641
|
+
# }
|
642
|
+
#
|
643
|
+
# @!attribute [rw] server_name
|
644
|
+
# The name of the server for which you want to view events.
|
645
|
+
# @return [String]
|
646
|
+
#
|
647
|
+
# @!attribute [rw] next_token
|
648
|
+
# NextToken is a string that is returned in some command responses. It
|
649
|
+
# indicates that not all entries have been returned, and that you must
|
650
|
+
# run at least one more request to get remaining items. To get
|
651
|
+
# remaining results, call `DescribeEvents` again, and assign the token
|
652
|
+
# from the previous results as the value of the `nextToken` parameter.
|
653
|
+
# If there are no more results, the response object's `nextToken`
|
654
|
+
# parameter value is `null`. Setting a `nextToken` value that was not
|
655
|
+
# returned in your previous results causes an
|
656
|
+
# `InvalidNextTokenException` to occur.
|
657
|
+
# @return [String]
|
658
|
+
#
|
659
|
+
# @!attribute [rw] max_results
|
660
|
+
# To receive a paginated response, use this parameter to specify the
|
661
|
+
# maximum number of results to be returned with a single call. If the
|
662
|
+
# number of available results exceeds this maximum, the response
|
663
|
+
# includes a `NextToken` value that you can assign to the `NextToken`
|
664
|
+
# request parameter to get the next set of results.
|
665
|
+
# @return [Integer]
|
666
|
+
#
|
667
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeEventsRequest AWS API Documentation
|
668
|
+
#
|
669
|
+
class DescribeEventsRequest < Struct.new(
|
670
|
+
:server_name,
|
671
|
+
:next_token,
|
672
|
+
:max_results)
|
673
|
+
include Aws::Structure
|
674
|
+
end
|
609
675
|
|
610
|
-
|
611
|
-
|
612
|
-
|
613
|
-
|
614
|
-
|
615
|
-
|
616
|
-
|
617
|
-
|
618
|
-
|
619
|
-
|
620
|
-
|
621
|
-
|
622
|
-
|
623
|
-
|
624
|
-
|
625
|
-
|
626
|
-
|
676
|
+
# @!attribute [rw] server_events
|
677
|
+
# Contains the response to a `DescribeEvents` request.
|
678
|
+
# @return [Array<Types::ServerEvent>]
|
679
|
+
#
|
680
|
+
# @!attribute [rw] next_token
|
681
|
+
# NextToken is a string that is returned in some command responses. It
|
682
|
+
# indicates that not all entries have been returned, and that you must
|
683
|
+
# run at least one more request to get remaining items. To get
|
684
|
+
# remaining results, call `DescribeEvents` again, and assign the token
|
685
|
+
# from the previous results as the value of the `nextToken` parameter.
|
686
|
+
# If there are no more results, the response object's `nextToken`
|
687
|
+
# parameter value is `null`. Setting a `nextToken` value that was not
|
688
|
+
# returned in your previous results causes an
|
689
|
+
# `InvalidNextTokenException` to occur.
|
690
|
+
# @return [String]
|
691
|
+
#
|
692
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeEventsResponse AWS API Documentation
|
693
|
+
#
|
694
|
+
class DescribeEventsResponse < Struct.new(
|
695
|
+
:server_events,
|
696
|
+
:next_token)
|
697
|
+
include Aws::Structure
|
698
|
+
end
|
627
699
|
|
628
|
-
|
629
|
-
|
630
|
-
|
631
|
-
|
632
|
-
|
633
|
-
|
700
|
+
# @note When making an API call, you may pass DescribeNodeAssociationStatusRequest
|
701
|
+
# data as a hash:
|
702
|
+
#
|
703
|
+
# {
|
704
|
+
# node_association_status_token: "NodeAssociationStatusToken", # required
|
705
|
+
# server_name: "ServerName", # required
|
706
|
+
# }
|
707
|
+
#
|
708
|
+
# @!attribute [rw] node_association_status_token
|
709
|
+
# @return [String]
|
710
|
+
#
|
711
|
+
# @!attribute [rw] server_name
|
712
|
+
# The name of the server from which to disassociate the node.
|
713
|
+
# @return [String]
|
714
|
+
#
|
715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeNodeAssociationStatusRequest AWS API Documentation
|
716
|
+
#
|
717
|
+
class DescribeNodeAssociationStatusRequest < Struct.new(
|
718
|
+
:node_association_status_token,
|
719
|
+
:server_name)
|
720
|
+
include Aws::Structure
|
721
|
+
end
|
634
722
|
|
635
|
-
|
636
|
-
|
637
|
-
|
638
|
-
|
639
|
-
|
640
|
-
|
641
|
-
|
642
|
-
|
643
|
-
|
644
|
-
|
645
|
-
|
646
|
-
|
647
|
-
|
648
|
-
|
649
|
-
|
650
|
-
|
651
|
-
|
652
|
-
|
653
|
-
|
654
|
-
# `nextToken` parameter value is `null`. Setting a `nextToken` value
|
655
|
-
# that was not returned in your previous results causes an
|
656
|
-
# `InvalidNextTokenException` to occur.
|
657
|
-
# @return [String]
|
658
|
-
#
|
659
|
-
# @!attribute [rw] max_results
|
660
|
-
# To receive a paginated response, use this parameter to specify the
|
661
|
-
# maximum number of results to be returned with a single call. If the
|
662
|
-
# number of available results exceeds this maximum, the response
|
663
|
-
# includes a `NextToken` value that you can assign to the `NextToken`
|
664
|
-
# request parameter to get the next set of results.
|
665
|
-
# @return [Integer]
|
666
|
-
class DescribeServersRequest < Struct.new(
|
667
|
-
:server_name,
|
668
|
-
:next_token,
|
669
|
-
:max_results)
|
670
|
-
include Aws::Structure
|
671
|
-
end
|
723
|
+
# @!attribute [rw] node_association_status
|
724
|
+
# The status of the association or disassociation request.
|
725
|
+
#
|
726
|
+
# **Possible values:**
|
727
|
+
#
|
728
|
+
# * `SUCCESS`\: The association or disassociation succeeded.
|
729
|
+
#
|
730
|
+
# * `FAILED`\: The association or disassociation failed.
|
731
|
+
#
|
732
|
+
# * `IN_PROGRESS`\: The association or disassociation is still in
|
733
|
+
# progress.
|
734
|
+
# @return [String]
|
735
|
+
#
|
736
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeNodeAssociationStatusResponse AWS API Documentation
|
737
|
+
#
|
738
|
+
class DescribeNodeAssociationStatusResponse < Struct.new(
|
739
|
+
:node_association_status)
|
740
|
+
include Aws::Structure
|
741
|
+
end
|
672
742
|
|
673
|
-
|
674
|
-
|
675
|
-
|
676
|
-
|
677
|
-
|
678
|
-
|
679
|
-
|
680
|
-
|
681
|
-
|
682
|
-
|
683
|
-
|
684
|
-
|
685
|
-
|
686
|
-
|
687
|
-
|
688
|
-
|
689
|
-
|
690
|
-
|
691
|
-
|
692
|
-
|
743
|
+
# @note When making an API call, you may pass DescribeServersRequest
|
744
|
+
# data as a hash:
|
745
|
+
#
|
746
|
+
# {
|
747
|
+
# server_name: "ServerName",
|
748
|
+
# next_token: "NextToken",
|
749
|
+
# max_results: 1,
|
750
|
+
# }
|
751
|
+
#
|
752
|
+
# @!attribute [rw] server_name
|
753
|
+
# Describes the server with the specified ServerName.
|
754
|
+
# @return [String]
|
755
|
+
#
|
756
|
+
# @!attribute [rw] next_token
|
757
|
+
# NextToken is a string that is returned in some command responses. It
|
758
|
+
# indicates that not all entries have been returned, and that you must
|
759
|
+
# run at least one more request to get remaining items. To get
|
760
|
+
# remaining results, call `DescribeServers` again, and assign the
|
761
|
+
# token from the previous results as the value of the `nextToken`
|
762
|
+
# parameter. If there are no more results, the response object's
|
763
|
+
# `nextToken` parameter value is `null`. Setting a `nextToken` value
|
764
|
+
# that was not returned in your previous results causes an
|
765
|
+
# `InvalidNextTokenException` to occur.
|
766
|
+
# @return [String]
|
767
|
+
#
|
768
|
+
# @!attribute [rw] max_results
|
769
|
+
# To receive a paginated response, use this parameter to specify the
|
770
|
+
# maximum number of results to be returned with a single call. If the
|
771
|
+
# number of available results exceeds this maximum, the response
|
772
|
+
# includes a `NextToken` value that you can assign to the `NextToken`
|
773
|
+
# request parameter to get the next set of results.
|
774
|
+
# @return [Integer]
|
775
|
+
#
|
776
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeServersRequest AWS API Documentation
|
777
|
+
#
|
778
|
+
class DescribeServersRequest < Struct.new(
|
779
|
+
:server_name,
|
780
|
+
:next_token,
|
781
|
+
:max_results)
|
782
|
+
include Aws::Structure
|
783
|
+
end
|
693
784
|
|
694
|
-
|
695
|
-
|
696
|
-
|
697
|
-
|
698
|
-
|
699
|
-
|
700
|
-
|
701
|
-
|
702
|
-
|
703
|
-
|
704
|
-
|
705
|
-
|
706
|
-
|
707
|
-
|
708
|
-
|
709
|
-
|
710
|
-
|
711
|
-
|
712
|
-
|
713
|
-
|
714
|
-
|
715
|
-
|
716
|
-
|
717
|
-
:node_name,
|
718
|
-
:engine_attributes)
|
719
|
-
include Aws::Structure
|
720
|
-
end
|
785
|
+
# @!attribute [rw] servers
|
786
|
+
# Contains the response to a `DescribeServers` request.
|
787
|
+
# @return [Array<Types::Server>]
|
788
|
+
#
|
789
|
+
# @!attribute [rw] next_token
|
790
|
+
# NextToken is a string that is returned in some command responses. It
|
791
|
+
# indicates that not all entries have been returned, and that you must
|
792
|
+
# run at least one more request to get remaining items. To get
|
793
|
+
# remaining results, call `DescribeServers` again, and assign the
|
794
|
+
# token from the previous results as the value of the `nextToken`
|
795
|
+
# parameter. If there are no more results, the response object's
|
796
|
+
# `nextToken` parameter value is `null`. Setting a `nextToken` value
|
797
|
+
# that was not returned in your previous results causes an
|
798
|
+
# `InvalidNextTokenException` to occur.
|
799
|
+
# @return [String]
|
800
|
+
#
|
801
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeServersResponse AWS API Documentation
|
802
|
+
#
|
803
|
+
class DescribeServersResponse < Struct.new(
|
804
|
+
:servers,
|
805
|
+
:next_token)
|
806
|
+
include Aws::Structure
|
807
|
+
end
|
721
808
|
|
722
|
-
|
723
|
-
|
724
|
-
|
725
|
-
|
726
|
-
|
727
|
-
|
809
|
+
# @note When making an API call, you may pass DisassociateNodeRequest
|
810
|
+
# data as a hash:
|
811
|
+
#
|
812
|
+
# {
|
813
|
+
# server_name: "ServerName", # required
|
814
|
+
# node_name: "NodeName", # required
|
815
|
+
# engine_attributes: [
|
816
|
+
# {
|
817
|
+
# name: "EngineAttributeName",
|
818
|
+
# value: "EngineAttributeValue",
|
819
|
+
# },
|
820
|
+
# ],
|
821
|
+
# }
|
822
|
+
#
|
823
|
+
# @!attribute [rw] server_name
|
824
|
+
# The name of the server from which to disassociate the node.
|
825
|
+
# @return [String]
|
826
|
+
#
|
827
|
+
# @!attribute [rw] node_name
|
828
|
+
# The name of the Chef client node.
|
829
|
+
# @return [String]
|
830
|
+
#
|
831
|
+
# @!attribute [rw] engine_attributes
|
832
|
+
# Engine attributes used for disassociating the node.
|
833
|
+
#
|
834
|
+
# **Attributes accepted in a DisassociateNode request:**
|
835
|
+
#
|
836
|
+
# * `CHEF_ORGANIZATION`\: The Chef organization with which the node
|
837
|
+
# was associated. By default only one organization named `default`
|
838
|
+
# can exist.
|
839
|
+
#
|
840
|
+
# ^
|
841
|
+
# @return [Array<Types::EngineAttribute>]
|
842
|
+
#
|
843
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DisassociateNodeRequest AWS API Documentation
|
844
|
+
#
|
845
|
+
class DisassociateNodeRequest < Struct.new(
|
846
|
+
:server_name,
|
847
|
+
:node_name,
|
848
|
+
:engine_attributes)
|
849
|
+
include Aws::Structure
|
850
|
+
end
|
728
851
|
|
729
|
-
|
730
|
-
|
731
|
-
|
732
|
-
|
733
|
-
|
734
|
-
|
735
|
-
|
736
|
-
|
737
|
-
|
738
|
-
|
739
|
-
|
740
|
-
|
741
|
-
# @!attribute [rw] value
|
742
|
-
# The value of the engine attribute.
|
743
|
-
# @return [String]
|
744
|
-
class EngineAttribute < Struct.new(
|
745
|
-
:name,
|
746
|
-
:value)
|
747
|
-
include Aws::Structure
|
748
|
-
end
|
852
|
+
# @!attribute [rw] node_association_status_token
|
853
|
+
# Contains a token which can be passed to the
|
854
|
+
# `DescribeNodeAssociationStatus` API call to get the status of the
|
855
|
+
# disassociation request.
|
856
|
+
# @return [String]
|
857
|
+
#
|
858
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DisassociateNodeResponse AWS API Documentation
|
859
|
+
#
|
860
|
+
class DisassociateNodeResponse < Struct.new(
|
861
|
+
:node_association_status_token)
|
862
|
+
include Aws::Structure
|
863
|
+
end
|
749
864
|
|
750
|
-
|
751
|
-
|
752
|
-
|
753
|
-
|
754
|
-
|
755
|
-
|
756
|
-
|
757
|
-
|
758
|
-
|
759
|
-
|
760
|
-
|
761
|
-
|
762
|
-
|
763
|
-
|
764
|
-
|
765
|
-
|
766
|
-
|
767
|
-
|
768
|
-
|
769
|
-
|
770
|
-
|
771
|
-
|
772
|
-
|
773
|
-
|
774
|
-
|
775
|
-
# The name of the key pair to set on the new EC2 instance. This can be
|
776
|
-
# helpful if any of the administrators who manage the server no longer
|
777
|
-
# have the SSH key.
|
778
|
-
# @return [String]
|
779
|
-
class RestoreServerRequest < Struct.new(
|
780
|
-
:backup_id,
|
781
|
-
:server_name,
|
782
|
-
:instance_type,
|
783
|
-
:key_pair)
|
784
|
-
include Aws::Structure
|
785
|
-
end
|
865
|
+
# A name and value pair that is specific to the engine of the server.
|
866
|
+
#
|
867
|
+
# @note When making an API call, you may pass EngineAttribute
|
868
|
+
# data as a hash:
|
869
|
+
#
|
870
|
+
# {
|
871
|
+
# name: "EngineAttributeName",
|
872
|
+
# value: "EngineAttributeValue",
|
873
|
+
# }
|
874
|
+
#
|
875
|
+
# @!attribute [rw] name
|
876
|
+
# The name of the engine attribute.
|
877
|
+
# @return [String]
|
878
|
+
#
|
879
|
+
# @!attribute [rw] value
|
880
|
+
# The value of the engine attribute.
|
881
|
+
# @return [String]
|
882
|
+
#
|
883
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/EngineAttribute AWS API Documentation
|
884
|
+
#
|
885
|
+
class EngineAttribute < Struct.new(
|
886
|
+
:name,
|
887
|
+
:value)
|
888
|
+
include Aws::Structure
|
889
|
+
end
|
786
890
|
|
787
|
-
|
891
|
+
# @note When making an API call, you may pass RestoreServerRequest
|
892
|
+
# data as a hash:
|
893
|
+
#
|
894
|
+
# {
|
895
|
+
# backup_id: "BackupId", # required
|
896
|
+
# server_name: "ServerName", # required
|
897
|
+
# instance_type: "String",
|
898
|
+
# key_pair: "KeyPair",
|
899
|
+
# }
|
900
|
+
#
|
901
|
+
# @!attribute [rw] backup_id
|
902
|
+
# The ID of the backup that you want to use to restore a server.
|
903
|
+
# @return [String]
|
904
|
+
#
|
905
|
+
# @!attribute [rw] server_name
|
906
|
+
# The name of the server that you want to restore.
|
907
|
+
# @return [String]
|
908
|
+
#
|
909
|
+
# @!attribute [rw] instance_type
|
910
|
+
# The type of the instance to create. Valid values must be specified
|
911
|
+
# in the following format: `^([cm][34]|t2).*` For example, `m4.large`.
|
912
|
+
# Valid values are `t2.medium`, `m4.large`, and `m4.2xlarge`. If you
|
913
|
+
# do not specify this parameter, RestoreServer uses the instance type
|
914
|
+
# from the specified backup.
|
915
|
+
# @return [String]
|
916
|
+
#
|
917
|
+
# @!attribute [rw] key_pair
|
918
|
+
# The name of the key pair to set on the new EC2 instance. This can be
|
919
|
+
# helpful if the administrator no longer has the SSH key.
|
920
|
+
# @return [String]
|
921
|
+
#
|
922
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/RestoreServerRequest AWS API Documentation
|
923
|
+
#
|
924
|
+
class RestoreServerRequest < Struct.new(
|
925
|
+
:backup_id,
|
926
|
+
:server_name,
|
927
|
+
:instance_type,
|
928
|
+
:key_pair)
|
929
|
+
include Aws::Structure
|
930
|
+
end
|
788
931
|
|
789
|
-
|
790
|
-
|
791
|
-
|
792
|
-
# @return [Integer]
|
793
|
-
#
|
794
|
-
# @!attribute [rw] server_name
|
795
|
-
# The name of the server.
|
796
|
-
# @return [String]
|
797
|
-
#
|
798
|
-
# @!attribute [rw] created_at
|
799
|
-
# Time stamp of server creation. Example `2016-07-29T13:38:47.520Z`
|
800
|
-
# @return [Time]
|
801
|
-
#
|
802
|
-
# @!attribute [rw] disable_automated_backup
|
803
|
-
# Disables automated backups. The number of stored backups is
|
804
|
-
# dependent on the value of PreferredBackupCount.
|
805
|
-
# @return [Boolean]
|
806
|
-
#
|
807
|
-
# @!attribute [rw] endpoint
|
808
|
-
# A DNS name that can be used to access the engine. Example:
|
809
|
-
# `myserver-asdfghjkl.us-east-1.opsworks.io`
|
810
|
-
# @return [String]
|
811
|
-
#
|
812
|
-
# @!attribute [rw] engine
|
813
|
-
# The engine type of the server. The valid value in this release is
|
814
|
-
# `Chef`.
|
815
|
-
# @return [String]
|
816
|
-
#
|
817
|
-
# @!attribute [rw] engine_model
|
818
|
-
# The engine model of the server. The valid value in this release is
|
819
|
-
# `Single`.
|
820
|
-
# @return [String]
|
821
|
-
#
|
822
|
-
# @!attribute [rw] engine_attributes
|
823
|
-
# The response of a createServer() request returns the master
|
824
|
-
# credential to access the server in EngineAttributes. These
|
825
|
-
# credentials are not stored by AWS OpsWorks for Chef Automate; they
|
826
|
-
# are returned only as part of the result of createServer().
|
827
|
-
#
|
828
|
-
# **Attributes returned in a createServer response:**
|
829
|
-
#
|
830
|
-
# * `CHEF_PIVOTAL_KEY`\: A base64-encoded RSA private key that is
|
831
|
-
# generated by AWS OpsWorks for Chef Automate. This private key is
|
832
|
-
# required to access the Chef API.
|
833
|
-
#
|
834
|
-
# * `CHEF_STARTER_KIT`\: A base64-encoded ZIP file. The ZIP file
|
835
|
-
# contains a Chef starter kit, which includes a README, a
|
836
|
-
# configuration file, and the required RSA private key. Save this
|
837
|
-
# file, unzip it, and then change to the directory where you've
|
838
|
-
# unzipped the file contents. From this directory, you can run Knife
|
839
|
-
# commands.
|
840
|
-
# @return [Array<Types::EngineAttribute>]
|
841
|
-
#
|
842
|
-
# @!attribute [rw] engine_version
|
843
|
-
# The engine version of the server. Because Chef is the engine
|
844
|
-
# available in this release, the valid value for EngineVersion is
|
845
|
-
# `12`.
|
846
|
-
# @return [String]
|
847
|
-
#
|
848
|
-
# @!attribute [rw] instance_profile_arn
|
849
|
-
# The instance profile ARN of the server.
|
850
|
-
# @return [String]
|
851
|
-
#
|
852
|
-
# @!attribute [rw] instance_type
|
853
|
-
# The instance type for the server, as specified in the CloudFormation
|
854
|
-
# stack. This might not be the same instance type that is shown in the
|
855
|
-
# EC2 console.
|
856
|
-
# @return [String]
|
857
|
-
#
|
858
|
-
# @!attribute [rw] key_pair
|
859
|
-
# The key pair associated with the server.
|
860
|
-
# @return [String]
|
861
|
-
#
|
862
|
-
# @!attribute [rw] maintenance_status
|
863
|
-
# The status of the most recent server maintenance run. Shows
|
864
|
-
# `SUCCESS` or `FAILED`.
|
865
|
-
# @return [String]
|
866
|
-
#
|
867
|
-
# @!attribute [rw] preferred_maintenance_window
|
868
|
-
# The preferred maintenance period specified for the server.
|
869
|
-
# @return [String]
|
870
|
-
#
|
871
|
-
# @!attribute [rw] preferred_backup_window
|
872
|
-
# The preferred backup period specified for the server.
|
873
|
-
# @return [String]
|
874
|
-
#
|
875
|
-
# @!attribute [rw] security_group_ids
|
876
|
-
# The security group IDs for the server, as specified in the
|
877
|
-
# CloudFormation stack. These might not be the same security groups
|
878
|
-
# that are shown in the EC2 console.
|
879
|
-
# @return [Array<String>]
|
880
|
-
#
|
881
|
-
# @!attribute [rw] service_role_arn
|
882
|
-
# The service role ARN used to create the server.
|
883
|
-
# @return [String]
|
884
|
-
#
|
885
|
-
# @!attribute [rw] status
|
886
|
-
# The server's status. This field displays the states of actions in
|
887
|
-
# progress, such as creating, running, or backing up the server, as
|
888
|
-
# well as server health.
|
889
|
-
# @return [String]
|
890
|
-
#
|
891
|
-
# @!attribute [rw] status_reason
|
892
|
-
# Depending on the server status, this field has either a
|
893
|
-
# human-readable message (such as a create or backup error), or an
|
894
|
-
# escaped block of JSON (used for health check results).
|
895
|
-
# @return [String]
|
896
|
-
#
|
897
|
-
# @!attribute [rw] subnet_ids
|
898
|
-
# The subnet IDs specified in a CreateServer request.
|
899
|
-
# @return [Array<String>]
|
900
|
-
#
|
901
|
-
# @!attribute [rw] server_arn
|
902
|
-
# The ARN of the server.
|
903
|
-
# @return [String]
|
904
|
-
class Server < Struct.new(
|
905
|
-
:backup_retention_count,
|
906
|
-
:server_name,
|
907
|
-
:created_at,
|
908
|
-
:disable_automated_backup,
|
909
|
-
:endpoint,
|
910
|
-
:engine,
|
911
|
-
:engine_model,
|
912
|
-
:engine_attributes,
|
913
|
-
:engine_version,
|
914
|
-
:instance_profile_arn,
|
915
|
-
:instance_type,
|
916
|
-
:key_pair,
|
917
|
-
:maintenance_status,
|
918
|
-
:preferred_maintenance_window,
|
919
|
-
:preferred_backup_window,
|
920
|
-
:security_group_ids,
|
921
|
-
:service_role_arn,
|
922
|
-
:status,
|
923
|
-
:status_reason,
|
924
|
-
:subnet_ids,
|
925
|
-
:server_arn)
|
926
|
-
include Aws::Structure
|
927
|
-
end
|
932
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/RestoreServerResponse AWS API Documentation
|
933
|
+
#
|
934
|
+
class RestoreServerResponse < Aws::EmptyStructure; end
|
928
935
|
|
929
|
-
|
930
|
-
|
931
|
-
|
932
|
-
|
933
|
-
|
934
|
-
|
935
|
-
|
936
|
-
|
937
|
-
|
938
|
-
|
939
|
-
|
940
|
-
|
941
|
-
|
942
|
-
|
943
|
-
|
944
|
-
|
945
|
-
|
946
|
-
|
947
|
-
|
948
|
-
|
949
|
-
|
950
|
-
|
951
|
-
|
952
|
-
|
936
|
+
# Describes a configuration management server.
|
937
|
+
#
|
938
|
+
# @!attribute [rw] associate_public_ip_address
|
939
|
+
# Associate a public IP address with a server that you are launching.
|
940
|
+
# @return [Boolean]
|
941
|
+
#
|
942
|
+
# @!attribute [rw] backup_retention_count
|
943
|
+
# The number of automated backups to keep.
|
944
|
+
# @return [Integer]
|
945
|
+
#
|
946
|
+
# @!attribute [rw] server_name
|
947
|
+
# The name of the server.
|
948
|
+
# @return [String]
|
949
|
+
#
|
950
|
+
# @!attribute [rw] created_at
|
951
|
+
# Time stamp of server creation. Example `2016-07-29T13:38:47.520Z`
|
952
|
+
# @return [Time]
|
953
|
+
#
|
954
|
+
# @!attribute [rw] cloud_formation_stack_arn
|
955
|
+
# The ARN of the CloudFormation stack that was used to create the
|
956
|
+
# server.
|
957
|
+
# @return [String]
|
958
|
+
#
|
959
|
+
# @!attribute [rw] disable_automated_backup
|
960
|
+
# Disables automated backups. The number of stored backups is
|
961
|
+
# dependent on the value of PreferredBackupCount.
|
962
|
+
# @return [Boolean]
|
963
|
+
#
|
964
|
+
# @!attribute [rw] endpoint
|
965
|
+
# A DNS name that can be used to access the engine. Example:
|
966
|
+
# `myserver-asdfghjkl.us-east-1.opsworks.io`
|
967
|
+
# @return [String]
|
968
|
+
#
|
969
|
+
# @!attribute [rw] engine
|
970
|
+
# The engine type of the server. The valid value in this release is
|
971
|
+
# `Chef`.
|
972
|
+
# @return [String]
|
973
|
+
#
|
974
|
+
# @!attribute [rw] engine_model
|
975
|
+
# The engine model of the server. The valid value in this release is
|
976
|
+
# `Single`.
|
977
|
+
# @return [String]
|
978
|
+
#
|
979
|
+
# @!attribute [rw] engine_attributes
|
980
|
+
# The response of a createServer() request returns the master
|
981
|
+
# credential to access the server in EngineAttributes. These
|
982
|
+
# credentials are not stored by AWS OpsWorks for Chef Automate; they
|
983
|
+
# are returned only as part of the result of createServer().
|
984
|
+
#
|
985
|
+
# **Attributes returned in a createServer response:**
|
986
|
+
#
|
987
|
+
# * `CHEF_PIVOTAL_KEY`\: A base64-encoded RSA private key that is
|
988
|
+
# generated by AWS OpsWorks for Chef Automate. This private key is
|
989
|
+
# required to access the Chef API.
|
990
|
+
#
|
991
|
+
# * `CHEF_STARTER_KIT`\: A base64-encoded ZIP file. The ZIP file
|
992
|
+
# contains a Chef starter kit, which includes a README, a
|
993
|
+
# configuration file, and the required RSA private key. Save this
|
994
|
+
# file, unzip it, and then change to the directory where you've
|
995
|
+
# unzipped the file contents. From this directory, you can run Knife
|
996
|
+
# commands.
|
997
|
+
# @return [Array<Types::EngineAttribute>]
|
998
|
+
#
|
999
|
+
# @!attribute [rw] engine_version
|
1000
|
+
# The engine version of the server. Because Chef is the engine
|
1001
|
+
# available in this release, the valid value for EngineVersion is
|
1002
|
+
# `12`.
|
1003
|
+
# @return [String]
|
1004
|
+
#
|
1005
|
+
# @!attribute [rw] instance_profile_arn
|
1006
|
+
# The instance profile ARN of the server.
|
1007
|
+
# @return [String]
|
1008
|
+
#
|
1009
|
+
# @!attribute [rw] instance_type
|
1010
|
+
# The instance type for the server, as specified in the CloudFormation
|
1011
|
+
# stack. This might not be the same instance type that is shown in the
|
1012
|
+
# EC2 console.
|
1013
|
+
# @return [String]
|
1014
|
+
#
|
1015
|
+
# @!attribute [rw] key_pair
|
1016
|
+
# The key pair associated with the server.
|
1017
|
+
# @return [String]
|
1018
|
+
#
|
1019
|
+
# @!attribute [rw] maintenance_status
|
1020
|
+
# The status of the most recent server maintenance run. Shows
|
1021
|
+
# `SUCCESS` or `FAILED`.
|
1022
|
+
# @return [String]
|
1023
|
+
#
|
1024
|
+
# @!attribute [rw] preferred_maintenance_window
|
1025
|
+
# The preferred maintenance period specified for the server.
|
1026
|
+
# @return [String]
|
1027
|
+
#
|
1028
|
+
# @!attribute [rw] preferred_backup_window
|
1029
|
+
# The preferred backup period specified for the server.
|
1030
|
+
# @return [String]
|
1031
|
+
#
|
1032
|
+
# @!attribute [rw] security_group_ids
|
1033
|
+
# The security group IDs for the server, as specified in the
|
1034
|
+
# CloudFormation stack. These might not be the same security groups
|
1035
|
+
# that are shown in the EC2 console.
|
1036
|
+
# @return [Array<String>]
|
1037
|
+
#
|
1038
|
+
# @!attribute [rw] service_role_arn
|
1039
|
+
# The service role ARN used to create the server.
|
1040
|
+
# @return [String]
|
1041
|
+
#
|
1042
|
+
# @!attribute [rw] status
|
1043
|
+
# The server's status. This field displays the states of actions in
|
1044
|
+
# progress, such as creating, running, or backing up the server, as
|
1045
|
+
# well as the server's health state.
|
1046
|
+
# @return [String]
|
1047
|
+
#
|
1048
|
+
# @!attribute [rw] status_reason
|
1049
|
+
# Depending on the server status, this field has either a
|
1050
|
+
# human-readable message (such as a create or backup error), or an
|
1051
|
+
# escaped block of JSON (used for health check results).
|
1052
|
+
# @return [String]
|
1053
|
+
#
|
1054
|
+
# @!attribute [rw] subnet_ids
|
1055
|
+
# The subnet IDs specified in a CreateServer request.
|
1056
|
+
# @return [Array<String>]
|
1057
|
+
#
|
1058
|
+
# @!attribute [rw] server_arn
|
1059
|
+
# The ARN of the server.
|
1060
|
+
# @return [String]
|
1061
|
+
#
|
1062
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/Server AWS API Documentation
|
1063
|
+
#
|
1064
|
+
class Server < Struct.new(
|
1065
|
+
:associate_public_ip_address,
|
1066
|
+
:backup_retention_count,
|
1067
|
+
:server_name,
|
1068
|
+
:created_at,
|
1069
|
+
:cloud_formation_stack_arn,
|
1070
|
+
:disable_automated_backup,
|
1071
|
+
:endpoint,
|
1072
|
+
:engine,
|
1073
|
+
:engine_model,
|
1074
|
+
:engine_attributes,
|
1075
|
+
:engine_version,
|
1076
|
+
:instance_profile_arn,
|
1077
|
+
:instance_type,
|
1078
|
+
:key_pair,
|
1079
|
+
:maintenance_status,
|
1080
|
+
:preferred_maintenance_window,
|
1081
|
+
:preferred_backup_window,
|
1082
|
+
:security_group_ids,
|
1083
|
+
:service_role_arn,
|
1084
|
+
:status,
|
1085
|
+
:status_reason,
|
1086
|
+
:subnet_ids,
|
1087
|
+
:server_arn)
|
1088
|
+
include Aws::Structure
|
1089
|
+
end
|
953
1090
|
|
954
|
-
|
955
|
-
|
956
|
-
|
957
|
-
|
958
|
-
|
959
|
-
|
960
|
-
|
961
|
-
|
962
|
-
|
963
|
-
|
964
|
-
|
965
|
-
|
966
|
-
|
1091
|
+
# An event that is related to the server, such as the start of
|
1092
|
+
# maintenance or backup.
|
1093
|
+
#
|
1094
|
+
# @!attribute [rw] created_at
|
1095
|
+
# The time when the event occurred.
|
1096
|
+
# @return [Time]
|
1097
|
+
#
|
1098
|
+
# @!attribute [rw] server_name
|
1099
|
+
# The name of the server on or for which the event occurred.
|
1100
|
+
# @return [String]
|
1101
|
+
#
|
1102
|
+
# @!attribute [rw] message
|
1103
|
+
# A human-readable informational or status message.
|
1104
|
+
# @return [String]
|
1105
|
+
#
|
1106
|
+
# @!attribute [rw] log_url
|
1107
|
+
# The Amazon S3 URL of the event's log file.
|
1108
|
+
# @return [String]
|
1109
|
+
#
|
1110
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/ServerEvent AWS API Documentation
|
1111
|
+
#
|
1112
|
+
class ServerEvent < Struct.new(
|
1113
|
+
:created_at,
|
1114
|
+
:server_name,
|
1115
|
+
:message,
|
1116
|
+
:log_url)
|
1117
|
+
include Aws::Structure
|
1118
|
+
end
|
967
1119
|
|
968
|
-
|
969
|
-
|
970
|
-
|
971
|
-
|
972
|
-
|
973
|
-
|
974
|
-
|
1120
|
+
# @note When making an API call, you may pass StartMaintenanceRequest
|
1121
|
+
# data as a hash:
|
1122
|
+
#
|
1123
|
+
# {
|
1124
|
+
# server_name: "ServerName", # required
|
1125
|
+
# }
|
1126
|
+
#
|
1127
|
+
# @!attribute [rw] server_name
|
1128
|
+
# The name of the server on which to run maintenance.
|
1129
|
+
# @return [String]
|
1130
|
+
#
|
1131
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/StartMaintenanceRequest AWS API Documentation
|
1132
|
+
#
|
1133
|
+
class StartMaintenanceRequest < Struct.new(
|
1134
|
+
:server_name)
|
1135
|
+
include Aws::Structure
|
1136
|
+
end
|
975
1137
|
|
976
|
-
|
977
|
-
|
978
|
-
|
979
|
-
|
980
|
-
|
981
|
-
|
982
|
-
|
983
|
-
|
984
|
-
|
985
|
-
|
986
|
-
# @return [String]
|
987
|
-
#
|
988
|
-
# @!attribute [rw] attribute_name
|
989
|
-
# The name of the engine attribute to update.
|
990
|
-
# @return [String]
|
991
|
-
#
|
992
|
-
# @!attribute [rw] attribute_value
|
993
|
-
# The value to set for the attribute.
|
994
|
-
# @return [String]
|
995
|
-
class UpdateServerEngineAttributesRequest < Struct.new(
|
996
|
-
:server_name,
|
997
|
-
:attribute_name,
|
998
|
-
:attribute_value)
|
999
|
-
include Aws::Structure
|
1000
|
-
end
|
1138
|
+
# @!attribute [rw] server
|
1139
|
+
# Contains the response to a `StartMaintenance` request.
|
1140
|
+
# @return [Types::Server]
|
1141
|
+
#
|
1142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/StartMaintenanceResponse AWS API Documentation
|
1143
|
+
#
|
1144
|
+
class StartMaintenanceResponse < Struct.new(
|
1145
|
+
:server)
|
1146
|
+
include Aws::Structure
|
1147
|
+
end
|
1001
1148
|
|
1002
|
-
|
1003
|
-
|
1004
|
-
|
1005
|
-
|
1006
|
-
|
1007
|
-
|
1008
|
-
|
1149
|
+
# @note When making an API call, you may pass UpdateServerEngineAttributesRequest
|
1150
|
+
# data as a hash:
|
1151
|
+
#
|
1152
|
+
# {
|
1153
|
+
# server_name: "ServerName", # required
|
1154
|
+
# attribute_name: "AttributeName", # required
|
1155
|
+
# attribute_value: "AttributeValue",
|
1156
|
+
# }
|
1157
|
+
#
|
1158
|
+
# @!attribute [rw] server_name
|
1159
|
+
# The name of the server to update.
|
1160
|
+
# @return [String]
|
1161
|
+
#
|
1162
|
+
# @!attribute [rw] attribute_name
|
1163
|
+
# The name of the engine attribute to update.
|
1164
|
+
# @return [String]
|
1165
|
+
#
|
1166
|
+
# @!attribute [rw] attribute_value
|
1167
|
+
# The value to set for the attribute.
|
1168
|
+
# @return [String]
|
1169
|
+
#
|
1170
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/UpdateServerEngineAttributesRequest AWS API Documentation
|
1171
|
+
#
|
1172
|
+
class UpdateServerEngineAttributesRequest < Struct.new(
|
1173
|
+
:server_name,
|
1174
|
+
:attribute_name,
|
1175
|
+
:attribute_value)
|
1176
|
+
include Aws::Structure
|
1177
|
+
end
|
1009
1178
|
|
1010
|
-
|
1011
|
-
|
1012
|
-
|
1013
|
-
|
1014
|
-
|
1015
|
-
|
1016
|
-
|
1017
|
-
|
1018
|
-
|
1019
|
-
|
1020
|
-
# @!attribute [rw] disable_automated_backup
|
1021
|
-
# Setting DisableAutomatedBackup to `true` disables automated or
|
1022
|
-
# scheduled backups. Automated backups are enabled by default.
|
1023
|
-
# @return [Boolean]
|
1024
|
-
#
|
1025
|
-
# @!attribute [rw] backup_retention_count
|
1026
|
-
# Sets the number of automated backups that you want to keep.
|
1027
|
-
# @return [Integer]
|
1028
|
-
#
|
1029
|
-
# @!attribute [rw] server_name
|
1030
|
-
# The name of the server to update.
|
1031
|
-
# @return [String]
|
1032
|
-
#
|
1033
|
-
# @!attribute [rw] preferred_maintenance_window
|
1034
|
-
# `DDD:HH:MM` (weekly start time) or `HH:MM` (daily start time).
|
1035
|
-
#
|
1036
|
-
# Time windows always use coordinated universal time (UTC).
|
1037
|
-
#
|
1038
|
-
# Valid strings for day of week (`DDD`) are: Mon, Tue, Wed, Thr, Fri,
|
1039
|
-
# Sat, Sun.
|
1040
|
-
# @return [String]
|
1041
|
-
#
|
1042
|
-
# @!attribute [rw] preferred_backup_window
|
1043
|
-
# `DDD:HH:MM` (weekly start time) or `HH:MM` (daily start time).
|
1044
|
-
#
|
1045
|
-
# Time windows always use coordinated universal time (UTC).
|
1046
|
-
#
|
1047
|
-
# Valid strings for day of week (`DDD`) are: Mon, Tue, Wed, Thr, Fri,
|
1048
|
-
# Sat, Sun.
|
1049
|
-
# @return [String]
|
1050
|
-
class UpdateServerRequest < Struct.new(
|
1051
|
-
:disable_automated_backup,
|
1052
|
-
:backup_retention_count,
|
1053
|
-
:server_name,
|
1054
|
-
:preferred_maintenance_window,
|
1055
|
-
:preferred_backup_window)
|
1056
|
-
include Aws::Structure
|
1057
|
-
end
|
1179
|
+
# @!attribute [rw] server
|
1180
|
+
# Contains the response to an `UpdateServerEngineAttributes` request.
|
1181
|
+
# @return [Types::Server]
|
1182
|
+
#
|
1183
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/UpdateServerEngineAttributesResponse AWS API Documentation
|
1184
|
+
#
|
1185
|
+
class UpdateServerEngineAttributesResponse < Struct.new(
|
1186
|
+
:server)
|
1187
|
+
include Aws::Structure
|
1188
|
+
end
|
1058
1189
|
|
1059
|
-
|
1060
|
-
|
1061
|
-
|
1062
|
-
|
1063
|
-
|
1064
|
-
|
1065
|
-
|
1190
|
+
# @note When making an API call, you may pass UpdateServerRequest
|
1191
|
+
# data as a hash:
|
1192
|
+
#
|
1193
|
+
# {
|
1194
|
+
# disable_automated_backup: false,
|
1195
|
+
# backup_retention_count: 1,
|
1196
|
+
# server_name: "ServerName", # required
|
1197
|
+
# preferred_maintenance_window: "TimeWindowDefinition",
|
1198
|
+
# preferred_backup_window: "TimeWindowDefinition",
|
1199
|
+
# }
|
1200
|
+
#
|
1201
|
+
# @!attribute [rw] disable_automated_backup
|
1202
|
+
# Setting DisableAutomatedBackup to `true` disables automated or
|
1203
|
+
# scheduled backups. Automated backups are enabled by default.
|
1204
|
+
# @return [Boolean]
|
1205
|
+
#
|
1206
|
+
# @!attribute [rw] backup_retention_count
|
1207
|
+
# Sets the number of automated backups that you want to keep.
|
1208
|
+
# @return [Integer]
|
1209
|
+
#
|
1210
|
+
# @!attribute [rw] server_name
|
1211
|
+
# The name of the server to update.
|
1212
|
+
# @return [String]
|
1213
|
+
#
|
1214
|
+
# @!attribute [rw] preferred_maintenance_window
|
1215
|
+
# `DDD:HH:MM` (weekly start time) or `HH:MM` (daily start time).
|
1216
|
+
#
|
1217
|
+
# Time windows always use coordinated universal time (UTC). Valid
|
1218
|
+
# strings for day of week (`DDD`) are: `Mon`, `Tue`, `Wed`, `Thr`,
|
1219
|
+
# `Fri`, `Sat`, or `Sun`.
|
1220
|
+
# @return [String]
|
1221
|
+
#
|
1222
|
+
# @!attribute [rw] preferred_backup_window
|
1223
|
+
# `DDD:HH:MM` (weekly start time) or `HH:MM` (daily start time).
|
1224
|
+
#
|
1225
|
+
# Time windows always use coordinated universal time (UTC). Valid
|
1226
|
+
# strings for day of week (`DDD`) are: `Mon`, `Tue`, `Wed`, `Thr`,
|
1227
|
+
# `Fri`, `Sat`, or `Sun`.
|
1228
|
+
# @return [String]
|
1229
|
+
#
|
1230
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/UpdateServerRequest AWS API Documentation
|
1231
|
+
#
|
1232
|
+
class UpdateServerRequest < Struct.new(
|
1233
|
+
:disable_automated_backup,
|
1234
|
+
:backup_retention_count,
|
1235
|
+
:server_name,
|
1236
|
+
:preferred_maintenance_window,
|
1237
|
+
:preferred_backup_window)
|
1238
|
+
include Aws::Structure
|
1239
|
+
end
|
1066
1240
|
|
1241
|
+
# @!attribute [rw] server
|
1242
|
+
# Contains the response to a `UpdateServer` request.
|
1243
|
+
# @return [Types::Server]
|
1244
|
+
#
|
1245
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/UpdateServerResponse AWS API Documentation
|
1246
|
+
#
|
1247
|
+
class UpdateServerResponse < Struct.new(
|
1248
|
+
:server)
|
1249
|
+
include Aws::Structure
|
1067
1250
|
end
|
1251
|
+
|
1068
1252
|
end
|
1069
1253
|
end
|