Struct aws_sdk_proton::client::fluent_builders::UpdateComponent

pub struct UpdateComponent { /* private fields */ }

Fluent builder constructing a request to UpdateComponent.

Update a component.

There are a few modes for updating a component. The deploymentType field defines the mode.

You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is IN_PROGRESS.

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

Implementations

impl UpdateComponent

pub async fn customize(
    self
) -> Result<CustomizableOperation<UpdateComponent, AwsResponseRetryClassifier>, SdkError<UpdateComponentError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<UpdateComponentOutput, SdkError<UpdateComponentError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn name(self, input: impl Into<String>) -> Self

The name of the component to update.

pub fn set_name(self, input: Option<String>) -> Self

The name of the component to update.

pub fn deployment_type(self, input: ComponentDeploymentUpdateType) -> Self

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.

pub fn set_deployment_type(
    self,
    input: Option<ComponentDeploymentUpdateType>
) -> Self

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.

pub fn description(self, input: impl Into<String>) -> Self

An optional customer-provided description of the component.

pub fn set_description(self, input: Option<String>) -> Self

An optional customer-provided description of the component.

pub fn service_name(self, input: impl Into<String>) -> Self

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.

pub fn set_service_name(self, input: Option<String>) -> Self

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.

pub fn service_instance_name(self, input: impl Into<String>) -> Self

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.

pub fn set_service_instance_name(self, input: Option<String>) -> Self

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.

pub fn service_spec(self, input: impl Into<String>) -> Self

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.

pub fn set_service_spec(self, input: Option<String>) -> Self

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.

pub fn template_file(self, input: impl Into<String>) -> Self

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.

pub fn set_template_file(self, input: Option<String>) -> Self

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.

Trait Implementations

impl Clone for UpdateComponent

fn clone(&self) -> UpdateComponent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateComponent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.