applications

Creates, updates, deletes, gets or lists an applications resource.

Overview

Name	applications
Type	Resource
Id	aws.elasticbeanstalk.applications

Fields

The following fields are returned by SELECT queries:

describe_applications

Name	Datatype	Description
application_arn	string	The Amazon Resource Name (ARN) of the application.
application_name	string	The name of the application.
configuration_templates	string	The names of the configuration templates associated with this application.
date_created	string	The date when the application was created.
date_updated	string	The date when the application was last modified.
description	string	User-defined description of the application.
resource_lifecycle_config	string	The lifecycle settings for the application.
versions	string	The names of the versions for this application.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_applications	select	region	ApplicationNames	Returns the descriptions of existing applications.
create_configuration_template	insert	ApplicationName, TemplateName, region	SolutionStackName, PlatformArn, SourceConfiguration, EnvironmentId, Description, OptionSettings, Tags	Creates an AWS 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
create_application	insert	ApplicationName, region	Description, ResourceLifecycleConfig, Tags	Creates an application that has one configuration template named default and no application versions.
update_application_resource_lifecycle	update	ApplicationName, ResourceLifecycleConfig, region		Modifies lifecycle settings for an application.
update_configuration_template	update	ApplicationName, TemplateName, region	Description, OptionSettings, OptionsToRemove	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
update_application	update	ApplicationName, region	Description	Updates the specified application to have the specified properties. If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.
delete_configuration_template	delete	ApplicationName, TemplateName, region		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.
delete_application	delete	ApplicationName, region	TerminateEnvByForce	Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket. You cannot delete an application that has a running environment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
ApplicationName	string	The name of the application to delete.
ResourceLifecycleConfig	object	The lifecycle configuration.
TemplateName	string	The name of the configuration template to delete.
region	string	AWS region (default: us-east-1)
ApplicationNames	array	If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.
Description	string	A new description for the application. Default: If not specified, AWS Elastic Beanstalk does not update the description.
EnvironmentId	string	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.
OptionSettings	array	A list of configuration option settings to update with the new specified option value.
OptionsToRemove	array	A list of configuration options to remove from the configuration set. Constraint: You can remove only UserDefined configuration options.
PlatformArn	string	The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide. If you specify PlatformArn, then don't specify SolutionStackName.
ResourceLifecycleConfig	object	Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.
SolutionStackName	string	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 AWS Elastic Beanstalk Developer Guide. You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration. Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.
SourceConfiguration	object	An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration. Values specified in OptionSettings override any values obtained from the SourceConfiguration. You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName. Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.
Tags	array	Specifies the tags applied to the application. Elastic Beanstalk applies these tags only to the application. Environments that you create in the application don't inherit the tags.
TerminateEnvByForce	boolean	When set to true, running environments will be terminated before deleting the application.

SELECT examples

describe_applications

Returns the descriptions of existing applications.

SELECT
application_arn,
application_name,
configuration_templates,
date_created,
date_updated,
description,
resource_lifecycle_config,
versions
FROM aws.elasticbeanstalk.applications
WHERE region = '{{ region }}' -- required
AND ApplicationNames = '{{ ApplicationNames }}'
;

INSERT examples

create_configuration_template

Creates an AWS 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

INSERT INTO aws.elasticbeanstalk.applications (
ApplicationName,
TemplateName,
region,
SolutionStackName,
PlatformArn,
SourceConfiguration,
EnvironmentId,
Description,
OptionSettings,
Tags
)
SELECT 
'{{ ApplicationName }}',
'{{ TemplateName }}',
'{{ region }}',
'{{ SolutionStackName }}',
'{{ PlatformArn }}',
'{{ SourceConfiguration }}',
'{{ EnvironmentId }}',
'{{ Description }}',
'{{ OptionSettings }}',
'{{ Tags }}'
RETURNING
application_name,
date_created,
date_updated,
deployment_status,
description,
environment_name,
option_settings,
platform_arn,
solution_stack_name,
template_name
;

create_application

Creates an application that has one configuration template named default and no application versions.

