Skip to content

CreateCustomLogSourceRequest

Source code in docs_src/capo_securitylake/types/create_custom_log_source_request.py
class CreateCustomLogSourceRequest(TypedDict, closed=True):
    source_name: "capo_securitylake.types.custom_log_source_name.CustomLogSourceName"
    """<p>Specify the name for a third-party custom source. This must be a Regionally unique value. The <code>sourceName</code> you enter here, is used in the <code>LogProviderRole</code> name which follows the convention <code>AmazonSecurityLake-Provider-{name of the custom source}-{region}</code>. You must use a <code>CustomLogSource</code> name that is shorter than or equal to 20 characters. This ensures that the <code>LogProviderRole</code> name is below the 64 character limit.</p>"""
    source_version: NotRequired[
        "capo_securitylake.types.custom_log_source_version.CustomLogSourceVersion"
    ]
    """<p>Specify the source version for the third-party custom source, to limit log collection to a specific version of custom data source.</p>"""
    event_classes: NotRequired[
        "capo_securitylake.types.ocsf_event_class_list.OcsfEventClassList"
    ]
    """<p>The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of data that the custom source will send to Security Lake. For the list of supported event classes, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/adding-custom-sources.html#ocsf-eventclass">Amazon Security Lake User Guide</a>.</p>"""
    configuration: "capo_securitylake.types.custom_log_source_configuration.CustomLogSourceConfiguration"
    """<p>The configuration used for the third-party custom source.</p>"""

configuration instance-attribute

The configuration used for the third-party custom source.

event_classes instance-attribute

event_classes: NotRequired[OcsfEventClassList]

The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of data that the custom source will send to Security Lake. For the list of supported event classes, see the Amazon Security Lake User Guide.

source_name instance-attribute

source_name: CustomLogSourceName

Specify the name for a third-party custom source. This must be a Regionally unique value. The sourceName you enter here, is used in the LogProviderRole name which follows the convention AmazonSecurityLake-Provider-{name of the custom source}-{region}. You must use a CustomLogSource name that is shorter than or equal to 20 characters. This ensures that the LogProviderRole name is below the 64 character limit.

source_version instance-attribute

source_version: NotRequired[CustomLogSourceVersion]

Specify the source version for the third-party custom source, to limit log collection to a specific version of custom data source.