Container for the parameters to the CreateEnvironment operation.
Namespace: Amazon.ElasticBeanstalk.ModelLaunches an environment for the specified application using the specified configuration.
Assembly: AWSSDK (in AWSSDK.dll) Version: 1.4.10.0 (1.4.10.0)
Syntax
| C# | Visual Basic | Visual C++ |
public class CreateEnvironmentRequest : AmazonWebServiceRequest
Public Class CreateEnvironmentRequest _ Inherits AmazonWebServiceRequest
public ref class CreateEnvironmentRequest : public AmazonWebServiceRequest
Members
| All Members | Constructors  | Properties  | Methods |
 Public Protected | Instance Static  | Declared Inherited | XNA Framework Only  .NET Compact Framework Only  |
| Member | Description | |
|---|---|---|
| CreateEnvironmentRequest()()()() | Initializes a new instance of the CreateEnvironmentRequest class |
| ApplicationName |
The name of the application that contains the version to be deployed. If no application is found with this name, CreateEnvironment
returns an InvalidParameterValue error.
Constraints: |
| CNAMEPrefix |
If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the environment uses the environment
name.
Constraints: |
| Description |
Describes this environment.
Constraints: |
| EnvironmentName |
A unique name for the deployment environment. Used in the application URL. Constraint: Must be from 4 to 23 characters in length. The name
can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique in your account. If the
specified name already exists, AWS Elastic Beanstalk returns an InvalidParameterValue error. Default: If the CNAME parameter is not
specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
Constraints: |
| Equals(Object) | (Inherited from Object.) |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| 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.
|
| OptionsToRemove |
A list of custom user-defined configuration options to remove from the configuration set for this new environment.
|
| SolutionStackName |
This is an alternative to specifying a configuration name. If specified, AWS Elastic Beanstalk sets the configuration values to the default
values associated with the specified solution stack. Condition: You must specify either this or a TemplateName, but not both. If you
specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk
returns a MissingRequiredParameter error.
Constraints: |
| TemplateName |
The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk
returns an InvalidParameterValue error. Condition: You must specify either this parameter or a SolutionStackName, but not
both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS
Elastic Beanstalk returns a MissingRequiredParameter error.
Constraints: |
| ToString()()()() | (Inherited from Object.) |
| VersionLabel |
The name of the application version to deploy. If the specified application has no associated application versions, AWS Elastic Beanstalk
UpdateEnvironment returns an InvalidParameterValue error. Default: If not specified, AWS Elastic Beanstalk attempts to launch
the most recently created application version.
Constraints: |
| WithApplicationName(String) |
Sets the ApplicationName property
|
| WithCNAMEPrefix(String) |
Sets the CNAMEPrefix property
|
| WithDescription(String) |
Sets the Description property
|
| WithEnvironmentName(String) |
Sets the EnvironmentName property
|
| WithOptionSettings(array<ConfigurationOptionSetting>[]()[][]) |
Adds elements to the OptionSettings collection
|
| WithOptionSettings(IEnumerable<(Of <<'(ConfigurationOptionSetting>)>>)) |
Adds elements to the OptionSettings collection
|
| WithOptionsToRemove(array<OptionSpecification>[]()[][]) |
Adds elements to the OptionsToRemove collection
|
| WithOptionsToRemove(IEnumerable<(Of <<'(OptionSpecification>)>>)) |
Adds elements to the OptionsToRemove collection
|
| WithSolutionStackName(String) |
Sets the SolutionStackName property
|
| WithTemplateName(String) |
Sets the TemplateName property
|
| WithVersionLabel(String) |
Sets the VersionLabel property
|
Inheritance Hierarchy
System..::..Object
Amazon.Runtime..::..AmazonWebServiceRequest
Amazon.ElasticBeanstalk.Model..::..CreateEnvironmentRequest
Amazon.Runtime..::..AmazonWebServiceRequest
Amazon.ElasticBeanstalk.Model..::..CreateEnvironmentRequest
See Also
