AWS Elastic Beanstalk Elastic Beanstalk Configuration Template API

openapi: 3.2.0
info:
  title: AWS Elastic Beanstalk Configuration Template API
  version: '2010-12-01'
  description: Generated from AWS's published Smithy model for AWS Elastic Beanstalk. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://elasticbeanstalk.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Configuration Template
paths:
  /?Action=CreateConfigurationTemplate:
    post:
      operationId: CreateConfigurationTemplate
      summary: Create Configuration Template
      description: Creates an Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings. Templates aren't associated with any environment. The EnvironmentName response element is always null. Related Topics DescribeConfigurationOptions DescribeConfigurationSettings ListAvailableSolutionStacks
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ConfigurationSettingsDescription'
              example:
                ApplicationName: my-app
                TemplateName: my-app-v1
                DateCreated: '2015-08-12T18:40:39Z'
                DateUpdated: '2015-08-12T18:40:39Z'
                SolutionStackName: 64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8
        '403':
          description: InsufficientPrivilegesException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InsufficientPrivilegesException'
        '400':
          description: TooManyBucketsException; TooManyConfigurationTemplatesException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/TooManyBucketsException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateConfigurationTemplate
                  Version:
                    type: string
                    const: '2010-12-01'
              - $ref: '#/components/schemas/CreateConfigurationTemplateMessage'
            example:
              ApplicationName: my-app
              TemplateName: my-app-v1
              EnvironmentId: e-rpqsewtp2j
      tags:
      - Configuration Template
  /?Action=DeleteConfigurationTemplate:
    post:
      operationId: DeleteConfigurationTemplate
      summary: Delete Configuration Template
      description: Deletes the specified configuration template. When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '400':
          description: OperationInProgressException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/OperationInProgressException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteConfigurationTemplate
                  Version:
                    type: string
                    const: '2010-12-01'
              - $ref: '#/components/schemas/DeleteConfigurationTemplateMessage'
            example:
              ApplicationName: my-app
              TemplateName: my-template
      tags:
      - Configuration Template
  /?Action=UpdateConfigurationTemplate:
    post:
      operationId: UpdateConfigurationTemplate
      summary: Update Configuration Template
      description: Updates the specified configuration template to have the specified properties or configuration option values. If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string. Related Topics DescribeConfigurationOptions
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ConfigurationSettingsDescription'
              example:
                ApplicationName: my-app
                TemplateName: my-template
                DateCreated: '2015-08-20T22:39:31Z'
                DateUpdated: '2015-08-20T22:43:11Z'
                SolutionStackName: 64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8
        '403':
          description: InsufficientPrivilegesException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InsufficientPrivilegesException'
        '400':
          description: TooManyBucketsException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/TooManyBucketsException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: UpdateConfigurationTemplate
                  Version:
                    type: string
                    const: '2010-12-01'
              - $ref: '#/components/schemas/UpdateConfigurationTemplateMessage'
            example:
              ApplicationName: my-app
              TemplateName: my-template
              OptionsToRemove:
              - Namespace: aws:elasticbeanstalk:healthreporting:system
                OptionName: ConfigDocument
      tags:
      - Configuration Template
components:
  schemas:
    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.
    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.
    TooManyBucketsException:
      type: object
      properties:
        message:
          type: string
          description: The exception error message.
    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.
    CreateConfigurationTemplateMessage:
      type: object
      properties:
        ApplicationName:
          type: string
          description: The name of the Elastic Beanstalk application to associate with this configuration template.
        TemplateName:
          type: string
          description: 'The name of the configuration template. Constraint: This name must be unique per application.'
        SolutionStackName:
          type: string
          description: The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see Supported Platforms in the Elastic Beanstalk Developer Guide. You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration. Use the ListAvailableSolutionStacks
        PlatformArn:
          type: string
          description: The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the Elastic Beanstalk Developer Guide. If you specify PlatformArn, then don't specify SolutionStackName.
        SourceConfiguration:
          $ref: '#/components/schemas/SourceConfiguration'
        EnvironmentId:
          type: string
          description: The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration.
        Description:
          type: string
          description: An optional description for this configuration.
        OptionSettings:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurationOptionSetting'
          description: Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the Elastic Beanstalk Developer Guide.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Specifies the tags applied to the configuration template.
      required:
      - ApplicationName
      - TemplateName
    OperationInProgressException:
      type: object
      properties:
        message:
          type: string
          description: The exception error message.
    UpdateConfigurationTemplateMessage:
      type: object
      properties:
        ApplicationName:
          type: string
          description: The name of the application associated with the configuration template to update. If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.
        TemplateName:
          type: string
          description: The name of the configuration template to update. If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.
        Description:
          type: string
          description: A new description for the configuration.
        OptionSettings:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurationOptionSetting'
          description: A list of configuration option settings to update with the new specified option value.
        OptionsToRemove:
          type: array
          items:
            $ref: '#/components/schemas/OptionSpecification'
          description: 'A list of configuration options to remove from the configuration set. Constraint: You can remove only UserDefined configuration options.'
      required:
      - ApplicationName
      - TemplateName
    ConfigurationSettingsDescription:
      type: object
      properties:
        SolutionStackName:
          type: string
          description: The name of the solution stack this configuration set uses.
        PlatformArn:
          type: string
          description: The ARN of the platform version.
        ApplicationName:
          type: string
          description: The name of the application associated with this configuration set.
        TemplateName:
          type: string
          description: If not null, the name of the configuration template for this configuration set.
        Description:
          type: string
          description: Describes this configuration set.
        EnvironmentName:
          type: string
          description: If not null, the name of the environment for this configuration set.
        DeploymentStatus:
          type: string
          enum:
          - deployed
          - pending
          - failed
          description: 'If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set: null: This configuration is not associated with a running environment. pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying. deployed: This is the configuration that is currently deployed to the associated running environment. failed: This is a draft configuration that failed to successfully deploy.'
        DateCreated:
          type: string
          format: date-time
          description: The date (in UTC time) when this configuration set was created.
        DateUpdated:
          type: string
          format: date-time
          description: The date (in UTC time) when this configuration set was last modified.
        OptionSettings:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurationOptionSetting'
          description: A list of the configuration options and their values in this configuration set.
    SourceConfiguration:
      type: object
      properties:
        ApplicationName:
          type: string
          description: The name of the application associated with the configuration.
        TemplateName:
          type: string
          description: The name of the configuration template.
    DeleteConfigurationTemplateMessage:
      type: object
      properties:
        ApplicationName:
          type: string
          description: The name of the application to delete the configuration template from.
        TemplateName:
          type: string
          description: The name of the configuration template to delete.
      required:
      - ApplicationName
      - TemplateName
  securitySchemes:
    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-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/elastic-beanstalk/service/2010-12-01/elastic-beanstalk-2010-12-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)