aws_sdk_proton/client/create_service.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`CreateService`](crate::operation::create_service::builders::CreateServiceFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`name(impl Into<String>)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::set_name):<br>required: **true**<br><p>The service name.</p><br>
7 /// - [`description(impl Into<String>)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::set_description):<br>required: **false**<br><p>A description of the Proton service.</p><br>
8 /// - [`template_name(impl Into<String>)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::template_name) / [`set_template_name(Option<String>)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::set_template_name):<br>required: **true**<br><p>The name of the service template that's used to create the service.</p><br>
9 /// - [`template_major_version(impl Into<String>)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::template_major_version) / [`set_template_major_version(Option<String>)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::set_template_major_version):<br>required: **true**<br><p>The major version of the service template that was used to create the service.</p><br>
10 /// - [`template_minor_version(impl Into<String>)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::template_minor_version) / [`set_template_minor_version(Option<String>)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::set_template_minor_version):<br>required: **false**<br><p>The minor version of the service template that was used to create the service.</p><br>
11 /// - [`spec(impl Into<String>)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::spec) / [`set_spec(Option<String>)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::set_spec):<br>required: **true**<br><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><br>
12 /// - [`repository_connection_arn(impl Into<String>)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::repository_connection_arn) / [`set_repository_connection_arn(Option<String>)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::set_repository_connection_arn):<br>required: **false**<br><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><br>
13 /// - [`repository_id(impl Into<String>)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::repository_id) / [`set_repository_id(Option<String>)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::set_repository_id):<br>required: **false**<br><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><br>
14 /// - [`branch_name(impl Into<String>)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::branch_name) / [`set_branch_name(Option<String>)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::set_branch_name):<br>required: **false**<br><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><br>
15 /// - [`tags(Tag)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_service::builders::CreateServiceFluentBuilder::set_tags):<br>required: **false**<br><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><br>
16 /// - On success, responds with [`CreateServiceOutput`](crate::operation::create_service::CreateServiceOutput) with field(s):
17 /// - [`service(Option<Service>)`](crate::operation::create_service::CreateServiceOutput::service): <p>The service detail data that's returned by Proton.</p>
18 /// - On failure, responds with [`SdkError<CreateServiceError>`](crate::operation::create_service::CreateServiceError)
19 pub fn create_service(&self) -> crate::operation::create_service::builders::CreateServiceFluentBuilder {
20 crate::operation::create_service::builders::CreateServiceFluentBuilder::new(self.handle.clone())
21 }
22}