com.amazonaws.services.elasticbeanstalk.model

Class CreateConfigurationTemplateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticbeanstalk.model.CreateConfigurationTemplateRequest

All Implemented Interfaces:

Serializable

public class CreateConfigurationTemplateRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the CreateConfigurationTemplate operation.

Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.

Related Topics

• DescribeConfigurationOptions
• DescribeConfigurationSettings
• ListAvailableSolutionStacks

See Also:

AWSElasticBeanstalk.createConfigurationTemplate(CreateConfigurationTemplateRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateConfigurationTemplateRequest() Default constructor for a new CreateConfigurationTemplateRequest object.
CreateConfigurationTemplateRequest(String applicationName, String templateName) Constructs a new CreateConfigurationTemplateRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getApplicationName() The name of the application to associate with this configuration template.
String	getDescription() Describes this configuration.
String	getEnvironmentId() The ID of the environment used with this configuration template.
List<ConfigurationOptionSetting>	getOptionSettings() If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value.
String	getSolutionStackName() The name of the solution stack used by this configuration.
SourceConfiguration	getSourceConfiguration() If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
String	getTemplateName() The name of the configuration template.
int	hashCode()
void	setApplicationName(String applicationName) The name of the application to associate with this configuration template.
void	setDescription(String description) Describes this configuration.
void	setEnvironmentId(String environmentId) The ID of the environment used with this configuration template.
void	setOptionSettings(Collection<ConfigurationOptionSetting> optionSettings) If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value.
void	setSolutionStackName(String solutionStackName) The name of the solution stack used by this configuration.
void	setSourceConfiguration(SourceConfiguration sourceConfiguration) If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
void	setTemplateName(String templateName) The name of the configuration template.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateConfigurationTemplateRequest	withApplicationName(String applicationName) The name of the application to associate with this configuration template.
CreateConfigurationTemplateRequest	withDescription(String description) Describes this configuration.
CreateConfigurationTemplateRequest	withEnvironmentId(String environmentId) The ID of the environment used with this configuration template.
CreateConfigurationTemplateRequest	withOptionSettings(Collection<ConfigurationOptionSetting> optionSettings) If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value.
CreateConfigurationTemplateRequest	withOptionSettings(ConfigurationOptionSetting... optionSettings) If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value.
CreateConfigurationTemplateRequest	withSolutionStackName(String solutionStackName) The name of the solution stack used by this configuration.
CreateConfigurationTemplateRequest	withSourceConfiguration(SourceConfiguration sourceConfiguration) If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
CreateConfigurationTemplateRequest	withTemplateName(String templateName) The name of the configuration template.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateConfigurationTemplateRequest

public CreateConfigurationTemplateRequest()

Default constructor for a new CreateConfigurationTemplateRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

CreateConfigurationTemplateRequest

public CreateConfigurationTemplateRequest(String applicationName,
                                  String templateName)

Constructs a new CreateConfigurationTemplateRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

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.

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.

Method Detail

getApplicationName

public String getApplicationName()

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.

Constraints:
Length: 1 - 100

Returns:

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.

setApplicationName

public void setApplicationName(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.

Constraints:
Length: 1 - 100

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.

withApplicationName

public CreateConfigurationTemplateRequest withApplicationName(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.

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

Constraints:
Length: 1 - 100

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:

A reference to this updated object so that method calls can be chained together.

getTemplateName

public String getTemplateName()

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.

Constraints:
Length: 1 - 100

Returns:

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.

setTemplateName

public void setTemplateName(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.

Constraints:
Length: 1 - 100

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.

withTemplateName

public CreateConfigurationTemplateRequest withTemplateName(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.

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

Constraints:
Length: 1 - 100

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:

A reference to this updated object so that method calls can be chained together.

getSolutionStackName

public String getSolutionStackName()

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.

Constraints:
Length: 0 - 100

Returns:

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.

setSolutionStackName

public void setSolutionStackName(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.

Constraints:
Length: 0 - 100

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.

withSolutionStackName

public CreateConfigurationTemplateRequest withSolutionStackName(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.

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

Constraints:
Length: 0 - 100

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:

A reference to this updated object so that method calls can be chained together.

getSourceConfiguration

public SourceConfiguration getSourceConfiguration()

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:

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.

setSourceConfiguration

public void setSourceConfiguration(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.

withSourceConfiguration

public CreateConfigurationTemplateRequest withSourceConfiguration(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.

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

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:

A reference to this updated object so that method calls can be chained together.

getEnvironmentId

public String getEnvironmentId()

The ID of the environment used with this configuration template.

Returns:

The ID of the environment used with this configuration template.

setEnvironmentId

public void setEnvironmentId(String environmentId)

The ID of the environment used with this configuration template.

Parameters:

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

withEnvironmentId

public CreateConfigurationTemplateRequest withEnvironmentId(String environmentId)

The ID of the environment used with this configuration template.

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getDescription

public String getDescription()

Describes this configuration.

Constraints:
Length: 0 - 200

Returns:

Describes this configuration.

setDescription

public void setDescription(String description)

Describes this configuration.

Constraints:
Length: 0 - 200

Parameters:

description - Describes this configuration.

withDescription

public CreateConfigurationTemplateRequest withDescription(String description)

Describes this configuration.

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

Constraints:
Length: 0 - 200

Parameters:

description - Describes this configuration.

Returns:

A reference to this updated object so that method calls can be chained together.

getOptionSettings

public List<ConfigurationOptionSetting> getOptionSettings()

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:

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.

setOptionSettings

public void setOptionSettings(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.

withOptionSettings

public CreateConfigurationTemplateRequest withOptionSettings(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.

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

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:

A reference to this updated object so that method calls can be chained together.

withOptionSettings

public CreateConfigurationTemplateRequest withOptionSettings(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.

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

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:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object