Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Interface CreateEnvironmentRequest



clientToken?: 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 runtime environment.

engineType: undefined | string

The engine type for the runtime environment.

engineVersion?: string

The version of the engine type for the runtime environment.

highAvailabilityConfig?: HighAvailabilityConfig

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

instanceType: undefined | string

The type of instance for the runtime environment.

kmsKeyId?: string

The identifier of a customer managed key.

name: undefined | string

The name of the runtime environment. Must be unique within the account.

preferredMaintenanceWindow?: string

Configures the maintenance window you want for the runtime environment. If you do not provide a value, a random system-generated value will be assigned.

publiclyAccessible?: boolean

Specifies whether the runtime environment is publicly accessible.

securityGroupIds?: string[]

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

storageConfigurations?: StorageConfiguration[]

Optional. The storage configurations for this runtime environment.

subnetIds?: string[]

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

tags?: Record<string, string>

The tags for the runtime environment.