AWS SDK for .NET Documentation
CreateEnvironmentRequest Class
AmazonAmazon.ElasticBeanstalk.ModelCreateEnvironmentRequest Did this page help you?   Yes   No    Tell us about it...
Container for the parameters to the CreateEnvironment operation. Launches an environment for the specified application using the specified configuration.
Declaration Syntax
C#
public class CreateEnvironmentRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
CreateEnvironmentRequest()()()()
Initializes a new instance of the CreateEnvironmentRequest class

ApplicationName
Gets and sets the property ApplicationName.

The name of the application that contains the version to be deployed.

If no application is found with this name,

CopyC#
CreateEnvironment
returns an
CopyC#
InvalidParameterValue
error.


CNAMEPrefix
Gets and sets the property CNAMEPrefix.

If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.


Description
Gets and sets the property Description.

Describes this environment.


EnvironmentName
Gets and sets the property 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

CopyC#
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.


Equals(Object)
Determines whether the specified Object is equal to the current 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
Gets and sets the property 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
Gets and sets the property OptionsToRemove.

A list of custom user-defined configuration options to remove from the configuration set for this new environment.


SolutionStackName
Gets and sets the property 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

CopyC#
TemplateName
, but not both. If you specify both, AWS Elastic Beanstalk returns an
CopyC#
InvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns a
CopyC#
MissingRequiredParameter
error.


Tags
Gets and sets the property Tags.

TemplateName
Gets and sets the property 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

CopyC#
InvalidParameterValue
error.

Condition: You must specify either this parameter or a

CopyC#
SolutionStackName
, but not both. If you specify both, AWS Elastic Beanstalk returns an
CopyC#
InvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns a
CopyC#
MissingRequiredParameter
error.


Tier
Gets and sets the property Tier.

This specifies the tier to use for creating this environment.


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
VersionLabel
Gets and sets the property VersionLabel.

The name of the application version to deploy.

If the specified application has no associated application versions, AWS Elastic Beanstalk

CopyC#
UpdateEnvironment
returns an
CopyC#
InvalidParameterValue
error.

Default: If not specified, AWS Elastic Beanstalk attempts to launch the most recently created application version sample application in the container.


WithApplicationName(String) Obsolete.
Sets the ApplicationName property

WithCNAMEPrefix(String) Obsolete.
Sets the CNAMEPrefix property

WithDescription(String) Obsolete.
Sets the Description property

WithEnvironmentName(String) Obsolete.
Sets the EnvironmentName property

WithOptionSettings(array<ConfigurationOptionSetting>[]()[][]) Obsolete.
Sets the OptionSettings property

WithOptionSettings(IEnumerable<(Of <<'(ConfigurationOptionSetting>)>>)) Obsolete.
Sets the OptionSettings property

WithOptionsToRemove(array<OptionSpecification>[]()[][]) Obsolete.
Sets the OptionsToRemove property

WithOptionsToRemove(IEnumerable<(Of <<'(OptionSpecification>)>>)) Obsolete.
Sets the OptionsToRemove property

WithSolutionStackName(String) Obsolete.
Sets the SolutionStackName property

WithTags(array<Tag>[]()[][]) Obsolete.
Sets the Tags property

WithTags(IEnumerable<(Of <<'(Tag>)>>)) Obsolete.
Sets the Tags property

WithTemplateName(String) Obsolete.
Sets the TemplateName property

WithTier(EnvironmentTier) Obsolete.
Sets the Tier property

WithVersionLabel(String) Obsolete.
Sets the VersionLabel property

Inheritance Hierarchy
Object
AmazonWebServiceRequest
 CreateEnvironmentRequest

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)