environments_list_only
Lists environments
in a region or regions, for all properties use environments
Overview
Name | environments_list_only |
Type | Resource |
Description | Resource Type definition for AWS::ElasticBeanstalk::Environment |
Id | aws.elasticbeanstalk.environments_list_only |
Fields
Name | Datatype | Description |
---|---|---|
platform_arn | string | The Amazon Resource Name (ARN) of the custom platform to use with the environment. |
application_name | string | The name of the application that is associated with this environment. |
description | string | Your description for this environment. |
environment_name | string | A unique name for the environment. |
operations_role | string | The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. |
tier | object | Specifies 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_label | string | The name of the application version to deploy. |
endpoint_url | string | |
option_settings | array | Key-value pairs defining configuration options for this environment, such as the instance type. |
template_name | string | The name of the Elastic Beanstalk configuration template to use with the environment. |
solution_stack_name | string | The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. |
cname_prefix | string | If 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. |
tags | array | Specifies the tags applied to resources in the environment. |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
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