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

Amazonka.Proton.UpdateEnvironment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Update an environment.

If the environment is associated with an environment account connection, don't update or include the protonServiceRoleArn parameter to update or connect to an environment account connection.

You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.

If the environment isn't associated with an environment account connection, don't update or include the environmentAccountConnectionId parameter to update or connect to an environment account connection.

You can update either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. You can’t update both.

There are four modes for updating an environment as described in the following. The deploymentType field defines the mode.

[] NONE

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

[] CURRENT_VERSION

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

[] MINOR_VERSION

In this mode, the environment 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 environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that's higher than the major version in use and a minor version (optional).

Synopsis

data UpdateEnvironment = UpdateEnvironment' {
- protonServiceRoleArn :: Maybe Text
- environmentAccountConnectionId :: Maybe Text
- spec :: Maybe (Sensitive Text)
- templateMinorVersion :: Maybe Text
- description :: Maybe (Sensitive Text)
- templateMajorVersion :: Maybe Text
- deploymentType :: DeploymentUpdateType
- name :: Text
}
newUpdateEnvironment :: DeploymentUpdateType -> Text -> UpdateEnvironment
updateEnvironment_protonServiceRoleArn :: Lens' UpdateEnvironment (Maybe Text)
updateEnvironment_environmentAccountConnectionId :: Lens' UpdateEnvironment (Maybe Text)
updateEnvironment_spec :: Lens' UpdateEnvironment (Maybe Text)
updateEnvironment_templateMinorVersion :: Lens' UpdateEnvironment (Maybe Text)
updateEnvironment_description :: Lens' UpdateEnvironment (Maybe Text)
updateEnvironment_templateMajorVersion :: Lens' UpdateEnvironment (Maybe Text)
updateEnvironment_deploymentType :: Lens' UpdateEnvironment DeploymentUpdateType
updateEnvironment_name :: Lens' UpdateEnvironment Text
data UpdateEnvironmentResponse = UpdateEnvironmentResponse' {
- httpStatus :: Int
- environment :: Environment
}
newUpdateEnvironmentResponse :: Int -> Environment -> UpdateEnvironmentResponse
updateEnvironmentResponse_httpStatus :: Lens' UpdateEnvironmentResponse Int
updateEnvironmentResponse_environment :: Lens' UpdateEnvironmentResponse Environment

Creating a Request

data UpdateEnvironment Source #

See: newUpdateEnvironment smart constructor.

Constructors

UpdateEnvironment'

Fields

protonServiceRoleArn :: Maybe Text
The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make API calls to other services your behalf.
environmentAccountConnectionId :: Maybe Text
The ID of the environment account connection.
You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.
spec :: Maybe (Sensitive Text)
The formatted specification that defines the update.
templateMinorVersion :: Maybe Text
The ID of the minor version of the environment to update.
description :: Maybe (Sensitive Text)
A description of the environment update.
templateMajorVersion :: Maybe Text
The ID of the major version of the environment to update.
deploymentType :: DeploymentUpdateType
There are four modes for updating an environment as described in the following. The deploymentType field defines the mode.
[] NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
[] CURRENT_VERSION
In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type.
[] MINOR_VERSION
In this mode, the environment 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 environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).
name :: Text
The name of the environment to update.

Instances

Instances details

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

newUpdateEnvironment Source #

Arguments

:: DeploymentUpdateType	`$sel:deploymentType:UpdateEnvironment'`
-> Text	`$sel:name:UpdateEnvironment'`
-> UpdateEnvironment

Create a value of UpdateEnvironment 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:protonServiceRoleArn:UpdateEnvironment', updateEnvironment_protonServiceRoleArn - The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make API calls to other services your behalf.

$sel:environmentAccountConnectionId:UpdateEnvironment', updateEnvironment_environmentAccountConnectionId - The ID of the environment account connection.

You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.

$sel:spec:UpdateEnvironment', updateEnvironment_spec - The formatted specification that defines the update.

$sel:templateMinorVersion:UpdateEnvironment', updateEnvironment_templateMinorVersion - The ID of the minor version of the environment to update.

$sel:description:UpdateEnvironment', updateEnvironment_description - A description of the environment update.

$sel:templateMajorVersion:UpdateEnvironment', updateEnvironment_templateMajorVersion - The ID of the major version of the environment to update.

$sel:deploymentType:UpdateEnvironment', updateEnvironment_deploymentType - There are four modes for updating an environment as described in the following. The deploymentType field defines the mode.

[] NONE

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

[] CURRENT_VERSION

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

[] MINOR_VERSION

In this mode, the environment 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 environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).

$sel:name:UpdateEnvironment', updateEnvironment_name - The name of the environment to update.

Request Lenses

updateEnvironment_protonServiceRoleArn :: Lens' UpdateEnvironment (Maybe Text) Source #

The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make API calls to other services your behalf.

updateEnvironment_environmentAccountConnectionId :: Lens' UpdateEnvironment (Maybe Text) Source #

The ID of the environment account connection.

You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.

updateEnvironment_spec :: Lens' UpdateEnvironment (Maybe Text) Source #

The formatted specification that defines the update.

updateEnvironment_templateMinorVersion :: Lens' UpdateEnvironment (Maybe Text) Source #

The ID of the minor version of the environment to update.

updateEnvironment_description :: Lens' UpdateEnvironment (Maybe Text) Source #

A description of the environment update.

updateEnvironment_templateMajorVersion :: Lens' UpdateEnvironment (Maybe Text) Source #

The ID of the major version of the environment to update.

updateEnvironment_deploymentType :: Lens' UpdateEnvironment DeploymentUpdateType Source #

There are four modes for updating an environment as described in the following. The deploymentType field defines the mode.

[] NONE

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

[] CURRENT_VERSION

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

[] MINOR_VERSION

In this mode, the environment 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 environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).

updateEnvironment_name :: Lens' UpdateEnvironment Text Source #

The name of the environment to update.

Destructuring the Response

data UpdateEnvironmentResponse Source #

See: newUpdateEnvironmentResponse smart constructor.

Constructors

UpdateEnvironmentResponse'
Fields httpStatus :: Int The response's http status code. environment :: Environment The environment detail data that's returned by AWS Proton.

Instances

Instances details

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

newUpdateEnvironmentResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateEnvironmentResponse'`
-> Environment	`$sel:environment:UpdateEnvironmentResponse'`
-> UpdateEnvironmentResponse

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

$sel:environment:UpdateEnvironmentResponse', updateEnvironmentResponse_environment - The environment detail data that's returned by AWS Proton.

Response Lenses

updateEnvironmentResponse_httpStatus :: Lens' UpdateEnvironmentResponse Int Source #

The response's http status code.

updateEnvironmentResponse_environment :: Lens' UpdateEnvironmentResponse Environment Source #

The environment detail data that's returned by AWS Proton.