Package software.amazon.awssdk.services.proton.model

Class UpdateEnvironmentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.proton.model.ProtonRequest

software.amazon.awssdk.services.proton.model.UpdateEnvironmentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateEnvironmentRequest
extends ProtonRequest
implements ToCopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateEnvironmentRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateEnvironmentRequest.Builder	builder()
String	codebuildRoleArn()	The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
String	componentRoleArn()	The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment.
DeploymentUpdateType	deploymentType()	There are four modes for updating an environment.
String	deploymentTypeAsString()	There are four modes for updating an environment.
String	description()	A description of the environment update.
String	environmentAccountConnectionId()	The ID of the environment account connection.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the environment to update.
String	protonServiceRoleArn()	The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.
RepositoryBranchInput	provisioningRepository()	The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateEnvironmentRequest.Builder>	serializableBuilderClass()
String	spec()	The formatted specification that defines the update.
String	templateMajorVersion()	The major version of the environment to update.
String	templateMinorVersion()	The minor version of the environment to update.
UpdateEnvironmentRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

codebuildRoleArn

public final String codebuildRoleArn()

The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

Returns:

The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

componentRoleArn

public final String componentRoleArn()

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.

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

Returns:

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.

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

deploymentType

public final DeploymentUpdateType deploymentType()

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 major or minor 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).

If the service returns an enum value that is not available in the current SDK version, deploymentType will return DeploymentUpdateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

Returns:

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 major or minor 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).

See Also:

DeploymentUpdateType

deploymentTypeAsString

public final String deploymentTypeAsString()

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 major or minor 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).

If the service returns an enum value that is not available in the current SDK version, deploymentType will return DeploymentUpdateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

Returns:

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 major or minor 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).

See Also:

DeploymentUpdateType

description

public final String description()

A description of the environment update.

Returns:

A description of the environment update.

environmentAccountConnectionId

public final String 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.

Returns:

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.

name

public final String name()

The name of the environment to update.

Returns:

The name of the environment to update.

protonServiceRoleArn

public final String protonServiceRoleArn()

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

Returns:

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

provisioningRepository

public final RepositoryBranchInput provisioningRepository()

The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

Returns:

The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

spec

public final String spec()

The formatted specification that defines the update.

Returns:

The formatted specification that defines the update.

templateMajorVersion

public final String templateMajorVersion()

The major version of the environment to update.

Returns:

The major version of the environment to update.

templateMinorVersion

public final String templateMinorVersion()

The minor version of the environment to update.

Returns:

The minor version of the environment to update.

toBuilder

public UpdateEnvironmentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

Specified by:

toBuilder in class ProtonRequest

builder

public static UpdateEnvironmentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateEnvironmentRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo