Interface CreateConfigurationTemplateRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateConfigurationTemplateRequest.Builder,
,CreateConfigurationTemplateRequest> ElasticBeanstalkRequest.Builder
,SdkBuilder<CreateConfigurationTemplateRequest.Builder,
,CreateConfigurationTemplateRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateConfigurationTemplateRequest
-
Method Summary
Modifier and TypeMethodDescriptionapplicationName
(String applicationName) The name of the Elastic Beanstalk application to associate with this configuration template.description
(String description) An optional description for this configuration.environmentId
(String environmentId) The ID of an environment whose settings you want to use to create the configuration template.optionSettings
(Collection<ConfigurationOptionSetting> optionSettings) Option values for the Elastic Beanstalk configuration, such as the instance type.optionSettings
(Consumer<ConfigurationOptionSetting.Builder>... optionSettings) Option values for the Elastic Beanstalk configuration, such as the instance type.optionSettings
(ConfigurationOptionSetting... optionSettings) Option values for the Elastic Beanstalk configuration, such as the instance type.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.platformArn
(String platformArn) The Amazon Resource Name (ARN) of the custom platform.solutionStackName
(String solutionStackName) The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses.sourceConfiguration
(Consumer<SourceConfiguration.Builder> sourceConfiguration) An Elastic Beanstalk configuration template to base this one on.sourceConfiguration
(SourceConfiguration sourceConfiguration) An Elastic Beanstalk configuration template to base this one on.tags
(Collection<Tag> tags) Specifies the tags applied to the configuration template.tags
(Consumer<Tag.Builder>... tags) Specifies the tags applied to the configuration template.Specifies the tags applied to the configuration template.templateName
(String templateName) The name of the configuration 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.elasticbeanstalk.model.ElasticBeanstalkRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
applicationName
The name of the Elastic Beanstalk application to associate with this configuration template.
- Parameters:
applicationName
- The name of the Elastic Beanstalk application to associate with this configuration template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
templateName
The name of the configuration template.
Constraint: This name must be unique per application.
- Parameters:
templateName
- The name of the configuration template.Constraint: This name must be unique per application.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
solutionStackName
The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example,
64bit Amazon Linux 2013.09 running Tomcat 7 Java 7
. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see Supported Platforms in the AWS Elastic Beanstalk Developer Guide.You must specify
SolutionStackName
if you don't specifyPlatformArn
,EnvironmentId
, orSourceConfiguration
.Use the
ListAvailableSolutionStacks
API to obtain a list of available solution stacks.- Parameters:
solutionStackName
- The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example,64bit Amazon Linux 2013.09 running Tomcat 7 Java 7
. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see Supported Platforms in the AWS Elastic Beanstalk Developer Guide.You must specify
SolutionStackName
if you don't specifyPlatformArn
,EnvironmentId
, orSourceConfiguration
.Use the
ListAvailableSolutionStacks
API to obtain a list of available solution stacks.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
platformArn
The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.
If you specify
PlatformArn
, then don't specifySolutionStackName
.- Parameters:
platformArn
- The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.If you specify
PlatformArn
, then don't specifySolutionStackName
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceConfiguration
CreateConfigurationTemplateRequest.Builder sourceConfiguration(SourceConfiguration sourceConfiguration) An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
Values specified in
OptionSettings
override any values obtained from theSourceConfiguration
.You must specify
SourceConfiguration
if you don't specifyPlatformArn
,EnvironmentId
, orSolutionStackName
.Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.
- Parameters:
sourceConfiguration
- An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.Values specified in
OptionSettings
override any values obtained from theSourceConfiguration
.You must specify
SourceConfiguration
if you don't specifyPlatformArn
,EnvironmentId
, orSolutionStackName
.Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceConfiguration
default CreateConfigurationTemplateRequest.Builder sourceConfiguration(Consumer<SourceConfiguration.Builder> sourceConfiguration) An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
Values specified in
OptionSettings
override any values obtained from theSourceConfiguration
.You must specify
SourceConfiguration
if you don't specifyPlatformArn
,EnvironmentId
, orSolutionStackName
.Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.
This is a convenience method that creates an instance of theSourceConfiguration.Builder
avoiding the need to create one manually viaSourceConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosourceConfiguration(SourceConfiguration)
.- Parameters:
sourceConfiguration
- a consumer that will call methods onSourceConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
environmentId
The ID of an environment whose settings you want to use to create the configuration template. You must specify
EnvironmentId
if you don't specifyPlatformArn
,SolutionStackName
, orSourceConfiguration
.- Parameters:
environmentId
- The ID of an environment whose settings you want to use to create the configuration template. You must specifyEnvironmentId
if you don't specifyPlatformArn
,SolutionStackName
, orSourceConfiguration
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
An optional description for this configuration.
- Parameters:
description
- An optional description for this configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
optionSettings
CreateConfigurationTemplateRequest.Builder optionSettings(Collection<ConfigurationOptionSetting> optionSettings) Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer Guide.
- Parameters:
optionSettings
- Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
optionSettings
CreateConfigurationTemplateRequest.Builder optionSettings(ConfigurationOptionSetting... optionSettings) Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer Guide.
- Parameters:
optionSettings
- Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
optionSettings
CreateConfigurationTemplateRequest.Builder optionSettings(Consumer<ConfigurationOptionSetting.Builder>... optionSettings) Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer Guide.
This is a convenience method that creates an instance of theConfigurationOptionSetting.Builder
avoiding the need to create one manually viaConfigurationOptionSetting.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooptionSettings(List<ConfigurationOptionSetting>)
.- Parameters:
optionSettings
- a consumer that will call methods onConfigurationOptionSetting.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
Specifies the tags applied to the configuration template.
- Parameters:
tags
- Specifies the tags applied to the configuration template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Specifies the tags applied to the configuration template.
- Parameters:
tags
- Specifies the tags applied to the configuration template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Specifies the tags applied to the configuration template.
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:
-
overrideConfiguration
CreateConfigurationTemplateRequest.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
CreateConfigurationTemplateRequest.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.
-