configuration_templates

Creates, updates, deletes or gets a configuration_template resource or lists configuration_templates in a region

Overview

Name	configuration_templates
Type	Resource
Description	Resource Type definition for AWS::ElasticBeanstalk::ConfigurationTemplate
Id	aws.elasticbeanstalk.configuration_templates

Fields

Name	Datatype	Description
application_name	string	The name of the Elastic Beanstalk application to associate with this configuration template.
description	string	An optional description for this configuration.
environment_id	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.
option_settings	array	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](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the AWS Elastic Beanstalk Developer Guide.
platform_arn	string	The Amazon Resource Name (ARN) of the custom platform. For more information, see [Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the AWS Elastic Beanstalk Developer Guide.
solution_stack_name	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](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) 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.
source_configuration	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.
template_name	string	The name of the configuration template
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ApplicationName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all configuration_templates in a region.

SELECT
region,
application_name,
description,
environment_id,
option_settings,
platform_arn,
solution_stack_name,
source_configuration,
template_name
FROM aws.elasticbeanstalk.configuration_templates
WHERE region = 'us-east-1';

Gets all properties from an individual configuration_template.

SELECT
region,
application_name,
description,
environment_id,
option_settings,
platform_arn,
solution_stack_name,
source_configuration,
template_name
FROM aws.elasticbeanstalk.configuration_templates
WHERE region = 'us-east-1' AND data__Identifier = '<ApplicationName>|<TemplateName>';

INSERT example

Use the following StackQL query and manifest file to create a new configuration_template resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.elasticbeanstalk.configuration_templates (
 ApplicationName,
 region
)
SELECT 
'{{ ApplicationName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.elasticbeanstalk.configuration_templates (
 ApplicationName,
 Description,
 EnvironmentId,
 OptionSettings,
 PlatformArn,
 SolutionStackName,
 SourceConfiguration,
 region
)
SELECT 
 '{{ ApplicationName }}',
 '{{ Description }}',
 '{{ EnvironmentId }}',
 '{{ OptionSettings }}',
 '{{ PlatformArn }}',
 '{{ SolutionStackName }}',
 '{{ SourceConfiguration }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: configuration_template
    props:
      - name: ApplicationName
        value: '{{ ApplicationName }}'
      - name: Description
        value: '{{ Description }}'
      - name: EnvironmentId
        value: '{{ EnvironmentId }}'
      - name: OptionSettings
        value:
          - Namespace: '{{ Namespace }}'
            OptionName: '{{ OptionName }}'
            ResourceName: '{{ ResourceName }}'
            Value: '{{ Value }}'
      - name: PlatformArn
        value: '{{ PlatformArn }}'
      - name: SolutionStackName
        value: '{{ SolutionStackName }}'
      - name: SourceConfiguration
        value:
          ApplicationName: '{{ ApplicationName }}'
          TemplateName: '{{ TemplateName }}'

DELETE example

/*+ delete */
DELETE FROM aws.elasticbeanstalk.configuration_templates
WHERE data__Identifier = '<ApplicationName|TemplateName>'
AND region = 'us-east-1';

Permissions

To operate on the configuration_templates resource, the following permissions are required:

Create

elasticbeanstalk:CreateConfigurationTemplate

Read

elasticbeanstalk:DescribeConfigurationSettings

Update

elasticbeanstalk:UpdateConfigurationTemplate

Delete

elasticbeanstalk:DeleteConfigurationTemplate,
elasticbeanstalk:DescribeConfigurationSettings

List

elasticbeanstalk:DescribeApplications