ElasticBeanstalk / Client / create_environment

create_environment#

ElasticBeanstalk.Client.create_environment(**kwargs)#

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

Request Syntax

response = client.create_environment(
    ApplicationName='string',
    EnvironmentName='string',
    GroupName='string',
    Description='string',
    CNAMEPrefix='string',
    Tier={
        'Name': 'string',
        'Type': 'string',
        'Version': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    VersionLabel='string',
    TemplateName='string',
    SolutionStackName='string',
    PlatformArn='string',
    OptionSettings=[
        {
            'ResourceName': 'string',
            'Namespace': 'string',
            'OptionName': 'string',
            'Value': 'string'
        },
    ],
    OptionsToRemove=[
        {
            'ResourceName': 'string',
            'Namespace': 'string',
            'OptionName': 'string'
        },
    ],
    OperationsRole='string'
)

Parameters:

ApplicationName (string) –
[REQUIRED]

The name of the application that is associated with this environment.
EnvironmentName (string) –
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) – 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.
Description (string) – Your description for this environment.
CNAMEPrefix (string) – 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.
Tier (dict) –
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.
- Name (string) –
  
  The name of this environment tier.
  
  Valid values:
  - For Web server tier – WebServer
  - For Worker tier – Worker
- Type (string) –
  
  The type of this environment tier.
  
  Valid values:
  - For Web server tier – Standard
  - For Worker tier – SQS/HTTP
- Version (string) –
  
  The version of this environment tier. When you don’t set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.
  
  Note
  This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
Tags (list) –
Specifies the tags applied to resources in the environment.
- (dict) –
  
  Describes a tag applied to a resource in an environment.
  - Key (string) –
    
    The key of the tag.
  - Value (string) –
    
    The value of the tag.
VersionLabel (string) –
The name of the application version to deploy.

Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
TemplateName (string) –
The name of the Elastic Beanstalk configuration template to use with the environment.

Note
If you specify TemplateName, then don’t specify SolutionStackName.
SolutionStackName (string) –
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.

Note
If you specify SolutionStackName, don’t specify PlatformArn or TemplateName.
PlatformArn (string) –
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.

Note
If you specify PlatformArn, don’t specify SolutionStackName.
OptionSettings (list) –
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.
- (dict) –
  
  A specification identifying an individual configuration option along with its current value. For a list of possible namespaces and option values, see Option Values in the AWS Elastic Beanstalk Developer Guide.
  - ResourceName (string) –
    
    A unique resource name for the option setting. Use it for a time–based scaling configuration option.
  - Namespace (string) –
    
    A unique namespace that identifies the option’s associated AWS resource.
  - OptionName (string) –
    
    The name of the configuration option.
  - Value (string) –
    
    The current value for the configuration option.
OptionsToRemove (list) –
A list of custom user-defined configuration options to remove from the configuration set for this new environment.
- (dict) –
  
  A specification identifying an individual configuration option.
  - ResourceName (string) –
    
    A unique resource name for a time-based scaling configuration option.
  - Namespace (string) –
    
    A unique namespace identifying the option’s associated AWS resource.
  - OptionName (string) –
    
    The name of the configuration option.
OperationsRole (string) – 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 type:

dict

Returns:

Response Syntax

{
    'EnvironmentName': 'string',
    'EnvironmentId': 'string',
    'ApplicationName': 'string',
    'VersionLabel': 'string',
    'SolutionStackName': 'string',
    'PlatformArn': 'string',
    'TemplateName': 'string',
    'Description': 'string',
    'EndpointURL': 'string',
    'CNAME': 'string',
    'DateCreated': datetime(2015, 1, 1),
    'DateUpdated': datetime(2015, 1, 1),
    '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': {
        'LoadBalancer': {
            'LoadBalancerName': 'string',
            'Domain': 'string',
            'Listeners': [
                {
                    'Protocol': 'string',
                    'Port': 123
                },
            ]
        }
    },
    'Tier': {
        'Name': 'string',
        'Type': 'string',
        'Version': 'string'
    },
    'EnvironmentLinks': [
        {
            'LinkName': 'string',
            'EnvironmentName': 'string'
        },
    ],
    'EnvironmentArn': 'string',
    'OperationsRole': 'string'
}

