[ aws . m2 ]

create-environment

Description

Creates a runtime environment for a given runtime engine.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-environment
[--client-token <value>]
[--description <value>]
--engine-type <value>
[--engine-version <value>]
[--high-availability-config <value>]
--instance-type <value>
--name <value>
[--preferred-maintenance-window <value>]
[--publicly-accessible | --no-publicly-accessible]
[--security-group-ids <value>]
[--storage-configurations <value>]
[--subnet-ids <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--client-token (string)

Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

--description (string)

The description of the environment.

--engine-type (string)

The engine type for the environment.

Possible values:

• microfocus

• bluage

--engine-version (string)

The version of the engine type for the environment.

--high-availability-config (structure)

The details of a high availability configuration for this runtime environment.

desiredCapacity -> (integer)

The number of instances in a high availability configuration.

Shorthand Syntax:

desiredCapacity=integer

JSON Syntax:

{
  "desiredCapacity": integer
}

--instance-type (string)

The type of instance for the environment.

--name (string)

The unique identifier 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 | --no-publicly-accessible (boolean)

Specifies whether the environment is publicly accessible.

--security-group-ids (list)

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

(string)

Syntax:

"string" "string" ...

--storage-configurations (list)

Optional. The storage configurations for this environment.

(structure)

Defines the storage configuration for an environment.

efs -> (structure)

Defines the storage configuration for an Amazon EFS file system.

fileSystemId -> (string)

The file system identifier.

mountPoint -> (string)

The mount point for the file system.

fsx -> (structure)

Defines the storage configuration for an Amazon FSx file system.

fileSystemId -> (string)

The file system identifier.

mountPoint -> (string)

The mount point for the file system.

Shorthand Syntax:

efs={fileSystemId=string,mountPoint=string},fsx={fileSystemId=string,mountPoint=string} ...

JSON Syntax:

[
  {
    "efs": {
      "fileSystemId": "string",
      "mountPoint": "string"
    },
    "fsx": {
      "fileSystemId": "string",
      "mountPoint": "string"
    }
  }
  ...
]

--subnet-ids (list)

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

(string)

Syntax:

"string" "string" ...

--tags (map)

The tags for the environment.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

environmentId -> (string)

The identifier of this environment.