Interface CreateServiceTemplateVersionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateServiceTemplateVersionRequest.Builder,CreateServiceTemplateVersionRequest>, ProtonRequest.Builder, SdkBuilder<CreateServiceTemplateVersionRequest.Builder,CreateServiceTemplateVersionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateServiceTemplateVersionRequest

@Mutable
@NotThreadSafe
public static interface CreateServiceTemplateVersionRequest.Builder
extends ProtonRequest.Builder, SdkPojo, CopyableBuilder<CreateServiceTemplateVersionRequest.Builder,CreateServiceTemplateVersionRequest>

Method Summary

Modifier and Type	Method	Description
CreateServiceTemplateVersionRequest.Builder	clientToken(String 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.
CreateServiceTemplateVersionRequest.Builder	compatibleEnvironmentTemplates(Collection<CompatibleEnvironmentTemplateInput> compatibleEnvironmentTemplates)	An array of environment template objects that are compatible with the new service template version.
CreateServiceTemplateVersionRequest.Builder	compatibleEnvironmentTemplates(Consumer<CompatibleEnvironmentTemplateInput.Builder>... compatibleEnvironmentTemplates)	An array of environment template objects that are compatible with the new service template version.
CreateServiceTemplateVersionRequest.Builder	compatibleEnvironmentTemplates(CompatibleEnvironmentTemplateInput... compatibleEnvironmentTemplates)	An array of environment template objects that are compatible with the new service template version.
CreateServiceTemplateVersionRequest.Builder	description(String description)	A description of the new version of a service template.
CreateServiceTemplateVersionRequest.Builder	majorVersion(String majorVersion)	To create a new minor version of the service template, include a major Version.
CreateServiceTemplateVersionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateServiceTemplateVersionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateServiceTemplateVersionRequest.Builder	source(Consumer<TemplateVersionSourceInput.Builder> source)	An object that includes the template bundle S3 bucket path and name for the new version of a service template.
CreateServiceTemplateVersionRequest.Builder	source(TemplateVersionSourceInput source)	An object that includes the template bundle S3 bucket path and name for the new version of a service template.
CreateServiceTemplateVersionRequest.Builder	supportedComponentSources(Collection<ServiceTemplateSupportedComponentSourceType> supportedComponentSources)	An array of supported component sources.
CreateServiceTemplateVersionRequest.Builder	supportedComponentSources(ServiceTemplateSupportedComponentSourceType... supportedComponentSources)	An array of supported component sources.
CreateServiceTemplateVersionRequest.Builder	supportedComponentSourcesWithStrings(String... supportedComponentSources)	An array of supported component sources.
CreateServiceTemplateVersionRequest.Builder	supportedComponentSourcesWithStrings(Collection<String> supportedComponentSources)	An array of supported component sources.
CreateServiceTemplateVersionRequest.Builder	tags(Collection<Tag> tags)	An optional list of metadata items that you can associate with the Proton service template version.
CreateServiceTemplateVersionRequest.Builder	tags(Consumer<Tag.Builder>... tags)	An optional list of metadata items that you can associate with the Proton service template version.
CreateServiceTemplateVersionRequest.Builder	tags(Tag... tags)	An optional list of metadata items that you can associate with the Proton service template version.
CreateServiceTemplateVersionRequest.Builder	templateName(String templateName)	The name of the service template.

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

clientToken

CreateServiceTemplateVersionRequest.Builder clientToken(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

compatibleEnvironmentTemplates

CreateServiceTemplateVersionRequest.Builder compatibleEnvironmentTemplates(Collection<CompatibleEnvironmentTemplateInput> compatibleEnvironmentTemplates)

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.

Parameters:

compatibleEnvironmentTemplates - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

compatibleEnvironmentTemplates

CreateServiceTemplateVersionRequest.Builder compatibleEnvironmentTemplates(CompatibleEnvironmentTemplateInput... compatibleEnvironmentTemplates)

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.

Parameters:

compatibleEnvironmentTemplates - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

compatibleEnvironmentTemplates

CreateServiceTemplateVersionRequest.Builder compatibleEnvironmentTemplates(Consumer<CompatibleEnvironmentTemplateInput.Builder>... compatibleEnvironmentTemplates)

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.

This is a convenience method that creates an instance of the CompatibleEnvironmentTemplateInput.Builder avoiding the need to create one manually via CompatibleEnvironmentTemplateInput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to compatibleEnvironmentTemplates(List<CompatibleEnvironmentTemplateInput>).

Parameters:

compatibleEnvironmentTemplates - a consumer that will call methods on CompatibleEnvironmentTemplateInput.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• compatibleEnvironmentTemplates(java.util.Collection<CompatibleEnvironmentTemplateInput>)

description

CreateServiceTemplateVersionRequest.Builder description(String description)

A description of the new version of a service template.

Parameters:

description - A description of the new version of a service template.

Returns:

Returns a reference to this object so that method calls can be chained together.

majorVersion

CreateServiceTemplateVersionRequest.Builder majorVersion(String majorVersion)

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.

Parameters:

majorVersion - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

source

CreateServiceTemplateVersionRequest.Builder source(TemplateVersionSourceInput source)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

source

default CreateServiceTemplateVersionRequest.Builder source(Consumer<TemplateVersionSourceInput.Builder> source)

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

This is a convenience method that creates an instance of the TemplateVersionSourceInput.Builder avoiding the need to create one manually via TemplateVersionSourceInput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to source(TemplateVersionSourceInput).

Parameters:

source - a consumer that will call methods on TemplateVersionSourceInput.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• source(TemplateVersionSourceInput)

supportedComponentSourcesWithStrings

CreateServiceTemplateVersionRequest.Builder supportedComponentSourcesWithStrings(Collection<String> supportedComponentSources)

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.

Parameters:

supportedComponentSources - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedComponentSourcesWithStrings

CreateServiceTemplateVersionRequest.Builder supportedComponentSourcesWithStrings(String... supportedComponentSources)

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.

Parameters:

supportedComponentSources - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedComponentSources

CreateServiceTemplateVersionRequest.Builder supportedComponentSources(Collection<ServiceTemplateSupportedComponentSourceType> supportedComponentSources)

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.

Parameters:

supportedComponentSources - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedComponentSources

CreateServiceTemplateVersionRequest.Builder supportedComponentSources(ServiceTemplateSupportedComponentSourceType... supportedComponentSources)

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.

Parameters:

supportedComponentSources - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateServiceTemplateVersionRequest.Builder tags(Collection<Tag> tags)

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.

Parameters:

tags - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateServiceTemplateVersionRequest.Builder tags(Tag... tags)

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.

Parameters:

tags - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateServiceTemplateVersionRequest.Builder tags(Consumer<Tag.Builder>... tags)

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.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• tags(java.util.Collection<Tag>)

templateName

CreateServiceTemplateVersionRequest.Builder templateName(String templateName)

The name of the service template.

Parameters:

templateName - The name of the service template.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateServiceTemplateVersionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateServiceTemplateVersionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.