@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateEnvironmentRequest()
Default constructor for CreateEnvironmentRequest object.
|
CreateEnvironmentRequest(String applicationName,
String environmentName)
Constructs a new CreateEnvironmentRequest object.
|
Modifier and Type | Method and Description |
---|---|
CreateEnvironmentRequest |
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 application that is associated with this environment.
|
String |
getCNAMEPrefix()
If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk
environment URL.
|
String |
getDescription()
Your description for this environment.
|
String |
getEnvironmentName()
A unique name for the environment.
|
String |
getGroupName()
The name of the group to which the target environment belongs.
|
String |
getOperationsRole()
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
|
List<ConfigurationOptionSetting> |
getOptionSettings()
If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the
configuration set for the new environment.
|
List<OptionSpecification> |
getOptionsToRemove()
A list of custom user-defined configuration options to remove from the configuration set for this new
environment.
|
String |
getPlatformArn()
The Amazon Resource Name (ARN) of the custom platform to use with the environment.
|
String |
getSolutionStackName()
The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
|
List<Tag> |
getTags()
Specifies the tags applied to resources in the environment.
|
String |
getTemplateName()
The name of the Elastic Beanstalk configuration template to use with the environment.
|
EnvironmentTier |
getTier()
Specifies the tier to use in creating this environment.
|
String |
getVersionLabel()
The name of the application version to deploy.
|
int |
hashCode() |
void |
setApplicationName(String applicationName)
The name of the application that is associated with this environment.
|
void |
setCNAMEPrefix(String cNAMEPrefix)
If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk
environment URL.
|
void |
setDescription(String description)
Your description for this environment.
|
void |
setEnvironmentName(String environmentName)
A unique name for the environment.
|
void |
setGroupName(String groupName)
The name of the group to which the target environment belongs.
|
void |
setOperationsRole(String operationsRole)
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
|
void |
setOptionSettings(Collection<ConfigurationOptionSetting> optionSettings)
If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the
configuration set for the new environment.
|
void |
setOptionsToRemove(Collection<OptionSpecification> optionsToRemove)
A list of custom user-defined configuration options to remove from the configuration set for this new
environment.
|
void |
setPlatformArn(String platformArn)
The Amazon Resource Name (ARN) of the custom platform to use with the environment.
|
void |
setSolutionStackName(String solutionStackName)
The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
|
void |
setTags(Collection<Tag> tags)
Specifies the tags applied to resources in the environment.
|
void |
setTemplateName(String templateName)
The name of the Elastic Beanstalk configuration template to use with the environment.
|
void |
setTier(EnvironmentTier tier)
Specifies the tier to use in creating this environment.
|
void |
setVersionLabel(String versionLabel)
The name of the application version to deploy.
|
String |
toString()
Returns a string representation of this object.
|
CreateEnvironmentRequest |
withApplicationName(String applicationName)
The name of the application that is associated with this environment.
|
CreateEnvironmentRequest |
withCNAMEPrefix(String cNAMEPrefix)
If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk
environment URL.
|
CreateEnvironmentRequest |
withDescription(String description)
Your description for this environment.
|
CreateEnvironmentRequest |
withEnvironmentName(String environmentName)
A unique name for the environment.
|
CreateEnvironmentRequest |
withGroupName(String groupName)
The name of the group to which the target environment belongs.
|
CreateEnvironmentRequest |
withOperationsRole(String operationsRole)
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
|
CreateEnvironmentRequest |
withOptionSettings(Collection<ConfigurationOptionSetting> optionSettings)
If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the
configuration set for the new environment.
|
CreateEnvironmentRequest |
withOptionSettings(ConfigurationOptionSetting... optionSettings)
If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the
configuration set for the new environment.
|
CreateEnvironmentRequest |
withOptionsToRemove(Collection<OptionSpecification> optionsToRemove)
A list of custom user-defined configuration options to remove from the configuration set for this new
environment.
|
CreateEnvironmentRequest |
withOptionsToRemove(OptionSpecification... optionsToRemove)
A list of custom user-defined configuration options to remove from the configuration set for this new
environment.
|
CreateEnvironmentRequest |
withPlatformArn(String platformArn)
The Amazon Resource Name (ARN) of the custom platform to use with the environment.
|
CreateEnvironmentRequest |
withSolutionStackName(String solutionStackName)
The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
|
CreateEnvironmentRequest |
withTags(Collection<Tag> tags)
Specifies the tags applied to resources in the environment.
|
CreateEnvironmentRequest |
withTags(Tag... tags)
Specifies the tags applied to resources in the environment.
|
CreateEnvironmentRequest |
withTemplateName(String templateName)
The name of the Elastic Beanstalk configuration template to use with the environment.
|
CreateEnvironmentRequest |
withTier(EnvironmentTier tier)
Specifies the tier to use in creating this environment.
|
CreateEnvironmentRequest |
withVersionLabel(String versionLabel)
The name of the application version to deploy.
|
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
public CreateEnvironmentRequest()
public CreateEnvironmentRequest(String applicationName, String environmentName)
applicationName
- The name of the application that is associated with this environment.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 setApplicationName(String applicationName)
The name of the application that is associated with this environment.
applicationName
- The name of the application that is associated with this environment.public String getApplicationName()
The name of the application that is associated with this environment.
public CreateEnvironmentRequest withApplicationName(String applicationName)
The name of the application that is associated with this environment.
applicationName
- The name of the application that is associated with this environment.public void setEnvironmentName(String 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.
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 String getEnvironmentName()
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.
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 withEnvironmentName(String 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.
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 setGroupName(String 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.
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 String getGroupName()
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 CreateEnvironmentRequest withGroupName(String 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.
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 setDescription(String description)
Your description for this environment.
description
- Your description for this environment.public String getDescription()
Your description for this environment.
public CreateEnvironmentRequest withDescription(String description)
Your description for this environment.
description
- Your description for this environment.public void setCNAMEPrefix(String 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.
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 String getCNAMEPrefix()
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 CreateEnvironmentRequest withCNAMEPrefix(String 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.
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 setTier(EnvironmentTier 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.
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 EnvironmentTier getTier()
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 CreateEnvironmentRequest withTier(EnvironmentTier 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.
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 List<Tag> getTags()
Specifies the tags applied to resources in the environment.
public void setTags(Collection<Tag> tags)
Specifies the tags applied to resources in the environment.
tags
- Specifies the tags applied to resources in the environment.public CreateEnvironmentRequest withTags(Tag... tags)
Specifies the tags applied to resources in the environment.
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.
tags
- Specifies the tags applied to resources in the environment.public CreateEnvironmentRequest withTags(Collection<Tag> tags)
Specifies the tags applied to resources in the environment.
tags
- Specifies the tags applied to resources in the environment.public void setVersionLabel(String versionLabel)
The name of the application version to deploy.
Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
versionLabel
- The name of the application version to deploy.
Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
public String getVersionLabel()
The name of the application version to deploy.
Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
public CreateEnvironmentRequest withVersionLabel(String versionLabel)
The name of the application version to deploy.
Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
versionLabel
- The name of the application version to deploy.
Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
public void setTemplateName(String templateName)
The name of the Elastic Beanstalk configuration template to use with the environment.
If you specify TemplateName
, then don't specify SolutionStackName
.
templateName
- 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()
The name of the Elastic Beanstalk configuration template to use with the environment.
If you specify TemplateName
, then don't specify SolutionStackName
.
If you specify TemplateName
, then don't specify SolutionStackName
.
public CreateEnvironmentRequest withTemplateName(String templateName)
The name of the Elastic Beanstalk configuration template to use with the environment.
If you specify TemplateName
, then don't specify SolutionStackName
.
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 setSolutionStackName(String 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
.
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 String getSolutionStackName()
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
.
If you specify SolutionStackName
, don't specify PlatformArn
or
TemplateName
.
public CreateEnvironmentRequest withSolutionStackName(String 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
.
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 setPlatformArn(String 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
.
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 String getPlatformArn()
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
.
If you specify PlatformArn
, don't specify SolutionStackName
.
public CreateEnvironmentRequest withPlatformArn(String 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
.
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 List<ConfigurationOptionSetting> getOptionSettings()
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(Collection<ConfigurationOptionSetting> 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.
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 CreateEnvironmentRequest withOptionSettings(ConfigurationOptionSetting... 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
setOptionSettings(java.util.Collection)
or withOptionSettings(java.util.Collection)
if you want
to override the existing values.
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 CreateEnvironmentRequest withOptionSettings(Collection<ConfigurationOptionSetting> 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.
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 List<OptionSpecification> getOptionsToRemove()
A list of custom user-defined configuration options to remove from the configuration set for this new environment.
public void setOptionsToRemove(Collection<OptionSpecification> optionsToRemove)
A list of custom user-defined configuration options to remove from the configuration set for this new environment.
optionsToRemove
- A list of custom user-defined configuration options to remove from the configuration set for this new
environment.public CreateEnvironmentRequest withOptionsToRemove(OptionSpecification... 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
setOptionsToRemove(java.util.Collection)
or withOptionsToRemove(java.util.Collection)
if you
want to override the existing values.
optionsToRemove
- A list of custom user-defined configuration options to remove from the configuration set for this new
environment.public CreateEnvironmentRequest withOptionsToRemove(Collection<OptionSpecification> optionsToRemove)
A list of custom user-defined configuration options to remove from the configuration set for this new environment.
optionsToRemove
- A list of custom user-defined configuration options to remove from the configuration set for this new
environment.public void setOperationsRole(String 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.
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 String getOperationsRole()
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.
iam:PassRole
permission for the role. For more information, see Operations
roles in the AWS Elastic Beanstalk Developer Guide.public CreateEnvironmentRequest withOperationsRole(String 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.
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 String toString()
toString
in class Object
Object.toString()
public CreateEnvironmentRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()