environment

Gets an individual environment resource

Overview

Name	environment
Type	Resource
Description	environment
Id	awscc.elasticbeanstalk.environment

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

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
platform_arn,
application_name,
description,
environment_name,
operations_role,
tier,
version_label,
endpoint_url,
option_settings,
template_name,
solution_stack_name,
cname_prefix,
tags
FROM awscc.elasticbeanstalk.environment
WHERE data__Identifier = '<EnvironmentName>';

Permissions

To operate on the environment resource, the following permissions are required:

Read

elasticbeanstalk:DescribeEnvironments,
elasticbeanstalk:DescribeConfigurationSettings,
elasticbeanstalk:ListTagsForResource

Update

elasticbeanstalk:DescribeEnvironments,
elasticbeanstalk:UpdateEnvironment,
elasticbeanstalk:UpdateTagsForResource,
elasticbeanstalk:AssociateEnvironmentOperationsRole,
elasticbeanstalk:DisassociateEnvironmentOperationsRole,
iam:PassRole

Delete

elasticbeanstalk:DescribeEnvironments,
elasticbeanstalk:TerminateEnvironment