software.amazon.awssdk.services.elasticbeanstalk.model

Interface CreateConfigurationTemplateRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateConfigurationTemplateRequest.Builder,CreateConfigurationTemplateRequest>, ElasticBeanstalkRequest.Builder, SdkBuilder<CreateConfigurationTemplateRequest.Builder,CreateConfigurationTemplateRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateConfigurationTemplateRequest

public static interface CreateConfigurationTemplateRequest.Builder
extends ElasticBeanstalkRequest.Builder, SdkPojo, CopyableBuilder<CreateConfigurationTemplateRequest.Builder,CreateConfigurationTemplateRequest>

Method Summary

Modifier and Type	Method and Description
CreateConfigurationTemplateRequest.Builder	applicationName(String applicationName) The name of the application to associate with this configuration template.
CreateConfigurationTemplateRequest.Builder	description(String description) Describes this configuration.
CreateConfigurationTemplateRequest.Builder	environmentId(String environmentId) The ID of the environment used with this configuration template.
CreateConfigurationTemplateRequest.Builder	optionSettings(Collection<ConfigurationOptionSetting> optionSettings) If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value.
CreateConfigurationTemplateRequest.Builder	optionSettings(ConfigurationOptionSetting... optionSettings) If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value.
CreateConfigurationTemplateRequest.Builder	optionSettings(Consumer<ConfigurationOptionSetting.Builder>... optionSettings) If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value.
CreateConfigurationTemplateRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateConfigurationTemplateRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateConfigurationTemplateRequest.Builder	platformArn(String platformArn) The ARN of the custom platform.
CreateConfigurationTemplateRequest.Builder	solutionStackName(String solutionStackName) The name of the solution stack used by this configuration.
default CreateConfigurationTemplateRequest.Builder	sourceConfiguration(Consumer<SourceConfiguration.Builder> sourceConfiguration) If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
CreateConfigurationTemplateRequest.Builder	sourceConfiguration(SourceConfiguration sourceConfiguration) If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
CreateConfigurationTemplateRequest.Builder	templateName(String templateName) The name of the configuration template.

Methods inherited from interface software.amazon.awssdk.services.elasticbeanstalk.model.ElasticBeanstalkRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

applicationName

CreateConfigurationTemplateRequest.Builder applicationName(String applicationName)

The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Parameters:

applicationName - The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Returns:

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

templateName

CreateConfigurationTemplateRequest.Builder templateName(String templateName)

The name of the configuration template.

Constraint: This name must be unique per application.

Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Parameters:

templateName - The name of the configuration template.

Constraint: This name must be unique per application.

Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Returns:

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

solutionStackName

CreateConfigurationTemplateRequest.Builder solutionStackName(String solutionStackName)

The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values.

Use ListAvailableSolutionStacks to obtain a list of available solution stacks.

A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an InvalidParameterValue error.

If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.

Parameters:

solutionStackName - The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values.

Use ListAvailableSolutionStacks to obtain a list of available solution stacks.

A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an InvalidParameterValue error.

If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.

Returns:

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

platformArn

CreateConfigurationTemplateRequest.Builder platformArn(String platformArn)

The ARN of the custom platform.

Parameters:

platformArn - The ARN of the custom platform.

Returns:

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

sourceConfiguration

CreateConfigurationTemplateRequest.Builder sourceConfiguration(SourceConfiguration sourceConfiguration)

If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.

Values specified in the OptionSettings parameter of this call overrides any values obtained from the SourceConfiguration.

If no configuration template is found, returns an InvalidParameterValue error.

Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an InvalidParameterCombination error.

Parameters:

sourceConfiguration - If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.

Values specified in the OptionSettings parameter of this call overrides any values obtained from the SourceConfiguration.

If no configuration template is found, returns an InvalidParameterValue error.

Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an InvalidParameterCombination error.

Returns:

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

sourceConfiguration

default CreateConfigurationTemplateRequest.Builder sourceConfiguration(Consumer<SourceConfiguration.Builder> sourceConfiguration)

If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.

Values specified in the OptionSettings parameter of this call overrides any values obtained from the SourceConfiguration.

If no configuration template is found, returns an InvalidParameterValue error.

Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an InvalidParameterCombination error.

This is a convenience that creates an instance of the SourceConfiguration.Builder avoiding the need to create one manually via SourceConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceConfiguration(SourceConfiguration).

Parameters:

sourceConfiguration - a consumer that will call methods on SourceConfiguration.Builder

Returns:

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

See Also:

sourceConfiguration(SourceConfiguration)

environmentId

CreateConfigurationTemplateRequest.Builder environmentId(String environmentId)

The ID of the environment used with this configuration template.

Parameters:

environmentId - The ID of the environment used with this configuration template.

Returns:

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

description

CreateConfigurationTemplateRequest.Builder description(String description)

Describes this configuration.

Parameters:

description - Describes this configuration.

Returns:

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

optionSettings

CreateConfigurationTemplateRequest.Builder optionSettings(Collection<ConfigurationOptionSetting> optionSettings)

If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.

Parameters:

optionSettings - If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.

Returns:

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

optionSettings

CreateConfigurationTemplateRequest.Builder optionSettings(ConfigurationOptionSetting... optionSettings)

If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.

Parameters:

optionSettings - If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.

Returns:

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

optionSettings

CreateConfigurationTemplateRequest.Builder optionSettings(Consumer<ConfigurationOptionSetting.Builder>... optionSettings)

If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #optionSettings(List).

Parameters:

optionSettings - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#optionSettings(List)

overrideConfiguration

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

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