com.amazonaws.services.elasticbeanstalk.model

Class UpdateConfigurationTemplateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticbeanstalk.model.UpdateConfigurationTemplateRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class UpdateConfigurationTemplateRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the UpdateConfigurationTemplate operation.

Updates the specified configuration template to have the specified properties or configuration option values.

NOTE: If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

Related Topics

• DescribeConfigurationOptions

See Also:

AWSElasticBeanstalk.updateConfigurationTemplate(UpdateConfigurationTemplateRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
UpdateConfigurationTemplateRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getApplicationName() The name of the application associated with the configuration template to update.
String	getDescription() A new description for the configuration.
List<ConfigurationOptionSetting>	getOptionSettings() A list of configuration option settings to update with the new specified option value.
List<OptionSpecification>	getOptionsToRemove() A list of configuration options to remove from the configuration set.
String	getTemplateName() The name of the configuration template to update.
int	hashCode()
void	setApplicationName(String applicationName) The name of the application associated with the configuration template to update.
void	setDescription(String description) A new description for the configuration.
void	setOptionSettings(Collection<ConfigurationOptionSetting> optionSettings) A list of configuration option settings to update with the new specified option value.
void	setOptionsToRemove(Collection<OptionSpecification> optionsToRemove) A list of configuration options to remove from the configuration set.
void	setTemplateName(String templateName) The name of the configuration template to update.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateConfigurationTemplateRequest	withApplicationName(String applicationName) The name of the application associated with the configuration template to update.
UpdateConfigurationTemplateRequest	withDescription(String description) A new description for the configuration.
UpdateConfigurationTemplateRequest	withOptionSettings(Collection<ConfigurationOptionSetting> optionSettings) A list of configuration option settings to update with the new specified option value.
UpdateConfigurationTemplateRequest	withOptionSettings(ConfigurationOptionSetting... optionSettings) A list of configuration option settings to update with the new specified option value.
UpdateConfigurationTemplateRequest	withOptionsToRemove(Collection<OptionSpecification> optionsToRemove) A list of configuration options to remove from the configuration set.
UpdateConfigurationTemplateRequest	withOptionsToRemove(OptionSpecification... optionsToRemove) A list of configuration options to remove from the configuration set.
UpdateConfigurationTemplateRequest	withTemplateName(String templateName) The name of the configuration template to update.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateConfigurationTemplateRequest

public UpdateConfigurationTemplateRequest()

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

UpdateConfigurationTemplateRequest

public UpdateConfigurationTemplateRequest(String applicationName,
                                  String templateName)

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

Parameters:

applicationName - The name of the application associated with the configuration template to update.

If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

templateName - The name of the configuration template to update.

If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

Method Detail

getApplicationName

public String getApplicationName()

The name of the application associated with the configuration template to update.

If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

Constraints:
Length: 1 - 100

Returns:

The name of the application associated with the configuration template to update.

If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

setApplicationName

public void setApplicationName(String applicationName)

The name of the application associated with the configuration template to update.

If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

Constraints:
Length: 1 - 100

Parameters:

applicationName - The name of the application associated with the configuration template to update.

If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

withApplicationName

public UpdateConfigurationTemplateRequest withApplicationName(String applicationName)

The name of the application associated with the configuration template to update.

If no application is found with this name, UpdateConfigurationTemplate 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 associated with the configuration template to update.

If no application is found with this name, UpdateConfigurationTemplate 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 to update.

If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

Constraints:
Length: 1 - 100

Returns:

The name of the configuration template to update.

If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

setTemplateName

public void setTemplateName(String templateName)

The name of the configuration template to update.

If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

Constraints:
Length: 1 - 100

Parameters:

templateName - The name of the configuration template to update.

If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

withTemplateName

public UpdateConfigurationTemplateRequest withTemplateName(String templateName)

The name of the configuration template to update.

If no configuration template is found with this name, UpdateConfigurationTemplate 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 to update.

If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

Returns:

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

getDescription

public String getDescription()

A new description for the configuration.

Constraints:
Length: 0 - 200

Returns:

A new description for the configuration.

setDescription

public void setDescription(String description)

A new description for the configuration.

Constraints:
Length: 0 - 200

Parameters:

description - A new description for the configuration.

withDescription

public UpdateConfigurationTemplateRequest withDescription(String description)

A new description for the configuration.

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

Constraints:
Length: 0 - 200

Parameters:

description - A new description for the configuration.

Returns:

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

getOptionSettings

public List<ConfigurationOptionSetting> getOptionSettings()

A list of configuration option settings to update with the new specified option value.

Returns:

A list of configuration option settings to update with the new specified option value.

setOptionSettings

public void setOptionSettings(Collection<ConfigurationOptionSetting> optionSettings)

A list of configuration option settings to update with the new specified option value.

Parameters:

optionSettings - A list of configuration option settings to update with the new specified option value.

withOptionSettings

public UpdateConfigurationTemplateRequest withOptionSettings(ConfigurationOptionSetting... optionSettings)

A list of configuration option settings to update with the new specified option value.

NOTE: This method appends the values to the existing list (if any). Use setOptionSettings(java.util.Collection) or withOptionSettings(java.util.Collection) if you want to override the existing values.

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

Parameters:

optionSettings - A list of configuration option settings to update with the new specified option value.

Returns:

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

withOptionSettings

public UpdateConfigurationTemplateRequest withOptionSettings(Collection<ConfigurationOptionSetting> optionSettings)

A list of configuration option settings to update with the new specified option value.

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

Parameters:

optionSettings - A list of configuration option settings to update with the new specified option value.

Returns:

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

getOptionsToRemove

public List<OptionSpecification> getOptionsToRemove()

A list of configuration options to remove from the configuration set.

Constraint: You can remove only UserDefined configuration options.

Returns:

A list of configuration options to remove from the configuration set.

Constraint: You can remove only UserDefined configuration options.

setOptionsToRemove

public void setOptionsToRemove(Collection<OptionSpecification> optionsToRemove)

A list of configuration options to remove from the configuration set.

Constraint: You can remove only UserDefined configuration options.

Parameters:

optionsToRemove - A list of configuration options to remove from the configuration set.

Constraint: You can remove only UserDefined configuration options.

withOptionsToRemove

public UpdateConfigurationTemplateRequest withOptionsToRemove(OptionSpecification... optionsToRemove)

A list of configuration options to remove from the configuration set.

Constraint: You can remove only UserDefined configuration options.

NOTE: This method appends the values to the existing list (if any). Use setOptionsToRemove(java.util.Collection) or withOptionsToRemove(java.util.Collection) if you want to override the existing values.

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

Parameters:

optionsToRemove - A list of configuration options to remove from the configuration set.

Constraint: You can remove only UserDefined configuration options.

Returns:

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

withOptionsToRemove

public UpdateConfigurationTemplateRequest withOptionsToRemove(Collection<OptionSpecification> optionsToRemove)

A list of configuration options to remove from the configuration set.

Constraint: You can remove only UserDefined configuration options.

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

Parameters:

optionsToRemove - A list of configuration options to remove from the configuration set.

Constraint: You can remove only UserDefined configuration options.

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

clone

public UpdateConfigurationTemplateRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()