Skip to content

aws.elasticbeanstalk.describe_configuration_options

Example SQL Queries

SELECT * FROM
aws.elasticbeanstalk.describe_configuration_options;

Description

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.

Table Definition

Column NameColumn Data Type
application_name Input Column

The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.

VARCHAR
environment_name Input Column

The name of the environment whose configuration options you want to describe.

VARCHAR
platform_arn Input Column

The ARN of the platform version.

VARCHAR
solution_stack_name Input Column

The name of the solution stack these configuration options belong to.

VARCHAR
template_name Input Column

The name of the configuration template whose configuration options you want to describe.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
_input_options Input Column
STRUCT(
"resource_name" VARCHAR,
"namespace" VARCHAR,
"option_name" VARCHAR
)[]
Show child fields
_input_options[]
Show child fields
_input_options[].namespace

A unique namespace identifying the option's associated AWS resource.

_input_options[].option_name

The name of the configuration option.

_input_options[].resource_name

A unique resource name for a time-based scaling configuration option.

options

A list of ConfigurationOptionDescription.

STRUCT(
"namespace" VARCHAR,
"name" VARCHAR,
"default_value" VARCHAR,
"change_severity" VARCHAR,
"user_defined" BOOLEAN,
"value_type" VARCHAR,
"value_options" VARCHAR[],
"min_value" BIGINT,
"max_value" BIGINT,
"max_length" BIGINT,
"regex" STRUCT(
"pattern" VARCHAR,
"label" VARCHAR
)
)[]
Show child fields
options[]
Show child fields
options[].change_severity

An indication of which action is required if the value for this configuration option changes:

  • NoInterruption : There is no interruption to the environment or application availability.

  • RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.

  • RestartApplicationServer : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.

options[].default_value

The default value for this configuration option.

options[].max_length

If specified, the configuration option must be a string value no longer than this value.

options[].max_value

If specified, the configuration option must be a numeric value less than this value.

options[].min_value

If specified, the configuration option must be a numeric value greater than this value.

options[].name

The name of the configuration option.

options[].namespace

A unique namespace identifying the option's associated AWS resource.

options[].regex

If specified, the configuration option must be a string value that satisfies this regular expression.

Show child fields
options[].regex.label

A unique name representing this regular expression.

options[].regex.pattern

The regular expression pattern that a string configuration option value with this restriction must match.

options[].user_defined

An indication of whether the user defined this configuration option:

  • true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings.

  • false : This configuration was not defined by the user.

Constraint: You can remove only UserDefined options from a configuration.

Valid Values: true | false

options[].value_options[]
options[].value_type

An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

  • Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.

  • List : Values for this option are multiple selections from the possible values.

  • Boolean : Values for this option are either true or false .

  • Json : Values for this option are a JSON representation of a ConfigDocument.