Skip to content

aws.elasticbeanstalk.describe_configuration_settings

Example SQL Queries

SELECT * FROM
aws.elasticbeanstalk.describe_configuration_settings
WHERE
"application_name" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
application_name Required Input Column

The application for the environment or configuration template.

VARCHAR
environment_name Input Column

The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

VARCHAR
template_name Input Column

The name of the configuration template to describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

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
configuration_settings

A list of ConfigurationSettingsDescription.

STRUCT(
"solution_stack_name" VARCHAR,
"platform_arn" VARCHAR,
"application_name" VARCHAR,
"template_name" VARCHAR,
"description" VARCHAR,
"environment_name" VARCHAR,
"deployment_status" VARCHAR,
"date_created" TIMESTAMP_S,
"date_updated" TIMESTAMP_S,
"option_settings" STRUCT(
"resource_name" VARCHAR,
"namespace" VARCHAR,
"option_name" VARCHAR,
"value" VARCHAR
)[]
)[]
Show child fields
configuration_settings[]
Show child fields
configuration_settings[].application_name

The name of the application associated with this configuration set.

configuration_settings[].date_created

The date (in UTC time) when this configuration set was created.

configuration_settings[].date_updated

The date (in UTC time) when this configuration set was last modified.

configuration_settings[].deployment_status

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.

configuration_settings[].description

Describes this configuration set.

configuration_settings[].environment_name

If not null, the name of the environment for this configuration set.

configuration_settings[].option_settings[]
Show child fields
configuration_settings[].option_settings[].namespace

A unique namespace that identifies the option's associated AWS resource.

configuration_settings[].option_settings[].option_name

The name of the configuration option.

configuration_settings[].option_settings[].resource_name

A unique resource name for the option setting. Use it for a time–based scaling configuration option.

configuration_settings[].option_settings[].value

The current value for the configuration option.

configuration_settings[].platform_arn

The ARN of the platform version.

configuration_settings[].solution_stack_name

The name of the solution stack this configuration set uses.

configuration_settings[].template_name

If not null, the name of the configuration template for this configuration set.