Skip to content

UpdateComponentInput

Source code in docs_src/capo_proton/types/update_component_input.py
class UpdateComponentInput(TypedDict, closed=True):
    name: "capo_proton.types.resource_name.ResourceName"
    """<p>The name of the component to update.</p>"""
    deployment_type: "capo_proton.types.component_deployment_update_type.ComponentDeploymentUpdateType"
    """<p>The deployment type. It defines the mode for updating a component, as follows:</p> <dl> <dt/> <dd> <p> <code>NONE</code> </p> <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated. You can only specify <code>description</code> in this mode.</p> </dd> <dt/> <dd> <p> <code>CURRENT_VERSION</code> </p> <p>In this mode, the component is deployed and updated with the new <code>serviceSpec</code>, <code>templateSource</code>, and/or <code>type</code> that you provide. Only requested parameters are updated.</p> </dd> </dl>"""
    description: NotRequired["capo_proton.types.description.Description"]
    """<p>An optional customer-provided description of the component.</p>"""
    service_name: NotRequired[
        "capo_proton.types.resource_name_or_empty.ResourceNameOrEmpty"
    ]
    """<p>The name of the service that <code>serviceInstanceName</code> 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 <code>serviceInstanceName</code> and <code>serviceName</code> or for neither of them.</p>"""
    service_instance_name: NotRequired[
        "capo_proton.types.resource_name_or_empty.ResourceNameOrEmpty"
    ]
    """<p>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 <code>serviceInstanceName</code> and <code>serviceName</code> or for neither of them.</p>"""
    service_spec: NotRequired["capo_proton.types.spec_contents.SpecContents"]
    """<p>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.</p>"""
    template_file: NotRequired[
        "capo_proton.types.template_file_contents.TemplateFileContents"
    ]
    """<p>A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.</p> <note> <p>Components support a single IaC file, even if you use Terraform as your template language.</p> </note>"""
    client_token: NotRequired["capo_proton.types.client_token.ClientToken"]
    """<p>The client token for the updated component.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

The client token for the updated component.

deployment_type instance-attribute

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.

description instance-attribute

description: NotRequired[Description]

An optional customer-provided description of the component.

name instance-attribute

The name of the component to update.

service_instance_name instance-attribute

service_instance_name: NotRequired[ResourceNameOrEmpty]

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.

service_name instance-attribute

service_name: NotRequired[ResourceNameOrEmpty]

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.

service_spec instance-attribute

service_spec: NotRequired[SpecContents]

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.

template_file instance-attribute

template_file: NotRequired[TemplateFileContents]

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.