Skip to content

CreateServiceInput

Source code in docs_src/capo_proton/types/create_service_input.py
class CreateServiceInput(TypedDict, closed=True):
    name: "capo_proton.types.resource_name.ResourceName"
    """<p>The service name.</p>"""
    description: NotRequired["capo_proton.types.description.Description"]
    """<p>A description of the Proton service.</p>"""
    template_name: "capo_proton.types.resource_name.ResourceName"
    """<p>The name of the service template that's used to create the service.</p>"""
    template_major_version: (
        "capo_proton.types.template_version_part.TemplateVersionPart"
    )
    """<p>The major version of the service template that was used to create the service.</p>"""
    template_minor_version: NotRequired[
        "capo_proton.types.template_version_part.TemplateVersionPart"
    ]
    """<p>The minor version of the service template that was used to create the service.</p>"""
    spec: "capo_proton.types.spec_contents.SpecContents"
    """<p>A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. <i>Don’t</i> include pipeline inputs in the spec if your service template <i>doesn’t</i> include a service pipeline. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-create-svc.html">Create a service</a> in the <i>Proton User Guide</i>.</p>"""
    repository_connection_arn: NotRequired["capo_proton.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the repository connection. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html#setting-up-vcontrol">Setting up an AWS CodeStar connection</a> in the <i>Proton User Guide</i>. <i>Don't</i> include this parameter if your service template <i>doesn't</i> include a service pipeline.</p>"""
    repository_id: NotRequired["capo_proton.types.repository_id.RepositoryId"]
    """<p>The ID of the code repository. <i>Don't</i> include this parameter if your service template <i>doesn't</i> include a service pipeline.</p>"""
    branch_name: NotRequired["capo_proton.types.git_branch_name.GitBranchName"]
    """<p>The name of the code repository branch that holds the code that's deployed in Proton. <i>Don't</i> include this parameter if your service template <i>doesn't</i> include a service pipeline.</p>"""
    tags: NotRequired["capo_proton.types.tag_list.TagList"]
    """<p>An optional list of metadata items that you can associate with the Proton service. 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>"""

branch_name instance-attribute

branch_name: NotRequired[GitBranchName]

The name of the code repository branch that holds the code that's deployed in Proton. Don't include this parameter if your service template doesn't include a service pipeline.

description instance-attribute

description: NotRequired[Description]

A description of the Proton service.

name instance-attribute

The service name.

repository_connection_arn instance-attribute

repository_connection_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide. Don't include this parameter if your service template doesn't include a service pipeline.

repository_id instance-attribute

repository_id: NotRequired[RepositoryId]

The ID of the code repository. Don't include this parameter if your service template doesn't include a service pipeline.

spec instance-attribute

A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see Create a service 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. A tag is a key-value pair.

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

template_major_version instance-attribute

template_major_version: TemplateVersionPart

The major version of the service template that was used to create the service.

template_minor_version instance-attribute

template_minor_version: NotRequired[TemplateVersionPart]

The minor version of the service template that was used to create the service.

template_name instance-attribute

template_name: ResourceName

The name of the service template that's used to create the service.