Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Proton.UpdateServiceInstance

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Update a service instance.

There are a few modes for updating a service instance. The deploymentType field defines the mode.

You can't update a service instance while its deployment status, or the deployment status of a component attached to it, is IN_PROGRESS.

For more information about components, see Proton components in the Proton User Guide.

Synopsis

Creating a Request

data UpdateServiceInstance Source #

See: newUpdateServiceInstance smart constructor.

Constructors

UpdateServiceInstance'

Fields

spec :: Maybe (Sensitive Text)
The formatted specification that defines the service instance update.
templateMajorVersion :: Maybe Text
The major version of the service template to update.
templateMinorVersion :: Maybe Text
The minor version of the service template to update.
deploymentType :: DeploymentUpdateType
The deployment type. It defines the mode for updating a service instance, as follows:
[] NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
[] CURRENT_VERSION
In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment type.
[] MINOR_VERSION
In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
[] MAJOR_VERSION
In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.
name :: Text
The name of the service instance to update.
serviceName :: Text
The name of the service that the service instance belongs to.

Instances

Instances details

ToJSON UpdateServiceInstance Source #
Instance details Defined in Amazonka.Proton.UpdateServiceInstance Methods toJSON :: UpdateServiceInstance -> Value # toEncoding :: UpdateServiceInstance -> Encoding # toJSONList :: [UpdateServiceInstance] -> Value # toEncodingList :: [UpdateServiceInstance] -> Encoding #
ToHeaders UpdateServiceInstance Source #
Instance details Defined in Amazonka.Proton.UpdateServiceInstance Methods toHeaders :: UpdateServiceInstance -> [Header] #
ToPath UpdateServiceInstance Source #
Instance details Defined in Amazonka.Proton.UpdateServiceInstance Methods toPath :: UpdateServiceInstance -> ByteString #
ToQuery UpdateServiceInstance Source #
Instance details Defined in Amazonka.Proton.UpdateServiceInstance Methods toQuery :: UpdateServiceInstance -> QueryString #
AWSRequest UpdateServiceInstance Source #
Instance details Defined in Amazonka.Proton.UpdateServiceInstance Associated Types type AWSResponse UpdateServiceInstance # Methods request :: (Service -> Service) -> UpdateServiceInstance -> Request UpdateServiceInstance # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateServiceInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateServiceInstance))) #
Generic UpdateServiceInstance Source #
Instance details Defined in Amazonka.Proton.UpdateServiceInstance Associated Types type Rep UpdateServiceInstance :: Type -> Type # Methods from :: UpdateServiceInstance -> Rep UpdateServiceInstance x # to :: Rep UpdateServiceInstance x -> UpdateServiceInstance #
Show UpdateServiceInstance Source #
Instance details Defined in Amazonka.Proton.UpdateServiceInstance Methods showsPrec :: Int -> UpdateServiceInstance -> ShowS # show :: UpdateServiceInstance -> String # showList :: [UpdateServiceInstance] -> ShowS #
NFData UpdateServiceInstance Source #
Instance details Defined in Amazonka.Proton.UpdateServiceInstance Methods rnf :: UpdateServiceInstance -> () #
Eq UpdateServiceInstance Source #
Instance details Defined in Amazonka.Proton.UpdateServiceInstance Methods (==) :: UpdateServiceInstance -> UpdateServiceInstance -> Bool # (/=) :: UpdateServiceInstance -> UpdateServiceInstance -> Bool #
Hashable UpdateServiceInstance Source #
Instance details Defined in Amazonka.Proton.UpdateServiceInstance Methods hashWithSalt :: Int -> UpdateServiceInstance -> Int # hash :: UpdateServiceInstance -> Int #
type AWSResponse UpdateServiceInstance Source #
Instance details Defined in Amazonka.Proton.UpdateServiceInstance type AWSResponse UpdateServiceInstance = UpdateServiceInstanceResponse
type Rep UpdateServiceInstance Source #
Instance details Defined in Amazonka.Proton.UpdateServiceInstance type Rep UpdateServiceInstance = D1 ('MetaData "UpdateServiceInstance" "Amazonka.Proton.UpdateServiceInstance" "amazonka-proton-2.0-LlJ92rKPVfGGXHsLqGeI74" 'False) (C1 ('MetaCons "UpdateServiceInstance'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "spec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "templateMajorVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "templateMinorVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "deploymentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeploymentUpdateType) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "serviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateServiceInstance Source #

Arguments

:: DeploymentUpdateType	`$sel:deploymentType:UpdateServiceInstance'`
-> Text	`UpdateServiceInstance`
-> Text	`UpdateServiceInstance`
-> UpdateServiceInstance

Create a value of UpdateServiceInstance 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:

UpdateServiceInstance, updateServiceInstance_spec - The formatted specification that defines the service instance update.

UpdateServiceInstance, updateServiceInstance_templateMajorVersion - The major version of the service template to update.

UpdateServiceInstance, updateServiceInstance_templateMinorVersion - The minor version of the service template to update.

$sel:deploymentType:UpdateServiceInstance', updateServiceInstance_deploymentType - The deployment type. It defines the mode for updating a service instance, as follows:

[] NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

[] CURRENT_VERSION

In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment type.

[] MINOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

[] MAJOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.

UpdateServiceInstance, updateServiceInstance_name - The name of the service instance to update.

UpdateServiceInstance, updateServiceInstance_serviceName - The name of the service that the service instance belongs to.

Request Lenses

updateServiceInstance_spec :: Lens' UpdateServiceInstance (Maybe Text) Source #

The formatted specification that defines the service instance update.

updateServiceInstance_templateMajorVersion :: Lens' UpdateServiceInstance (Maybe Text) Source #

The major version of the service template to update.

updateServiceInstance_templateMinorVersion :: Lens' UpdateServiceInstance (Maybe Text) Source #

The minor version of the service template to update.

updateServiceInstance_deploymentType :: Lens' UpdateServiceInstance DeploymentUpdateType Source #

The deployment type. It defines the mode for updating a service instance, as follows:

[] NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

[] CURRENT_VERSION

In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment type.

[] MINOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

[] MAJOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.

updateServiceInstance_name :: Lens' UpdateServiceInstance Text Source #

The name of the service instance to update.

updateServiceInstance_serviceName :: Lens' UpdateServiceInstance Text Source #

The name of the service that the service instance belongs to.

Destructuring the Response

data UpdateServiceInstanceResponse Source #

See: newUpdateServiceInstanceResponse smart constructor.

Constructors

UpdateServiceInstanceResponse'
Fields httpStatus :: Int The response's http status code. serviceInstance :: ServiceInstance The service instance summary data that's returned by Proton.

Instances

Instances details

Generic UpdateServiceInstanceResponse Source #
Instance details Defined in Amazonka.Proton.UpdateServiceInstance Associated Types type Rep UpdateServiceInstanceResponse :: Type -> Type # Methods from :: UpdateServiceInstanceResponse -> Rep UpdateServiceInstanceResponse x # to :: Rep UpdateServiceInstanceResponse x -> UpdateServiceInstanceResponse #
Show UpdateServiceInstanceResponse Source #
Instance details Defined in Amazonka.Proton.UpdateServiceInstance Methods showsPrec :: Int -> UpdateServiceInstanceResponse -> ShowS # show :: UpdateServiceInstanceResponse -> String # showList :: [UpdateServiceInstanceResponse] -> ShowS #
NFData UpdateServiceInstanceResponse Source #
Instance details Defined in Amazonka.Proton.UpdateServiceInstance Methods rnf :: UpdateServiceInstanceResponse -> () #
Eq UpdateServiceInstanceResponse Source #
Instance details Defined in Amazonka.Proton.UpdateServiceInstance Methods (==) :: UpdateServiceInstanceResponse -> UpdateServiceInstanceResponse -> Bool # (/=) :: UpdateServiceInstanceResponse -> UpdateServiceInstanceResponse -> Bool #
type Rep UpdateServiceInstanceResponse Source #
Instance details Defined in Amazonka.Proton.UpdateServiceInstance type Rep UpdateServiceInstanceResponse = D1 ('MetaData "UpdateServiceInstanceResponse" "Amazonka.Proton.UpdateServiceInstance" "amazonka-proton-2.0-LlJ92rKPVfGGXHsLqGeI74" 'False) (C1 ('MetaCons "UpdateServiceInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "serviceInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServiceInstance)))

newUpdateServiceInstanceResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateServiceInstanceResponse'`
-> ServiceInstance	`$sel:serviceInstance:UpdateServiceInstanceResponse'`
-> UpdateServiceInstanceResponse

Create a value of UpdateServiceInstanceResponse 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:UpdateServiceInstanceResponse', updateServiceInstanceResponse_httpStatus - The response's http status code.

$sel:serviceInstance:UpdateServiceInstanceResponse', updateServiceInstanceResponse_serviceInstance - The service instance summary data that's returned by Proton.

Response Lenses

updateServiceInstanceResponse_httpStatus :: Lens' UpdateServiceInstanceResponse Int Source #

The response's http status code.

updateServiceInstanceResponse_serviceInstance :: Lens' UpdateServiceInstanceResponse ServiceInstance Source #

The service instance summary data that's returned by Proton.