AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Update an environment.
If the environment is associated with an environment account connection, don't
update or include the protonServiceRoleArn and provisioningRepository
parameter to update or connect to an environment account connection.
You can only update to a new environment account connection if that connection was created in the same environment account that the current environment account connection was created in. The account connection must also be associated with the current environment.
If the environment isn't associated with an environment account connection,
don't update or include the environmentAccountConnectionId parameter.
You can't update or connect the environment to an environment account connection
if it isn't already associated with an environment connection.
You can update either the environmentAccountConnectionId or protonServiceRoleArn
parameter and value. You can’t update both.
If the environment was configured for Amazon Web Services-managed provisioning, omit
the provisioningRepository parameter.
If the environment was configured for self-managed provisioning, specify the provisioningRepository
parameter and omit the protonServiceRoleArn and environmentAccountConnectionId
parameters.
For more information, see Environments and Provisioning methods in the Proton User Guide.
There are four modes for updating an environment. 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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginUpdateEnvironment and EndUpdateEnvironment.
Namespace: Amazon.Proton
Assembly: AWSSDK.Proton.dll
Version: 3.x.y.z
public abstract Task<UpdateEnvironmentResponse> UpdateEnvironmentAsync( UpdateEnvironmentRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the UpdateEnvironment service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| AccessDeniedException | There isn't sufficient access for performing this action. |
| ConflictException | The request couldn't be made due to a conflicting operation or resource. |
| InternalServerException | The request failed to register with the service. |
| ResourceNotFoundException | The requested resource wasn't found. |
| ThrottlingException | The request was denied due to request throttling. |
| ValidationException | The input is invalid or an out-of-range value was supplied for the input parameter. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer