com.amazonaws.services.elasticbeanstalk.model.CreateEnvironmentRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-elasticbeanstalk Show documentation
/*
* Copyright 2017-2022 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;
/**
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateEnvironmentRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the application that is associated with this environment.
*
*/
private String applicationName;
/**
*
* A unique name for the environment.
*
*
* Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens.
* It can't start or end with a hyphen. This name must be unique within a region in your account. If the specified
* name already exists in the region, Elastic Beanstalk returns an InvalidParameterValue error.
*
*
* If you don't specify the CNAMEPrefix parameter, the environment name becomes part of the CNAME, and
* therefore part of the visible URL for your application.
*
*/
private String environmentName;
/**
*
* The name of the group to which the target environment belongs. Specify a group name only if the environment's
* name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest
* (env.yaml) for details.
*
*/
private String groupName;
/**
*
* Your description for this environment.
*
*/
private String description;
/**
*
* If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk
* environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string
* to the environment name.
*
*/
private String cNAMEPrefix;
/**
*
* Specifies the tier to use in creating this environment. The environment tier that you choose determines whether
* Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web
* application that handles background-processing tasks.
*
*/
private EnvironmentTier tier;
/**
*
* Specifies the tags applied to resources in the environment.
*
*/
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* The name of the application version to deploy.
*
*
* Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
*
*/
private String versionLabel;
/**
*
* The name of the Elastic Beanstalk configuration template to use with the environment.
*
*
*
* If you specify TemplateName, then don't specify SolutionStackName.
*
*
*/
private String templateName;
/**
*
* The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If specified,
* Elastic Beanstalk sets the configuration values to the default values associated with the specified solution
* stack. For a list of current solution stacks, see Elastic Beanstalk
* Supported Platforms in the AWS Elastic Beanstalk Platforms guide.
*
*
*
* If you specify SolutionStackName, don't specify PlatformArn or
* TemplateName.
*
*
*/
private String solutionStackName;
/**
*
* The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see Custom Platforms in the
* AWS Elastic Beanstalk Developer Guide.
*
*
*
* If you specify PlatformArn, don't specify SolutionStackName.
*
*
*/
private String platformArn;
/**
*
* If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the
* configuration set for the new environment. These override the values obtained from the solution stack or the
* configuration template.
*
*/
private com.amazonaws.internal.SdkInternalList optionSettings;
/**
*
* A list of custom user-defined configuration options to remove from the configuration set for this new
* environment.
*
*/
private com.amazonaws.internal.SdkInternalList optionsToRemove;
/**
*
* The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. If
* specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this call and
* during subsequent calls acting on this environment. To specify an operations role, you must have the
* iam:PassRole permission for the role. For more information, see Operations roles in the
* AWS Elastic Beanstalk Developer Guide.
*
*/
private String operationsRole;
/**
* Default constructor for CreateEnvironmentRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize the object after creating it.
*/
public CreateEnvironmentRequest() {
}
/**
* Constructs a new CreateEnvironmentRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize any additional object members.
*
* @param applicationName
* The name of the application that is associated with this environment.
* @param environmentName
* A unique name for the environment.
*
* Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and
* hyphens. It can't start or end with a hyphen. This name must be unique within a region in your account. If
* the specified name already exists in the region, Elastic Beanstalk returns an
* InvalidParameterValue error.
*
*
* If you don't specify the CNAMEPrefix parameter, the environment name becomes part of the
* CNAME, and therefore part of the visible URL for your application.
*/
public CreateEnvironmentRequest(String applicationName, String environmentName) {
setApplicationName(applicationName);
setEnvironmentName(environmentName);
}
/**
*
* The name of the application that is associated with this environment.
*
*
* @param applicationName
* The name of the application that is associated with this environment.
*/
public void setApplicationName(String applicationName) {
this.applicationName = applicationName;
}
/**
*
* The name of the application that is associated with this environment.
*
*
* @return The name of the application that is associated with this environment.
*/
public String getApplicationName() {
return this.applicationName;
}
/**
*
* The name of the application that is associated with this environment.
*
*
* @param applicationName
* The name of the application that is associated with this environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEnvironmentRequest withApplicationName(String applicationName) {
setApplicationName(applicationName);
return this;
}
/**
*
* A unique name for the environment.
*
*
* Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens.
* It can't start or end with a hyphen. This name must be unique within a region in your account. If the specified
* name already exists in the region, Elastic Beanstalk returns an InvalidParameterValue error.
*
*
* If you don't specify the CNAMEPrefix parameter, the environment name becomes part of the CNAME, and
* therefore part of the visible URL for your application.
*
*
* @param environmentName
* A unique name for the environment.
*
* Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and
* hyphens. It can't start or end with a hyphen. This name must be unique within a region in your account. If
* the specified name already exists in the region, Elastic Beanstalk returns an
* InvalidParameterValue error.
*
*
* If you don't specify the CNAMEPrefix parameter, the environment name becomes part of the
* CNAME, and therefore part of the visible URL for your application.
*/
public void setEnvironmentName(String environmentName) {
this.environmentName = environmentName;
}
/**
*
* A unique name for the environment.
*
*
* Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens.
* It can't start or end with a hyphen. This name must be unique within a region in your account. If the specified
* name already exists in the region, Elastic Beanstalk returns an InvalidParameterValue error.
*
*
* If you don't specify the CNAMEPrefix parameter, the environment name becomes part of the CNAME, and
* therefore part of the visible URL for your application.
*
*
* @return A unique name for the environment.
*
* Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and
* hyphens. It can't start or end with a hyphen. This name must be unique within a region in your account.
* If the specified name already exists in the region, Elastic Beanstalk returns an
* InvalidParameterValue error.
*
*
* If you don't specify the CNAMEPrefix parameter, the environment name becomes part of the
* CNAME, and therefore part of the visible URL for your application.
*/
public String getEnvironmentName() {
return this.environmentName;
}
/**
*
* A unique name for the environment.
*
*
* Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens.
* It can't start or end with a hyphen. This name must be unique within a region in your account. If the specified
* name already exists in the region, Elastic Beanstalk returns an InvalidParameterValue error.
*
*
* If you don't specify the CNAMEPrefix parameter, the environment name becomes part of the CNAME, and
* therefore part of the visible URL for your application.
*
*
* @param environmentName
* A unique name for the environment.
*
* Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and
* hyphens. It can't start or end with a hyphen. This name must be unique within a region in your account. If
* the specified name already exists in the region, Elastic Beanstalk returns an
* InvalidParameterValue error.
*
*
* If you don't specify the CNAMEPrefix parameter, the environment name becomes part of the
* CNAME, and therefore part of the visible URL for your application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEnvironmentRequest withEnvironmentName(String environmentName) {
setEnvironmentName(environmentName);
return this;
}
/**
*
* The name of the group to which the target environment belongs. Specify a group name only if the environment's
* name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest
* (env.yaml) for details.
*
*
* @param groupName
* The name of the group to which the target environment belongs. Specify a group name only if the
* environment's name is specified in an environment manifest and not with the environment name parameter.
* See Environment
* Manifest (env.yaml) for details.
*/
public void setGroupName(String groupName) {
this.groupName = groupName;
}
/**
*
* The name of the group to which the target environment belongs. Specify a group name only if the environment's
* name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest
* (env.yaml) for details.
*
*
* @return The name of the group to which the target environment belongs. Specify a group name only if the
* environment's name is specified in an environment manifest and not with the environment name parameter.
* See Environment
* Manifest (env.yaml) for details.
*/
public String getGroupName() {
return this.groupName;
}
/**
*
* The name of the group to which the target environment belongs. Specify a group name only if the environment's
* name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest
* (env.yaml) for details.
*
*
* @param groupName
* The name of the group to which the target environment belongs. Specify a group name only if the
* environment's name is specified in an environment manifest and not with the environment name parameter.
* See Environment
* Manifest (env.yaml) for details.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEnvironmentRequest withGroupName(String groupName) {
setGroupName(groupName);
return this;
}
/**
*
* Your description for this environment.
*
*
* @param description
* Your description for this environment.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* Your description for this environment.
*
*
* @return Your description for this environment.
*/
public String getDescription() {
return this.description;
}
/**
*
* Your description for this environment.
*
*
* @param description
* Your description for this environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEnvironmentRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk
* environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string
* to the environment name.
*
*
* @param cNAMEPrefix
* If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic
* Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random
* alphanumeric string to the environment name.
*/
public void setCNAMEPrefix(String cNAMEPrefix) {
this.cNAMEPrefix = cNAMEPrefix;
}
/**
*
* If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk
* environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string
* to the environment name.
*
*
* @return If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic
* Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random
* alphanumeric string to the environment name.
*/
public String getCNAMEPrefix() {
return this.cNAMEPrefix;
}
/**
*
* If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk
* environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string
* to the environment name.
*
*
* @param cNAMEPrefix
* If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic
* Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random
* alphanumeric string to the environment name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEnvironmentRequest withCNAMEPrefix(String cNAMEPrefix) {
setCNAMEPrefix(cNAMEPrefix);
return this;
}
/**
*
* Specifies the tier to use in creating this environment. The environment tier that you choose determines whether
* Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web
* application that handles background-processing tasks.
*
*
* @param tier
* Specifies the tier to use in creating this environment. The environment tier that you choose determines
* whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests
* or a web application that handles background-processing tasks.
*/
public void setTier(EnvironmentTier tier) {
this.tier = tier;
}
/**
*
* Specifies the tier to use in creating this environment. The environment tier that you choose determines whether
* Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web
* application that handles background-processing tasks.
*
*
* @return Specifies the tier to use in creating this environment. The environment tier that you choose determines
* whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests
* or a web application that handles background-processing tasks.
*/
public EnvironmentTier getTier() {
return this.tier;
}
/**
*
* Specifies the tier to use in creating this environment. The environment tier that you choose determines whether
* Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web
* application that handles background-processing tasks.
*
*
* @param tier
* Specifies the tier to use in creating this environment. The environment tier that you choose determines
* whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests
* or a web application that handles background-processing tasks.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEnvironmentRequest withTier(EnvironmentTier tier) {
setTier(tier);
return this;
}
/**
*
* Specifies the tags applied to resources in the environment.
*
*
* @return Specifies the tags applied to resources in the environment.
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return tags;
}
/**
*
* Specifies the tags applied to resources in the environment.
*
*
* @param tags
* Specifies the tags applied to resources in the environment.
*/
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 resources in the environment.
*
*
* 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 resources in the environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEnvironmentRequest 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 resources in the environment.
*
*
* @param tags
* Specifies the tags applied to resources in the environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEnvironmentRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* The name of the application version to deploy.
*
*
* Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
*
*
* @param versionLabel
* The name of the application version to deploy.
*
* Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
*/
public void setVersionLabel(String versionLabel) {
this.versionLabel = versionLabel;
}
/**
*
* The name of the application version to deploy.
*
*
* Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
*
*
* @return The name of the application version to deploy.
*
* Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
*/
public String getVersionLabel() {
return this.versionLabel;
}
/**
*
* The name of the application version to deploy.
*
*
* Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
*
*
* @param versionLabel
* The name of the application version to deploy.
*
* Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEnvironmentRequest withVersionLabel(String versionLabel) {
setVersionLabel(versionLabel);
return this;
}
/**
*
* The name of the Elastic Beanstalk configuration template to use with the environment.
*
*
*
* If you specify TemplateName, then don't specify SolutionStackName.
*
*
*
* @param templateName
* The name of the Elastic Beanstalk configuration template to use with the environment.
*
* If you specify TemplateName, then don't specify SolutionStackName.
*
*/
public void setTemplateName(String templateName) {
this.templateName = templateName;
}
/**
*
* The name of the Elastic Beanstalk configuration template to use with the environment.
*
*
*
* If you specify TemplateName, then don't specify SolutionStackName.
*
*
*
* @return The name of the Elastic Beanstalk configuration template to use with the environment.
*
* If you specify TemplateName, then don't specify SolutionStackName.
*
*/
public String getTemplateName() {
return this.templateName;
}
/**
*
* The name of the Elastic Beanstalk configuration template to use with the environment.
*
*
*
* If you specify TemplateName, then don't specify SolutionStackName.
*
*
*
* @param templateName
* The name of the Elastic Beanstalk configuration template to use with the environment.
*
* If you specify TemplateName, then don't specify SolutionStackName.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEnvironmentRequest withTemplateName(String templateName) {
setTemplateName(templateName);
return this;
}
/**
*
* The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If specified,
* Elastic Beanstalk sets the configuration values to the default values associated with the specified solution
* stack. For a list of current solution stacks, see Elastic Beanstalk
* Supported Platforms in the AWS Elastic Beanstalk Platforms guide.
*
*
*
* If you specify SolutionStackName, don't specify PlatformArn or
* TemplateName.
*
*
*
* @param solutionStackName
* The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If
* specified, Elastic Beanstalk sets the configuration values to the default values associated with the
* specified solution stack. For a list of current solution stacks, see Elastic
* Beanstalk Supported Platforms in the AWS Elastic Beanstalk Platforms guide.
*
* If you specify SolutionStackName, don't specify PlatformArn or
* TemplateName.
*
*/
public void setSolutionStackName(String solutionStackName) {
this.solutionStackName = solutionStackName;
}
/**
*
* The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If specified,
* Elastic Beanstalk sets the configuration values to the default values associated with the specified solution
* stack. For a list of current solution stacks, see Elastic Beanstalk
* Supported Platforms in the AWS Elastic Beanstalk Platforms guide.
*
*
*
* If you specify SolutionStackName, don't specify PlatformArn or
* TemplateName.
*
*
*
* @return The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If
* specified, Elastic Beanstalk sets the configuration values to the default values associated with the
* specified solution stack. For a list of current solution stacks, see Elastic
* Beanstalk Supported Platforms in the AWS Elastic Beanstalk Platforms guide.
*
* If you specify SolutionStackName, don't specify PlatformArn or
* TemplateName.
*
*/
public String getSolutionStackName() {
return this.solutionStackName;
}
/**
*
* The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If specified,
* Elastic Beanstalk sets the configuration values to the default values associated with the specified solution
* stack. For a list of current solution stacks, see Elastic Beanstalk
* Supported Platforms in the AWS Elastic Beanstalk Platforms guide.
*
*
*
* If you specify SolutionStackName, don't specify PlatformArn or
* TemplateName.
*
*
*
* @param solutionStackName
* The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If
* specified, Elastic Beanstalk sets the configuration values to the default values associated with the
* specified solution stack. For a list of current solution stacks, see Elastic
* Beanstalk Supported Platforms in the AWS Elastic Beanstalk Platforms guide.
*
* If you specify SolutionStackName, don't specify PlatformArn or
* TemplateName.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEnvironmentRequest withSolutionStackName(String solutionStackName) {
setSolutionStackName(solutionStackName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see Custom Platforms in the
* AWS Elastic Beanstalk Developer Guide.
*
*
*
* If you specify PlatformArn, don't specify SolutionStackName.
*
*
*
* @param platformArn
* The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information,
* see Custom
* Platforms in the AWS Elastic Beanstalk Developer Guide.
*
* If you specify PlatformArn, don't specify SolutionStackName.
*
*/
public void setPlatformArn(String platformArn) {
this.platformArn = platformArn;
}
/**
*
* The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see Custom Platforms in the
* AWS Elastic Beanstalk Developer Guide.
*
*
*
* If you specify PlatformArn, don't specify SolutionStackName.
*
*
*
* @return The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information,
* see Custom
* Platforms in the AWS Elastic Beanstalk Developer Guide.
*
* If you specify PlatformArn, don't specify SolutionStackName.
*
*/
public String getPlatformArn() {
return this.platformArn;
}
/**
*
* The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see Custom Platforms in the
* AWS Elastic Beanstalk Developer Guide.
*
*
*
* If you specify PlatformArn, don't specify SolutionStackName.
*
*
*
* @param platformArn
* The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information,
* see Custom
* Platforms in the AWS Elastic Beanstalk Developer Guide.
*
* If you specify PlatformArn, don't specify SolutionStackName.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEnvironmentRequest withPlatformArn(String platformArn) {
setPlatformArn(platformArn);
return this;
}
/**
*
* If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the
* configuration set for the new environment. These override the values obtained from the solution stack or the
* configuration template.
*
*
* @return If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in
* the configuration set for the new environment. These override the values obtained from the solution stack
* or the configuration template.
*/
public java.util.List getOptionSettings() {
if (optionSettings == null) {
optionSettings = new com.amazonaws.internal.SdkInternalList();
}
return optionSettings;
}
/**
*
* If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the
* configuration set for the new environment. These override the values obtained from the solution stack or the
* configuration template.
*
*
* @param optionSettings
* If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the
* configuration set for the new environment. These override the values obtained from the solution stack or
* the configuration template.
*/
public void setOptionSettings(java.util.Collection optionSettings) {
if (optionSettings == null) {
this.optionSettings = null;
return;
}
this.optionSettings = new com.amazonaws.internal.SdkInternalList(optionSettings);
}
/**
*
* If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the
* configuration set for the new environment. These override the values obtained from the solution stack or the
* configuration template.
*
*
* 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
* If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the
* configuration set for the new environment. These override the values obtained from the solution stack or
* the configuration template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEnvironmentRequest 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;
}
/**
*
* If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the
* configuration set for the new environment. These override the values obtained from the solution stack or the
* configuration template.
*
*
* @param optionSettings
* If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the
* configuration set for the new environment. These override the values obtained from the solution stack or
* the configuration template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEnvironmentRequest withOptionSettings(java.util.Collection optionSettings) {
setOptionSettings(optionSettings);
return this;
}
/**
*
* A list of custom user-defined configuration options to remove from the configuration set for this new
* environment.
*
*
* @return A list of custom user-defined configuration options to remove from the configuration set for this new
* environment.
*/
public java.util.List getOptionsToRemove() {
if (optionsToRemove == null) {
optionsToRemove = new com.amazonaws.internal.SdkInternalList();
}
return optionsToRemove;
}
/**
*
* A list of custom user-defined configuration options to remove from the configuration set for this new
* environment.
*
*
* @param optionsToRemove
* A list of custom user-defined configuration options to remove from the configuration set for this new
* environment.
*/
public void setOptionsToRemove(java.util.Collection optionsToRemove) {
if (optionsToRemove == null) {
this.optionsToRemove = null;
return;
}
this.optionsToRemove = new com.amazonaws.internal.SdkInternalList(optionsToRemove);
}
/**
*
* A list of custom user-defined configuration options to remove from the configuration set for this new
* environment.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setOptionsToRemove(java.util.Collection)} or {@link #withOptionsToRemove(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param optionsToRemove
* A list of custom user-defined configuration options to remove from the configuration set for this new
* environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEnvironmentRequest withOptionsToRemove(OptionSpecification... optionsToRemove) {
if (this.optionsToRemove == null) {
setOptionsToRemove(new com.amazonaws.internal.SdkInternalList(optionsToRemove.length));
}
for (OptionSpecification ele : optionsToRemove) {
this.optionsToRemove.add(ele);
}
return this;
}
/**
*
* A list of custom user-defined configuration options to remove from the configuration set for this new
* environment.
*
*
* @param optionsToRemove
* A list of custom user-defined configuration options to remove from the configuration set for this new
* environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEnvironmentRequest withOptionsToRemove(java.util.Collection optionsToRemove) {
setOptionsToRemove(optionsToRemove);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. If
* specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this call and
* during subsequent calls acting on this environment. To specify an operations role, you must have the
* iam:PassRole permission for the role. For more information, see Operations roles in the
* AWS Elastic Beanstalk Developer Guide.
*
*
* @param operationsRole
* The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. If
* specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this
* call and during subsequent calls acting on this environment. To specify an operations role, you must have
* the iam:PassRole permission for the role. For more information, see Operations roles
* in the AWS Elastic Beanstalk Developer Guide.
*/
public void setOperationsRole(String operationsRole) {
this.operationsRole = operationsRole;
}
/**
*
* The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. If
* specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this call and
* during subsequent calls acting on this environment. To specify an operations role, you must have the
* iam:PassRole permission for the role. For more information, see Operations roles in the
* AWS Elastic Beanstalk Developer Guide.
*
*
* @return The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
* If specified, Elastic Beanstalk uses the operations role for permissions to downstream services during
* this call and during subsequent calls acting on this environment. To specify an operations role, you must
* have the iam:PassRole permission for the role. For more information, see Operations
* roles in the AWS Elastic Beanstalk Developer Guide.
*/
public String getOperationsRole() {
return this.operationsRole;
}
/**
*
* The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. If
* specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this call and
* during subsequent calls acting on this environment. To specify an operations role, you must have the
* iam:PassRole permission for the role. For more information, see Operations roles in the
* AWS Elastic Beanstalk Developer Guide.
*
*
* @param operationsRole
* The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. If
* specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this
* call and during subsequent calls acting on this environment. To specify an operations role, you must have
* the iam:PassRole permission for the role. For more information, see Operations roles
* in the AWS Elastic Beanstalk Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEnvironmentRequest withOperationsRole(String operationsRole) {
setOperationsRole(operationsRole);
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 (getEnvironmentName() != null)
sb.append("EnvironmentName: ").append(getEnvironmentName()).append(",");
if (getGroupName() != null)
sb.append("GroupName: ").append(getGroupName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getCNAMEPrefix() != null)
sb.append("CNAMEPrefix: ").append(getCNAMEPrefix()).append(",");
if (getTier() != null)
sb.append("Tier: ").append(getTier()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getVersionLabel() != null)
sb.append("VersionLabel: ").append(getVersionLabel()).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 (getOptionSettings() != null)
sb.append("OptionSettings: ").append(getOptionSettings()).append(",");
if (getOptionsToRemove() != null)
sb.append("OptionsToRemove: ").append(getOptionsToRemove()).append(",");
if (getOperationsRole() != null)
sb.append("OperationsRole: ").append(getOperationsRole());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateEnvironmentRequest == false)
return false;
CreateEnvironmentRequest other = (CreateEnvironmentRequest) obj;
if (other.getApplicationName() == null ^ this.getApplicationName() == null)
return false;
if (other.getApplicationName() != null && other.getApplicationName().equals(this.getApplicationName()) == false)
return false;
if (other.getEnvironmentName() == null ^ this.getEnvironmentName() == null)
return false;
if (other.getEnvironmentName() != null && other.getEnvironmentName().equals(this.getEnvironmentName()) == false)
return false;
if (other.getGroupName() == null ^ this.getGroupName() == null)
return false;
if (other.getGroupName() != null && other.getGroupName().equals(this.getGroupName()) == 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.getCNAMEPrefix() == null ^ this.getCNAMEPrefix() == null)
return false;
if (other.getCNAMEPrefix() != null && other.getCNAMEPrefix().equals(this.getCNAMEPrefix()) == false)
return false;
if (other.getTier() == null ^ this.getTier() == null)
return false;
if (other.getTier() != null && other.getTier().equals(this.getTier()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getVersionLabel() == null ^ this.getVersionLabel() == null)
return false;
if (other.getVersionLabel() != null && other.getVersionLabel().equals(this.getVersionLabel()) == 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.getOptionSettings() == null ^ this.getOptionSettings() == null)
return false;
if (other.getOptionSettings() != null && other.getOptionSettings().equals(this.getOptionSettings()) == false)
return false;
if (other.getOptionsToRemove() == null ^ this.getOptionsToRemove() == null)
return false;
if (other.getOptionsToRemove() != null && other.getOptionsToRemove().equals(this.getOptionsToRemove()) == false)
return false;
if (other.getOperationsRole() == null ^ this.getOperationsRole() == null)
return false;
if (other.getOperationsRole() != null && other.getOperationsRole().equals(this.getOperationsRole()) == 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 + ((getEnvironmentName() == null) ? 0 : getEnvironmentName().hashCode());
hashCode = prime * hashCode + ((getGroupName() == null) ? 0 : getGroupName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getCNAMEPrefix() == null) ? 0 : getCNAMEPrefix().hashCode());
hashCode = prime * hashCode + ((getTier() == null) ? 0 : getTier().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getVersionLabel() == null) ? 0 : getVersionLabel().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 + ((getOptionSettings() == null) ? 0 : getOptionSettings().hashCode());
hashCode = prime * hashCode + ((getOptionsToRemove() == null) ? 0 : getOptionsToRemove().hashCode());
hashCode = prime * hashCode + ((getOperationsRole() == null) ? 0 : getOperationsRole().hashCode());
return hashCode;
}
@Override
public CreateEnvironmentRequest clone() {
return (CreateEnvironmentRequest) super.clone();
}
}