Skip to content

CreateComponentInput

Source code in docs_src/capo_proton/types/create_component_input.py
class CreateComponentInput(TypedDict, closed=True):
    name: "capo_proton.types.resource_name.ResourceName"
    """<p>The customer-provided name of the component.</p>"""
    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.ResourceName"]
    """<p>The name of the service that <code>serviceInstanceName</code> is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both <code>serviceInstanceName</code> and <code>serviceName</code> or neither of them.</p>"""
    service_instance_name: NotRequired["capo_proton.types.resource_name.ResourceName"]
    """<p>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 <code>serviceInstanceName</code> and <code>serviceName</code> or neither of them.</p>"""
    environment_name: NotRequired["capo_proton.types.resource_name.ResourceName"]
    """<p>The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify <code>serviceInstanceName</code> and <code>serviceName</code>.</p>"""
    template_file: "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>"""
    manifest: "capo_proton.types.template_manifest_contents.TemplateManifestContents"
    """<p>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.</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 you attach the component to a service instance.</p>"""
    tags: NotRequired["capo_proton.types.tag_list.TagList"]
    """<p>An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the <i>Proton User Guide</i>.</p>"""
    client_token: NotRequired["capo_proton.types.client_token.ClientToken"]
    """<p>The client token for the created component.</p>"""

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

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.

name instance-attribute

The customer-provided name of the component.

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.