Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

CreateEnvironmentCommand

Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ElasticBeanstalkClient, CreateEnvironmentCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import
// const { ElasticBeanstalkClient, CreateEnvironmentCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import
const client = new ElasticBeanstalkClient(config);
const input = { // CreateEnvironmentMessage
  ApplicationName: "STRING_VALUE", // required
  EnvironmentName: "STRING_VALUE",
  GroupName: "STRING_VALUE",
  Description: "STRING_VALUE",
  CNAMEPrefix: "STRING_VALUE",
  Tier: { // EnvironmentTier
    Name: "STRING_VALUE",
    Type: "STRING_VALUE",
    Version: "STRING_VALUE",
  },
  Tags: [ // Tags
    { // Tag
      Key: "STRING_VALUE",
      Value: "STRING_VALUE",
    },
  ],
  VersionLabel: "STRING_VALUE",
  TemplateName: "STRING_VALUE",
  SolutionStackName: "STRING_VALUE",
  PlatformArn: "STRING_VALUE",
  OptionSettings: [ // ConfigurationOptionSettingsList
    { // ConfigurationOptionSetting
      ResourceName: "STRING_VALUE",
      Namespace: "STRING_VALUE",
      OptionName: "STRING_VALUE",
      Value: "STRING_VALUE",
    },
  ],
  OptionsToRemove: [ // OptionsSpecifierList
    { // OptionSpecification
      ResourceName: "STRING_VALUE",
      Namespace: "STRING_VALUE",
      OptionName: "STRING_VALUE",
    },
  ],
  OperationsRole: "STRING_VALUE",
};
const command = new CreateEnvironmentCommand(input);
const response = await client.send(command);
// { // EnvironmentDescription
//   EnvironmentName: "STRING_VALUE",
//   EnvironmentId: "STRING_VALUE",
//   ApplicationName: "STRING_VALUE",
//   VersionLabel: "STRING_VALUE",
//   SolutionStackName: "STRING_VALUE",
//   PlatformArn: "STRING_VALUE",
//   TemplateName: "STRING_VALUE",
//   Description: "STRING_VALUE",
//   EndpointURL: "STRING_VALUE",
//   CNAME: "STRING_VALUE",
//   DateCreated: new Date("TIMESTAMP"),
//   DateUpdated: new Date("TIMESTAMP"),
//   Status: "Aborting" || "Launching" || "Updating" || "LinkingFrom" || "LinkingTo" || "Ready" || "Terminating" || "Terminated",
//   AbortableOperationInProgress: true || false,
//   Health: "Green" || "Yellow" || "Red" || "Grey",
//   HealthStatus: "NoData" || "Unknown" || "Pending" || "Ok" || "Info" || "Warning" || "Degraded" || "Severe" || "Suspended",
//   Resources: { // EnvironmentResourcesDescription
//     LoadBalancer: { // LoadBalancerDescription
//       LoadBalancerName: "STRING_VALUE",
//       Domain: "STRING_VALUE",
//       Listeners: [ // LoadBalancerListenersDescription
//         { // Listener
//           Protocol: "STRING_VALUE",
//           Port: Number("int"),
//         },
//       ],
//     },
//   },
//   Tier: { // EnvironmentTier
//     Name: "STRING_VALUE",
//     Type: "STRING_VALUE",
//     Version: "STRING_VALUE",
//   },
//   EnvironmentLinks: [ // EnvironmentLinks
//     { // EnvironmentLink
//       LinkName: "STRING_VALUE",
//       EnvironmentName: "STRING_VALUE",
//     },
//   ],
//   EnvironmentArn: "STRING_VALUE",
//   OperationsRole: "STRING_VALUE",
// };

Example Usage

Loading code editorLoading code editor

CreateEnvironmentCommand Input

See CreateEnvironmentCommandInput for more details

Parameter	Type	Description
`ApplicationName` Required	`string \| undefined`	The name of the application that is associated with this environment.
`CNAMEPrefix`	`string \| undefined`	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.
`Description`	`string \| undefined`	Your description for this environment.
`EnvironmentName`	`string \| undefined`	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.
`GroupName`	`string \| undefined`	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.
`OperationsRole`	`string \| undefined`	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.
`OptionSettings`	`ConfigurationOptionSetting[] \| undefined`	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`	`OptionSpecification[] \| undefined`	A list of custom user-defined configuration options to remove from the configuration set for this new environment.
`PlatformArn`	`string \| undefined`	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`.
`SolutionStackName`	`string \| undefined`	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`.
`Tags`	`Tag[] \| undefined`	Specifies the tags applied to resources in the environment.
`TemplateName`	`string \| undefined`	The name of the Elastic Beanstalk configuration template to use with the environment. If you specify `TemplateName`, then don't specify `SolutionStackName`.
`Tier`	`EnvironmentTier \| undefined`	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.
`VersionLabel`	`string \| undefined`	The name of the application version to deploy. Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.

CreateEnvironmentCommand Output

See CreateEnvironmentCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`AbortableOperationInProgress`	`boolean \| undefined`	Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel. `true:` There is an update in progress. `false:` There are no updates currently in progress.
`ApplicationName`	`string \| undefined`	The name of the application associated with this environment.
`CNAME`	`string \| undefined`	The URL to the CNAME for this environment.
`DateCreated`	`Date \| undefined`	The creation date for this environment.
`DateUpdated`	`Date \| undefined`	The last modified date for this environment.
`Description`	`string \| undefined`	Describes this environment.
`EndpointURL`	`string \| undefined`	For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
`EnvironmentArn`	`string \| undefined`	The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
`EnvironmentId`	`string \| undefined`	The ID of this environment.
`EnvironmentLinks`	`EnvironmentLink[] \| undefined`	A list of links to other environments in the same group.
`EnvironmentName`	`string \| undefined`	The name of this environment.
`Health`	`EnvironmentHealth \| undefined`	Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment: `Red`: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment. `Yellow`: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment. `Green`: Indicates the environment is healthy and fully functional. `Grey`: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an `UpdateEnvironment` or `RestartEnvironment` request. Default: `Grey`
`HealthStatus`	`EnvironmentHealthStatus \| undefined`	Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses .
`OperationsRole`	`string \| undefined`	The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
`PlatformArn`	`string \| undefined`	The ARN of the platform version.
`Resources`	`EnvironmentResourcesDescription \| undefined`	The description of the AWS resources used by this environment.
`SolutionStackName`	`string \| undefined`	The name of the `SolutionStack` deployed with this environment.
`Status`	`EnvironmentStatus \| undefined`	The current operational status of the environment: `Launching`: Environment is in the process of initial deployment. `Updating`: Environment is in the process of updating its configuration settings or application version. `Ready`: Environment is available to have an action performed on it, such as update or terminate. `Terminating`: Environment is in the shut-down process. `Terminated`: Environment is not running.
`TemplateName`	`string \| undefined`	The name of the configuration template used to originally launch this environment.
`Tier`	`EnvironmentTier \| undefined`	Describes the current tier of this environment.
`VersionLabel`	`string \| undefined`	The application version deployed in this environment.

Throws

Name	Fault	Details
InsufficientPrivilegesException	client	The specified account does not have sufficient privileges for one or more AWS services.
TooManyEnvironmentsException	client	The specified account has reached its limit of environments.
ElasticBeanstalkServiceException		Base exception class for all service exceptions from ElasticBeanstalk service.

Getting Started

References