CreateComponentInput
¶
Source code in docs_src/capo_proton/types/create_component_input.py
client_token
instance-attribute
¶
client_token: NotRequired[ClientToken]
The client token for the created component.
description
instance-attribute
¶
description: NotRequired[Description]
An optional customer-provided description of the component.
environment_name
instance-attribute
¶
environment_name: NotRequired[ResourceName]
The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify serviceInstanceName and serviceName.
manifest
instance-attribute
¶
manifest: TemplateManifestContents
A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.
service_instance_name
instance-attribute
¶
service_instance_name: NotRequired[ResourceName]
The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.
service_name
instance-attribute
¶
service_name: NotRequired[ResourceName]
The name of the service that serviceInstanceName is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or 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 you attach the component to a service instance.
tags
instance-attribute
¶
tags: NotRequired[TagList]
An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide.
template_file
instance-attribute
¶
template_file: 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.