com.amazonaws.services.elasticbeanstalk.model

Class CreateConfigurationTemplateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticbeanstalk.model.CreateConfigurationTemplateRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateConfigurationTemplateRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Request to create a configuration template.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CreateConfigurationTemplateRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getApplicationName() The name of the Elastic Beanstalk application to associate with this configuration template.
String	getDescription() An optional description for this configuration.
String	getEnvironmentId() The ID of an environment whose settings you want to use to create the configuration template.
List<ConfigurationOptionSetting>	getOptionSettings() Option values for the Elastic Beanstalk configuration, such as the instance type.
String	getPlatformArn() The Amazon Resource Name (ARN) of the custom platform.
String	getSolutionStackName() The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses.
SourceConfiguration	getSourceConfiguration() An Elastic Beanstalk configuration template to base this one on.
List<Tag>	getTags() Specifies the tags applied to the configuration template.
String	getTemplateName() The name of the configuration template.
int	hashCode()
void	setApplicationName(String applicationName) The name of the Elastic Beanstalk application to associate with this configuration template.
void	setDescription(String description) An optional description for this configuration.
void	setEnvironmentId(String environmentId) The ID of an environment whose settings you want to use to create the configuration template.
void	setOptionSettings(Collection<ConfigurationOptionSetting> optionSettings) Option values for the Elastic Beanstalk configuration, such as the instance type.
void	setPlatformArn(String platformArn) The Amazon Resource Name (ARN) of the custom platform.
void	setSolutionStackName(String solutionStackName) The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses.
void	setSourceConfiguration(SourceConfiguration sourceConfiguration) An Elastic Beanstalk configuration template to base this one on.
void	setTags(Collection<Tag> tags) Specifies the tags applied to the configuration template.
void	setTemplateName(String templateName) The name of the configuration template.
String	toString() Returns a string representation of this object.
CreateConfigurationTemplateRequest	withApplicationName(String applicationName) The name of the Elastic Beanstalk application to associate with this configuration template.
CreateConfigurationTemplateRequest	withDescription(String description) An optional description for this configuration.
CreateConfigurationTemplateRequest	withEnvironmentId(String environmentId) The ID of an environment whose settings you want to use to create the configuration template.
CreateConfigurationTemplateRequest	withOptionSettings(Collection<ConfigurationOptionSetting> optionSettings) Option values for the Elastic Beanstalk configuration, such as the instance type.
CreateConfigurationTemplateRequest	withOptionSettings(ConfigurationOptionSetting... optionSettings) Option values for the Elastic Beanstalk configuration, such as the instance type.
CreateConfigurationTemplateRequest	withPlatformArn(String platformArn) The Amazon Resource Name (ARN) of the custom platform.
CreateConfigurationTemplateRequest	withSolutionStackName(String solutionStackName) The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses.
CreateConfigurationTemplateRequest	withSourceConfiguration(SourceConfiguration sourceConfiguration) An Elastic Beanstalk configuration template to base this one on.
CreateConfigurationTemplateRequest	withTags(Collection<Tag> tags) Specifies the tags applied to the configuration template.
CreateConfigurationTemplateRequest	withTags(Tag... tags) Specifies the tags applied to the configuration template.
CreateConfigurationTemplateRequest	withTemplateName(String templateName) The name of the configuration template.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateConfigurationTemplateRequest

public CreateConfigurationTemplateRequest()

Default constructor for CreateConfigurationTemplateRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the 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 Elastic Beanstalk application to associate with this configuration template.

templateName - The name of the configuration template.

Constraint: This name must be unique per application.

Method Detail

setApplicationName

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

getApplicationName

public String getApplicationName()

The name of the Elastic Beanstalk application to associate with this configuration template.

Returns:

The name of the Elastic Beanstalk application to associate with this configuration template.

withApplicationName

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

setTemplateName

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

getTemplateName

public String getTemplateName()

The name of the configuration template.

Constraint: This name must be unique per application.

Returns:

The name of the configuration template.

Constraint: This name must be unique per application.

withTemplateName

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

setSolutionStackName

public void setSolutionStackName(String 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 specify PlatformArn, EnvironmentId, or SourceConfiguration.

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 specify PlatformArn, EnvironmentId, or SourceConfiguration.

Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.

getSolutionStackName

public String getSolutionStackName()

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 specify PlatformArn, EnvironmentId, or SourceConfiguration.

Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.

Returns:

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 specify PlatformArn, EnvironmentId, or SourceConfiguration.

Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.

withSolutionStackName

public CreateConfigurationTemplateRequest withSolutionStackName(String 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 specify PlatformArn, EnvironmentId, or SourceConfiguration.

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 specify PlatformArn, EnvironmentId, or SourceConfiguration.

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.

setPlatformArn

public void setPlatformArn(String 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 specify SolutionStackName.

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 specify SolutionStackName.

getPlatformArn

public String getPlatformArn()

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 specify SolutionStackName.

Returns:

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 specify SolutionStackName.

withPlatformArn

public CreateConfigurationTemplateRequest withPlatformArn(String 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 specify SolutionStackName.

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 specify SolutionStackName.

Returns:

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

setSourceConfiguration

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

You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.

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 the SourceConfiguration.

You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.

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.

getSourceConfiguration

public SourceConfiguration getSourceConfiguration()

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 the SourceConfiguration.

You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.

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:

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 the SourceConfiguration.

You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.

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.

withSourceConfiguration

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

You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.

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 the SourceConfiguration.

You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.

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.

setEnvironmentId

public void setEnvironmentId(String 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 specify PlatformArn, SolutionStackName, or SourceConfiguration.

Parameters:

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 specify PlatformArn, SolutionStackName, or SourceConfiguration.

getEnvironmentId

public String getEnvironmentId()

The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration.

Returns:

The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration.

withEnvironmentId

public CreateConfigurationTemplateRequest withEnvironmentId(String 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 specify PlatformArn, SolutionStackName, or SourceConfiguration.

Parameters:

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 specify PlatformArn, SolutionStackName, or SourceConfiguration.

Returns:

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

setDescription

public void setDescription(String description)

An optional description for this configuration.

Parameters:

description - An optional description for this configuration.

getDescription

public String getDescription()

An optional description for this configuration.

Returns:

An optional description for this configuration.

withDescription

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

getOptionSettings

public List<ConfigurationOptionSetting> getOptionSettings()

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:

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.

setOptionSettings

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

withOptionSettings

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

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.

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.

withOptionSettings

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

getTags

public List<Tag> getTags()

Specifies the tags applied to the configuration template.

Returns:

Specifies the tags applied to the configuration template.

setTags

public void setTags(Collection<Tag> tags)

Specifies the tags applied to the configuration template.

Parameters:

tags - Specifies the tags applied to the configuration template.

withTags

public CreateConfigurationTemplateRequest withTags(Tag... tags)

Specifies the tags applied to the configuration template.

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

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.

withTags

public CreateConfigurationTemplateRequest withTags(Collection<Tag> 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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateConfigurationTemplateRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()