aws-sdk-apprunner 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-apprunner.rb +53 -0
- data/lib/aws-sdk-apprunner/client.rb +1833 -0
- data/lib/aws-sdk-apprunner/client_api.rb +790 -0
- data/lib/aws-sdk-apprunner/customizations.rb +0 -0
- data/lib/aws-sdk-apprunner/errors.rb +118 -0
- data/lib/aws-sdk-apprunner/resource.rb +26 -0
- data/lib/aws-sdk-apprunner/types.rb +2403 -0
- metadata +90 -0
File without changes
|
@@ -0,0 +1,118 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::AppRunner
|
11
|
+
|
12
|
+
# When AppRunner returns an error response, the Ruby SDK constructs and raises an error.
|
13
|
+
# These errors all extend Aws::AppRunner::Errors::ServiceError < {Aws::Errors::ServiceError}
|
14
|
+
#
|
15
|
+
# You can rescue all AppRunner errors using ServiceError:
|
16
|
+
#
|
17
|
+
# begin
|
18
|
+
# # do stuff
|
19
|
+
# rescue Aws::AppRunner::Errors::ServiceError
|
20
|
+
# # rescues all AppRunner API errors
|
21
|
+
# end
|
22
|
+
#
|
23
|
+
#
|
24
|
+
# ## Request Context
|
25
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
26
|
+
# information about the request that generated the error.
|
27
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
28
|
+
#
|
29
|
+
# ## Error Classes
|
30
|
+
# * {InternalServiceErrorException}
|
31
|
+
# * {InvalidRequestException}
|
32
|
+
# * {InvalidStateException}
|
33
|
+
# * {ResourceNotFoundException}
|
34
|
+
# * {ServiceQuotaExceededException}
|
35
|
+
#
|
36
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
37
|
+
# if they are not defined above.
|
38
|
+
module Errors
|
39
|
+
|
40
|
+
extend Aws::Errors::DynamicErrors
|
41
|
+
|
42
|
+
class InternalServiceErrorException < ServiceError
|
43
|
+
|
44
|
+
# @param [Seahorse::Client::RequestContext] context
|
45
|
+
# @param [String] message
|
46
|
+
# @param [Aws::AppRunner::Types::InternalServiceErrorException] data
|
47
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
48
|
+
super(context, message, data)
|
49
|
+
end
|
50
|
+
|
51
|
+
# @return [String]
|
52
|
+
def message
|
53
|
+
@message || @data[:message]
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
class InvalidRequestException < ServiceError
|
58
|
+
|
59
|
+
# @param [Seahorse::Client::RequestContext] context
|
60
|
+
# @param [String] message
|
61
|
+
# @param [Aws::AppRunner::Types::InvalidRequestException] data
|
62
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
63
|
+
super(context, message, data)
|
64
|
+
end
|
65
|
+
|
66
|
+
# @return [String]
|
67
|
+
def message
|
68
|
+
@message || @data[:message]
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
72
|
+
class InvalidStateException < ServiceError
|
73
|
+
|
74
|
+
# @param [Seahorse::Client::RequestContext] context
|
75
|
+
# @param [String] message
|
76
|
+
# @param [Aws::AppRunner::Types::InvalidStateException] data
|
77
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
78
|
+
super(context, message, data)
|
79
|
+
end
|
80
|
+
|
81
|
+
# @return [String]
|
82
|
+
def message
|
83
|
+
@message || @data[:message]
|
84
|
+
end
|
85
|
+
end
|
86
|
+
|
87
|
+
class ResourceNotFoundException < ServiceError
|
88
|
+
|
89
|
+
# @param [Seahorse::Client::RequestContext] context
|
90
|
+
# @param [String] message
|
91
|
+
# @param [Aws::AppRunner::Types::ResourceNotFoundException] data
|
92
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
93
|
+
super(context, message, data)
|
94
|
+
end
|
95
|
+
|
96
|
+
# @return [String]
|
97
|
+
def message
|
98
|
+
@message || @data[:message]
|
99
|
+
end
|
100
|
+
end
|
101
|
+
|
102
|
+
class ServiceQuotaExceededException < ServiceError
|
103
|
+
|
104
|
+
# @param [Seahorse::Client::RequestContext] context
|
105
|
+
# @param [String] message
|
106
|
+
# @param [Aws::AppRunner::Types::ServiceQuotaExceededException] data
|
107
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
108
|
+
super(context, message, data)
|
109
|
+
end
|
110
|
+
|
111
|
+
# @return [String]
|
112
|
+
def message
|
113
|
+
@message || @data[:message]
|
114
|
+
end
|
115
|
+
end
|
116
|
+
|
117
|
+
end
|
118
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::AppRunner
|
11
|
+
|
12
|
+
class Resource
|
13
|
+
|
14
|
+
# @param options ({})
|
15
|
+
# @option options [Client] :client
|
16
|
+
def initialize(options = {})
|
17
|
+
@client = options[:client] || Client.new(options)
|
18
|
+
end
|
19
|
+
|
20
|
+
# @return [Client]
|
21
|
+
def client
|
22
|
+
@client
|
23
|
+
end
|
24
|
+
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,2403 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::AppRunner
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# @note When making an API call, you may pass AssociateCustomDomainRequest
|
14
|
+
# data as a hash:
|
15
|
+
#
|
16
|
+
# {
|
17
|
+
# service_arn: "AppRunnerResourceArn", # required
|
18
|
+
# domain_name: "DomainName", # required
|
19
|
+
# enable_www_subdomain: false,
|
20
|
+
# }
|
21
|
+
#
|
22
|
+
# @!attribute [rw] service_arn
|
23
|
+
# The Amazon Resource Name (ARN) of the App Runner service that you
|
24
|
+
# want to associate a custom domain name with.
|
25
|
+
# @return [String]
|
26
|
+
#
|
27
|
+
# @!attribute [rw] domain_name
|
28
|
+
# A custom domain endpoint to associate. Specify a root domain (for
|
29
|
+
# example, `example.com`), a subdomain (for example,
|
30
|
+
# `login.example.com` or `admin.login.example.com`), or a wildcard
|
31
|
+
# (for example, `*.example.com`).
|
32
|
+
# @return [String]
|
33
|
+
#
|
34
|
+
# @!attribute [rw] enable_www_subdomain
|
35
|
+
# Set to `true` to associate the subdomain `www.DomainName ` with the
|
36
|
+
# App Runner service in addition to the base domain.
|
37
|
+
#
|
38
|
+
# Default: `true`
|
39
|
+
# @return [Boolean]
|
40
|
+
#
|
41
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/AssociateCustomDomainRequest AWS API Documentation
|
42
|
+
#
|
43
|
+
class AssociateCustomDomainRequest < Struct.new(
|
44
|
+
:service_arn,
|
45
|
+
:domain_name,
|
46
|
+
:enable_www_subdomain)
|
47
|
+
SENSITIVE = []
|
48
|
+
include Aws::Structure
|
49
|
+
end
|
50
|
+
|
51
|
+
# @!attribute [rw] dns_target
|
52
|
+
# The App Runner subdomain of the App Runner service. The custom
|
53
|
+
# domain name is mapped to this target name.
|
54
|
+
# @return [String]
|
55
|
+
#
|
56
|
+
# @!attribute [rw] service_arn
|
57
|
+
# The Amazon Resource Name (ARN) of the App Runner service with which
|
58
|
+
# a custom domain name is associated.
|
59
|
+
# @return [String]
|
60
|
+
#
|
61
|
+
# @!attribute [rw] custom_domain
|
62
|
+
# A description of the domain name that's being associated.
|
63
|
+
# @return [Types::CustomDomain]
|
64
|
+
#
|
65
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/AssociateCustomDomainResponse AWS API Documentation
|
66
|
+
#
|
67
|
+
class AssociateCustomDomainResponse < Struct.new(
|
68
|
+
:dns_target,
|
69
|
+
:service_arn,
|
70
|
+
:custom_domain)
|
71
|
+
SENSITIVE = []
|
72
|
+
include Aws::Structure
|
73
|
+
end
|
74
|
+
|
75
|
+
# Describes resources needed to authenticate access to some source
|
76
|
+
# repositories. The specific resource depends on the repository
|
77
|
+
# provider.
|
78
|
+
#
|
79
|
+
# @note When making an API call, you may pass AuthenticationConfiguration
|
80
|
+
# data as a hash:
|
81
|
+
#
|
82
|
+
# {
|
83
|
+
# connection_arn: "AppRunnerResourceArn",
|
84
|
+
# access_role_arn: "RoleArn",
|
85
|
+
# }
|
86
|
+
#
|
87
|
+
# @!attribute [rw] connection_arn
|
88
|
+
# The Amazon Resource Name (ARN) of the App Runner connection that
|
89
|
+
# enables the App Runner service to connect to a source repository.
|
90
|
+
# It's required for GitHub code repositories.
|
91
|
+
# @return [String]
|
92
|
+
#
|
93
|
+
# @!attribute [rw] access_role_arn
|
94
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants the App
|
95
|
+
# Runner service access to a source repository. It's required for ECR
|
96
|
+
# image repositories (but not for ECR Public repositories).
|
97
|
+
# @return [String]
|
98
|
+
#
|
99
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/AuthenticationConfiguration AWS API Documentation
|
100
|
+
#
|
101
|
+
class AuthenticationConfiguration < Struct.new(
|
102
|
+
:connection_arn,
|
103
|
+
:access_role_arn)
|
104
|
+
SENSITIVE = []
|
105
|
+
include Aws::Structure
|
106
|
+
end
|
107
|
+
|
108
|
+
# Describes an AWS App Runner automatic scaling configuration resource.
|
109
|
+
# Multiple revisions of a configuration have the same
|
110
|
+
# `AutoScalingConfigurationName` and different
|
111
|
+
# `AutoScalingConfigurationRevision` values.
|
112
|
+
#
|
113
|
+
# A higher `MinSize` increases the spread of your App Runner service
|
114
|
+
# over more Availability Zones in the AWS Region. The tradeoff is a
|
115
|
+
# higher minimal cost.
|
116
|
+
#
|
117
|
+
# A lower `MaxSize` controls your cost. The tradeoff is lower
|
118
|
+
# responsiveness during peak demand.
|
119
|
+
#
|
120
|
+
# @!attribute [rw] auto_scaling_configuration_arn
|
121
|
+
# The Amazon Resource Name (ARN) of this auto scaling configuration.
|
122
|
+
# @return [String]
|
123
|
+
#
|
124
|
+
# @!attribute [rw] auto_scaling_configuration_name
|
125
|
+
# The customer-provided auto scaling configuration name. It can be
|
126
|
+
# used in multiple revisions of a configuration.
|
127
|
+
# @return [String]
|
128
|
+
#
|
129
|
+
# @!attribute [rw] auto_scaling_configuration_revision
|
130
|
+
# The revision of this auto scaling configuration. It's unique among
|
131
|
+
# all the active configurations (`"Status": "ACTIVE"`) that share the
|
132
|
+
# same `AutoScalingConfigurationName`.
|
133
|
+
# @return [Integer]
|
134
|
+
#
|
135
|
+
# @!attribute [rw] latest
|
136
|
+
# It's set to `true` for the configuration with the highest
|
137
|
+
# `Revision` among all configurations that share the same `Name`.
|
138
|
+
# It's set to `false` otherwise.
|
139
|
+
# @return [Boolean]
|
140
|
+
#
|
141
|
+
# @!attribute [rw] status
|
142
|
+
# The current state of the auto scaling configuration. If the status
|
143
|
+
# of a configuration revision is `INACTIVE`, it was deleted and can't
|
144
|
+
# be used. Inactive configuration revisions are permanently removed
|
145
|
+
# some time after they are deleted.
|
146
|
+
# @return [String]
|
147
|
+
#
|
148
|
+
# @!attribute [rw] max_concurrency
|
149
|
+
# The maximum number of concurrent requests that an instance
|
150
|
+
# processes. If the number of concurrent requests exceeds this limit,
|
151
|
+
# App Runner scales the service up.
|
152
|
+
# @return [Integer]
|
153
|
+
#
|
154
|
+
# @!attribute [rw] min_size
|
155
|
+
# The minimum number of instances that App Runner provisions for a
|
156
|
+
# service. The service always has at least `MinSize` provisioned
|
157
|
+
# instances. Some of them actively serve traffic. The rest of them
|
158
|
+
# (provisioned and inactive instances) are a cost-effective compute
|
159
|
+
# capacity reserve and are ready to be quickly activated. You pay for
|
160
|
+
# memory usage of all the provisioned instances. You pay for CPU usage
|
161
|
+
# of only the active subset.
|
162
|
+
#
|
163
|
+
# App Runner temporarily doubles the number of provisioned instances
|
164
|
+
# during deployments, to maintain the same capacity for both old and
|
165
|
+
# new code.
|
166
|
+
# @return [Integer]
|
167
|
+
#
|
168
|
+
# @!attribute [rw] max_size
|
169
|
+
# The maximum number of instances that a service scales up to. At most
|
170
|
+
# `MaxSize` instances actively serve traffic for your service.
|
171
|
+
# @return [Integer]
|
172
|
+
#
|
173
|
+
# @!attribute [rw] created_at
|
174
|
+
# The time when the auto scaling configuration was created. It's in
|
175
|
+
# Unix time stamp format.
|
176
|
+
# @return [Time]
|
177
|
+
#
|
178
|
+
# @!attribute [rw] deleted_at
|
179
|
+
# The time when the auto scaling configuration was deleted. It's in
|
180
|
+
# Unix time stamp format.
|
181
|
+
# @return [Time]
|
182
|
+
#
|
183
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/AutoScalingConfiguration AWS API Documentation
|
184
|
+
#
|
185
|
+
class AutoScalingConfiguration < Struct.new(
|
186
|
+
:auto_scaling_configuration_arn,
|
187
|
+
:auto_scaling_configuration_name,
|
188
|
+
:auto_scaling_configuration_revision,
|
189
|
+
:latest,
|
190
|
+
:status,
|
191
|
+
:max_concurrency,
|
192
|
+
:min_size,
|
193
|
+
:max_size,
|
194
|
+
:created_at,
|
195
|
+
:deleted_at)
|
196
|
+
SENSITIVE = []
|
197
|
+
include Aws::Structure
|
198
|
+
end
|
199
|
+
|
200
|
+
# Provides summary information about an AWS App Runner automatic scaling
|
201
|
+
# configuration resource.
|
202
|
+
#
|
203
|
+
# This type contains limited information about an auto scaling
|
204
|
+
# configuration. It includes only identification information, without
|
205
|
+
# configuration details. It's returned by the
|
206
|
+
# ListAutoScalingConfigurations action. Complete configuration
|
207
|
+
# information is returned by the CreateAutoScalingConfiguration,
|
208
|
+
# DescribeAutoScalingConfiguration, and DeleteAutoScalingConfiguration
|
209
|
+
# actions using the AutoScalingConfiguration type.
|
210
|
+
#
|
211
|
+
# @!attribute [rw] auto_scaling_configuration_arn
|
212
|
+
# The Amazon Resource Name (ARN) of this auto scaling configuration.
|
213
|
+
# @return [String]
|
214
|
+
#
|
215
|
+
# @!attribute [rw] auto_scaling_configuration_name
|
216
|
+
# The customer-provided auto scaling configuration name. It can be
|
217
|
+
# used in multiple revisions of a configuration.
|
218
|
+
# @return [String]
|
219
|
+
#
|
220
|
+
# @!attribute [rw] auto_scaling_configuration_revision
|
221
|
+
# The revision of this auto scaling configuration. It's unique among
|
222
|
+
# all the active configurations (`"Status": "ACTIVE"`) with the same
|
223
|
+
# `AutoScalingConfigurationName`.
|
224
|
+
# @return [Integer]
|
225
|
+
#
|
226
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/AutoScalingConfigurationSummary AWS API Documentation
|
227
|
+
#
|
228
|
+
class AutoScalingConfigurationSummary < Struct.new(
|
229
|
+
:auto_scaling_configuration_arn,
|
230
|
+
:auto_scaling_configuration_name,
|
231
|
+
:auto_scaling_configuration_revision)
|
232
|
+
SENSITIVE = []
|
233
|
+
include Aws::Structure
|
234
|
+
end
|
235
|
+
|
236
|
+
# Describes a certificate CNAME record to add to your DNS. For more
|
237
|
+
# information, see [AssociateCustomDomain][1].
|
238
|
+
#
|
239
|
+
#
|
240
|
+
#
|
241
|
+
# [1]: https://docs.aws.amazon.com/apprunner/latest/api/API_AssociateCustomDomain.html
|
242
|
+
#
|
243
|
+
# @!attribute [rw] name
|
244
|
+
# The certificate CNAME record name.
|
245
|
+
# @return [String]
|
246
|
+
#
|
247
|
+
# @!attribute [rw] type
|
248
|
+
# The record type, always `CNAME`.
|
249
|
+
# @return [String]
|
250
|
+
#
|
251
|
+
# @!attribute [rw] value
|
252
|
+
# The certificate CNAME record value.
|
253
|
+
# @return [String]
|
254
|
+
#
|
255
|
+
# @!attribute [rw] status
|
256
|
+
# The current state of the certificate CNAME record validation. It
|
257
|
+
# should change to `SUCCESS` after App Runner completes validation
|
258
|
+
# with your DNS.
|
259
|
+
# @return [String]
|
260
|
+
#
|
261
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/CertificateValidationRecord AWS API Documentation
|
262
|
+
#
|
263
|
+
class CertificateValidationRecord < Struct.new(
|
264
|
+
:name,
|
265
|
+
:type,
|
266
|
+
:value,
|
267
|
+
:status)
|
268
|
+
SENSITIVE = []
|
269
|
+
include Aws::Structure
|
270
|
+
end
|
271
|
+
|
272
|
+
# Describes the configuration that AWS App Runner uses to build and run
|
273
|
+
# an App Runner service from a source code repository.
|
274
|
+
#
|
275
|
+
# @note When making an API call, you may pass CodeConfiguration
|
276
|
+
# data as a hash:
|
277
|
+
#
|
278
|
+
# {
|
279
|
+
# configuration_source: "REPOSITORY", # required, accepts REPOSITORY, API
|
280
|
+
# code_configuration_values: {
|
281
|
+
# runtime: "PYTHON_3", # required, accepts PYTHON_3, NODEJS_12
|
282
|
+
# build_command: "BuildCommand",
|
283
|
+
# start_command: "StartCommand",
|
284
|
+
# port: "String",
|
285
|
+
# runtime_environment_variables: {
|
286
|
+
# "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue",
|
287
|
+
# },
|
288
|
+
# },
|
289
|
+
# }
|
290
|
+
#
|
291
|
+
# @!attribute [rw] configuration_source
|
292
|
+
# The source of the App Runner configuration. Values are interpreted
|
293
|
+
# as follows:
|
294
|
+
#
|
295
|
+
# * `REPOSITORY` – App Runner reads configuration values from the
|
296
|
+
# `apprunner.yaml` file in the source code repository and ignores
|
297
|
+
# `CodeConfigurationValues`.
|
298
|
+
#
|
299
|
+
# * `API` – App Runner uses configuration values provided in
|
300
|
+
# `CodeConfigurationValues` and ignores the `apprunner.yaml` file in
|
301
|
+
# the source code repository.
|
302
|
+
# @return [String]
|
303
|
+
#
|
304
|
+
# @!attribute [rw] code_configuration_values
|
305
|
+
# The basic configuration for building and running the App Runner
|
306
|
+
# service. Use it to quickly launch an App Runner service without
|
307
|
+
# providing a `apprunner.yaml` file in the source code repository (or
|
308
|
+
# ignoring the file if it exists).
|
309
|
+
# @return [Types::CodeConfigurationValues]
|
310
|
+
#
|
311
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/CodeConfiguration AWS API Documentation
|
312
|
+
#
|
313
|
+
class CodeConfiguration < Struct.new(
|
314
|
+
:configuration_source,
|
315
|
+
:code_configuration_values)
|
316
|
+
SENSITIVE = []
|
317
|
+
include Aws::Structure
|
318
|
+
end
|
319
|
+
|
320
|
+
# Describes the basic configuration needed for building and running an
|
321
|
+
# AWS App Runner service. This type doesn't support the full set of
|
322
|
+
# possible configuration options. Fur full configuration capabilities,
|
323
|
+
# use a `apprunner.yaml` file in the source code repository.
|
324
|
+
#
|
325
|
+
# @note When making an API call, you may pass CodeConfigurationValues
|
326
|
+
# data as a hash:
|
327
|
+
#
|
328
|
+
# {
|
329
|
+
# runtime: "PYTHON_3", # required, accepts PYTHON_3, NODEJS_12
|
330
|
+
# build_command: "BuildCommand",
|
331
|
+
# start_command: "StartCommand",
|
332
|
+
# port: "String",
|
333
|
+
# runtime_environment_variables: {
|
334
|
+
# "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue",
|
335
|
+
# },
|
336
|
+
# }
|
337
|
+
#
|
338
|
+
# @!attribute [rw] runtime
|
339
|
+
# A runtime environment type for building and running an App Runner
|
340
|
+
# service. It represents a programming language runtime.
|
341
|
+
# @return [String]
|
342
|
+
#
|
343
|
+
# @!attribute [rw] build_command
|
344
|
+
# The command App Runner runs to build your application.
|
345
|
+
# @return [String]
|
346
|
+
#
|
347
|
+
# @!attribute [rw] start_command
|
348
|
+
# The command App Runner runs to start your application.
|
349
|
+
# @return [String]
|
350
|
+
#
|
351
|
+
# @!attribute [rw] port
|
352
|
+
# The port that your application listens to in the container.
|
353
|
+
#
|
354
|
+
# Default: `8080`
|
355
|
+
# @return [String]
|
356
|
+
#
|
357
|
+
# @!attribute [rw] runtime_environment_variables
|
358
|
+
# The environment variables that are available to your running App
|
359
|
+
# Runner service. An array of key-value pairs. Keys with a prefix of
|
360
|
+
# `AWSAPPRUNNER` are reserved for system use and aren't valid.
|
361
|
+
# @return [Hash<String,String>]
|
362
|
+
#
|
363
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/CodeConfigurationValues AWS API Documentation
|
364
|
+
#
|
365
|
+
class CodeConfigurationValues < Struct.new(
|
366
|
+
:runtime,
|
367
|
+
:build_command,
|
368
|
+
:start_command,
|
369
|
+
:port,
|
370
|
+
:runtime_environment_variables)
|
371
|
+
SENSITIVE = [:build_command, :start_command]
|
372
|
+
include Aws::Structure
|
373
|
+
end
|
374
|
+
|
375
|
+
# Describes a source code repository.
|
376
|
+
#
|
377
|
+
# @note When making an API call, you may pass CodeRepository
|
378
|
+
# data as a hash:
|
379
|
+
#
|
380
|
+
# {
|
381
|
+
# repository_url: "String", # required
|
382
|
+
# source_code_version: { # required
|
383
|
+
# type: "BRANCH", # required, accepts BRANCH
|
384
|
+
# value: "String", # required
|
385
|
+
# },
|
386
|
+
# code_configuration: {
|
387
|
+
# configuration_source: "REPOSITORY", # required, accepts REPOSITORY, API
|
388
|
+
# code_configuration_values: {
|
389
|
+
# runtime: "PYTHON_3", # required, accepts PYTHON_3, NODEJS_12
|
390
|
+
# build_command: "BuildCommand",
|
391
|
+
# start_command: "StartCommand",
|
392
|
+
# port: "String",
|
393
|
+
# runtime_environment_variables: {
|
394
|
+
# "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue",
|
395
|
+
# },
|
396
|
+
# },
|
397
|
+
# },
|
398
|
+
# }
|
399
|
+
#
|
400
|
+
# @!attribute [rw] repository_url
|
401
|
+
# The location of the repository that contains the source code.
|
402
|
+
# @return [String]
|
403
|
+
#
|
404
|
+
# @!attribute [rw] source_code_version
|
405
|
+
# The version that should be used within the source code repository.
|
406
|
+
# @return [Types::SourceCodeVersion]
|
407
|
+
#
|
408
|
+
# @!attribute [rw] code_configuration
|
409
|
+
# Configuration for building and running the service from a source
|
410
|
+
# code repository.
|
411
|
+
# @return [Types::CodeConfiguration]
|
412
|
+
#
|
413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/CodeRepository AWS API Documentation
|
414
|
+
#
|
415
|
+
class CodeRepository < Struct.new(
|
416
|
+
:repository_url,
|
417
|
+
:source_code_version,
|
418
|
+
:code_configuration)
|
419
|
+
SENSITIVE = []
|
420
|
+
include Aws::Structure
|
421
|
+
end
|
422
|
+
|
423
|
+
# Describes an AWS App Runner connection resource.
|
424
|
+
#
|
425
|
+
# @!attribute [rw] connection_name
|
426
|
+
# The customer-provided connection name.
|
427
|
+
# @return [String]
|
428
|
+
#
|
429
|
+
# @!attribute [rw] connection_arn
|
430
|
+
# The Amazon Resource Name (ARN) of this connection.
|
431
|
+
# @return [String]
|
432
|
+
#
|
433
|
+
# @!attribute [rw] provider_type
|
434
|
+
# The source repository provider.
|
435
|
+
# @return [String]
|
436
|
+
#
|
437
|
+
# @!attribute [rw] status
|
438
|
+
# The current state of the App Runner connection. When the state is
|
439
|
+
# `AVAILABLE`, you can use the connection to create an App Runner
|
440
|
+
# service.
|
441
|
+
# @return [String]
|
442
|
+
#
|
443
|
+
# @!attribute [rw] created_at
|
444
|
+
# The App Runner connection creation time, expressed as a Unix time
|
445
|
+
# stamp.
|
446
|
+
# @return [Time]
|
447
|
+
#
|
448
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/Connection AWS API Documentation
|
449
|
+
#
|
450
|
+
class Connection < Struct.new(
|
451
|
+
:connection_name,
|
452
|
+
:connection_arn,
|
453
|
+
:provider_type,
|
454
|
+
:status,
|
455
|
+
:created_at)
|
456
|
+
SENSITIVE = []
|
457
|
+
include Aws::Structure
|
458
|
+
end
|
459
|
+
|
460
|
+
# Provides summary information about an AWS App Runner connection
|
461
|
+
# resource.
|
462
|
+
#
|
463
|
+
# @!attribute [rw] connection_name
|
464
|
+
# The customer-provided connection name.
|
465
|
+
# @return [String]
|
466
|
+
#
|
467
|
+
# @!attribute [rw] connection_arn
|
468
|
+
# The Amazon Resource Name (ARN) of this connection.
|
469
|
+
# @return [String]
|
470
|
+
#
|
471
|
+
# @!attribute [rw] provider_type
|
472
|
+
# The source repository provider.
|
473
|
+
# @return [String]
|
474
|
+
#
|
475
|
+
# @!attribute [rw] status
|
476
|
+
# The current state of the App Runner connection. When the state is
|
477
|
+
# `AVAILABLE`, you can use the connection to create an App Runner
|
478
|
+
# service.
|
479
|
+
# @return [String]
|
480
|
+
#
|
481
|
+
# @!attribute [rw] created_at
|
482
|
+
# The App Runner connection creation time, expressed as a Unix time
|
483
|
+
# stamp.
|
484
|
+
# @return [Time]
|
485
|
+
#
|
486
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ConnectionSummary AWS API Documentation
|
487
|
+
#
|
488
|
+
class ConnectionSummary < Struct.new(
|
489
|
+
:connection_name,
|
490
|
+
:connection_arn,
|
491
|
+
:provider_type,
|
492
|
+
:status,
|
493
|
+
:created_at)
|
494
|
+
SENSITIVE = []
|
495
|
+
include Aws::Structure
|
496
|
+
end
|
497
|
+
|
498
|
+
# @note When making an API call, you may pass CreateAutoScalingConfigurationRequest
|
499
|
+
# data as a hash:
|
500
|
+
#
|
501
|
+
# {
|
502
|
+
# auto_scaling_configuration_name: "AutoScalingConfigurationName", # required
|
503
|
+
# max_concurrency: 1,
|
504
|
+
# min_size: 1,
|
505
|
+
# max_size: 1,
|
506
|
+
# tags: [
|
507
|
+
# {
|
508
|
+
# key: "TagKey",
|
509
|
+
# value: "TagValue",
|
510
|
+
# },
|
511
|
+
# ],
|
512
|
+
# }
|
513
|
+
#
|
514
|
+
# @!attribute [rw] auto_scaling_configuration_name
|
515
|
+
# A name for the auto scaling configuration. When you use it for the
|
516
|
+
# first time in an AWS Region, App Runner creates revision number `1`
|
517
|
+
# of this name. When you use the same name in subsequent calls, App
|
518
|
+
# Runner creates incremental revisions of the configuration.
|
519
|
+
# @return [String]
|
520
|
+
#
|
521
|
+
# @!attribute [rw] max_concurrency
|
522
|
+
# The maximum number of concurrent requests that you want an instance
|
523
|
+
# to process. If the number of concurrent requests exceeds this limit,
|
524
|
+
# App Runner scales up your service.
|
525
|
+
#
|
526
|
+
# Default: `100`
|
527
|
+
# @return [Integer]
|
528
|
+
#
|
529
|
+
# @!attribute [rw] min_size
|
530
|
+
# The minimum number of instances that App Runner provisions for your
|
531
|
+
# service. The service always has at least `MinSize` provisioned
|
532
|
+
# instances. Some of them actively serve traffic. The rest of them
|
533
|
+
# (provisioned and inactive instances) are a cost-effective compute
|
534
|
+
# capacity reserve and are ready to be quickly activated. You pay for
|
535
|
+
# memory usage of all the provisioned instances. You pay for CPU usage
|
536
|
+
# of only the active subset.
|
537
|
+
#
|
538
|
+
# App Runner temporarily doubles the number of provisioned instances
|
539
|
+
# during deployments, to maintain the same capacity for both old and
|
540
|
+
# new code.
|
541
|
+
#
|
542
|
+
# Default: `1`
|
543
|
+
# @return [Integer]
|
544
|
+
#
|
545
|
+
# @!attribute [rw] max_size
|
546
|
+
# The maximum number of instances that your service scales up to. At
|
547
|
+
# most `MaxSize` instances actively serve traffic for your service.
|
548
|
+
#
|
549
|
+
# Default: `25`
|
550
|
+
# @return [Integer]
|
551
|
+
#
|
552
|
+
# @!attribute [rw] tags
|
553
|
+
# A list of metadata items that you can associate with your auto
|
554
|
+
# scaling configuration resource. A tag is a key-value pair.
|
555
|
+
# @return [Array<Types::Tag>]
|
556
|
+
#
|
557
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/CreateAutoScalingConfigurationRequest AWS API Documentation
|
558
|
+
#
|
559
|
+
class CreateAutoScalingConfigurationRequest < Struct.new(
|
560
|
+
:auto_scaling_configuration_name,
|
561
|
+
:max_concurrency,
|
562
|
+
:min_size,
|
563
|
+
:max_size,
|
564
|
+
:tags)
|
565
|
+
SENSITIVE = []
|
566
|
+
include Aws::Structure
|
567
|
+
end
|
568
|
+
|
569
|
+
# @!attribute [rw] auto_scaling_configuration
|
570
|
+
# A description of the App Runner auto scaling configuration that's
|
571
|
+
# created by this request.
|
572
|
+
# @return [Types::AutoScalingConfiguration]
|
573
|
+
#
|
574
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/CreateAutoScalingConfigurationResponse AWS API Documentation
|
575
|
+
#
|
576
|
+
class CreateAutoScalingConfigurationResponse < Struct.new(
|
577
|
+
:auto_scaling_configuration)
|
578
|
+
SENSITIVE = []
|
579
|
+
include Aws::Structure
|
580
|
+
end
|
581
|
+
|
582
|
+
# @note When making an API call, you may pass CreateConnectionRequest
|
583
|
+
# data as a hash:
|
584
|
+
#
|
585
|
+
# {
|
586
|
+
# connection_name: "ConnectionName", # required
|
587
|
+
# provider_type: "GITHUB", # required, accepts GITHUB
|
588
|
+
# tags: [
|
589
|
+
# {
|
590
|
+
# key: "TagKey",
|
591
|
+
# value: "TagValue",
|
592
|
+
# },
|
593
|
+
# ],
|
594
|
+
# }
|
595
|
+
#
|
596
|
+
# @!attribute [rw] connection_name
|
597
|
+
# A name for the new connection. It must be unique across all App
|
598
|
+
# Runner connections for the AWS account in the AWS Region.
|
599
|
+
# @return [String]
|
600
|
+
#
|
601
|
+
# @!attribute [rw] provider_type
|
602
|
+
# The source repository provider.
|
603
|
+
# @return [String]
|
604
|
+
#
|
605
|
+
# @!attribute [rw] tags
|
606
|
+
# A list of metadata items that you can associate with your connection
|
607
|
+
# resource. A tag is a key-value pair.
|
608
|
+
# @return [Array<Types::Tag>]
|
609
|
+
#
|
610
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/CreateConnectionRequest AWS API Documentation
|
611
|
+
#
|
612
|
+
class CreateConnectionRequest < Struct.new(
|
613
|
+
:connection_name,
|
614
|
+
:provider_type,
|
615
|
+
:tags)
|
616
|
+
SENSITIVE = []
|
617
|
+
include Aws::Structure
|
618
|
+
end
|
619
|
+
|
620
|
+
# @!attribute [rw] connection
|
621
|
+
# A description of the App Runner connection that's created by this
|
622
|
+
# request.
|
623
|
+
# @return [Types::Connection]
|
624
|
+
#
|
625
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/CreateConnectionResponse AWS API Documentation
|
626
|
+
#
|
627
|
+
class CreateConnectionResponse < Struct.new(
|
628
|
+
:connection)
|
629
|
+
SENSITIVE = []
|
630
|
+
include Aws::Structure
|
631
|
+
end
|
632
|
+
|
633
|
+
# @note When making an API call, you may pass CreateServiceRequest
|
634
|
+
# data as a hash:
|
635
|
+
#
|
636
|
+
# {
|
637
|
+
# service_name: "ServiceName", # required
|
638
|
+
# source_configuration: { # required
|
639
|
+
# code_repository: {
|
640
|
+
# repository_url: "String", # required
|
641
|
+
# source_code_version: { # required
|
642
|
+
# type: "BRANCH", # required, accepts BRANCH
|
643
|
+
# value: "String", # required
|
644
|
+
# },
|
645
|
+
# code_configuration: {
|
646
|
+
# configuration_source: "REPOSITORY", # required, accepts REPOSITORY, API
|
647
|
+
# code_configuration_values: {
|
648
|
+
# runtime: "PYTHON_3", # required, accepts PYTHON_3, NODEJS_12
|
649
|
+
# build_command: "BuildCommand",
|
650
|
+
# start_command: "StartCommand",
|
651
|
+
# port: "String",
|
652
|
+
# runtime_environment_variables: {
|
653
|
+
# "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue",
|
654
|
+
# },
|
655
|
+
# },
|
656
|
+
# },
|
657
|
+
# },
|
658
|
+
# image_repository: {
|
659
|
+
# image_identifier: "ImageIdentifier", # required
|
660
|
+
# image_configuration: {
|
661
|
+
# runtime_environment_variables: {
|
662
|
+
# "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue",
|
663
|
+
# },
|
664
|
+
# start_command: "String",
|
665
|
+
# port: "String",
|
666
|
+
# },
|
667
|
+
# image_repository_type: "ECR", # required, accepts ECR, ECR_PUBLIC
|
668
|
+
# },
|
669
|
+
# auto_deployments_enabled: false,
|
670
|
+
# authentication_configuration: {
|
671
|
+
# connection_arn: "AppRunnerResourceArn",
|
672
|
+
# access_role_arn: "RoleArn",
|
673
|
+
# },
|
674
|
+
# },
|
675
|
+
# instance_configuration: {
|
676
|
+
# cpu: "Cpu",
|
677
|
+
# memory: "Memory",
|
678
|
+
# instance_role_arn: "RoleArn",
|
679
|
+
# },
|
680
|
+
# tags: [
|
681
|
+
# {
|
682
|
+
# key: "TagKey",
|
683
|
+
# value: "TagValue",
|
684
|
+
# },
|
685
|
+
# ],
|
686
|
+
# encryption_configuration: {
|
687
|
+
# kms_key: "KmsKeyArn", # required
|
688
|
+
# },
|
689
|
+
# health_check_configuration: {
|
690
|
+
# protocol: "TCP", # accepts TCP, HTTP
|
691
|
+
# path: "String",
|
692
|
+
# interval: 1,
|
693
|
+
# timeout: 1,
|
694
|
+
# healthy_threshold: 1,
|
695
|
+
# unhealthy_threshold: 1,
|
696
|
+
# },
|
697
|
+
# auto_scaling_configuration_arn: "AppRunnerResourceArn",
|
698
|
+
# }
|
699
|
+
#
|
700
|
+
# @!attribute [rw] service_name
|
701
|
+
# A name for the new service. It must be unique across all the running
|
702
|
+
# App Runner services in your AWS account in the AWS Region.
|
703
|
+
# @return [String]
|
704
|
+
#
|
705
|
+
# @!attribute [rw] source_configuration
|
706
|
+
# The source to deploy to the App Runner service. It can be a code or
|
707
|
+
# an image repository.
|
708
|
+
# @return [Types::SourceConfiguration]
|
709
|
+
#
|
710
|
+
# @!attribute [rw] instance_configuration
|
711
|
+
# The runtime configuration of instances (scaling units) of the App
|
712
|
+
# Runner service.
|
713
|
+
# @return [Types::InstanceConfiguration]
|
714
|
+
#
|
715
|
+
# @!attribute [rw] tags
|
716
|
+
# An optional list of metadata items that you can associate with your
|
717
|
+
# service resource. A tag is a key-value pair.
|
718
|
+
# @return [Array<Types::Tag>]
|
719
|
+
#
|
720
|
+
# @!attribute [rw] encryption_configuration
|
721
|
+
# An optional custom encryption key that App Runner uses to encrypt
|
722
|
+
# the copy of your source repository that it maintains and your
|
723
|
+
# service logs. By default, App Runner uses an AWS managed CMK.
|
724
|
+
# @return [Types::EncryptionConfiguration]
|
725
|
+
#
|
726
|
+
# @!attribute [rw] health_check_configuration
|
727
|
+
# The settings for the health check that AWS App Runner performs to
|
728
|
+
# monitor the health of your service.
|
729
|
+
# @return [Types::HealthCheckConfiguration]
|
730
|
+
#
|
731
|
+
# @!attribute [rw] auto_scaling_configuration_arn
|
732
|
+
# The Amazon Resource Name (ARN) of an App Runner automatic scaling
|
733
|
+
# configuration resource that you want to associate with your service.
|
734
|
+
# If not provided, App Runner associates the latest revision of a
|
735
|
+
# default auto scaling configuration.
|
736
|
+
# @return [String]
|
737
|
+
#
|
738
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/CreateServiceRequest AWS API Documentation
|
739
|
+
#
|
740
|
+
class CreateServiceRequest < Struct.new(
|
741
|
+
:service_name,
|
742
|
+
:source_configuration,
|
743
|
+
:instance_configuration,
|
744
|
+
:tags,
|
745
|
+
:encryption_configuration,
|
746
|
+
:health_check_configuration,
|
747
|
+
:auto_scaling_configuration_arn)
|
748
|
+
SENSITIVE = []
|
749
|
+
include Aws::Structure
|
750
|
+
end
|
751
|
+
|
752
|
+
# @!attribute [rw] service
|
753
|
+
# A description of the App Runner service that's created by this
|
754
|
+
# request.
|
755
|
+
# @return [Types::Service]
|
756
|
+
#
|
757
|
+
# @!attribute [rw] operation_id
|
758
|
+
# The unique ID of the asynchronous operation that this request
|
759
|
+
# started. You can use it combined with the [ListOperations][1] call
|
760
|
+
# to track the operation's progress.
|
761
|
+
#
|
762
|
+
#
|
763
|
+
#
|
764
|
+
# [1]: https://docs.aws.amazon.com/apprunner/latest/api/API_ListOperations.html
|
765
|
+
# @return [String]
|
766
|
+
#
|
767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/CreateServiceResponse AWS API Documentation
|
768
|
+
#
|
769
|
+
class CreateServiceResponse < Struct.new(
|
770
|
+
:service,
|
771
|
+
:operation_id)
|
772
|
+
SENSITIVE = []
|
773
|
+
include Aws::Structure
|
774
|
+
end
|
775
|
+
|
776
|
+
# Describes a custom domain that's associated with an AWS App Runner
|
777
|
+
# service.
|
778
|
+
#
|
779
|
+
# @!attribute [rw] domain_name
|
780
|
+
# An associated custom domain endpoint. It can be a root domain (for
|
781
|
+
# example, `example.com`), a subdomain (for example,
|
782
|
+
# `login.example.com` or `admin.login.example.com`), or a wildcard
|
783
|
+
# (for example, `*.example.com`).
|
784
|
+
# @return [String]
|
785
|
+
#
|
786
|
+
# @!attribute [rw] enable_www_subdomain
|
787
|
+
# When `true`, the subdomain `www.DomainName ` is associated with the
|
788
|
+
# App Runner service in addition to the base domain.
|
789
|
+
# @return [Boolean]
|
790
|
+
#
|
791
|
+
# @!attribute [rw] certificate_validation_records
|
792
|
+
# A list of certificate CNAME records that's used for this domain
|
793
|
+
# name.
|
794
|
+
# @return [Array<Types::CertificateValidationRecord>]
|
795
|
+
#
|
796
|
+
# @!attribute [rw] status
|
797
|
+
# The current state of the domain name association.
|
798
|
+
# @return [String]
|
799
|
+
#
|
800
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/CustomDomain AWS API Documentation
|
801
|
+
#
|
802
|
+
class CustomDomain < Struct.new(
|
803
|
+
:domain_name,
|
804
|
+
:enable_www_subdomain,
|
805
|
+
:certificate_validation_records,
|
806
|
+
:status)
|
807
|
+
SENSITIVE = []
|
808
|
+
include Aws::Structure
|
809
|
+
end
|
810
|
+
|
811
|
+
# @note When making an API call, you may pass DeleteAutoScalingConfigurationRequest
|
812
|
+
# data as a hash:
|
813
|
+
#
|
814
|
+
# {
|
815
|
+
# auto_scaling_configuration_arn: "AppRunnerResourceArn", # required
|
816
|
+
# }
|
817
|
+
#
|
818
|
+
# @!attribute [rw] auto_scaling_configuration_arn
|
819
|
+
# The Amazon Resource Name (ARN) of the App Runner auto scaling
|
820
|
+
# configuration that you want to delete.
|
821
|
+
#
|
822
|
+
# The ARN can be a full auto scaling configuration ARN, or a partial
|
823
|
+
# ARN ending with either `.../name ` or `.../name/revision `. If a
|
824
|
+
# revision isn't specified, the latest active revision is deleted.
|
825
|
+
# @return [String]
|
826
|
+
#
|
827
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DeleteAutoScalingConfigurationRequest AWS API Documentation
|
828
|
+
#
|
829
|
+
class DeleteAutoScalingConfigurationRequest < Struct.new(
|
830
|
+
:auto_scaling_configuration_arn)
|
831
|
+
SENSITIVE = []
|
832
|
+
include Aws::Structure
|
833
|
+
end
|
834
|
+
|
835
|
+
# @!attribute [rw] auto_scaling_configuration
|
836
|
+
# A description of the App Runner auto scaling configuration that this
|
837
|
+
# request just deleted.
|
838
|
+
# @return [Types::AutoScalingConfiguration]
|
839
|
+
#
|
840
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DeleteAutoScalingConfigurationResponse AWS API Documentation
|
841
|
+
#
|
842
|
+
class DeleteAutoScalingConfigurationResponse < Struct.new(
|
843
|
+
:auto_scaling_configuration)
|
844
|
+
SENSITIVE = []
|
845
|
+
include Aws::Structure
|
846
|
+
end
|
847
|
+
|
848
|
+
# @note When making an API call, you may pass DeleteConnectionRequest
|
849
|
+
# data as a hash:
|
850
|
+
#
|
851
|
+
# {
|
852
|
+
# connection_arn: "AppRunnerResourceArn", # required
|
853
|
+
# }
|
854
|
+
#
|
855
|
+
# @!attribute [rw] connection_arn
|
856
|
+
# The Amazon Resource Name (ARN) of the App Runner connection that you
|
857
|
+
# want to delete.
|
858
|
+
# @return [String]
|
859
|
+
#
|
860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DeleteConnectionRequest AWS API Documentation
|
861
|
+
#
|
862
|
+
class DeleteConnectionRequest < Struct.new(
|
863
|
+
:connection_arn)
|
864
|
+
SENSITIVE = []
|
865
|
+
include Aws::Structure
|
866
|
+
end
|
867
|
+
|
868
|
+
# @!attribute [rw] connection
|
869
|
+
# A description of the App Runner connection that this request just
|
870
|
+
# deleted.
|
871
|
+
# @return [Types::Connection]
|
872
|
+
#
|
873
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DeleteConnectionResponse AWS API Documentation
|
874
|
+
#
|
875
|
+
class DeleteConnectionResponse < Struct.new(
|
876
|
+
:connection)
|
877
|
+
SENSITIVE = []
|
878
|
+
include Aws::Structure
|
879
|
+
end
|
880
|
+
|
881
|
+
# @note When making an API call, you may pass DeleteServiceRequest
|
882
|
+
# data as a hash:
|
883
|
+
#
|
884
|
+
# {
|
885
|
+
# service_arn: "AppRunnerResourceArn", # required
|
886
|
+
# }
|
887
|
+
#
|
888
|
+
# @!attribute [rw] service_arn
|
889
|
+
# The Amazon Resource Name (ARN) of the App Runner service that you
|
890
|
+
# want to delete.
|
891
|
+
# @return [String]
|
892
|
+
#
|
893
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DeleteServiceRequest AWS API Documentation
|
894
|
+
#
|
895
|
+
class DeleteServiceRequest < Struct.new(
|
896
|
+
:service_arn)
|
897
|
+
SENSITIVE = []
|
898
|
+
include Aws::Structure
|
899
|
+
end
|
900
|
+
|
901
|
+
# @!attribute [rw] service
|
902
|
+
# A description of the App Runner service that this request just
|
903
|
+
# deleted.
|
904
|
+
# @return [Types::Service]
|
905
|
+
#
|
906
|
+
# @!attribute [rw] operation_id
|
907
|
+
# The unique ID of the asynchronous operation that this request
|
908
|
+
# started. You can use it combined with the ListOperations call to
|
909
|
+
# track the operation's progress.
|
910
|
+
# @return [String]
|
911
|
+
#
|
912
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DeleteServiceResponse AWS API Documentation
|
913
|
+
#
|
914
|
+
class DeleteServiceResponse < Struct.new(
|
915
|
+
:service,
|
916
|
+
:operation_id)
|
917
|
+
SENSITIVE = []
|
918
|
+
include Aws::Structure
|
919
|
+
end
|
920
|
+
|
921
|
+
# @note When making an API call, you may pass DescribeAutoScalingConfigurationRequest
|
922
|
+
# data as a hash:
|
923
|
+
#
|
924
|
+
# {
|
925
|
+
# auto_scaling_configuration_arn: "AppRunnerResourceArn", # required
|
926
|
+
# }
|
927
|
+
#
|
928
|
+
# @!attribute [rw] auto_scaling_configuration_arn
|
929
|
+
# The Amazon Resource Name (ARN) of the App Runner auto scaling
|
930
|
+
# configuration that you want a description for.
|
931
|
+
#
|
932
|
+
# The ARN can be a full auto scaling configuration ARN, or a partial
|
933
|
+
# ARN ending with either `.../name ` or `.../name/revision `. If a
|
934
|
+
# revision isn't specified, the latest active revision is described.
|
935
|
+
# @return [String]
|
936
|
+
#
|
937
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DescribeAutoScalingConfigurationRequest AWS API Documentation
|
938
|
+
#
|
939
|
+
class DescribeAutoScalingConfigurationRequest < Struct.new(
|
940
|
+
:auto_scaling_configuration_arn)
|
941
|
+
SENSITIVE = []
|
942
|
+
include Aws::Structure
|
943
|
+
end
|
944
|
+
|
945
|
+
# @!attribute [rw] auto_scaling_configuration
|
946
|
+
# A full description of the App Runner auto scaling configuration that
|
947
|
+
# you specified in this request.
|
948
|
+
# @return [Types::AutoScalingConfiguration]
|
949
|
+
#
|
950
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DescribeAutoScalingConfigurationResponse AWS API Documentation
|
951
|
+
#
|
952
|
+
class DescribeAutoScalingConfigurationResponse < Struct.new(
|
953
|
+
:auto_scaling_configuration)
|
954
|
+
SENSITIVE = []
|
955
|
+
include Aws::Structure
|
956
|
+
end
|
957
|
+
|
958
|
+
# @note When making an API call, you may pass DescribeCustomDomainsRequest
|
959
|
+
# data as a hash:
|
960
|
+
#
|
961
|
+
# {
|
962
|
+
# service_arn: "AppRunnerResourceArn", # required
|
963
|
+
# next_token: "String",
|
964
|
+
# max_results: 1,
|
965
|
+
# }
|
966
|
+
#
|
967
|
+
# @!attribute [rw] service_arn
|
968
|
+
# The Amazon Resource Name (ARN) of the App Runner service that you
|
969
|
+
# want associated custom domain names to be described for.
|
970
|
+
# @return [String]
|
971
|
+
#
|
972
|
+
# @!attribute [rw] next_token
|
973
|
+
# A token from a previous result page. It's used for a paginated
|
974
|
+
# request. The request retrieves the next result page. All other
|
975
|
+
# parameter values must be identical to the ones that are specified in
|
976
|
+
# the initial request.
|
977
|
+
#
|
978
|
+
# If you don't specify `NextToken`, the request retrieves the first
|
979
|
+
# result page.
|
980
|
+
# @return [String]
|
981
|
+
#
|
982
|
+
# @!attribute [rw] max_results
|
983
|
+
# The maximum number of results that each response (result page) can
|
984
|
+
# include. It's used for a paginated request.
|
985
|
+
#
|
986
|
+
# If you don't specify `MaxResults`, the request retrieves all
|
987
|
+
# available results in a single response.
|
988
|
+
# @return [Integer]
|
989
|
+
#
|
990
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DescribeCustomDomainsRequest AWS API Documentation
|
991
|
+
#
|
992
|
+
class DescribeCustomDomainsRequest < Struct.new(
|
993
|
+
:service_arn,
|
994
|
+
:next_token,
|
995
|
+
:max_results)
|
996
|
+
SENSITIVE = []
|
997
|
+
include Aws::Structure
|
998
|
+
end
|
999
|
+
|
1000
|
+
# @!attribute [rw] dns_target
|
1001
|
+
# The App Runner subdomain of the App Runner service. The associated
|
1002
|
+
# custom domain names are mapped to this target name.
|
1003
|
+
# @return [String]
|
1004
|
+
#
|
1005
|
+
# @!attribute [rw] service_arn
|
1006
|
+
# The Amazon Resource Name (ARN) of the App Runner service whose
|
1007
|
+
# associated custom domain names you want to describe.
|
1008
|
+
# @return [String]
|
1009
|
+
#
|
1010
|
+
# @!attribute [rw] custom_domains
|
1011
|
+
# A list of descriptions of custom domain names that are associated
|
1012
|
+
# with the service. In a paginated request, the request returns up to
|
1013
|
+
# `MaxResults` records per call.
|
1014
|
+
# @return [Array<Types::CustomDomain>]
|
1015
|
+
#
|
1016
|
+
# @!attribute [rw] next_token
|
1017
|
+
# The token that you can pass in a subsequent request to get the next
|
1018
|
+
# result page. It's returned in a paginated request.
|
1019
|
+
# @return [String]
|
1020
|
+
#
|
1021
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DescribeCustomDomainsResponse AWS API Documentation
|
1022
|
+
#
|
1023
|
+
class DescribeCustomDomainsResponse < Struct.new(
|
1024
|
+
:dns_target,
|
1025
|
+
:service_arn,
|
1026
|
+
:custom_domains,
|
1027
|
+
:next_token)
|
1028
|
+
SENSITIVE = []
|
1029
|
+
include Aws::Structure
|
1030
|
+
end
|
1031
|
+
|
1032
|
+
# @note When making an API call, you may pass DescribeServiceRequest
|
1033
|
+
# data as a hash:
|
1034
|
+
#
|
1035
|
+
# {
|
1036
|
+
# service_arn: "AppRunnerResourceArn", # required
|
1037
|
+
# }
|
1038
|
+
#
|
1039
|
+
# @!attribute [rw] service_arn
|
1040
|
+
# The Amazon Resource Name (ARN) of the App Runner service that you
|
1041
|
+
# want a description for.
|
1042
|
+
# @return [String]
|
1043
|
+
#
|
1044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DescribeServiceRequest AWS API Documentation
|
1045
|
+
#
|
1046
|
+
class DescribeServiceRequest < Struct.new(
|
1047
|
+
:service_arn)
|
1048
|
+
SENSITIVE = []
|
1049
|
+
include Aws::Structure
|
1050
|
+
end
|
1051
|
+
|
1052
|
+
# @!attribute [rw] service
|
1053
|
+
# A full description of the App Runner service that you specified in
|
1054
|
+
# this request.
|
1055
|
+
# @return [Types::Service]
|
1056
|
+
#
|
1057
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DescribeServiceResponse AWS API Documentation
|
1058
|
+
#
|
1059
|
+
class DescribeServiceResponse < Struct.new(
|
1060
|
+
:service)
|
1061
|
+
SENSITIVE = []
|
1062
|
+
include Aws::Structure
|
1063
|
+
end
|
1064
|
+
|
1065
|
+
# @note When making an API call, you may pass DisassociateCustomDomainRequest
|
1066
|
+
# data as a hash:
|
1067
|
+
#
|
1068
|
+
# {
|
1069
|
+
# service_arn: "AppRunnerResourceArn", # required
|
1070
|
+
# domain_name: "DomainName", # required
|
1071
|
+
# }
|
1072
|
+
#
|
1073
|
+
# @!attribute [rw] service_arn
|
1074
|
+
# The Amazon Resource Name (ARN) of the App Runner service that you
|
1075
|
+
# want to disassociate a custom domain name from.
|
1076
|
+
# @return [String]
|
1077
|
+
#
|
1078
|
+
# @!attribute [rw] domain_name
|
1079
|
+
# The domain name that you want to disassociate from the App Runner
|
1080
|
+
# service.
|
1081
|
+
# @return [String]
|
1082
|
+
#
|
1083
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DisassociateCustomDomainRequest AWS API Documentation
|
1084
|
+
#
|
1085
|
+
class DisassociateCustomDomainRequest < Struct.new(
|
1086
|
+
:service_arn,
|
1087
|
+
:domain_name)
|
1088
|
+
SENSITIVE = []
|
1089
|
+
include Aws::Structure
|
1090
|
+
end
|
1091
|
+
|
1092
|
+
# @!attribute [rw] dns_target
|
1093
|
+
# The App Runner subdomain of the App Runner service. The
|
1094
|
+
# disassociated custom domain name was mapped to this target name.
|
1095
|
+
# @return [String]
|
1096
|
+
#
|
1097
|
+
# @!attribute [rw] service_arn
|
1098
|
+
# The Amazon Resource Name (ARN) of the App Runner service that a
|
1099
|
+
# custom domain name is disassociated from.
|
1100
|
+
# @return [String]
|
1101
|
+
#
|
1102
|
+
# @!attribute [rw] custom_domain
|
1103
|
+
# A description of the domain name that's being disassociated.
|
1104
|
+
# @return [Types::CustomDomain]
|
1105
|
+
#
|
1106
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DisassociateCustomDomainResponse AWS API Documentation
|
1107
|
+
#
|
1108
|
+
class DisassociateCustomDomainResponse < Struct.new(
|
1109
|
+
:dns_target,
|
1110
|
+
:service_arn,
|
1111
|
+
:custom_domain)
|
1112
|
+
SENSITIVE = []
|
1113
|
+
include Aws::Structure
|
1114
|
+
end
|
1115
|
+
|
1116
|
+
# Describes a custom encryption key that AWS App Runner uses to encrypt
|
1117
|
+
# copies of the source repository and service logs.
|
1118
|
+
#
|
1119
|
+
# @note When making an API call, you may pass EncryptionConfiguration
|
1120
|
+
# data as a hash:
|
1121
|
+
#
|
1122
|
+
# {
|
1123
|
+
# kms_key: "KmsKeyArn", # required
|
1124
|
+
# }
|
1125
|
+
#
|
1126
|
+
# @!attribute [rw] kms_key
|
1127
|
+
# The ARN of the KMS key that's used for encryption.
|
1128
|
+
# @return [String]
|
1129
|
+
#
|
1130
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/EncryptionConfiguration AWS API Documentation
|
1131
|
+
#
|
1132
|
+
class EncryptionConfiguration < Struct.new(
|
1133
|
+
:kms_key)
|
1134
|
+
SENSITIVE = []
|
1135
|
+
include Aws::Structure
|
1136
|
+
end
|
1137
|
+
|
1138
|
+
# Describes the settings for the health check that AWS App Runner
|
1139
|
+
# performs to monitor the health of a service.
|
1140
|
+
#
|
1141
|
+
# @note When making an API call, you may pass HealthCheckConfiguration
|
1142
|
+
# data as a hash:
|
1143
|
+
#
|
1144
|
+
# {
|
1145
|
+
# protocol: "TCP", # accepts TCP, HTTP
|
1146
|
+
# path: "String",
|
1147
|
+
# interval: 1,
|
1148
|
+
# timeout: 1,
|
1149
|
+
# healthy_threshold: 1,
|
1150
|
+
# unhealthy_threshold: 1,
|
1151
|
+
# }
|
1152
|
+
#
|
1153
|
+
# @!attribute [rw] protocol
|
1154
|
+
# The IP protocol that App Runner uses to perform health checks for
|
1155
|
+
# your service.
|
1156
|
+
#
|
1157
|
+
# If you set `Protocol` to `HTTP`, App Runner sends health check
|
1158
|
+
# requests to the HTTP path specified by `Path`.
|
1159
|
+
#
|
1160
|
+
# Default: `TCP`
|
1161
|
+
# @return [String]
|
1162
|
+
#
|
1163
|
+
# @!attribute [rw] path
|
1164
|
+
# The URL that health check requests are sent to.
|
1165
|
+
#
|
1166
|
+
# `Path` is only applicable when you set `Protocol` to `HTTP`.
|
1167
|
+
#
|
1168
|
+
# Default: `"/"`
|
1169
|
+
# @return [String]
|
1170
|
+
#
|
1171
|
+
# @!attribute [rw] interval
|
1172
|
+
# The time interval, in seconds, between health checks.
|
1173
|
+
#
|
1174
|
+
# Default: `5`
|
1175
|
+
# @return [Integer]
|
1176
|
+
#
|
1177
|
+
# @!attribute [rw] timeout
|
1178
|
+
# The time, in seconds, to wait for a health check response before
|
1179
|
+
# deciding it failed.
|
1180
|
+
#
|
1181
|
+
# Default: `2`
|
1182
|
+
# @return [Integer]
|
1183
|
+
#
|
1184
|
+
# @!attribute [rw] healthy_threshold
|
1185
|
+
# The number of consecutive checks that must succeed before App Runner
|
1186
|
+
# decides that the service is healthy.
|
1187
|
+
#
|
1188
|
+
# Default: `3`
|
1189
|
+
# @return [Integer]
|
1190
|
+
#
|
1191
|
+
# @!attribute [rw] unhealthy_threshold
|
1192
|
+
# The number of consecutive checks that must fail before App Runner
|
1193
|
+
# decides that the service is unhealthy.
|
1194
|
+
#
|
1195
|
+
# Default: `3`
|
1196
|
+
# @return [Integer]
|
1197
|
+
#
|
1198
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/HealthCheckConfiguration AWS API Documentation
|
1199
|
+
#
|
1200
|
+
class HealthCheckConfiguration < Struct.new(
|
1201
|
+
:protocol,
|
1202
|
+
:path,
|
1203
|
+
:interval,
|
1204
|
+
:timeout,
|
1205
|
+
:healthy_threshold,
|
1206
|
+
:unhealthy_threshold)
|
1207
|
+
SENSITIVE = []
|
1208
|
+
include Aws::Structure
|
1209
|
+
end
|
1210
|
+
|
1211
|
+
# Describes the configuration that AWS App Runner uses to run an App
|
1212
|
+
# Runner service using an image pulled from a source image repository.
|
1213
|
+
#
|
1214
|
+
# @note When making an API call, you may pass ImageConfiguration
|
1215
|
+
# data as a hash:
|
1216
|
+
#
|
1217
|
+
# {
|
1218
|
+
# runtime_environment_variables: {
|
1219
|
+
# "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue",
|
1220
|
+
# },
|
1221
|
+
# start_command: "String",
|
1222
|
+
# port: "String",
|
1223
|
+
# }
|
1224
|
+
#
|
1225
|
+
# @!attribute [rw] runtime_environment_variables
|
1226
|
+
# Environment variables that are available to your running App Runner
|
1227
|
+
# service. An array of key-value pairs. Keys with a prefix of
|
1228
|
+
# `AWSAPPRUNNER` are reserved for system use and aren't valid.
|
1229
|
+
# @return [Hash<String,String>]
|
1230
|
+
#
|
1231
|
+
# @!attribute [rw] start_command
|
1232
|
+
# An optional command that App Runner runs to start the application in
|
1233
|
+
# the source image. If specified, this command overrides the Docker
|
1234
|
+
# image’s default start command.
|
1235
|
+
# @return [String]
|
1236
|
+
#
|
1237
|
+
# @!attribute [rw] port
|
1238
|
+
# The port that your application listens to in the container.
|
1239
|
+
#
|
1240
|
+
# Default: `8080`
|
1241
|
+
# @return [String]
|
1242
|
+
#
|
1243
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ImageConfiguration AWS API Documentation
|
1244
|
+
#
|
1245
|
+
class ImageConfiguration < Struct.new(
|
1246
|
+
:runtime_environment_variables,
|
1247
|
+
:start_command,
|
1248
|
+
:port)
|
1249
|
+
SENSITIVE = []
|
1250
|
+
include Aws::Structure
|
1251
|
+
end
|
1252
|
+
|
1253
|
+
# Describes a source image repository.
|
1254
|
+
#
|
1255
|
+
# @note When making an API call, you may pass ImageRepository
|
1256
|
+
# data as a hash:
|
1257
|
+
#
|
1258
|
+
# {
|
1259
|
+
# image_identifier: "ImageIdentifier", # required
|
1260
|
+
# image_configuration: {
|
1261
|
+
# runtime_environment_variables: {
|
1262
|
+
# "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue",
|
1263
|
+
# },
|
1264
|
+
# start_command: "String",
|
1265
|
+
# port: "String",
|
1266
|
+
# },
|
1267
|
+
# image_repository_type: "ECR", # required, accepts ECR, ECR_PUBLIC
|
1268
|
+
# }
|
1269
|
+
#
|
1270
|
+
# @!attribute [rw] image_identifier
|
1271
|
+
# The identifier of an image.
|
1272
|
+
#
|
1273
|
+
# For an image in Amazon Elastic Container Registry (Amazon ECR), this
|
1274
|
+
# is an image name. For the image name format, see [Pulling an
|
1275
|
+
# image][1] in the *Amazon ECR User Guide*.
|
1276
|
+
#
|
1277
|
+
#
|
1278
|
+
#
|
1279
|
+
# [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html
|
1280
|
+
# @return [String]
|
1281
|
+
#
|
1282
|
+
# @!attribute [rw] image_configuration
|
1283
|
+
# Configuration for running the identified image.
|
1284
|
+
# @return [Types::ImageConfiguration]
|
1285
|
+
#
|
1286
|
+
# @!attribute [rw] image_repository_type
|
1287
|
+
# The type of the image repository. This reflects the repository
|
1288
|
+
# provider and whether the repository is private or public.
|
1289
|
+
# @return [String]
|
1290
|
+
#
|
1291
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ImageRepository AWS API Documentation
|
1292
|
+
#
|
1293
|
+
class ImageRepository < Struct.new(
|
1294
|
+
:image_identifier,
|
1295
|
+
:image_configuration,
|
1296
|
+
:image_repository_type)
|
1297
|
+
SENSITIVE = []
|
1298
|
+
include Aws::Structure
|
1299
|
+
end
|
1300
|
+
|
1301
|
+
# Describes the runtime configuration of an AWS App Runner service
|
1302
|
+
# instance (scaling unit).
|
1303
|
+
#
|
1304
|
+
# @note When making an API call, you may pass InstanceConfiguration
|
1305
|
+
# data as a hash:
|
1306
|
+
#
|
1307
|
+
# {
|
1308
|
+
# cpu: "Cpu",
|
1309
|
+
# memory: "Memory",
|
1310
|
+
# instance_role_arn: "RoleArn",
|
1311
|
+
# }
|
1312
|
+
#
|
1313
|
+
# @!attribute [rw] cpu
|
1314
|
+
# The number of CPU units reserved for each instance of your App
|
1315
|
+
# Runner service.
|
1316
|
+
#
|
1317
|
+
# Default: `1 vCPU`
|
1318
|
+
# @return [String]
|
1319
|
+
#
|
1320
|
+
# @!attribute [rw] memory
|
1321
|
+
# The amount of memory, in MB or GB, reserved for each instance of
|
1322
|
+
# your App Runner service.
|
1323
|
+
#
|
1324
|
+
# Default: `2 GB`
|
1325
|
+
# @return [String]
|
1326
|
+
#
|
1327
|
+
# @!attribute [rw] instance_role_arn
|
1328
|
+
# The Amazon Resource Name (ARN) of an IAM role that provides
|
1329
|
+
# permissions to your App Runner service. These are permissions that
|
1330
|
+
# your code needs when it calls any AWS APIs.
|
1331
|
+
# @return [String]
|
1332
|
+
#
|
1333
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/InstanceConfiguration AWS API Documentation
|
1334
|
+
#
|
1335
|
+
class InstanceConfiguration < Struct.new(
|
1336
|
+
:cpu,
|
1337
|
+
:memory,
|
1338
|
+
:instance_role_arn)
|
1339
|
+
SENSITIVE = []
|
1340
|
+
include Aws::Structure
|
1341
|
+
end
|
1342
|
+
|
1343
|
+
# An unexpected service exception occurred.
|
1344
|
+
#
|
1345
|
+
# @!attribute [rw] message
|
1346
|
+
# @return [String]
|
1347
|
+
#
|
1348
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/InternalServiceErrorException AWS API Documentation
|
1349
|
+
#
|
1350
|
+
class InternalServiceErrorException < Struct.new(
|
1351
|
+
:message)
|
1352
|
+
SENSITIVE = []
|
1353
|
+
include Aws::Structure
|
1354
|
+
end
|
1355
|
+
|
1356
|
+
# One or more input parameters aren't valid. Refer to the API action's
|
1357
|
+
# document page, correct the input parameters, and try the action again.
|
1358
|
+
#
|
1359
|
+
# @!attribute [rw] message
|
1360
|
+
# @return [String]
|
1361
|
+
#
|
1362
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/InvalidRequestException AWS API Documentation
|
1363
|
+
#
|
1364
|
+
class InvalidRequestException < Struct.new(
|
1365
|
+
:message)
|
1366
|
+
SENSITIVE = []
|
1367
|
+
include Aws::Structure
|
1368
|
+
end
|
1369
|
+
|
1370
|
+
# You can't perform this action when the resource is in its current
|
1371
|
+
# state.
|
1372
|
+
#
|
1373
|
+
# @!attribute [rw] message
|
1374
|
+
# @return [String]
|
1375
|
+
#
|
1376
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/InvalidStateException AWS API Documentation
|
1377
|
+
#
|
1378
|
+
class InvalidStateException < Struct.new(
|
1379
|
+
:message)
|
1380
|
+
SENSITIVE = []
|
1381
|
+
include Aws::Structure
|
1382
|
+
end
|
1383
|
+
|
1384
|
+
# @note When making an API call, you may pass ListAutoScalingConfigurationsRequest
|
1385
|
+
# data as a hash:
|
1386
|
+
#
|
1387
|
+
# {
|
1388
|
+
# auto_scaling_configuration_name: "AutoScalingConfigurationName",
|
1389
|
+
# latest_only: false,
|
1390
|
+
# max_results: 1,
|
1391
|
+
# next_token: "NextToken",
|
1392
|
+
# }
|
1393
|
+
#
|
1394
|
+
# @!attribute [rw] auto_scaling_configuration_name
|
1395
|
+
# The name of the App Runner auto scaling configuration that you want
|
1396
|
+
# to list. If specified, App Runner lists revisions that share this
|
1397
|
+
# name. If not specified, App Runner returns revisions of all
|
1398
|
+
# configurations.
|
1399
|
+
# @return [String]
|
1400
|
+
#
|
1401
|
+
# @!attribute [rw] latest_only
|
1402
|
+
# Set to `true` to list only the latest revision for each requested
|
1403
|
+
# configuration name.
|
1404
|
+
#
|
1405
|
+
# Keep as `false` to list all revisions for each requested
|
1406
|
+
# configuration name.
|
1407
|
+
#
|
1408
|
+
# Default: `false`
|
1409
|
+
# @return [Boolean]
|
1410
|
+
#
|
1411
|
+
# @!attribute [rw] max_results
|
1412
|
+
# The maximum number of results to include in each response (result
|
1413
|
+
# page). It's used for a paginated request.
|
1414
|
+
#
|
1415
|
+
# If you don't specify `MaxResults`, the request retrieves all
|
1416
|
+
# available results in a single response.
|
1417
|
+
# @return [Integer]
|
1418
|
+
#
|
1419
|
+
# @!attribute [rw] next_token
|
1420
|
+
# A token from a previous result page. It's used for a paginated
|
1421
|
+
# request. The request retrieves the next result page. All other
|
1422
|
+
# parameter values must be identical to the ones that are specified in
|
1423
|
+
# the initial request.
|
1424
|
+
#
|
1425
|
+
# If you don't specify `NextToken`, the request retrieves the first
|
1426
|
+
# result page.
|
1427
|
+
# @return [String]
|
1428
|
+
#
|
1429
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ListAutoScalingConfigurationsRequest AWS API Documentation
|
1430
|
+
#
|
1431
|
+
class ListAutoScalingConfigurationsRequest < Struct.new(
|
1432
|
+
:auto_scaling_configuration_name,
|
1433
|
+
:latest_only,
|
1434
|
+
:max_results,
|
1435
|
+
:next_token)
|
1436
|
+
SENSITIVE = []
|
1437
|
+
include Aws::Structure
|
1438
|
+
end
|
1439
|
+
|
1440
|
+
# @!attribute [rw] auto_scaling_configuration_summary_list
|
1441
|
+
# A list of summary information records for auto scaling
|
1442
|
+
# configurations. In a paginated request, the request returns up to
|
1443
|
+
# `MaxResults` records for each call.
|
1444
|
+
# @return [Array<Types::AutoScalingConfigurationSummary>]
|
1445
|
+
#
|
1446
|
+
# @!attribute [rw] next_token
|
1447
|
+
# The token that you can pass in a subsequent request to get the next
|
1448
|
+
# result page. It's returned in a paginated request.
|
1449
|
+
# @return [String]
|
1450
|
+
#
|
1451
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ListAutoScalingConfigurationsResponse AWS API Documentation
|
1452
|
+
#
|
1453
|
+
class ListAutoScalingConfigurationsResponse < Struct.new(
|
1454
|
+
:auto_scaling_configuration_summary_list,
|
1455
|
+
:next_token)
|
1456
|
+
SENSITIVE = []
|
1457
|
+
include Aws::Structure
|
1458
|
+
end
|
1459
|
+
|
1460
|
+
# @note When making an API call, you may pass ListConnectionsRequest
|
1461
|
+
# data as a hash:
|
1462
|
+
#
|
1463
|
+
# {
|
1464
|
+
# connection_name: "ConnectionName",
|
1465
|
+
# max_results: 1,
|
1466
|
+
# next_token: "NextToken",
|
1467
|
+
# }
|
1468
|
+
#
|
1469
|
+
# @!attribute [rw] connection_name
|
1470
|
+
# If specified, only this connection is returned. If not specified,
|
1471
|
+
# the result isn't filtered by name.
|
1472
|
+
# @return [String]
|
1473
|
+
#
|
1474
|
+
# @!attribute [rw] max_results
|
1475
|
+
# The maximum number of results to include in each response (result
|
1476
|
+
# page). Used for a paginated request.
|
1477
|
+
#
|
1478
|
+
# If you don't specify `MaxResults`, the request retrieves all
|
1479
|
+
# available results in a single response.
|
1480
|
+
# @return [Integer]
|
1481
|
+
#
|
1482
|
+
# @!attribute [rw] next_token
|
1483
|
+
# A token from a previous result page. Used for a paginated request.
|
1484
|
+
# The request retrieves the next result page. All other parameter
|
1485
|
+
# values must be identical to the ones specified in the initial
|
1486
|
+
# request.
|
1487
|
+
#
|
1488
|
+
# If you don't specify `NextToken`, the request retrieves the first
|
1489
|
+
# result page.
|
1490
|
+
# @return [String]
|
1491
|
+
#
|
1492
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ListConnectionsRequest AWS API Documentation
|
1493
|
+
#
|
1494
|
+
class ListConnectionsRequest < Struct.new(
|
1495
|
+
:connection_name,
|
1496
|
+
:max_results,
|
1497
|
+
:next_token)
|
1498
|
+
SENSITIVE = []
|
1499
|
+
include Aws::Structure
|
1500
|
+
end
|
1501
|
+
|
1502
|
+
# @!attribute [rw] connection_summary_list
|
1503
|
+
# A list of summary information records for connections. In a
|
1504
|
+
# paginated request, the request returns up to `MaxResults` records
|
1505
|
+
# for each call.
|
1506
|
+
# @return [Array<Types::ConnectionSummary>]
|
1507
|
+
#
|
1508
|
+
# @!attribute [rw] next_token
|
1509
|
+
# The token that you can pass in a subsequent request to get the next
|
1510
|
+
# result page. Returned in a paginated request.
|
1511
|
+
# @return [String]
|
1512
|
+
#
|
1513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ListConnectionsResponse AWS API Documentation
|
1514
|
+
#
|
1515
|
+
class ListConnectionsResponse < Struct.new(
|
1516
|
+
:connection_summary_list,
|
1517
|
+
:next_token)
|
1518
|
+
SENSITIVE = []
|
1519
|
+
include Aws::Structure
|
1520
|
+
end
|
1521
|
+
|
1522
|
+
# @note When making an API call, you may pass ListOperationsRequest
|
1523
|
+
# data as a hash:
|
1524
|
+
#
|
1525
|
+
# {
|
1526
|
+
# service_arn: "AppRunnerResourceArn", # required
|
1527
|
+
# next_token: "String",
|
1528
|
+
# max_results: 1,
|
1529
|
+
# }
|
1530
|
+
#
|
1531
|
+
# @!attribute [rw] service_arn
|
1532
|
+
# The Amazon Resource Name (ARN) of the App Runner service that you
|
1533
|
+
# want a list of operations for.
|
1534
|
+
# @return [String]
|
1535
|
+
#
|
1536
|
+
# @!attribute [rw] next_token
|
1537
|
+
# A token from a previous result page. It's used for a paginated
|
1538
|
+
# request. The request retrieves the next result page. All other
|
1539
|
+
# parameter values must be identical to the ones specified in the
|
1540
|
+
# initial request.
|
1541
|
+
#
|
1542
|
+
# If you don't specify `NextToken`, the request retrieves the first
|
1543
|
+
# result page.
|
1544
|
+
# @return [String]
|
1545
|
+
#
|
1546
|
+
# @!attribute [rw] max_results
|
1547
|
+
# The maximum number of results to include in each response (result
|
1548
|
+
# page). It's used for a paginated request.
|
1549
|
+
#
|
1550
|
+
# If you don't specify `MaxResults`, the request retrieves all
|
1551
|
+
# available results in a single response.
|
1552
|
+
# @return [Integer]
|
1553
|
+
#
|
1554
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ListOperationsRequest AWS API Documentation
|
1555
|
+
#
|
1556
|
+
class ListOperationsRequest < Struct.new(
|
1557
|
+
:service_arn,
|
1558
|
+
:next_token,
|
1559
|
+
:max_results)
|
1560
|
+
SENSITIVE = []
|
1561
|
+
include Aws::Structure
|
1562
|
+
end
|
1563
|
+
|
1564
|
+
# @!attribute [rw] operation_summary_list
|
1565
|
+
# A list of operation summary information records. In a paginated
|
1566
|
+
# request, the request returns up to `MaxResults` records for each
|
1567
|
+
# call.
|
1568
|
+
# @return [Array<Types::OperationSummary>]
|
1569
|
+
#
|
1570
|
+
# @!attribute [rw] next_token
|
1571
|
+
# The token that you can pass in a subsequent request to get the next
|
1572
|
+
# result page. It's returned in a paginated request.
|
1573
|
+
# @return [String]
|
1574
|
+
#
|
1575
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ListOperationsResponse AWS API Documentation
|
1576
|
+
#
|
1577
|
+
class ListOperationsResponse < Struct.new(
|
1578
|
+
:operation_summary_list,
|
1579
|
+
:next_token)
|
1580
|
+
SENSITIVE = []
|
1581
|
+
include Aws::Structure
|
1582
|
+
end
|
1583
|
+
|
1584
|
+
# @note When making an API call, you may pass ListServicesRequest
|
1585
|
+
# data as a hash:
|
1586
|
+
#
|
1587
|
+
# {
|
1588
|
+
# next_token: "String",
|
1589
|
+
# max_results: 1,
|
1590
|
+
# }
|
1591
|
+
#
|
1592
|
+
# @!attribute [rw] next_token
|
1593
|
+
# A token from a previous result page. Used for a paginated request.
|
1594
|
+
# The request retrieves the next result page. All other parameter
|
1595
|
+
# values must be identical to the ones specified in the initial
|
1596
|
+
# request.
|
1597
|
+
#
|
1598
|
+
# If you don't specify `NextToken`, the request retrieves the first
|
1599
|
+
# result page.
|
1600
|
+
# @return [String]
|
1601
|
+
#
|
1602
|
+
# @!attribute [rw] max_results
|
1603
|
+
# The maximum number of results to include in each response (result
|
1604
|
+
# page). It's used for a paginated request.
|
1605
|
+
#
|
1606
|
+
# If you don't specify `MaxResults`, the request retrieves all
|
1607
|
+
# available results in a single response.
|
1608
|
+
# @return [Integer]
|
1609
|
+
#
|
1610
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ListServicesRequest AWS API Documentation
|
1611
|
+
#
|
1612
|
+
class ListServicesRequest < Struct.new(
|
1613
|
+
:next_token,
|
1614
|
+
:max_results)
|
1615
|
+
SENSITIVE = []
|
1616
|
+
include Aws::Structure
|
1617
|
+
end
|
1618
|
+
|
1619
|
+
# @!attribute [rw] service_summary_list
|
1620
|
+
# A list of service summary information records. In a paginated
|
1621
|
+
# request, the request returns up to `MaxResults` records for each
|
1622
|
+
# call.
|
1623
|
+
# @return [Array<Types::ServiceSummary>]
|
1624
|
+
#
|
1625
|
+
# @!attribute [rw] next_token
|
1626
|
+
# The token that you can pass in a subsequent request to get the next
|
1627
|
+
# result page. It's returned in a paginated request.
|
1628
|
+
# @return [String]
|
1629
|
+
#
|
1630
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ListServicesResponse AWS API Documentation
|
1631
|
+
#
|
1632
|
+
class ListServicesResponse < Struct.new(
|
1633
|
+
:service_summary_list,
|
1634
|
+
:next_token)
|
1635
|
+
SENSITIVE = []
|
1636
|
+
include Aws::Structure
|
1637
|
+
end
|
1638
|
+
|
1639
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
1640
|
+
# data as a hash:
|
1641
|
+
#
|
1642
|
+
# {
|
1643
|
+
# resource_arn: "AppRunnerResourceArn", # required
|
1644
|
+
# }
|
1645
|
+
#
|
1646
|
+
# @!attribute [rw] resource_arn
|
1647
|
+
# The Amazon Resource Name (ARN) of the resource that a tag list is
|
1648
|
+
# requested for.
|
1649
|
+
#
|
1650
|
+
# It must be the ARN of an App Runner resource.
|
1651
|
+
# @return [String]
|
1652
|
+
#
|
1653
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ListTagsForResourceRequest AWS API Documentation
|
1654
|
+
#
|
1655
|
+
class ListTagsForResourceRequest < Struct.new(
|
1656
|
+
:resource_arn)
|
1657
|
+
SENSITIVE = []
|
1658
|
+
include Aws::Structure
|
1659
|
+
end
|
1660
|
+
|
1661
|
+
# @!attribute [rw] tags
|
1662
|
+
# A list of the tag key-value pairs that are associated with the
|
1663
|
+
# resource.
|
1664
|
+
# @return [Array<Types::Tag>]
|
1665
|
+
#
|
1666
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ListTagsForResourceResponse AWS API Documentation
|
1667
|
+
#
|
1668
|
+
class ListTagsForResourceResponse < Struct.new(
|
1669
|
+
:tags)
|
1670
|
+
SENSITIVE = []
|
1671
|
+
include Aws::Structure
|
1672
|
+
end
|
1673
|
+
|
1674
|
+
# Provides summary information for an operation that occurred on an AWS
|
1675
|
+
# App Runner service.
|
1676
|
+
#
|
1677
|
+
# @!attribute [rw] id
|
1678
|
+
# A unique ID of this operation. It's unique in the scope of the App
|
1679
|
+
# Runner service.
|
1680
|
+
# @return [String]
|
1681
|
+
#
|
1682
|
+
# @!attribute [rw] type
|
1683
|
+
# The type of operation. It indicates a specific action that occured.
|
1684
|
+
# @return [String]
|
1685
|
+
#
|
1686
|
+
# @!attribute [rw] status
|
1687
|
+
# The current state of the operation.
|
1688
|
+
# @return [String]
|
1689
|
+
#
|
1690
|
+
# @!attribute [rw] target_arn
|
1691
|
+
# The Amazon Resource Name (ARN) of the resource that the operation
|
1692
|
+
# acted on (for example, an App Runner service).
|
1693
|
+
# @return [String]
|
1694
|
+
#
|
1695
|
+
# @!attribute [rw] started_at
|
1696
|
+
# The time when the operation started. It's in the Unix time stamp
|
1697
|
+
# format.
|
1698
|
+
# @return [Time]
|
1699
|
+
#
|
1700
|
+
# @!attribute [rw] ended_at
|
1701
|
+
# The time when the operation ended. It's in the Unix time stamp
|
1702
|
+
# format.
|
1703
|
+
# @return [Time]
|
1704
|
+
#
|
1705
|
+
# @!attribute [rw] updated_at
|
1706
|
+
# The time when the operation was last updated. It's in the Unix time
|
1707
|
+
# stamp format.
|
1708
|
+
# @return [Time]
|
1709
|
+
#
|
1710
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/OperationSummary AWS API Documentation
|
1711
|
+
#
|
1712
|
+
class OperationSummary < Struct.new(
|
1713
|
+
:id,
|
1714
|
+
:type,
|
1715
|
+
:status,
|
1716
|
+
:target_arn,
|
1717
|
+
:started_at,
|
1718
|
+
:ended_at,
|
1719
|
+
:updated_at)
|
1720
|
+
SENSITIVE = []
|
1721
|
+
include Aws::Structure
|
1722
|
+
end
|
1723
|
+
|
1724
|
+
# @note When making an API call, you may pass PauseServiceRequest
|
1725
|
+
# data as a hash:
|
1726
|
+
#
|
1727
|
+
# {
|
1728
|
+
# service_arn: "AppRunnerResourceArn", # required
|
1729
|
+
# }
|
1730
|
+
#
|
1731
|
+
# @!attribute [rw] service_arn
|
1732
|
+
# The Amazon Resource Name (ARN) of the App Runner service that you
|
1733
|
+
# want to pause.
|
1734
|
+
# @return [String]
|
1735
|
+
#
|
1736
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/PauseServiceRequest AWS API Documentation
|
1737
|
+
#
|
1738
|
+
class PauseServiceRequest < Struct.new(
|
1739
|
+
:service_arn)
|
1740
|
+
SENSITIVE = []
|
1741
|
+
include Aws::Structure
|
1742
|
+
end
|
1743
|
+
|
1744
|
+
# @!attribute [rw] service
|
1745
|
+
# A description of the App Runner service that this request just
|
1746
|
+
# paused.
|
1747
|
+
# @return [Types::Service]
|
1748
|
+
#
|
1749
|
+
# @!attribute [rw] operation_id
|
1750
|
+
# The unique ID of the asynchronous operation that this request
|
1751
|
+
# started. You can use it combined with the ListOperations call to
|
1752
|
+
# track the operation's progress.
|
1753
|
+
# @return [String]
|
1754
|
+
#
|
1755
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/PauseServiceResponse AWS API Documentation
|
1756
|
+
#
|
1757
|
+
class PauseServiceResponse < Struct.new(
|
1758
|
+
:service,
|
1759
|
+
:operation_id)
|
1760
|
+
SENSITIVE = []
|
1761
|
+
include Aws::Structure
|
1762
|
+
end
|
1763
|
+
|
1764
|
+
# A resource doesn't exist for the specified Amazon Resource Name (ARN)
|
1765
|
+
# in your AWS account.
|
1766
|
+
#
|
1767
|
+
# @!attribute [rw] message
|
1768
|
+
# @return [String]
|
1769
|
+
#
|
1770
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ResourceNotFoundException AWS API Documentation
|
1771
|
+
#
|
1772
|
+
class ResourceNotFoundException < Struct.new(
|
1773
|
+
:message)
|
1774
|
+
SENSITIVE = []
|
1775
|
+
include Aws::Structure
|
1776
|
+
end
|
1777
|
+
|
1778
|
+
# @note When making an API call, you may pass ResumeServiceRequest
|
1779
|
+
# data as a hash:
|
1780
|
+
#
|
1781
|
+
# {
|
1782
|
+
# service_arn: "AppRunnerResourceArn", # required
|
1783
|
+
# }
|
1784
|
+
#
|
1785
|
+
# @!attribute [rw] service_arn
|
1786
|
+
# The Amazon Resource Name (ARN) of the App Runner service that you
|
1787
|
+
# want to resume.
|
1788
|
+
# @return [String]
|
1789
|
+
#
|
1790
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ResumeServiceRequest AWS API Documentation
|
1791
|
+
#
|
1792
|
+
class ResumeServiceRequest < Struct.new(
|
1793
|
+
:service_arn)
|
1794
|
+
SENSITIVE = []
|
1795
|
+
include Aws::Structure
|
1796
|
+
end
|
1797
|
+
|
1798
|
+
# @!attribute [rw] service
|
1799
|
+
# A description of the App Runner service that this request just
|
1800
|
+
# resumed.
|
1801
|
+
# @return [Types::Service]
|
1802
|
+
#
|
1803
|
+
# @!attribute [rw] operation_id
|
1804
|
+
# The unique ID of the asynchronous operation that this request
|
1805
|
+
# started. You can use it combined with the ListOperations call to
|
1806
|
+
# track the operation's progress.
|
1807
|
+
# @return [String]
|
1808
|
+
#
|
1809
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ResumeServiceResponse AWS API Documentation
|
1810
|
+
#
|
1811
|
+
class ResumeServiceResponse < Struct.new(
|
1812
|
+
:service,
|
1813
|
+
:operation_id)
|
1814
|
+
SENSITIVE = []
|
1815
|
+
include Aws::Structure
|
1816
|
+
end
|
1817
|
+
|
1818
|
+
# Describes an AWS App Runner service. It can describe a service in any
|
1819
|
+
# state, including deleted services.
|
1820
|
+
#
|
1821
|
+
# This type contains the full information about a service, including
|
1822
|
+
# configuration details. It's returned by the [CreateService][1],
|
1823
|
+
# [DescribeService][2], and [DeleteService][3] actions. A subset of this
|
1824
|
+
# information is returned by the [ListServices][4] action using the
|
1825
|
+
# [ServiceSummary][5] type.
|
1826
|
+
#
|
1827
|
+
#
|
1828
|
+
#
|
1829
|
+
# [1]: https://docs.aws.amazon.com/apprunner/latest/api/API_CreateService.html
|
1830
|
+
# [2]: https://docs.aws.amazon.com/apprunner/latest/api/API_DescribeService.html
|
1831
|
+
# [3]: https://docs.aws.amazon.com/apprunner/latest/api/API_DeleteService.html
|
1832
|
+
# [4]: https://docs.aws.amazon.com/apprunner/latest/api/API_ListServices.html
|
1833
|
+
# [5]: https://docs.aws.amazon.com/apprunner/latest/api/API_ServiceSummary.html
|
1834
|
+
#
|
1835
|
+
# @!attribute [rw] service_name
|
1836
|
+
# The customer-provided service name.
|
1837
|
+
# @return [String]
|
1838
|
+
#
|
1839
|
+
# @!attribute [rw] service_id
|
1840
|
+
# An ID that App Runner generated for this service. It's unique
|
1841
|
+
# within the AWS Region.
|
1842
|
+
# @return [String]
|
1843
|
+
#
|
1844
|
+
# @!attribute [rw] service_arn
|
1845
|
+
# The Amazon Resource Name (ARN) of this service.
|
1846
|
+
# @return [String]
|
1847
|
+
#
|
1848
|
+
# @!attribute [rw] service_url
|
1849
|
+
# A subdomain URL that App Runner generated for this service. You can
|
1850
|
+
# use this URL to access your service web application.
|
1851
|
+
# @return [String]
|
1852
|
+
#
|
1853
|
+
# @!attribute [rw] created_at
|
1854
|
+
# The time when the App Runner service was created. It's in the Unix
|
1855
|
+
# time stamp format.
|
1856
|
+
# @return [Time]
|
1857
|
+
#
|
1858
|
+
# @!attribute [rw] updated_at
|
1859
|
+
# The time when the App Runner service was last updated at. It's in
|
1860
|
+
# the Unix time stamp format.
|
1861
|
+
# @return [Time]
|
1862
|
+
#
|
1863
|
+
# @!attribute [rw] deleted_at
|
1864
|
+
# The time when the App Runner service was deleted. It's in the Unix
|
1865
|
+
# time stamp format.
|
1866
|
+
# @return [Time]
|
1867
|
+
#
|
1868
|
+
# @!attribute [rw] status
|
1869
|
+
# The current state of the App Runner service. These particular values
|
1870
|
+
# mean the following.
|
1871
|
+
#
|
1872
|
+
# * `CREATE_FAILED` – The service failed to create. To troubleshoot
|
1873
|
+
# this failure, read the failure events and logs, change any
|
1874
|
+
# parameters that need to be fixed, and retry the call to create the
|
1875
|
+
# service.
|
1876
|
+
#
|
1877
|
+
# The failed service isn't usable, and still counts towards your
|
1878
|
+
# service quota. When you're done analyzing the failure, delete the
|
1879
|
+
# service.
|
1880
|
+
#
|
1881
|
+
# * `DELETE_FAILED` – The service failed to delete and can't be
|
1882
|
+
# successfully recovered. Retry the service deletion call to ensure
|
1883
|
+
# that all related resources are removed.
|
1884
|
+
# @return [String]
|
1885
|
+
#
|
1886
|
+
# @!attribute [rw] source_configuration
|
1887
|
+
# The source deployed to the App Runner service. It can be a code or
|
1888
|
+
# an image repository.
|
1889
|
+
# @return [Types::SourceConfiguration]
|
1890
|
+
#
|
1891
|
+
# @!attribute [rw] instance_configuration
|
1892
|
+
# The runtime configuration of instances (scaling units) of this
|
1893
|
+
# service.
|
1894
|
+
# @return [Types::InstanceConfiguration]
|
1895
|
+
#
|
1896
|
+
# @!attribute [rw] encryption_configuration
|
1897
|
+
# The encryption key that App Runner uses to encrypt the service logs
|
1898
|
+
# and the copy of the source repository that App Runner maintains for
|
1899
|
+
# the service. It can be either a customer-provided encryption key or
|
1900
|
+
# an AWS managed CMK.
|
1901
|
+
# @return [Types::EncryptionConfiguration]
|
1902
|
+
#
|
1903
|
+
# @!attribute [rw] health_check_configuration
|
1904
|
+
# The settings for the health check that App Runner performs to
|
1905
|
+
# monitor the health of this service.
|
1906
|
+
# @return [Types::HealthCheckConfiguration]
|
1907
|
+
#
|
1908
|
+
# @!attribute [rw] auto_scaling_configuration_summary
|
1909
|
+
# Summary information for the App Runner automatic scaling
|
1910
|
+
# configuration resource that's associated with this service.
|
1911
|
+
# @return [Types::AutoScalingConfigurationSummary]
|
1912
|
+
#
|
1913
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/Service AWS API Documentation
|
1914
|
+
#
|
1915
|
+
class Service < Struct.new(
|
1916
|
+
:service_name,
|
1917
|
+
:service_id,
|
1918
|
+
:service_arn,
|
1919
|
+
:service_url,
|
1920
|
+
:created_at,
|
1921
|
+
:updated_at,
|
1922
|
+
:deleted_at,
|
1923
|
+
:status,
|
1924
|
+
:source_configuration,
|
1925
|
+
:instance_configuration,
|
1926
|
+
:encryption_configuration,
|
1927
|
+
:health_check_configuration,
|
1928
|
+
:auto_scaling_configuration_summary)
|
1929
|
+
SENSITIVE = []
|
1930
|
+
include Aws::Structure
|
1931
|
+
end
|
1932
|
+
|
1933
|
+
# App Runner can't create this resource. You've reached your account
|
1934
|
+
# quota for this resource type.
|
1935
|
+
#
|
1936
|
+
# For App Runner per-resource quotas, see [AWS App Runner endpoints and
|
1937
|
+
# quotas][1] in the *AWS General Reference*.
|
1938
|
+
#
|
1939
|
+
#
|
1940
|
+
#
|
1941
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/apprunner.html
|
1942
|
+
#
|
1943
|
+
# @!attribute [rw] message
|
1944
|
+
# @return [String]
|
1945
|
+
#
|
1946
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ServiceQuotaExceededException AWS API Documentation
|
1947
|
+
#
|
1948
|
+
class ServiceQuotaExceededException < Struct.new(
|
1949
|
+
:message)
|
1950
|
+
SENSITIVE = []
|
1951
|
+
include Aws::Structure
|
1952
|
+
end
|
1953
|
+
|
1954
|
+
# Provides summary information for an AWS App Runner service.
|
1955
|
+
#
|
1956
|
+
# This type contains limited information about a service. It doesn't
|
1957
|
+
# include configuration details. It's returned by the [ListServices][1]
|
1958
|
+
# action. Complete service information is returned by the
|
1959
|
+
# [CreateService][2], [DescribeService][3], and [DeleteService][4]
|
1960
|
+
# actions using the [Service][5] type.
|
1961
|
+
#
|
1962
|
+
#
|
1963
|
+
#
|
1964
|
+
# [1]: https://docs.aws.amazon.com/apprunner/latest/api/API_ListServices.html
|
1965
|
+
# [2]: https://docs.aws.amazon.com/apprunner/latest/api/API_CreateService.html
|
1966
|
+
# [3]: https://docs.aws.amazon.com/apprunner/latest/api/API_DescribeService.html
|
1967
|
+
# [4]: https://docs.aws.amazon.com/apprunner/latest/api/API_DeleteService.html
|
1968
|
+
# [5]: https://docs.aws.amazon.com/apprunner/latest/api/API_Service.html
|
1969
|
+
#
|
1970
|
+
# @!attribute [rw] service_name
|
1971
|
+
# The customer-provided service name.
|
1972
|
+
# @return [String]
|
1973
|
+
#
|
1974
|
+
# @!attribute [rw] service_id
|
1975
|
+
# An ID that App Runner generated for this service. It's unique
|
1976
|
+
# within the AWS Region.
|
1977
|
+
# @return [String]
|
1978
|
+
#
|
1979
|
+
# @!attribute [rw] service_arn
|
1980
|
+
# The Amazon Resource Name (ARN) of this service.
|
1981
|
+
# @return [String]
|
1982
|
+
#
|
1983
|
+
# @!attribute [rw] service_url
|
1984
|
+
# A subdomain URL that App Runner generated for this service. You can
|
1985
|
+
# use this URL to access your service web application.
|
1986
|
+
# @return [String]
|
1987
|
+
#
|
1988
|
+
# @!attribute [rw] created_at
|
1989
|
+
# The time when the App Runner service was created. It's in the Unix
|
1990
|
+
# time stamp format.
|
1991
|
+
# @return [Time]
|
1992
|
+
#
|
1993
|
+
# @!attribute [rw] updated_at
|
1994
|
+
# The time when the App Runner service was last updated. It's in
|
1995
|
+
# theUnix time stamp format.
|
1996
|
+
# @return [Time]
|
1997
|
+
#
|
1998
|
+
# @!attribute [rw] status
|
1999
|
+
# The current state of the App Runner service. These particular values
|
2000
|
+
# mean the following.
|
2001
|
+
#
|
2002
|
+
# * `CREATE_FAILED` – The service failed to create. Read the failure
|
2003
|
+
# events and logs, change any parameters that need to be fixed, and
|
2004
|
+
# retry the call to create the service.
|
2005
|
+
#
|
2006
|
+
# The failed service isn't usable, and still counts towards your
|
2007
|
+
# service quota. When you're done analyzing the failure, delete the
|
2008
|
+
# service.
|
2009
|
+
#
|
2010
|
+
# * `DELETE_FAILED` – The service failed to delete and can't be
|
2011
|
+
# successfully recovered. Retry the service deletion call to ensure
|
2012
|
+
# that all related resources are removed.
|
2013
|
+
# @return [String]
|
2014
|
+
#
|
2015
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ServiceSummary AWS API Documentation
|
2016
|
+
#
|
2017
|
+
class ServiceSummary < Struct.new(
|
2018
|
+
:service_name,
|
2019
|
+
:service_id,
|
2020
|
+
:service_arn,
|
2021
|
+
:service_url,
|
2022
|
+
:created_at,
|
2023
|
+
:updated_at,
|
2024
|
+
:status)
|
2025
|
+
SENSITIVE = []
|
2026
|
+
include Aws::Structure
|
2027
|
+
end
|
2028
|
+
|
2029
|
+
# Identifies a version of code that AWS App Runner refers to within a
|
2030
|
+
# source code repository.
|
2031
|
+
#
|
2032
|
+
# @note When making an API call, you may pass SourceCodeVersion
|
2033
|
+
# data as a hash:
|
2034
|
+
#
|
2035
|
+
# {
|
2036
|
+
# type: "BRANCH", # required, accepts BRANCH
|
2037
|
+
# value: "String", # required
|
2038
|
+
# }
|
2039
|
+
#
|
2040
|
+
# @!attribute [rw] type
|
2041
|
+
# The type of version identifier.
|
2042
|
+
#
|
2043
|
+
# For a git-based repository, branches represent versions.
|
2044
|
+
# @return [String]
|
2045
|
+
#
|
2046
|
+
# @!attribute [rw] value
|
2047
|
+
# A source code version.
|
2048
|
+
#
|
2049
|
+
# For a git-based repository, a branch name maps to a specific
|
2050
|
+
# version. App Runner uses the most recent commit to the branch.
|
2051
|
+
# @return [String]
|
2052
|
+
#
|
2053
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/SourceCodeVersion AWS API Documentation
|
2054
|
+
#
|
2055
|
+
class SourceCodeVersion < Struct.new(
|
2056
|
+
:type,
|
2057
|
+
:value)
|
2058
|
+
SENSITIVE = []
|
2059
|
+
include Aws::Structure
|
2060
|
+
end
|
2061
|
+
|
2062
|
+
# Describes the source deployed to an AWS App Runner service. It can be
|
2063
|
+
# a code or an image repository.
|
2064
|
+
#
|
2065
|
+
# @note When making an API call, you may pass SourceConfiguration
|
2066
|
+
# data as a hash:
|
2067
|
+
#
|
2068
|
+
# {
|
2069
|
+
# code_repository: {
|
2070
|
+
# repository_url: "String", # required
|
2071
|
+
# source_code_version: { # required
|
2072
|
+
# type: "BRANCH", # required, accepts BRANCH
|
2073
|
+
# value: "String", # required
|
2074
|
+
# },
|
2075
|
+
# code_configuration: {
|
2076
|
+
# configuration_source: "REPOSITORY", # required, accepts REPOSITORY, API
|
2077
|
+
# code_configuration_values: {
|
2078
|
+
# runtime: "PYTHON_3", # required, accepts PYTHON_3, NODEJS_12
|
2079
|
+
# build_command: "BuildCommand",
|
2080
|
+
# start_command: "StartCommand",
|
2081
|
+
# port: "String",
|
2082
|
+
# runtime_environment_variables: {
|
2083
|
+
# "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue",
|
2084
|
+
# },
|
2085
|
+
# },
|
2086
|
+
# },
|
2087
|
+
# },
|
2088
|
+
# image_repository: {
|
2089
|
+
# image_identifier: "ImageIdentifier", # required
|
2090
|
+
# image_configuration: {
|
2091
|
+
# runtime_environment_variables: {
|
2092
|
+
# "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue",
|
2093
|
+
# },
|
2094
|
+
# start_command: "String",
|
2095
|
+
# port: "String",
|
2096
|
+
# },
|
2097
|
+
# image_repository_type: "ECR", # required, accepts ECR, ECR_PUBLIC
|
2098
|
+
# },
|
2099
|
+
# auto_deployments_enabled: false,
|
2100
|
+
# authentication_configuration: {
|
2101
|
+
# connection_arn: "AppRunnerResourceArn",
|
2102
|
+
# access_role_arn: "RoleArn",
|
2103
|
+
# },
|
2104
|
+
# }
|
2105
|
+
#
|
2106
|
+
# @!attribute [rw] code_repository
|
2107
|
+
# The description of a source code repository.
|
2108
|
+
#
|
2109
|
+
# You must provide either this member or `ImageRepository` (but not
|
2110
|
+
# both).
|
2111
|
+
# @return [Types::CodeRepository]
|
2112
|
+
#
|
2113
|
+
# @!attribute [rw] image_repository
|
2114
|
+
# The description of a source image repository.
|
2115
|
+
#
|
2116
|
+
# You must provide either this member or `CodeRepository` (but not
|
2117
|
+
# both).
|
2118
|
+
# @return [Types::ImageRepository]
|
2119
|
+
#
|
2120
|
+
# @!attribute [rw] auto_deployments_enabled
|
2121
|
+
# If `true`, continuous integration from the source repository is
|
2122
|
+
# enabled for the App Runner service. Each repository change (source
|
2123
|
+
# code commit or new image version) starts a deployment.
|
2124
|
+
#
|
2125
|
+
# Default: `true`
|
2126
|
+
# @return [Boolean]
|
2127
|
+
#
|
2128
|
+
# @!attribute [rw] authentication_configuration
|
2129
|
+
# Describes the resources that are needed to authenticate access to
|
2130
|
+
# some source repositories.
|
2131
|
+
# @return [Types::AuthenticationConfiguration]
|
2132
|
+
#
|
2133
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/SourceConfiguration AWS API Documentation
|
2134
|
+
#
|
2135
|
+
class SourceConfiguration < Struct.new(
|
2136
|
+
:code_repository,
|
2137
|
+
:image_repository,
|
2138
|
+
:auto_deployments_enabled,
|
2139
|
+
:authentication_configuration)
|
2140
|
+
SENSITIVE = []
|
2141
|
+
include Aws::Structure
|
2142
|
+
end
|
2143
|
+
|
2144
|
+
# @note When making an API call, you may pass StartDeploymentRequest
|
2145
|
+
# data as a hash:
|
2146
|
+
#
|
2147
|
+
# {
|
2148
|
+
# service_arn: "AppRunnerResourceArn", # required
|
2149
|
+
# }
|
2150
|
+
#
|
2151
|
+
# @!attribute [rw] service_arn
|
2152
|
+
# The Amazon Resource Name (ARN) of the App Runner service that you
|
2153
|
+
# want to manually deploy to.
|
2154
|
+
# @return [String]
|
2155
|
+
#
|
2156
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/StartDeploymentRequest AWS API Documentation
|
2157
|
+
#
|
2158
|
+
class StartDeploymentRequest < Struct.new(
|
2159
|
+
:service_arn)
|
2160
|
+
SENSITIVE = []
|
2161
|
+
include Aws::Structure
|
2162
|
+
end
|
2163
|
+
|
2164
|
+
# @!attribute [rw] operation_id
|
2165
|
+
# The unique ID of the asynchronous operation that this request
|
2166
|
+
# started. You can use it combined with the ListOperations call to
|
2167
|
+
# track the operation's progress.
|
2168
|
+
# @return [String]
|
2169
|
+
#
|
2170
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/StartDeploymentResponse AWS API Documentation
|
2171
|
+
#
|
2172
|
+
class StartDeploymentResponse < Struct.new(
|
2173
|
+
:operation_id)
|
2174
|
+
SENSITIVE = []
|
2175
|
+
include Aws::Structure
|
2176
|
+
end
|
2177
|
+
|
2178
|
+
# Describes a tag that is applied to an AWS App Runner resource. A tag
|
2179
|
+
# is a metadata item consisting of a key-value pair.
|
2180
|
+
#
|
2181
|
+
# @note When making an API call, you may pass Tag
|
2182
|
+
# data as a hash:
|
2183
|
+
#
|
2184
|
+
# {
|
2185
|
+
# key: "TagKey",
|
2186
|
+
# value: "TagValue",
|
2187
|
+
# }
|
2188
|
+
#
|
2189
|
+
# @!attribute [rw] key
|
2190
|
+
# The key of the tag.
|
2191
|
+
# @return [String]
|
2192
|
+
#
|
2193
|
+
# @!attribute [rw] value
|
2194
|
+
# The value of the tag.
|
2195
|
+
# @return [String]
|
2196
|
+
#
|
2197
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/Tag AWS API Documentation
|
2198
|
+
#
|
2199
|
+
class Tag < Struct.new(
|
2200
|
+
:key,
|
2201
|
+
:value)
|
2202
|
+
SENSITIVE = []
|
2203
|
+
include Aws::Structure
|
2204
|
+
end
|
2205
|
+
|
2206
|
+
# @note When making an API call, you may pass TagResourceRequest
|
2207
|
+
# data as a hash:
|
2208
|
+
#
|
2209
|
+
# {
|
2210
|
+
# resource_arn: "AppRunnerResourceArn", # required
|
2211
|
+
# tags: [ # required
|
2212
|
+
# {
|
2213
|
+
# key: "TagKey",
|
2214
|
+
# value: "TagValue",
|
2215
|
+
# },
|
2216
|
+
# ],
|
2217
|
+
# }
|
2218
|
+
#
|
2219
|
+
# @!attribute [rw] resource_arn
|
2220
|
+
# The Amazon Resource Name (ARN) of the resource that you want to
|
2221
|
+
# update tags for.
|
2222
|
+
#
|
2223
|
+
# It must be the ARN of an App Runner resource.
|
2224
|
+
# @return [String]
|
2225
|
+
#
|
2226
|
+
# @!attribute [rw] tags
|
2227
|
+
# A list of tag key-value pairs to add or update. If a key is new to
|
2228
|
+
# the resource, the tag is added with the provided value. If a key is
|
2229
|
+
# already associated with the resource, the value of the tag is
|
2230
|
+
# updated.
|
2231
|
+
# @return [Array<Types::Tag>]
|
2232
|
+
#
|
2233
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/TagResourceRequest AWS API Documentation
|
2234
|
+
#
|
2235
|
+
class TagResourceRequest < Struct.new(
|
2236
|
+
:resource_arn,
|
2237
|
+
:tags)
|
2238
|
+
SENSITIVE = []
|
2239
|
+
include Aws::Structure
|
2240
|
+
end
|
2241
|
+
|
2242
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/TagResourceResponse AWS API Documentation
|
2243
|
+
#
|
2244
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
2245
|
+
|
2246
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
2247
|
+
# data as a hash:
|
2248
|
+
#
|
2249
|
+
# {
|
2250
|
+
# resource_arn: "AppRunnerResourceArn", # required
|
2251
|
+
# tag_keys: ["TagKey"], # required
|
2252
|
+
# }
|
2253
|
+
#
|
2254
|
+
# @!attribute [rw] resource_arn
|
2255
|
+
# The Amazon Resource Name (ARN) of the resource that you want to
|
2256
|
+
# remove tags from.
|
2257
|
+
#
|
2258
|
+
# It must be the ARN of an App Runner resource.
|
2259
|
+
# @return [String]
|
2260
|
+
#
|
2261
|
+
# @!attribute [rw] tag_keys
|
2262
|
+
# A list of tag keys that you want to remove.
|
2263
|
+
# @return [Array<String>]
|
2264
|
+
#
|
2265
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/UntagResourceRequest AWS API Documentation
|
2266
|
+
#
|
2267
|
+
class UntagResourceRequest < Struct.new(
|
2268
|
+
:resource_arn,
|
2269
|
+
:tag_keys)
|
2270
|
+
SENSITIVE = []
|
2271
|
+
include Aws::Structure
|
2272
|
+
end
|
2273
|
+
|
2274
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/UntagResourceResponse AWS API Documentation
|
2275
|
+
#
|
2276
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
2277
|
+
|
2278
|
+
# @note When making an API call, you may pass UpdateServiceRequest
|
2279
|
+
# data as a hash:
|
2280
|
+
#
|
2281
|
+
# {
|
2282
|
+
# service_arn: "AppRunnerResourceArn", # required
|
2283
|
+
# source_configuration: {
|
2284
|
+
# code_repository: {
|
2285
|
+
# repository_url: "String", # required
|
2286
|
+
# source_code_version: { # required
|
2287
|
+
# type: "BRANCH", # required, accepts BRANCH
|
2288
|
+
# value: "String", # required
|
2289
|
+
# },
|
2290
|
+
# code_configuration: {
|
2291
|
+
# configuration_source: "REPOSITORY", # required, accepts REPOSITORY, API
|
2292
|
+
# code_configuration_values: {
|
2293
|
+
# runtime: "PYTHON_3", # required, accepts PYTHON_3, NODEJS_12
|
2294
|
+
# build_command: "BuildCommand",
|
2295
|
+
# start_command: "StartCommand",
|
2296
|
+
# port: "String",
|
2297
|
+
# runtime_environment_variables: {
|
2298
|
+
# "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue",
|
2299
|
+
# },
|
2300
|
+
# },
|
2301
|
+
# },
|
2302
|
+
# },
|
2303
|
+
# image_repository: {
|
2304
|
+
# image_identifier: "ImageIdentifier", # required
|
2305
|
+
# image_configuration: {
|
2306
|
+
# runtime_environment_variables: {
|
2307
|
+
# "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue",
|
2308
|
+
# },
|
2309
|
+
# start_command: "String",
|
2310
|
+
# port: "String",
|
2311
|
+
# },
|
2312
|
+
# image_repository_type: "ECR", # required, accepts ECR, ECR_PUBLIC
|
2313
|
+
# },
|
2314
|
+
# auto_deployments_enabled: false,
|
2315
|
+
# authentication_configuration: {
|
2316
|
+
# connection_arn: "AppRunnerResourceArn",
|
2317
|
+
# access_role_arn: "RoleArn",
|
2318
|
+
# },
|
2319
|
+
# },
|
2320
|
+
# instance_configuration: {
|
2321
|
+
# cpu: "Cpu",
|
2322
|
+
# memory: "Memory",
|
2323
|
+
# instance_role_arn: "RoleArn",
|
2324
|
+
# },
|
2325
|
+
# auto_scaling_configuration_arn: "AppRunnerResourceArn",
|
2326
|
+
# health_check_configuration: {
|
2327
|
+
# protocol: "TCP", # accepts TCP, HTTP
|
2328
|
+
# path: "String",
|
2329
|
+
# interval: 1,
|
2330
|
+
# timeout: 1,
|
2331
|
+
# healthy_threshold: 1,
|
2332
|
+
# unhealthy_threshold: 1,
|
2333
|
+
# },
|
2334
|
+
# }
|
2335
|
+
#
|
2336
|
+
# @!attribute [rw] service_arn
|
2337
|
+
# The Amazon Resource Name (ARN) of the App Runner service that you
|
2338
|
+
# want to update.
|
2339
|
+
# @return [String]
|
2340
|
+
#
|
2341
|
+
# @!attribute [rw] source_configuration
|
2342
|
+
# The source configuration to apply to the App Runner service.
|
2343
|
+
#
|
2344
|
+
# You can change the configuration of the code or image repository
|
2345
|
+
# that the service uses. However, you can't switch from code to image
|
2346
|
+
# or the other way around. This means that you must provide the same
|
2347
|
+
# structure member of `SourceConfiguration` that you originally
|
2348
|
+
# included when you created the service. Specifically, you can include
|
2349
|
+
# either `CodeRepository` or `ImageRepository`. To update the source
|
2350
|
+
# configuration, set the values to members of the structure that you
|
2351
|
+
# include.
|
2352
|
+
# @return [Types::SourceConfiguration]
|
2353
|
+
#
|
2354
|
+
# @!attribute [rw] instance_configuration
|
2355
|
+
# The runtime configuration to apply to instances (scaling units) of
|
2356
|
+
# the App Runner service.
|
2357
|
+
# @return [Types::InstanceConfiguration]
|
2358
|
+
#
|
2359
|
+
# @!attribute [rw] auto_scaling_configuration_arn
|
2360
|
+
# The Amazon Resource Name (ARN) of an App Runner automatic scaling
|
2361
|
+
# configuration resource that you want to associate with your service.
|
2362
|
+
# @return [String]
|
2363
|
+
#
|
2364
|
+
# @!attribute [rw] health_check_configuration
|
2365
|
+
# The settings for the health check that AWS App Runner performs to
|
2366
|
+
# monitor the health of your service.
|
2367
|
+
# @return [Types::HealthCheckConfiguration]
|
2368
|
+
#
|
2369
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/UpdateServiceRequest AWS API Documentation
|
2370
|
+
#
|
2371
|
+
class UpdateServiceRequest < Struct.new(
|
2372
|
+
:service_arn,
|
2373
|
+
:source_configuration,
|
2374
|
+
:instance_configuration,
|
2375
|
+
:auto_scaling_configuration_arn,
|
2376
|
+
:health_check_configuration)
|
2377
|
+
SENSITIVE = []
|
2378
|
+
include Aws::Structure
|
2379
|
+
end
|
2380
|
+
|
2381
|
+
# @!attribute [rw] service
|
2382
|
+
# A description of the App Runner service updated by this request. All
|
2383
|
+
# configuration values in the returned `Service` structure reflect
|
2384
|
+
# configuration changes that are being applied by this request.
|
2385
|
+
# @return [Types::Service]
|
2386
|
+
#
|
2387
|
+
# @!attribute [rw] operation_id
|
2388
|
+
# The unique ID of the asynchronous operation that this request
|
2389
|
+
# started. You can use it combined with the ListOperations call to
|
2390
|
+
# track the operation's progress.
|
2391
|
+
# @return [String]
|
2392
|
+
#
|
2393
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/UpdateServiceResponse AWS API Documentation
|
2394
|
+
#
|
2395
|
+
class UpdateServiceResponse < Struct.new(
|
2396
|
+
:service,
|
2397
|
+
:operation_id)
|
2398
|
+
SENSITIVE = []
|
2399
|
+
include Aws::Structure
|
2400
|
+
end
|
2401
|
+
|
2402
|
+
end
|
2403
|
+
end
|