Class CreateConfigurationTemplateRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.elasticbeanstalk.model.CreateConfigurationTemplateRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class CreateConfigurationTemplateRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Request to create a configuration template.

See Also:
  • Constructor Details

    • 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 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 Details

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

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

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

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

      Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

      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.

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

      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.

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

      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:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      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.

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

      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.

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

      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:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

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

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

      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:
      Returns a reference to this object so that method calls can be chained together.
    • 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.
    • 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.
    • withEnvironmentId

      public CreateConfigurationTemplateRequest withEnvironmentId(String environmentId)

      The ID of the environment used with this configuration template.

      Parameters:
      environmentId - The ID of the environment used with this configuration template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDescription

      public void setDescription(String description)

      Describes this configuration.

      Parameters:
      description - Describes this configuration.
    • getDescription

      public String getDescription()

      Describes this configuration.

      Returns:
      Describes this configuration.
    • withDescription

      public CreateConfigurationTemplateRequest withDescription(String description)

      Describes this configuration.

      Parameters:
      description - Describes this configuration.
      Returns:
      Returns a reference to this 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.

      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 - 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:
      Returns a reference to this 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.

      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:
      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; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • 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: