libZSservicesZSamazonka-apprunnerZSamazonka-apprunner
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AppRunner.UpdateService

Description

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

Creating a Request

data UpdateService Source #

See: newUpdateService smart constructor.

Constructors

UpdateService' 

Fields

  • autoScalingConfigurationArn :: Maybe Text

    The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service.

  • healthCheckConfiguration :: Maybe HealthCheckConfiguration

    The settings for the health check that App Runner performs to monitor the health of your service.

  • sourceConfiguration :: Maybe 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.

  • instanceConfiguration :: Maybe InstanceConfiguration

    The runtime configuration to apply to instances (scaling units) of the App Runner service.

  • serviceArn :: Text

    The Amazon Resource Name (ARN) of the App Runner service that you want to update.

Instances

Instances details
Eq UpdateService Source # 
Instance details

Defined in Amazonka.AppRunner.UpdateService

Show UpdateService Source # 
Instance details

Defined in Amazonka.AppRunner.UpdateService

Generic UpdateService Source # 
Instance details

Defined in Amazonka.AppRunner.UpdateService

Associated Types

type Rep UpdateService :: Type -> Type #

NFData UpdateService Source # 
Instance details

Defined in Amazonka.AppRunner.UpdateService

Methods

rnf :: UpdateService -> () #

Hashable UpdateService Source # 
Instance details

Defined in Amazonka.AppRunner.UpdateService

ToJSON UpdateService Source # 
Instance details

Defined in Amazonka.AppRunner.UpdateService

AWSRequest UpdateService Source # 
Instance details

Defined in Amazonka.AppRunner.UpdateService

Associated Types

type AWSResponse UpdateService #

ToHeaders UpdateService Source # 
Instance details

Defined in Amazonka.AppRunner.UpdateService

ToPath UpdateService Source # 
Instance details

Defined in Amazonka.AppRunner.UpdateService

ToQuery UpdateService Source # 
Instance details

Defined in Amazonka.AppRunner.UpdateService

type Rep UpdateService Source # 
Instance details

Defined in Amazonka.AppRunner.UpdateService

type Rep UpdateService = D1 ('MetaData "UpdateService" "Amazonka.AppRunner.UpdateService" "libZSservicesZSamazonka-apprunnerZSamazonka-apprunner" 'False) (C1 ('MetaCons "UpdateService'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "autoScalingConfigurationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "healthCheckConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HealthCheckConfiguration))) :*: (S1 ('MetaSel ('Just "sourceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceConfiguration)) :*: (S1 ('MetaSel ('Just "instanceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceConfiguration)) :*: S1 ('MetaSel ('Just "serviceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse UpdateService Source # 
Instance details

Defined in Amazonka.AppRunner.UpdateService

newUpdateService Source #

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.

Constructors

UpdateServiceResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • service :: 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.

  • operationId :: Text

    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.

Instances

Instances details
Eq UpdateServiceResponse Source # 
Instance details

Defined in Amazonka.AppRunner.UpdateService

Show UpdateServiceResponse Source # 
Instance details

Defined in Amazonka.AppRunner.UpdateService

Generic UpdateServiceResponse Source # 
Instance details

Defined in Amazonka.AppRunner.UpdateService

Associated Types

type Rep UpdateServiceResponse :: Type -> Type #

NFData UpdateServiceResponse Source # 
Instance details

Defined in Amazonka.AppRunner.UpdateService

Methods

rnf :: UpdateServiceResponse -> () #

type Rep UpdateServiceResponse Source # 
Instance details

Defined in Amazonka.AppRunner.UpdateService

type Rep UpdateServiceResponse = D1 ('MetaData "UpdateServiceResponse" "Amazonka.AppRunner.UpdateService" "libZSservicesZSamazonka-apprunnerZSamazonka-apprunner" 'False) (C1 ('MetaCons "UpdateServiceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "service") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Service) :*: S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateServiceResponse Source #

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_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.