AWS::M2::Environment - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::M2::Environment

Specifies a runtime environment for a given runtime engine.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::M2::Environment",
  "Properties" : {
      "Description" : String,
      "EngineType" : String,
      "EngineVersion" : String,
      "HighAvailabilityConfig" : HighAvailabilityConfig,
      "InstanceType" : String,
      "KmsKeyId" : String,
      "Name" : String,
      "NetworkType" : String,
      "PreferredMaintenanceWindow" : String,
      "PubliclyAccessible" : Boolean,
      "SecurityGroupIds" : [ String, ... ],
      "StorageConfigurations" : [ StorageConfiguration, ... ],
      "SubnetIds" : [ String, ... ],
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::M2::Environment
Properties:
  Description: String
  EngineType: String
  EngineVersion: String
  HighAvailabilityConfig: 
    HighAvailabilityConfig
  InstanceType: String
  KmsKeyId: String
  Name: String
  NetworkType: String
  PreferredMaintenanceWindow: String
  PubliclyAccessible: Boolean
  SecurityGroupIds: 
    - String
  StorageConfigurations: 
    - StorageConfiguration
  SubnetIds: 
    - String
  Tags: 
    Key: Value

Properties

Description

The description of the runtime environment.

Required: No

Type: String

Minimum: 0

Maximum: 500

Update requires: Replacement

EngineType

The target platform for the runtime environment.

Required: Yes

Type: String

Allowed values: microfocus | bluage

Update requires: Replacement

EngineVersion

The version of the runtime engine.

Required: No

Type: String

Pattern: ^\S{1,10}$

Update requires: No interruption

HighAvailabilityConfig

Defines the details of a high availability configuration.

Required: No

Type: HighAvailabilityConfig

Update requires: No interruption

InstanceType

The instance type of the runtime environment.

Required: Yes

Type: String

Pattern: ^\S{1,20}$

Update requires: No interruption

KmsKeyId

The identifier of a customer managed key.

Required: No

Type: String

Maximum: 2048

Update requires: Replacement

Name

The name of the runtime environment.

Required: Yes

Type: String

Pattern: ^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$

Update requires: Replacement

NetworkType

The network type supported by the runtime environment.

Required: No

Type: String

Allowed values: ipv4 | dual

Update requires: Replacement

PreferredMaintenanceWindow

Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

If you do not provide a value, a random system-generated value will be assigned.

Required: No

Type: String

Pattern: ^\S{1,50}$

Update requires: No interruption

PubliclyAccessible

Specifies whether the runtime environment is publicly accessible.

Required: No

Type: Boolean

Update requires: Replacement

SecurityGroupIds

The list of security groups for the VPC associated with this runtime environment.

Required: No

Type: Array of String

Update requires: Replacement

StorageConfigurations

Defines the storage configuration for a runtime environment.

Required: No

Type: Array of StorageConfiguration

Update requires: Replacement

SubnetIds

The list of subnets associated with the VPC for this runtime environment.

Required: No

Type: Array of String

Update requires: Replacement

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Object of String

Pattern: ^(?!aws:).+$

Minimum: 0

Maximum: 256

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the environment Amazon Resource Name (ARN), such as the following:

{ "Ref": “SampleEnv” }

Returns a value similar to the following:

arn:aws:m2:us-west-2:1234567890:env/y3ca6bhaife2bcvxar3lpivfou

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

EnvironmentArn

The Amazon Resource Name (ARN) of the runtime environment.

EnvironmentId

The unique identifier of the runtime environment.