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

Interface UpdateEnvironmentRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>, ProtonRequest.Builder, SdkBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateEnvironmentRequest
public static interface UpdateEnvironmentRequest.Builder extends ProtonRequest.Builder, SdkPojo, CopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

  • Method Details

    • codebuildRoleArn

      UpdateEnvironmentRequest.Builder codebuildRoleArn(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.

    • componentRoleArn

      UpdateEnvironmentRequest.Builder componentRoleArn(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.

    • deploymentType

      UpdateEnvironmentRequest.Builder deploymentType(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:

    • deploymentType

      UpdateEnvironmentRequest.Builder deploymentType(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:

    • description

      UpdateEnvironmentRequest.Builder description(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.

    • environmentAccountConnectionId

      UpdateEnvironmentRequest.Builder environmentAccountConnectionId(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.

    • name

      UpdateEnvironmentRequest.Builder name(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.

    • protonServiceRoleArn

      UpdateEnvironmentRequest.Builder protonServiceRoleArn(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.

    • provisioningRepository

      UpdateEnvironmentRequest.Builder provisioningRepository(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.

    • provisioningRepository

      default UpdateEnvironmentRequest.Builder provisioningRepository(Consumer<RepositoryBranchInput.Builder> 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.

      This is a convenience method that creates an instance of the RepositoryBranchInput.Builder avoiding the need to create one manually via RepositoryBranchInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to provisioningRepository(RepositoryBranchInput).

      Parameters:
      provisioningRepository - a consumer that will call methods on RepositoryBranchInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • spec

      UpdateEnvironmentRequest.Builder spec(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.

    • templateMajorVersion

      UpdateEnvironmentRequest.Builder templateMajorVersion(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.

    • templateMinorVersion

      UpdateEnvironmentRequest.Builder templateMinorVersion(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.

    • overrideConfiguration

      UpdateEnvironmentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateEnvironmentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.