Skip to main content

environments_list_only

Lists environments in a region or regions, for all properties use environments

Overview

Nameenvironments_list_only
TypeResource
DescriptionResource Type definition for AWS::ElasticBeanstalk::Environment
Idaws.elasticbeanstalk.environments_list_only

Fields

NameDatatypeDescription
platform_arnstringThe Amazon Resource Name (ARN) of the custom platform to use with the environment.
application_namestringThe name of the application that is associated with this environment.
descriptionstringYour description for this environment.
environment_namestringA unique name for the environment.
operations_rolestringThe Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
tierobjectSpecifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
version_labelstringThe name of the application version to deploy.
endpoint_urlstring
option_settingsarrayKey-value pairs defining configuration options for this environment, such as the instance type.
template_namestringThe name of the Elastic Beanstalk configuration template to use with the environment.
solution_stack_namestringThe name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
cname_prefixstringIf specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
tagsarraySpecifies the tags applied to resources in the environment.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all environments in a region.

SELECT
region,
environment_name
FROM aws.elasticbeanstalk.environments_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the environments_list_only resource, see environments