Skip to content

EndpointSetting

Source code in docs_src/capo_database_migration_service/types/endpoint_setting.py
class EndpointSetting(TypedDict, closed=True):
    name: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The name that you want to give the endpoint settings.</p>"""
    type: NotRequired[
        "capo_database_migration_service.types.endpoint_setting_type_value.EndpointSettingTypeValue"
    ]
    """<p>The type of endpoint. Valid values are <code>source</code> and <code>target</code>.</p>"""
    enum_values: NotRequired[
        "capo_database_migration_service.types.endpoint_setting_enum_values.EndpointSettingEnumValues"
    ]
    """<p>Enumerated values to use for this endpoint.</p>"""
    sensitive: NotRequired[
        "capo_database_migration_service.types.boolean_optional.BooleanOptional"
    ]
    """<p>A value that marks this endpoint setting as sensitive.</p>"""
    units: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The unit of measure for this endpoint setting.</p>"""
    applicability: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The relevance or validity of an endpoint setting for an engine name and its endpoint type.</p>"""
    int_value_min: NotRequired[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ]
    """<p>The minimum value of an endpoint setting that is of type <code>int</code>.</p>"""
    int_value_max: NotRequired[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ]
    """<p>The maximum value of an endpoint setting that is of type <code>int</code>.</p>"""
    default_value: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The default value of the endpoint setting if no value is specified using <code>CreateEndpoint</code> or <code>ModifyEndpoint</code>.</p>"""

applicability instance-attribute

applicability: NotRequired[String]

The relevance or validity of an endpoint setting for an engine name and its endpoint type.

default_value instance-attribute

default_value: NotRequired[String]

The default value of the endpoint setting if no value is specified using CreateEndpoint or ModifyEndpoint.

enum_values instance-attribute

enum_values: NotRequired[EndpointSettingEnumValues]

Enumerated values to use for this endpoint.

int_value_max instance-attribute

int_value_max: NotRequired[IntegerOptional]

The maximum value of an endpoint setting that is of type int.

int_value_min instance-attribute

int_value_min: NotRequired[IntegerOptional]

The minimum value of an endpoint setting that is of type int.

name instance-attribute

name: NotRequired[String]

The name that you want to give the endpoint settings.

sensitive instance-attribute

sensitive: NotRequired[BooleanOptional]

A value that marks this endpoint setting as sensitive.

type instance-attribute

type: NotRequired[EndpointSettingTypeValue]

The type of endpoint. Valid values are source and target.

units instance-attribute

units: NotRequired[String]

The unit of measure for this endpoint setting.