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

Interface UpdateComponentRequest.Builder

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

  • Method Details

    • clientToken

      UpdateComponentRequest.Builder clientToken(String clientToken)

      The client token for the updated component.

      Parameters:
      clientToken - The client token for the updated component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentType

      UpdateComponentRequest.Builder deploymentType(String deploymentType)

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

      NONE

      In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify description in this mode.

      CURRENT_VERSION

      In this mode, the component is deployed and updated with the new serviceSpec, templateSource, and/or type that you provide. Only requested parameters are updated.

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

      NONE

      In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify description in this mode.

      CURRENT_VERSION

      In this mode, the component is deployed and updated with the new serviceSpec, templateSource, and/or type that you provide. Only requested parameters are updated.

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

    • deploymentType

      UpdateComponentRequest.Builder deploymentType(ComponentDeploymentUpdateType deploymentType)

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

      NONE

      In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify description in this mode.

      CURRENT_VERSION

      In this mode, the component is deployed and updated with the new serviceSpec, templateSource, and/or type that you provide. Only requested parameters are updated.

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

      NONE

      In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify description in this mode.

      CURRENT_VERSION

      In this mode, the component is deployed and updated with the new serviceSpec, templateSource, and/or type that you provide. Only requested parameters are updated.

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

    • description

      UpdateComponentRequest.Builder description(String description)

      An optional customer-provided description of the component.

      Parameters:
      description - An optional customer-provided description of the component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      UpdateComponentRequest.Builder name(String name)

      The name of the component to update.

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

    • serviceInstanceName

      UpdateComponentRequest.Builder serviceInstanceName(String serviceInstanceName)

      The name of the service instance that you want to attach this component to. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

      Parameters:
      serviceInstanceName - The name of the service instance that you want to attach this component to. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceName

      UpdateComponentRequest.Builder serviceName(String serviceName)

      The name of the service that serviceInstanceName is associated with. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

      Parameters:
      serviceName - The name of the service that serviceInstanceName is associated with. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceSpec

      UpdateComponentRequest.Builder serviceSpec(String serviceSpec)

      The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.

      Parameters:
      serviceSpec - The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • templateFile

      UpdateComponentRequest.Builder templateFile(String templateFile)

      A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

      Components support a single IaC file, even if you use Terraform as your template language.

      Parameters:
      templateFile - A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

      Components support a single IaC file, even if you use Terraform as your template language.

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

    • overrideConfiguration

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

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