INSERT INTO aws.elasticbeanstalk.applications (
ApplicationName,
region,
Description,
ResourceLifecycleConfig,
Tags
)
SELECT 
'{{ ApplicationName }}',
'{{ region }}',
'{{ Description }}',
'{{ ResourceLifecycleConfig }}',
'{{ Tags }}'
RETURNING
application_arn,
application_name,
configuration_templates,
date_created,
date_updated,
description,
resource_lifecycle_config,
versions
;

Manifest

# Description fields are for documentation purposes
- name: applications
props:
  - name: ApplicationName
    value: "{{ ApplicationName }}"
    description: Required parameter for the applications resource.
  - name: TemplateName
    value: "{{ TemplateName }}"
    description: Required parameter for the applications resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the applications resource.
  - name: SolutionStackName
    value: "{{ SolutionStackName }}"
    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 AWS Elastic Beanstalk Developer Guide. You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration. Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.
    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 AWS Elastic Beanstalk Developer Guide. You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration. Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.
  - name: PlatformArn
    value: "{{ PlatformArn }}"
    description: The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide. If you specify PlatformArn, then don't specify SolutionStackName.
    description: The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide. If you specify PlatformArn, then don't specify SolutionStackName.
  - name: SourceConfiguration
    value: "{{ SourceConfiguration }}"
    description: An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration. Values specified in OptionSettings override any values obtained from the SourceConfiguration. You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName. Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.
    description: An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration. Values specified in OptionSettings override any values obtained from the SourceConfiguration. You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName. Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.
  - name: EnvironmentId
    value: "{{ EnvironmentId }}"
    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: 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.
  - name: Description
    value: "{{ Description }}"
    description: An optional description for this configuration.
    description: An optional description for this configuration.
  - name: OptionSettings
    value: "{{ OptionSettings }}"
    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 AWS Elastic Beanstalk Developer Guide.
    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 AWS Elastic Beanstalk Developer Guide.
  - name: Tags
    value: "{{ Tags }}"
    description: Specifies the tags applied to the configuration template.
    description: Specifies the tags applied to the configuration template.
  - name: ResourceLifecycleConfig
    value: "{{ ResourceLifecycleConfig }}"
    description: Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.
    description: Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.

UPDATE examples

update_application_resource_lifecycle

Modifies lifecycle settings for an application.

UPDATE aws.elasticbeanstalk.applications
SET 
-- No updatable properties
WHERE 
ApplicationName = '{{ ApplicationName }}' --required
AND ResourceLifecycleConfig = '{{ ResourceLifecycleConfig }}' --required
AND region = '{{ region }}' --required
RETURNING
application_name,
resource_lifecycle_config;

update_configuration_template

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

UPDATE aws.elasticbeanstalk.applications
SET 
-- No updatable properties
WHERE 
ApplicationName = '{{ ApplicationName }}' --required
AND TemplateName = '{{ TemplateName }}' --required
AND region = '{{ region }}' --required
AND Description = '{{ Description}}'
AND OptionSettings = '{{ OptionSettings}}'
AND OptionsToRemove = '{{ OptionsToRemove}}'
RETURNING
application_name,
date_created,
date_updated,
deployment_status,
description,
environment_name,
option_settings,
platform_arn,
solution_stack_name,
template_name;

update_application

Updates the specified application to have the specified properties. If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.

UPDATE aws.elasticbeanstalk.applications
SET 
-- No updatable properties
WHERE 
ApplicationName = '{{ ApplicationName }}' --required
AND region = '{{ region }}' --required
AND Description = '{{ Description}}'
RETURNING
application_arn,
application_name,
configuration_templates,
date_created,
date_updated,
description,
resource_lifecycle_config,
versions;

DELETE examples

delete_configuration_template

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.

DELETE FROM aws.elasticbeanstalk.applications
WHERE ApplicationName = '{{ ApplicationName }}' --required
AND TemplateName = '{{ TemplateName }}' --required
AND region = '{{ region }}' --required
;

delete_application

Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket. You cannot delete an application that has a running environment.

DELETE FROM aws.elasticbeanstalk.applications
WHERE ApplicationName = '{{ ApplicationName }}' --required
AND region = '{{ region }}' --required
AND TerminateEnvByForce = '{{ TerminateEnvByForce }}'
;