configuration_settings

Creates, updates, deletes, gets or lists a configuration_settings resource.

Overview

Name	configuration_settings
Type	Resource
Id	aws.elasticbeanstalk.configuration_settings

Fields

The following fields are returned by SELECT queries:

describe_configuration_settings

Name	Datatype	Description
application_name	string	The name of the application associated with this configuration set.
date_created	string	The date (in UTC time) when this configuration set was created.
date_updated	string	The date (in UTC time) when this configuration set was last modified.
deployment_status	string	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.
description	string	Describes this configuration set.
environment_name	string	If not null, the name of the environment for this configuration set.
option_settings	string	A list of the configuration options and their values in this configuration set.
platform_arn	string	The ARN of the platform version.
solution_stack_name	string	The name of the solution stack this configuration set uses.
template_name	string	If not null, the name of the configuration template for this configuration set.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_configuration_settings	select	ApplicationName, region	TemplateName, EnvironmentName	Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment. When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy. Related Topics DeleteEnvironmentConfiguration
validate_configuration_settings	exec	ApplicationName, OptionSettings, region	TemplateName, EnvironmentName	Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid. This action returns a list of messages indicating any errors or warnings associated with the selection of option values.

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 that the configuration template or environment belongs to.
OptionSettings	array	A list of the options and desired values to evaluate.
region	string	AWS region (default: us-east-1)
EnvironmentName	string	The name of the environment to validate the settings against. Condition: You cannot specify both this and a configuration template name.
TemplateName	string	The name of the configuration template to validate the settings against. Condition: You cannot specify both this and an environment name.

SELECT examples

describe_configuration_settings

Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment. When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy. Related Topics DeleteEnvironmentConfiguration

SELECT
application_name,
date_created,
date_updated,
deployment_status,
description,
environment_name,
option_settings,
platform_arn,
solution_stack_name,
template_name
FROM aws.elasticbeanstalk.configuration_settings
WHERE ApplicationName = '{{ ApplicationName }}' -- required
AND region = '{{ region }}' -- required
AND TemplateName = '{{ TemplateName }}'
AND EnvironmentName = '{{ EnvironmentName }}'
;

Lifecycle Methods

validate_configuration_settings

Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid. This action returns a list of messages indicating any errors or warnings associated with the selection of option values.

EXEC aws.elasticbeanstalk.configuration_settings.validate_configuration_settings 
@ApplicationName='{{ ApplicationName }}' --required, 
@OptionSettings='{{ OptionSettings }}' --required, 
@region='{{ region }}' --required, 
@TemplateName='{{ TemplateName }}', 
@EnvironmentName='{{ EnvironmentName }}'
;