Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Update an App Runner service. You can update the source configuration and instance configuration of the service. You can also update the ARN of the auto scaling configuration resource that's associated with the service. However, you can't change the name or the encryption configuration of the service. These can be set only when you create the service.
To update the tags applied to your service, use the separate actions TagResource and UntagResource.
This is an asynchronous operation. On a successful call, you can use the
returned OperationId
and the ListOperations call to track the
operation's progress.
Synopsis
- data UpdateService = UpdateService' {}
- newUpdateService :: Text -> UpdateService
- updateService_autoScalingConfigurationArn :: Lens' UpdateService (Maybe Text)
- updateService_healthCheckConfiguration :: Lens' UpdateService (Maybe HealthCheckConfiguration)
- updateService_sourceConfiguration :: Lens' UpdateService (Maybe SourceConfiguration)
- updateService_instanceConfiguration :: Lens' UpdateService (Maybe InstanceConfiguration)
- updateService_serviceArn :: Lens' UpdateService Text
- data UpdateServiceResponse = UpdateServiceResponse' {
- httpStatus :: Int
- service :: Service
- operationId :: Text
- newUpdateServiceResponse :: Int -> Service -> Text -> UpdateServiceResponse
- updateServiceResponse_httpStatus :: Lens' UpdateServiceResponse Int
- updateServiceResponse_service :: Lens' UpdateServiceResponse Service
- updateServiceResponse_operationId :: Lens' UpdateServiceResponse Text
Creating a Request
data UpdateService Source #
See: newUpdateService
smart constructor.
UpdateService' | |
|
Instances
Create a value of UpdateService
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoScalingConfigurationArn:UpdateService'
, updateService_autoScalingConfigurationArn
- The Amazon Resource Name (ARN) of an App Runner automatic scaling
configuration resource that you want to associate with your service.
$sel:healthCheckConfiguration:UpdateService'
, updateService_healthCheckConfiguration
- The settings for the health check that App Runner performs to monitor
the health of your service.
$sel:sourceConfiguration:UpdateService'
, updateService_sourceConfiguration
- The source configuration to apply to the App Runner service.
You can change the configuration of the code or image repository that
the service uses. However, you can't switch from code to image or the
other way around. This means that you must provide the same structure
member of SourceConfiguration
that you originally included when you
created the service. Specifically, you can include either
CodeRepository
or ImageRepository
. To update the source
configuration, set the values to members of the structure that you
include.
$sel:instanceConfiguration:UpdateService'
, updateService_instanceConfiguration
- The runtime configuration to apply to instances (scaling units) of the
App Runner service.
$sel:serviceArn:UpdateService'
, updateService_serviceArn
- The Amazon Resource Name (ARN) of the App Runner service that you want
to update.
Request Lenses
updateService_autoScalingConfigurationArn :: Lens' UpdateService (Maybe Text) Source #
The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service.
updateService_healthCheckConfiguration :: Lens' UpdateService (Maybe HealthCheckConfiguration) Source #
The settings for the health check that App Runner performs to monitor the health of your service.
updateService_sourceConfiguration :: Lens' UpdateService (Maybe SourceConfiguration) Source #
The source configuration to apply to the App Runner service.
You can change the configuration of the code or image repository that
the service uses. However, you can't switch from code to image or the
other way around. This means that you must provide the same structure
member of SourceConfiguration
that you originally included when you
created the service. Specifically, you can include either
CodeRepository
or ImageRepository
. To update the source
configuration, set the values to members of the structure that you
include.
updateService_instanceConfiguration :: Lens' UpdateService (Maybe InstanceConfiguration) Source #
The runtime configuration to apply to instances (scaling units) of the App Runner service.
updateService_serviceArn :: Lens' UpdateService Text Source #
The Amazon Resource Name (ARN) of the App Runner service that you want to update.
Destructuring the Response
data UpdateServiceResponse Source #
See: newUpdateServiceResponse
smart constructor.
UpdateServiceResponse' | |
|
Instances
newUpdateServiceResponse Source #
:: Int | |
-> Service | |
-> Text | |
-> UpdateServiceResponse |
Create a value of UpdateServiceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateServiceResponse'
, updateServiceResponse_httpStatus
- The response's http status code.
$sel:service:UpdateServiceResponse'
, updateServiceResponse_service
- A description of the App Runner service updated by this request. All
configuration values in the returned Service
structure reflect
configuration changes that are being applied by this request.
$sel:operationId:UpdateServiceResponse'
, updateServiceResponse_operationId
- The unique ID of the asynchronous operation that this request started.
You can use it combined with the ListOperations call to track the
operation's progress.
Response Lenses
updateServiceResponse_httpStatus :: Lens' UpdateServiceResponse Int Source #
The response's http status code.
updateServiceResponse_service :: Lens' UpdateServiceResponse Service Source #
A description of the App Runner service updated by this request. All
configuration values in the returned Service
structure reflect
configuration changes that are being applied by this request.
updateServiceResponse_operationId :: Lens' UpdateServiceResponse Text Source #
The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track the operation's progress.