Skip to main content

environments_list_only

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

Overview

Nameenvironments_list_only
TypeResource
DescriptionRepresents a runtime environment that can run migrated mainframe applications.
Idaws.m2.environments_list_only

Fields

NameDatatypeDescription
descriptionstringThe description of the environment.
engine_typestringThe target platform for the environment.
engine_versionstringThe version of the runtime engine for the environment.
environment_arnstringThe Amazon Resource Name (ARN) of the runtime environment.
environment_idstringThe unique identifier of the environment.
high_availability_configobjectDefines the details of a high availability configuration.
instance_typestringThe type of instance underlying the environment.
kms_key_idstringThe ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting environment-related resources.
namestringThe name of the environment.
preferred_maintenance_windowstringConfigures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.
publicly_accessiblebooleanSpecifies whether the environment is publicly accessible.
security_group_idsarrayThe list of security groups for the VPC associated with this environment.
storage_configurationsarrayThe storage configurations defined for the runtime environment.
subnet_idsarrayThe unique identifiers of the subnets assigned to this runtime environment.
tagsobjectTags associated to this environment.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all environments in a region.

SELECT
region,
environment_arn
FROM aws.m2.environments_list_only
WHERE region = 'us-east-1';

Permissions

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