/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.elasticbeanstalk.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *

* Request to create a configuration template. *

* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateConfigurationTemplateRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

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

*/ private String applicationName; /** *

* The name of the configuration template. *

* Constraint: This name must be unique per application. *

*/ private String templateName; /** *

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

*/ private String solutionStackName; /** *

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

* */ private String platformArn; /** *

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

*/ private SourceConfiguration sourceConfiguration; /** *

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

*/ private String environmentId; /** *

* An optional description for this configuration. *

*/ private String description; /** *

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

*/ private com.amazonaws.internal.SdkInternalList optionSettings; /** *

* Specifies the tags applied to the configuration template. *

*/ private com.amazonaws.internal.SdkInternalList tags; /** * Default constructor for CreateConfigurationTemplateRequest object. Callers should use the setter or fluent setter * (with...) methods to initialize the object after creating it. */ public CreateConfigurationTemplateRequest() { } /** * Constructs a new CreateConfigurationTemplateRequest object. Callers should use the setter or fluent setter * (with...) methods to initialize any additional object members. * * @param applicationName * The name of the Elastic Beanstalk application to associate with this configuration template. * @param templateName * The name of the configuration template.

* Constraint: This name must be unique per application. */ public CreateConfigurationTemplateRequest(String applicationName, String templateName) { setApplicationName(applicationName); setTemplateName(templateName); } /** *

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

* * @param applicationName * The name of the Elastic Beanstalk application to associate with this configuration template. */ public void setApplicationName(String applicationName) { this.applicationName = applicationName; } /** *

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

* * @return The name of the Elastic Beanstalk application to associate with this configuration template. */ public String getApplicationName() { return this.applicationName; } /** *

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

* * @param applicationName * The name of the Elastic Beanstalk application to associate with this configuration template. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateConfigurationTemplateRequest withApplicationName(String applicationName) { setApplicationName(applicationName); return this; } /** *

* The name of the configuration template. *

* Constraint: This name must be unique per application. *

* * @param templateName * The name of the configuration template.

* Constraint: This name must be unique per application. */ public void setTemplateName(String templateName) { this.templateName = templateName; } /** *

* The name of the configuration template. *

* Constraint: This name must be unique per application. *

* * @return The name of the configuration template.

* Constraint: This name must be unique per application. */ public String getTemplateName() { return this.templateName; } /** *

* The name of the configuration template. *

* Constraint: This name must be unique per application. *

* * @param templateName * The name of the configuration template.

* Constraint: This name must be unique per application. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateConfigurationTemplateRequest withTemplateName(String templateName) { setTemplateName(templateName); return this; } /** *

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

* * @param 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. */ public void setSolutionStackName(String solutionStackName) { this.solutionStackName = solutionStackName; } /** *

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

* * @return 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. */ public String getSolutionStackName() { return this.solutionStackName; } /** *

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

* 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateConfigurationTemplateRequest withSolutionStackName(String solutionStackName) { setSolutionStackName(solutionStackName); return this; } /** *

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

* * * @param 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. *

*/ public void setPlatformArn(String platformArn) { this.platformArn = 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. *

* * * @return 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. *

*/ public String getPlatformArn() { return this.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. *

* * * @param 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. *

* @return Returns a reference to this object so that method calls can be chained together. */ public CreateConfigurationTemplateRequest withPlatformArn(String platformArn) { setPlatformArn(platformArn); return this; } /** *

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

* * @param 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. */ public void setSourceConfiguration(SourceConfiguration sourceConfiguration) { this.sourceConfiguration = sourceConfiguration; } /** *

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

* * @return 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. *

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

* 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateConfigurationTemplateRequest withSourceConfiguration(SourceConfiguration sourceConfiguration) { setSourceConfiguration(sourceConfiguration); return this; } /** *

* * @param 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. */ public void setEnvironmentId(String environmentId) { this.environmentId = environmentId; } /** *

* * @return 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. */ public String getEnvironmentId() { return this.environmentId; } /** *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateConfigurationTemplateRequest withEnvironmentId(String environmentId) { setEnvironmentId(environmentId); return this; } /** *

* An optional description for this configuration. *

* * @param description * An optional description for this configuration. */ public void setDescription(String description) { this.description = description; } /** *

* An optional description for this configuration. *

* * @return An optional description for this configuration. */ public String getDescription() { return this.description; } /** *

* An optional description for this configuration. *

* * @param description * An optional description for this configuration. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateConfigurationTemplateRequest withDescription(String description) { setDescription(description); return this; } /** *

* * @return 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. */ public java.util.List getOptionSettings() { if (optionSettings == null) { optionSettings = new com.amazonaws.internal.SdkInternalList(); } return optionSettings; } /** *

* * @param 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. */ public void setOptionSettings(java.util.Collection optionSettings) { if (optionSettings == null) { this.optionSettings = null; return; } this.optionSettings = new com.amazonaws.internal.SdkInternalList(optionSettings); } /** *

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

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateConfigurationTemplateRequest withOptionSettings(ConfigurationOptionSetting... optionSettings) { if (this.optionSettings == null) { setOptionSettings(new com.amazonaws.internal.SdkInternalList(optionSettings.length)); } for (ConfigurationOptionSetting ele : optionSettings) { this.optionSettings.add(ele); } return this; } /** *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateConfigurationTemplateRequest withOptionSettings(java.util.Collection optionSettings) { setOptionSettings(optionSettings); return this; } /** *

* Specifies the tags applied to the configuration template. *

* * @return Specifies the tags applied to the configuration template. */ public java.util.List getTags() { if (tags == null) { tags = new com.amazonaws.internal.SdkInternalList(); } return tags; } /** *

* Specifies the tags applied to the configuration template. *

* * @param tags * Specifies the tags applied to the configuration template. */ public void setTags(java.util.Collection tags) { if (tags == null) { this.tags = null; return; } this.tags = new com.amazonaws.internal.SdkInternalList(tags); } /** *

* Specifies the tags applied to the configuration template. *

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

* * @param tags * Specifies the tags applied to the configuration template. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateConfigurationTemplateRequest withTags(Tag... tags) { if (this.tags == null) { setTags(new com.amazonaws.internal.SdkInternalList(tags.length)); } for (Tag ele : tags) { this.tags.add(ele); } return this; } /** *

* Specifies the tags applied to the configuration template. *

* * @param tags * Specifies the tags applied to the configuration template. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateConfigurationTemplateRequest withTags(java.util.Collection tags) { setTags(tags); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getApplicationName() != null) sb.append("ApplicationName: ").append(getApplicationName()).append(","); if (getTemplateName() != null) sb.append("TemplateName: ").append(getTemplateName()).append(","); if (getSolutionStackName() != null) sb.append("SolutionStackName: ").append(getSolutionStackName()).append(","); if (getPlatformArn() != null) sb.append("PlatformArn: ").append(getPlatformArn()).append(","); if (getSourceConfiguration() != null) sb.append("SourceConfiguration: ").append(getSourceConfiguration()).append(","); if (getEnvironmentId() != null) sb.append("EnvironmentId: ").append(getEnvironmentId()).append(","); if (getDescription() != null) sb.append("Description: ").append(getDescription()).append(","); if (getOptionSettings() != null) sb.append("OptionSettings: ").append(getOptionSettings()).append(","); if (getTags() != null) sb.append("Tags: ").append(getTags()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateConfigurationTemplateRequest == false) return false; CreateConfigurationTemplateRequest other = (CreateConfigurationTemplateRequest) obj; if (other.getApplicationName() == null ^ this.getApplicationName() == null) return false; if (other.getApplicationName() != null && other.getApplicationName().equals(this.getApplicationName()) == false) return false; if (other.getTemplateName() == null ^ this.getTemplateName() == null) return false; if (other.getTemplateName() != null && other.getTemplateName().equals(this.getTemplateName()) == false) return false; if (other.getSolutionStackName() == null ^ this.getSolutionStackName() == null) return false; if (other.getSolutionStackName() != null && other.getSolutionStackName().equals(this.getSolutionStackName()) == false) return false; if (other.getPlatformArn() == null ^ this.getPlatformArn() == null) return false; if (other.getPlatformArn() != null && other.getPlatformArn().equals(this.getPlatformArn()) == false) return false; if (other.getSourceConfiguration() == null ^ this.getSourceConfiguration() == null) return false; if (other.getSourceConfiguration() != null && other.getSourceConfiguration().equals(this.getSourceConfiguration()) == false) return false; if (other.getEnvironmentId() == null ^ this.getEnvironmentId() == null) return false; if (other.getEnvironmentId() != null && other.getEnvironmentId().equals(this.getEnvironmentId()) == false) return false; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; if (other.getOptionSettings() == null ^ this.getOptionSettings() == null) return false; if (other.getOptionSettings() != null && other.getOptionSettings().equals(this.getOptionSettings()) == false) return false; if (other.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getApplicationName() == null) ? 0 : getApplicationName().hashCode()); hashCode = prime * hashCode + ((getTemplateName() == null) ? 0 : getTemplateName().hashCode()); hashCode = prime * hashCode + ((getSolutionStackName() == null) ? 0 : getSolutionStackName().hashCode()); hashCode = prime * hashCode + ((getPlatformArn() == null) ? 0 : getPlatformArn().hashCode()); hashCode = prime * hashCode + ((getSourceConfiguration() == null) ? 0 : getSourceConfiguration().hashCode()); hashCode = prime * hashCode + ((getEnvironmentId() == null) ? 0 : getEnvironmentId().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getOptionSettings() == null) ? 0 : getOptionSettings().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); return hashCode; } @Override public CreateConfigurationTemplateRequest clone() { return (CreateConfigurationTemplateRequest) super.clone(); } }