environment

Gets an individual environment resource

Overview

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

Fields

Name	Datatype	Description
description	string	The description of the environment.
engine_type	string
engine_version	string	The version of the runtime engine for the environment.
environment_arn	string	The Amazon Resource Name (ARN) of the runtime environment.
environment_id	string	The unique identifier of the environment.
high_availability_config	object
instance_type	string	The type of instance underlying the environment.
kms_key_id	string	The ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting environment-related resources.
name	string	The name of the environment.
preferred_maintenance_window	string	Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.
publicly_accessible	boolean	Specifies whether the environment is publicly accessible.
security_group_ids	array	The list of security groups for the VPC associated with this environment.
storage_configurations	array	The storage configurations defined for the runtime environment.
subnet_ids	array	The unique identifiers of the subnets assigned to this runtime environment.
tags	object	Tags associated to this environment.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
description,
engine_type,
engine_version,
environment_arn,
environment_id,
high_availability_config,
instance_type,
kms_key_id,
name,
preferred_maintenance_window,
publicly_accessible,
security_group_ids,
storage_configurations,
subnet_ids,
tags
FROM awscc.m2.environment
WHERE data__Identifier = '<EnvironmentArn>';

Permissions

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

Read

m2:ListTagsForResource,
m2:GetEnvironment

Update

m2:TagResource,
m2:UntagResource,
m2:ListTagsForResource,
m2:GetEnvironment,
m2:UpdateEnvironment

Delete

elasticloadbalancing:DeleteLoadBalancer,
m2:DeleteEnvironment,
m2:GetEnvironment