AWS Elastic Beanstalk Amazon Elastic Beanstalk AWS Elastic Beanstalk #Create… API

openapi: 3.2.0
info:
  title: 'Amazon Elastic Beanstalk AWS Elastic Beanstalk #Create… API'
  version: '2010-12-01'
  description: 'Operations tagged Amazon Elastic Beanstalk AWS Elastic Beanstalk #Create… across 2 of this provider''s published API definitions: amazon-elastic-beanstalk-createenvironment-api-openapi.yml, aws-elastic-beanstalk-amazon-elastic-beanstalk-aws-elastic-beanstalk-create-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://elasticbeanstalk.amazonaws.com
  description: AWS Elastic Beanstalk API endpoint
- url: https://elasticbeanstalk.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
tags:
- name: 'Amazon Elastic Beanstalk AWS Elastic Beanstalk #Create…'
paths:
  /#CreateEnvironment:
    post:
      operationId: createEnvironment
      summary: Amazon Elastic Beanstalk Create Environment
      description: Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - CreateEnvironment
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2010-12-01'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - ApplicationName
              properties:
                ApplicationName:
                  type: string
                  description: The name of the application that is associated with this environment.
                EnvironmentName:
                  type: string
                  description: A unique name for the environment.
                Description:
                  type: string
                  description: Your description for this environment.
                CNAMEPrefix:
                  type: string
                  description: If specified, the environment attempts to use this value as the prefix for the CNAME.
                Tier:
                  type: object
                  properties:
                    Name:
                      type: string
                      enum:
                      - WebServer
                      - Worker
                    Type:
                      type: string
                      enum:
                      - Standard
                      - SQS/HTTP
                    Version:
                      type: string
                  description: Specifies the tier to use in creating this environment.
                SolutionStackName:
                  type: string
                  description: The name of an Elastic Beanstalk solution stack to base the environment on.
                PlatformArn:
                  type: string
                  description: The Amazon Resource Name (ARN) of the custom platform.
                VersionLabel:
                  type: string
                  description: The name of the application version to deploy.
                TemplateName:
                  type: string
                  description: The name of the Elastic Beanstalk configuration template.
                OptionSettings:
                  type: array
                  items:
                    type: object
                    properties:
                      ResourceName:
                        type: string
                      Namespace:
                        type: string
                      OptionName:
                        type: string
                      Value:
                        type: string
                  description: Option values for the Elastic Beanstalk configuration.
                Tags:
                  type: array
                  items:
                    type: object
                    properties:
                      Key:
                        type: string
                      Value:
                        type: string
                  description: Specifies the tags applied to resources in the environment.
            examples:
              createEnvironmentRequestExample:
                summary: Default createEnvironment request
                x-microcks-default: true
                value:
                  ApplicationName: example-name
                  EnvironmentName: example-name
                  Description: Example description
                  CNAMEPrefix: example-name
                  Tier: {}
      responses:
        '200':
          description: Successful response with the created environment details.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/Environment'
              examples:
                createEnvironment200Example:
                  summary: Default createEnvironment 200 response
                  x-microcks-default: true
                  value:
                    EnvironmentId: example-id-12345
                    EnvironmentName: example-name
                    EnvironmentArn: arn:aws:service:us-east-1:123456789012:resource/example
                    ApplicationName: example-name
                    VersionLabel: '2025-01-01'
        '400':
          description: Bad request error.
      tags:
      - 'Amazon Elastic Beanstalk AWS Elastic Beanstalk #Create…'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://elasticbeanstalk.amazonaws.com
      description: AWS Elastic Beanstalk API endpoint
  /?Action=CreateEnvironment:
    post:
      operationId: CreateEnvironment
      summary: Create Environment
      description: Launches an Elastic Beanstalk environment for the specified application using the specified configuration.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/EnvironmentDescription'
              example:
                ApplicationName: my-app
                EnvironmentName: my-env
                VersionLabel: v1
                Status: Launching
                EnvironmentId: e-izqpassy4h
                SolutionStackName: 64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8
                CNAME: my-app.elasticbeanstalk.com
                Health: Grey
                Tier:
                  Type: Standard
                  Name: WebServer
                  Version: ' '
                DateUpdated: '2015-02-03T23:04:54.479Z'
                DateCreated: '2015-02-03T23:04:54.479Z'
        '403':
          description: InsufficientPrivilegesException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InsufficientPrivilegesException'
        '400':
          description: TooManyEnvironmentsException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/TooManyEnvironmentsException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateEnvironment
                  Version:
                    type: string
                    const: '2010-12-01'
              - $ref: '#/components/schemas/CreateEnvironmentMessage'
            example:
              ApplicationName: my-app
              EnvironmentName: my-env
              CNAMEPrefix: my-app
              VersionLabel: v1
              SolutionStackName: 64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8
      tags:
      - 'Amazon Elastic Beanstalk AWS Elastic Beanstalk #Create…'
      security:
      - sigv4: []
    servers:
    - url: https://elasticbeanstalk.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    Environment:
      type: object
      properties:
        EnvironmentId:
          type: string
          description: The ID of this environment.
        EnvironmentName:
          type: string
          description: The name of this environment.
        EnvironmentArn:
          type: string
          description: The ARN of this environment.
        ApplicationName:
          type: string
          description: The name of the application associated with this environment.
        VersionLabel:
          type: string
          description: The application version deployed in this environment.
        SolutionStackName:
          type: string
          description: The name of the solution stack deployed with this environment.
        PlatformArn:
          type: string
          description: The ARN of the platform version.
        Description:
          type: string
          description: Describes this environment.
        EndpointURL:
          type: string
          description: The URL to the LoadBalancer for this environment.
        CNAME:
          type: string
          description: The URL to the CNAME for this environment.
        DateCreated:
          type: string
          format: date-time
          description: The creation date for this environment.
        DateUpdated:
          type: string
          format: date-time
          description: The last modified date for this environment.
        Status:
          type: string
          enum:
          - Aborting
          - Launching
          - Updating
          - LinkingFrom
          - LinkingTo
          - Ready
          - Terminating
          - Terminated
          description: The current operational status of the environment.
        Health:
          type: string
          enum:
          - Green
          - Yellow
          - Red
          - Grey
          description: Describes the health status of the environment.
        HealthStatus:
          type: string
          enum:
          - NoData
          - Unknown
          - Pending
          - Ok
          - Info
          - Warning
          - Degraded
          - Severe
          - Suspended
          description: Returns the health status of the application running in your environment.
        Tier:
          type: object
          properties:
            Name:
              type: string
            Type:
              type: string
            Version:
              type: string
          description: Describes the current tier of this environment.
    EnvironmentLink:
      type: object
      properties:
        LinkName:
          type: string
          description: The name of the link.
        EnvironmentName:
          type: string
          description: The name of the linked environment (the dependency).
    InsufficientPrivilegesException:
      type: object
      properties:
        message:
          type: string
          description: The exception error message.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key of the tag.
        Value:
          type: string
          description: The value of the tag.
    EnvironmentResourcesDescription:
      type: object
      properties:
        LoadBalancer:
          $ref: '#/components/schemas/LoadBalancerDescription'
    EnvironmentDescription:
      type: object
      properties:
        EnvironmentName:
          type: string
          description: The name of this environment.
        EnvironmentId:
          type: string
          description: The ID of this environment.
        ApplicationName:
          type: string
          description: The name of the application associated with this environment.
        VersionLabel:
          type: string
          description: The application version deployed in this environment.
        SolutionStackName:
          type: string
          description: The name of the SolutionStack deployed with this environment.
        PlatformArn:
          type: string
          description: The ARN of the platform version.
        TemplateName:
          type: string
          description: The name of the configuration template used to originally launch this environment.
        Description:
          type: string
          description: Describes this environment.
        EndpointURL:
          type: string
          description: For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
        CNAME:
          type: string
          description: The URL to the CNAME for this environment.
        DateCreated:
          type: string
          format: date-time
          description: The creation date for this environment.
        DateUpdated:
          type: string
          format: date-time
          description: The last modified date for this environment.
        Status:
          type: string
          enum:
          - Aborting
          - Launching
          - Updating
          - LinkingFrom
          - LinkingTo
          - Ready
          - Terminating
          - Terminated
          description: 'The current operational status of the environment: Aborting: Environment is in the process of aborting a deployment. Launching: Environment is in the process of initial deployment. LinkingFrom: Environment is in the process of being linked to by another environment. See Environment links for details. LinkingTo: Environment is in the process of linking to another environment. See Environment links for details. 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'
        AbortableOperationInProgress:
          type: boolean
          description: '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:
          type: string
          enum:
          - Green
          - Yellow
          - Red
          - Grey
          description: 'Describes the health status of the environment. 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 Rest'
        HealthStatus:
          type: string
          enum:
          - NoData
          - Unknown
          - Pending
          - Ok
          - Info
          - Warning
          - Degraded
          - Severe
          - Suspended
          description: Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
        Resources:
          $ref: '#/components/schemas/EnvironmentResourcesDescription'
        Tier:
          $ref: '#/components/schemas/EnvironmentTier'
        EnvironmentLinks:
          type: array
          items:
            $ref: '#/components/schemas/EnvironmentLink'
          description: A list of links to other environments in the same group.
        EnvironmentArn:
          type: string
          description: The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
        OperationsRole:
          type: string
          description: The operations role feature of Elastic Beanstalk is in beta release and is subject to change. The Amazon Resource Name (ARN) of the environment's operations role.
    CreateEnvironmentMessage:
      type: object
      properties:
        ApplicationName:
          type: string
          description: The name of the application that is associated with this environment.
        EnvironmentName:
          type: string
          description: '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:
          type: string
          description: 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:
          type: string
          description: Your description for this environment.
        CNAMEPrefix:
          type: string
          description: 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:
          $ref: '#/components/schemas/EnvironmentTier'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Specifies the tags applied to resources in the environment.
        VersionLabel:
          type: string
          description: 'The name of the application version to deploy. Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.'
        TemplateName:
          type: string
          description: The name of the Elastic Beanstalk configuration template to use with the environment. If you specify TemplateName, then don't specify SolutionStackName.
        SolutionStackName:
          type: string
          description: 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 Elastic Beanstalk Platforms guide. If you specify SolutionStackName, don't specify PlatformArn or TemplateName.
        PlatformArn:
          type: string
          description: The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see Custom Platforms in the Elastic Beanstalk Developer Guide. If you specify PlatformArn, don't specify SolutionStackName.
        OptionSettings:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurationOptionSetting'
          description: If specified, 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:
          type: array
          items:
            $ref: '#/components/schemas/OptionSpecification'
          description: A list of custom user-defined configuration options to remove from the configuration set for this new environment.
        OperationsRole:
          type: string
          description: The operations role feature of Elastic Beanstalk is in beta release and is subject to change. 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.
      required:
      - ApplicationName
    ConfigurationOptionSetting:
      type: object
      properties:
        ResourceName:
          type: string
          description: A unique resource name for the option setting. Use it for a time–based scaling configuration option.
        Namespace:
          type: string
          description: A unique namespace that identifies the option's associated Amazon Web Services resource.
        OptionName:
          type: string
          description: The name of the configuration option.
        Value:
          type: string
          description: The current value for the configuration option.
    Listener:
      type: object
      properties:
        Protocol:
          type: string
          description: The protocol that is used by the Listener.
        Port:
          type: integer
          description: The port that is used by the Listener.
    TooManyEnvironmentsException:
      type: object
      properties:
        message:
          type: string
          description: The exception error message.
    EnvironmentTier:
      type: object
      properties:
        Name:
          type: string
          description: 'The name of this environment tier. Valid values: For Standard-mode EC2-based web server – WebServer For Standard-mode EC2-based backend application with Amazon SQS – Worker For Cluster-mode Amazon EKS-based applications – Cluster'
        Type:
          type: string
          description: 'The type of this environment tier. Valid values: For Web server tier – Standard For Worker tier – SQS/HTTP For Cluster tier – EKS'
        Version:
          type: string
          description: The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version. This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
    LoadBalancerDescription:
      type: object
      properties:
        LoadBalancerName:
          type: string
          description: The name of the LoadBalancer.
        Domain:
          type: string
          description: The domain name of the LoadBalancer.
        Listeners:
          type: array
          items:
            $ref: '#/components/schemas/Listener'
          description: A list of Listeners used by the LoadBalancer.
    OptionSpecification:
      type: object
      properties:
        ResourceName:
          type: string
          description: A unique resource name for a time-based scaling configuration option.
        Namespace:
          type: string
          description: A unique namespace identifying the option's associated Amazon Web Services resource.
        OptionName:
          type: string
          description: The name of the configuration option.
  securitySchemes:
    aws_sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication.
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: elasticbeanstalk
x-refined-from:
- amazon-elastic-beanstalk-createenvironment-api-openapi.yml
- aws-elastic-beanstalk-amazon-elastic-beanstalk-aws-elastic-beanstalk-create-api-openapi.yml