Skip to content

CreateServiceTemplateVersionInput

Source code in docs_src/capo_proton/types/create_service_template_version_input.py
class CreateServiceTemplateVersionInput(TypedDict, closed=True):
    client_token: NotRequired["capo_proton.types.client_token.ClientToken"]
    """<p>When included, if two identical requests are made with the same client token, Proton returns the service template version that the first request created.</p>"""
    template_name: "capo_proton.types.resource_name.ResourceName"
    """<p>The name of the service template.</p>"""
    description: NotRequired["capo_proton.types.description.Description"]
    """<p>A description of the new version of a service template.</p>"""
    major_version: NotRequired[
        "capo_proton.types.template_version_part.TemplateVersionPart"
    ]
    """<p>To create a new minor version of the service template, include a <code>major Version</code>.</p> <p>To create a new major and minor version of the service template, <i>exclude</i> <code>major Version</code>.</p>"""
    source: "capo_proton.types.template_version_source_input.TemplateVersionSourceInput"
    """<p>An object that includes the template bundle S3 bucket path and name for the new version of a service template.</p>"""
    compatible_environment_templates: "capo_proton.types.compatible_environment_template_input_list.CompatibleEnvironmentTemplateInputList"
    """<p>An array of environment template objects that are compatible with the new service template version. A service instance based on this service template version can run in environments based on compatible templates.</p>"""
    tags: NotRequired["capo_proton.types.tag_list.TagList"]
    """<p>An optional list of metadata items that you can associate with the Proton service template version. 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>"""
    supported_component_sources: NotRequired[
        "capo_proton.types.service_template_supported_component_source_input_list.ServiceTemplateSupportedComponentSourceInputList"
    ]
    """<p>An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.</p> <p>For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

When included, if two identical requests are made with the same client token, Proton returns the service template version that the first request created.

compatible_environment_templates instance-attribute

compatible_environment_templates: CompatibleEnvironmentTemplateInputList

An array of environment template objects that are compatible with the new service template version. A service instance based on this service template version can run in environments based on compatible templates.

description instance-attribute

description: NotRequired[Description]

A description of the new version of a service template.

major_version instance-attribute

major_version: NotRequired[TemplateVersionPart]

To create a new minor version of the service template, include a major Version.

To create a new major and minor version of the service template, exclude major Version.

source instance-attribute

An object that includes the template bundle S3 bucket path and name for the new version of a service template.

supported_component_sources instance-attribute

supported_component_sources: NotRequired[
    ServiceTemplateSupportedComponentSourceInputList
]

An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

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

tags instance-attribute

tags: NotRequired[TagList]

An optional list of metadata items that you can associate with the Proton service template version. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton User Guide.

template_name instance-attribute

template_name: ResourceName

The name of the service template.