com.amazonaws.services.proton.model

Class UpdateEnvironmentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.proton.model.UpdateEnvironmentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateEnvironmentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateEnvironmentRequest()

Method Summary

Modifier and Type	Method and Description
UpdateEnvironmentRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCodebuildRoleArn() The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
String	getComponentRoleArn() The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment.
String	getDeploymentType() There are four modes for updating an environment.
String	getDescription() A description of the environment update.
String	getEnvironmentAccountConnectionId() The ID of the environment account connection.
String	getName() The name of the environment to update.
String	getProtonServiceRoleArn() The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.
RepositoryBranchInput	getProvisioningRepository() The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning.
String	getSpec() The formatted specification that defines the update.
String	getTemplateMajorVersion() The major version of the environment to update.
String	getTemplateMinorVersion() The minor version of the environment to update.
int	hashCode()
void	setCodebuildRoleArn(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.
void	setComponentRoleArn(String componentRoleArn) The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment.
void	setDeploymentType(String deploymentType) There are four modes for updating an environment.
void	setDescription(String description) A description of the environment update.
void	setEnvironmentAccountConnectionId(String environmentAccountConnectionId) The ID of the environment account connection.
void	setName(String name) The name of the environment to update.
void	setProtonServiceRoleArn(String protonServiceRoleArn) The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.
void	setProvisioningRepository(RepositoryBranchInput provisioningRepository) The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning.
void	setSpec(String spec) The formatted specification that defines the update.
void	setTemplateMajorVersion(String templateMajorVersion) The major version of the environment to update.
void	setTemplateMinorVersion(String templateMinorVersion) The minor version of the environment to update.
String	toString() Returns a string representation of this object.
UpdateEnvironmentRequest	withCodebuildRoleArn(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.
UpdateEnvironmentRequest	withComponentRoleArn(String componentRoleArn) The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment.
UpdateEnvironmentRequest	withDeploymentType(DeploymentUpdateType deploymentType) There are four modes for updating an environment.
UpdateEnvironmentRequest	withDeploymentType(String deploymentType) There are four modes for updating an environment.
UpdateEnvironmentRequest	withDescription(String description) A description of the environment update.
UpdateEnvironmentRequest	withEnvironmentAccountConnectionId(String environmentAccountConnectionId) The ID of the environment account connection.
UpdateEnvironmentRequest	withName(String name) The name of the environment to update.
UpdateEnvironmentRequest	withProtonServiceRoleArn(String protonServiceRoleArn) The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.
UpdateEnvironmentRequest	withProvisioningRepository(RepositoryBranchInput provisioningRepository) The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning.
UpdateEnvironmentRequest	withSpec(String spec) The formatted specification that defines the update.
UpdateEnvironmentRequest	withTemplateMajorVersion(String templateMajorVersion) The major version of the environment to update.
UpdateEnvironmentRequest	withTemplateMinorVersion(String templateMinorVersion) The minor version of the environment to update.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateEnvironmentRequest

public UpdateEnvironmentRequest()

Method Detail

setCodebuildRoleArn

public void setCodebuildRoleArn(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.

Parameters:

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

getCodebuildRoleArn

public String getCodebuildRoleArn()

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.

withCodebuildRoleArn

public UpdateEnvironmentRequest withCodebuildRoleArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setComponentRoleArn

public void setComponentRoleArn(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.

Parameters:

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.

getComponentRoleArn

public String getComponentRoleArn()

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.

withComponentRoleArn

public UpdateEnvironmentRequest withComponentRoleArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setDeploymentType

public void setDeploymentType(String 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).

Parameters:

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

See Also:

DeploymentUpdateType

getDeploymentType

public String getDeploymentType()

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

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

withDeploymentType

public UpdateEnvironmentRequest withDeploymentType(String 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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DeploymentUpdateType

withDeploymentType

public UpdateEnvironmentRequest withDeploymentType(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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DeploymentUpdateType

setDescription

public void setDescription(String description)

A description of the environment update.

Parameters:

description - A description of the environment update.

getDescription

public String getDescription()

A description of the environment update.

Returns:

A description of the environment update.

withDescription

public UpdateEnvironmentRequest withDescription(String description)

A description of the environment update.

Parameters:

description - A description of the environment update.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEnvironmentAccountConnectionId

public void setEnvironmentAccountConnectionId(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.

Parameters:

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.

getEnvironmentAccountConnectionId

public String getEnvironmentAccountConnectionId()

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.

withEnvironmentAccountConnectionId

public UpdateEnvironmentRequest withEnvironmentAccountConnectionId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setName

public void setName(String name)

The name of the environment to update.

Parameters:

name - The name of the environment to update.

getName

public String getName()

The name of the environment to update.

Returns:

The name of the environment to update.

withName

public UpdateEnvironmentRequest withName(String name)

The name of the environment to update.

Parameters:

name - The name of the environment to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

setProtonServiceRoleArn

public void setProtonServiceRoleArn(String protonServiceRoleArn)

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

Parameters:

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

getProtonServiceRoleArn

public String getProtonServiceRoleArn()

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.

withProtonServiceRoleArn

public UpdateEnvironmentRequest withProtonServiceRoleArn(String protonServiceRoleArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setProvisioningRepository

public void setProvisioningRepository(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.

Parameters:

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.

getProvisioningRepository

public RepositoryBranchInput getProvisioningRepository()

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.

withProvisioningRepository

public UpdateEnvironmentRequest withProvisioningRepository(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setSpec

public void setSpec(String spec)

The formatted specification that defines the update.

Parameters:

spec - The formatted specification that defines the update.

getSpec

public String getSpec()

The formatted specification that defines the update.

Returns:

The formatted specification that defines the update.

withSpec

public UpdateEnvironmentRequest withSpec(String spec)

The formatted specification that defines the update.

Parameters:

spec - The formatted specification that defines the update.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTemplateMajorVersion

public void setTemplateMajorVersion(String templateMajorVersion)

The major version of the environment to update.

Parameters:

templateMajorVersion - The major version of the environment to update.

getTemplateMajorVersion

public String getTemplateMajorVersion()

The major version of the environment to update.

Returns:

The major version of the environment to update.

withTemplateMajorVersion

public UpdateEnvironmentRequest withTemplateMajorVersion(String templateMajorVersion)

The major version of the environment to update.

Parameters:

templateMajorVersion - The major version of the environment to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTemplateMinorVersion

public void setTemplateMinorVersion(String templateMinorVersion)

The minor version of the environment to update.

Parameters:

templateMinorVersion - The minor version of the environment to update.

getTemplateMinorVersion

public String getTemplateMinorVersion()

The minor version of the environment to update.

Returns:

The minor version of the environment to update.

withTemplateMinorVersion

public UpdateEnvironmentRequest withTemplateMinorVersion(String templateMinorVersion)

The minor version of the environment to update.

Parameters:

templateMinorVersion - The minor version of the environment to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateEnvironmentRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()