/AWS1/CL_PRN=>UPDATECOMPONENT()

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

Method Signature

IMPORTING

Required arguments:

IV_NAME TYPE /AWS1/PRNRESOURCENAME /AWS1/PRNRESOURCENAME

The name of the component to update.

IV_DEPLOYMENTTYPE TYPE /AWS1/PRNCOMPONENTDEPLOYMENT00 /AWS1/PRNCOMPONENTDEPLOYMENT00

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.

Optional arguments:

IV_DESCRIPTION TYPE /AWS1/PRNDESCRIPTION /AWS1/PRNDESCRIPTION

An optional customer-provided description of the component.

IV_SERVICENAME TYPE /AWS1/PRNRESOURCENAMEOREMPTY /AWS1/PRNRESOURCENAMEOREMPTY

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.

IV_SERVICEINSTANCENAME TYPE /AWS1/PRNRESOURCENAMEOREMPTY /AWS1/PRNRESOURCENAMEOREMPTY

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.

IV_SERVICESPEC TYPE /AWS1/PRNSPECCONTENTS /AWS1/PRNSPECCONTENTS

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.

IV_TEMPLATEFILE TYPE /AWS1/PRNTEMPLATEFILECONTENTS /AWS1/PRNTEMPLATEFILECONTENTS

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.

IV_CLIENTTOKEN TYPE /AWS1/PRNCLIENTTOKEN /AWS1/PRNCLIENTTOKEN

The client token for the updated component.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_PRNUPDCOMPONENTOUTPUT /AWS1/CL_PRNUPDCOMPONENTOUTPUT