Skip to content

CreateEnvironmentRequest

Source code in docs_src/capo_m2/types/create_environment_request.py
class CreateEnvironmentRequest(TypedDict, closed=True):
    name: "capo_m2.types.entity_name.EntityName"
    """<p>The name of the runtime environment. Must be unique within the account.</p>"""
    instance_type: "capo_m2.types.string20.String20"
    """<p>The type of instance for the runtime environment.</p>"""
    description: NotRequired["capo_m2.types.entity_description.EntityDescription"]
    """<p>The description of the runtime environment.</p>"""
    engine_type: "capo_m2.types.engine_type.EngineType"
    """<p>The engine type for the runtime environment.</p>"""
    engine_version: NotRequired["capo_m2.types.engine_version.EngineVersion"]
    """<p>The version of the engine type for the runtime environment.</p>"""
    subnet_ids: NotRequired["capo_m2.types.string50_list.String50List"]
    """<p>The list of subnets associated with the VPC for this runtime environment.</p>"""
    security_group_ids: NotRequired["capo_m2.types.string50_list.String50List"]
    """<p>The list of security groups for the VPC associated with this runtime environment.</p>"""
    storage_configurations: NotRequired[
        "capo_m2.types.storage_configuration_list.StorageConfigurationList"
    ]
    """<p>Optional. The storage configurations for this runtime environment.</p>"""
    publicly_accessible: "capo_m2.types.boolean.Boolean"
    """<p>Specifies whether the runtime environment is publicly accessible.</p>"""
    high_availability_config: NotRequired[
        "capo_m2.types.high_availability_config.HighAvailabilityConfig"
    ]
    """<p>The details of a high availability configuration for this runtime environment.</p>"""
    tags: NotRequired["capo_m2.types.tag_map.TagMap"]
    """<p>The tags for the runtime environment.</p>"""
    preferred_maintenance_window: NotRequired["capo_m2.types.string50.String50"]
    """<p>Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format <code>ddd:hh24:mi-ddd:hh24:mi</code> and must be less than 24 hours. The following two examples are valid maintenance windows: <code>sun:23:45-mon:00:15</code> or <code>sat:01:00-sat:03:00</code>. </p> <p>If you do not provide a value, a random system-generated value will be assigned.</p>"""
    network_type: NotRequired["capo_m2.types.network_type.NetworkType"]
    """<p>The network type required for the runtime environment.</p>"""
    client_token: NotRequired["capo_m2.types.client_token.ClientToken"]
    """<p>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. </p>"""
    kms_key_id: NotRequired["str"]
    """<p>The identifier of a customer managed key.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

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 instance-attribute

description: NotRequired[EntityDescription]

The description of the runtime environment.

engine_type instance-attribute

engine_type: EngineType

The engine type for the runtime environment.

engine_version instance-attribute

engine_version: NotRequired[EngineVersion]

The version of the engine type for the runtime environment.

high_availability_config instance-attribute

high_availability_config: NotRequired[HighAvailabilityConfig]

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

instance_type instance-attribute

instance_type: String20

The type of instance for the runtime environment.

kms_key_id instance-attribute

kms_key_id: NotRequired[str]

The identifier of a customer managed key.

name instance-attribute

name: EntityName

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

network_type instance-attribute

network_type: NotRequired[NetworkType]

The network type required for the runtime environment.

preferred_maintenance_window instance-attribute

preferred_maintenance_window: NotRequired[String50]

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.

publicly_accessible instance-attribute

publicly_accessible: Boolean

Specifies whether the runtime environment is publicly accessible.

security_group_ids instance-attribute

security_group_ids: NotRequired[String50List]

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

storage_configurations instance-attribute

storage_configurations: NotRequired[StorageConfigurationList]

Optional. The storage configurations for this runtime environment.

subnet_ids instance-attribute

subnet_ids: NotRequired[String50List]

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

tags instance-attribute

tags: NotRequired[TagMap]

The tags for the runtime environment.