Interface CreateServiceRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateServiceRequest.Builder,
,CreateServiceRequest> ProtonRequest.Builder
,SdkBuilder<CreateServiceRequest.Builder,
,CreateServiceRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateServiceRequest
-
Method Summary
Modifier and TypeMethodDescriptionbranchName
(String branchName) The name of the code repository branch that holds the code that's deployed in Proton.description
(String description) A description of the Proton service.The service name.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.repositoryConnectionArn
(String repositoryConnectionArn) The Amazon Resource Name (ARN) of the repository connection.repositoryId
(String repositoryId) The ID of the code repository.A link to a spec file that provides inputs as defined in the service template bundle schema file.tags
(Collection<Tag> tags) An optional list of metadata items that you can associate with the Proton service.tags
(Consumer<Tag.Builder>... tags) An optional list of metadata items that you can associate with the Proton service.An optional list of metadata items that you can associate with the Proton service.templateMajorVersion
(String templateMajorVersion) The major version of the service template that was used to create the service.templateMinorVersion
(String templateMinorVersion) The minor version of the service template that was used to create the service.templateName
(String templateName) The name of the service template that's used to create the service.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.proton.model.ProtonRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
branchName
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.
- Parameters:
branchName
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
A description of the Proton service.
- Parameters:
description
- A description of the Proton service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The service name.
- Parameters:
name
- The service name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
repositoryConnectionArn
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.
- Parameters:
repositoryConnectionArn
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
repositoryId
The ID of the code repository. Don't include this parameter if your service template doesn't include a service pipeline.
- Parameters:
repositoryId
- The ID of the code repository. Don't include this parameter if your service template doesn't include a service pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
spec
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.
- Parameters:
spec
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
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.
- Parameters:
tags
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
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.
- Parameters:
tags
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
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.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
templateMajorVersion
The major version of the service template that was used to create the service.
- Parameters:
templateMajorVersion
- The major version of the service template that was used to create the service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
templateMinorVersion
The minor version of the service template that was used to create the service.
- Parameters:
templateMinorVersion
- The minor version of the service template that was used to create the service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
templateName
The name of the service template that's used to create the service.
- Parameters:
templateName
- The name of the service template that's used to create the service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateServiceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateServiceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-