com.amazonaws.services.elasticbeanstalk.model

Class DescribeConfigurationSettingsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationSettingsRequest

All Implemented Interfaces:

Serializable

public class DescribeConfigurationSettingsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribeConfigurationSettings operation.

Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.

When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.

Related Topics

• DeleteEnvironmentConfiguration

See Also:

AWSElasticBeanstalk.describeConfigurationSettings(DescribeConfigurationSettingsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeConfigurationSettingsRequest() Default constructor for a new DescribeConfigurationSettingsRequest object.
DescribeConfigurationSettingsRequest(String applicationName) Constructs a new DescribeConfigurationSettingsRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getApplicationName() The application for the environment or configuration template.
String	getEnvironmentName() The name of the environment to describe.
String	getTemplateName() The name of the configuration template to describe.
int	hashCode()
void	setApplicationName(String applicationName) The application for the environment or configuration template.
void	setEnvironmentName(String environmentName) The name of the environment to describe.
void	setTemplateName(String templateName) The name of the configuration template to describe.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeConfigurationSettingsRequest	withApplicationName(String applicationName) The application for the environment or configuration template.
DescribeConfigurationSettingsRequest	withEnvironmentName(String environmentName) The name of the environment to describe.
DescribeConfigurationSettingsRequest	withTemplateName(String templateName) The name of the configuration template to describe.

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

DescribeConfigurationSettingsRequest

public DescribeConfigurationSettingsRequest()

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

DescribeConfigurationSettingsRequest

public DescribeConfigurationSettingsRequest(String applicationName)

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

Parameters:

applicationName - The application for the environment or configuration template.

Method Detail

getApplicationName

public String getApplicationName()

The application for the environment or configuration template.

Constraints:
Length: 1 - 100

Returns:

The application for the environment or configuration template.

setApplicationName

public void setApplicationName(String applicationName)

The application for the environment or configuration template.

Constraints:
Length: 1 - 100

Parameters:

applicationName - The application for the environment or configuration template.

withApplicationName

public DescribeConfigurationSettingsRequest withApplicationName(String applicationName)

The application for the environment or configuration template.

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

Constraints:
Length: 1 - 100

Parameters:

applicationName - The application for the environment or configuration template.

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

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

Constraints:
Length: 1 - 100

Returns:

The name of the configuration template to describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

setTemplateName

public void setTemplateName(String templateName)

The name of the configuration template to describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

Constraints:
Length: 1 - 100

Parameters:

templateName - The name of the configuration template to describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

withTemplateName

public DescribeConfigurationSettingsRequest withTemplateName(String templateName)

The name of the configuration template to describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter 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 describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

Returns:

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

getEnvironmentName

public String getEnvironmentName()

The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Constraints:
Length: 4 - 23

Returns:

The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

setEnvironmentName

public void setEnvironmentName(String environmentName)

The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Constraints:
Length: 4 - 23

Parameters:

environmentName - The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

withEnvironmentName

public DescribeConfigurationSettingsRequest withEnvironmentName(String environmentName)

The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

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

Constraints:
Length: 4 - 23

Parameters:

environmentName - The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

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