Response Structure

(dict) –

Describes the properties of an environment.
- EnvironmentName (string) –
  
  The name of this environment.
- EnvironmentId (string) –
  
  The ID of this environment.
- ApplicationName (string) –
  
  The name of the application associated with this environment.
- VersionLabel (string) –
  
  The application version deployed in this environment.
- SolutionStackName (string) –
  
  The name of the SolutionStack deployed with this environment.
- PlatformArn (string) –
  
  The ARN of the platform version.
- TemplateName (string) –
  
  The name of the configuration template used to originally launch this environment.
- Description (string) –
  
  Describes this environment.
- EndpointURL (string) –
  
  For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
- CNAME (string) –
  
  The URL to the CNAME for this environment.
- DateCreated (datetime) –
  
  The creation date for this environment.
- DateUpdated (datetime) –
  
  The last modified date for this environment.
- Status (string) –
  
  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.
- AbortableOperationInProgress (boolean) –
  
  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.
- Health (string) –
  
  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 (string) –
  
  Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
- Resources (dict) –
  
  The description of the AWS resources used by this environment.
  - LoadBalancer (dict) –
    
    Describes the LoadBalancer.
    - LoadBalancerName (string) –
      
      The name of the LoadBalancer.
    - Domain (string) –
      
      The domain name of the LoadBalancer.
    - Listeners (list) –
      
      A list of Listeners used by the LoadBalancer.
      - (dict) –
        
        Describes the properties of a Listener for the LoadBalancer.
        
        Protocol (string) –
        
        The protocol that is used by the Listener.
        
        Port (integer) –
        
        The port that is used by the Listener.
- Tier (dict) –
  
  Describes the current tier of this environment.
  - Name (string) –
    
    The name of this environment tier.
    
    Valid values:
    - For Web server tier – WebServer
    - For Worker tier – Worker
  - Type (string) –
    
    The type of this environment tier.
    
    Valid values:
    - For Web server tier – Standard
    - For Worker tier – SQS/HTTP
  - Version (string) –
    
    The version of this environment tier. When you don’t set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.
    
    Note
    This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
- EnvironmentLinks (list) –
  
  A list of links to other environments in the same group.
  - (dict) –
    
    A link to another environment, defined in the environment’s manifest. Links provide connection information in system properties that can be used to connect to another environment in the same group. See Environment Manifest (env.yaml) for details.
    - LinkName (string) –
      
      The name of the link.
    - EnvironmentName (string) –
      
      The name of the linked environment (the dependency).
- EnvironmentArn (string) –
  
  The environment’s Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
- OperationsRole (string) –
  
  The Amazon Resource Name (ARN) of the environment’s operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

Exceptions

Examples

The following operation creates a new environment for version v1 of a java application named my-app:

response = client.create_environment(
    ApplicationName='my-app',
    CNAMEPrefix='my-app',
    EnvironmentName='my-env',
    SolutionStackName='64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8',
    VersionLabel='v1',
)

print(response)

Expected Output:

{
    'ApplicationName': 'my-app',
    'CNAME': 'my-app.elasticbeanstalk.com',
    'DateCreated': datetime(2015, 2, 3, 23, 4, 54, 1, 34, 0),
    'DateUpdated': datetime(2015, 2, 3, 23, 4, 54, 1, 34, 0),
    'EnvironmentId': 'e-izqpassy4h',
    'EnvironmentName': 'my-env',
    'Health': 'Grey',
    'SolutionStackName': '64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8',
    'Status': 'Launching',
    'Tier': {
        'Name': 'WebServer',
        'Type': 'Standard',
        'Version': ' ',
    },
    'VersionLabel': 'v1',
    'ResponseMetadata': {
        '...': '...',
    },
}