Skip to content

SettingEntry

Source code in docs_src/capo_directory_service/types/setting_entry.py
class SettingEntry(TypedDict, closed=True):
    type: NotRequired[
        "capo_directory_service.types.directory_configuration_setting_type.DirectoryConfigurationSettingType"
    ]
    """<p>The type, or category, of a directory setting. Similar settings have the same type. For example, <code>Protocol</code>, <code>Cipher</code>, or <code>Certificate-Based Authentication</code>.</p>"""
    name: NotRequired[
        "capo_directory_service.types.directory_configuration_setting_name.DirectoryConfigurationSettingName"
    ]
    """<p>The name of the directory setting. For example:</p> <p> <code>TLS_1_0</code> </p>"""
    allowed_values: NotRequired[
        "capo_directory_service.types.directory_configuration_setting_allowed_values.DirectoryConfigurationSettingAllowedValues"
    ]
    """<p>The valid range of values for the directory setting. These values depend on the <code>DataType</code> of your directory.</p>"""
    applied_value: NotRequired[
        "capo_directory_service.types.directory_configuration_setting_value.DirectoryConfigurationSettingValue"
    ]
    """<p>The value of the directory setting that is applied to the directory.</p>"""
    requested_value: NotRequired[
        "capo_directory_service.types.directory_configuration_setting_value.DirectoryConfigurationSettingValue"
    ]
    """<p>The value that was last requested for the directory setting.</p>"""
    request_status: NotRequired[
        "capo_directory_service.types.directory_configuration_status.DirectoryConfigurationStatus"
    ]
    """<p>The overall status of the request to update the directory setting request. If the directory setting is deployed in more than one region, and the request fails in any region, the overall status is <code>Failed</code>.</p>"""
    request_detailed_status: NotRequired[
        "capo_directory_service.types.directory_configuration_setting_request_detailed_status.DirectoryConfigurationSettingRequestDetailedStatus"
    ]
    """<p>Details about the status of the request to update the directory setting. If the directory setting is deployed in more than one region, status is returned for the request in each region where the setting is deployed.</p>"""
    request_status_message: NotRequired[
        "capo_directory_service.types.directory_configuration_setting_request_status_message.DirectoryConfigurationSettingRequestStatusMessage"
    ]
    """<p>The last status message for the directory status request.</p>"""
    last_updated_date_time: NotRequired[
        "capo_directory_service.types.directory_configuration_setting_last_updated_date_time.DirectoryConfigurationSettingLastUpdatedDateTime"
    ]
    """<p>The date and time when the directory setting was last updated.</p>"""
    last_requested_date_time: NotRequired[
        "capo_directory_service.types.directory_configuration_setting_last_requested_date_time.DirectoryConfigurationSettingLastRequestedDateTime"
    ]
    """<p>The date and time when the request to update a directory setting was last submitted.</p>"""
    data_type: NotRequired[
        "capo_directory_service.types.directory_configuration_setting_data_type.DirectoryConfigurationSettingDataType"
    ]
    """<p>The data type of a directory setting. This is used to define the <code>AllowedValues</code> of a setting. For example a data type can be <code>Boolean</code>, <code>DurationInSeconds</code>, or <code>Enum</code>.</p>"""

allowed_values instance-attribute

allowed_values: NotRequired[DirectoryConfigurationSettingAllowedValues]

The valid range of values for the directory setting. These values depend on the DataType of your directory.

applied_value instance-attribute

applied_value: NotRequired[DirectoryConfigurationSettingValue]

The value of the directory setting that is applied to the directory.

data_type instance-attribute

data_type: NotRequired[DirectoryConfigurationSettingDataType]

The data type of a directory setting. This is used to define the AllowedValues of a setting. For example a data type can be Boolean, DurationInSeconds, or Enum.

last_requested_date_time instance-attribute

last_requested_date_time: NotRequired[
    DirectoryConfigurationSettingLastRequestedDateTime
]

The date and time when the request to update a directory setting was last submitted.

last_updated_date_time instance-attribute

last_updated_date_time: NotRequired[DirectoryConfigurationSettingLastUpdatedDateTime]

The date and time when the directory setting was last updated.

name instance-attribute

The name of the directory setting. For example:

TLS_1_0

request_detailed_status instance-attribute

request_detailed_status: NotRequired[DirectoryConfigurationSettingRequestDetailedStatus]

Details about the status of the request to update the directory setting. If the directory setting is deployed in more than one region, status is returned for the request in each region where the setting is deployed.

request_status instance-attribute

request_status: NotRequired[DirectoryConfigurationStatus]

The overall status of the request to update the directory setting request. If the directory setting is deployed in more than one region, and the request fails in any region, the overall status is Failed.

request_status_message instance-attribute

request_status_message: NotRequired[DirectoryConfigurationSettingRequestStatusMessage]

The last status message for the directory status request.

requested_value instance-attribute

requested_value: NotRequired[DirectoryConfigurationSettingValue]

The value that was last requested for the directory setting.

type instance-attribute

The type, or category, of a directory setting. Similar settings have the same type. For example, Protocol, Cipher, or Certificate-Based Authentication.