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

Interface UpdateServiceInstanceRequest.Builder

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

  • Method Details

    • clientToken

      UpdateServiceInstanceRequest.Builder clientToken(String clientToken)

      The client token of the service instance to update.

      Parameters:
      clientToken - The client token of the service instance to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentType

      UpdateServiceInstanceRequest.Builder deploymentType(String deploymentType)

      The deployment type. It defines the mode for updating a service instance, as follows:

      NONE

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

      CURRENT_VERSION

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

      Parameters:
      deploymentType - The deployment type. It defines the mode for updating a service instance, as follows:

      NONE

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

      CURRENT_VERSION

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

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

    • deploymentType

      UpdateServiceInstanceRequest.Builder deploymentType(DeploymentUpdateType deploymentType)

      The deployment type. It defines the mode for updating a service instance, as follows:

      NONE

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

      CURRENT_VERSION

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

      Parameters:
      deploymentType - The deployment type. It defines the mode for updating a service instance, as follows:

      NONE

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

      CURRENT_VERSION

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

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

    • name

      UpdateServiceInstanceRequest.Builder name(String name)

      The name of the service instance to update.

      Parameters:
      name - The name of the service instance to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceName

      UpdateServiceInstanceRequest.Builder serviceName(String serviceName)

      The name of the service that the service instance belongs to.

      Parameters:
      serviceName - The name of the service that the service instance belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • spec

      UpdateServiceInstanceRequest.Builder spec(String spec)

      The formatted specification that defines the service instance update.

      Parameters:
      spec - The formatted specification that defines the service instance update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • templateMajorVersion

      UpdateServiceInstanceRequest.Builder templateMajorVersion(String templateMajorVersion)

      The major version of the service template to update.

      Parameters:
      templateMajorVersion - The major version of the service template to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • templateMinorVersion

      UpdateServiceInstanceRequest.Builder templateMinorVersion(String templateMinorVersion)

      The minor version of the service template to update.

      Parameters:
      templateMinorVersion - The minor version of the service template to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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