SecurityLake / Client / create_custom_log_source

create_custom_log_source#

SecurityLake.Client.create_custom_log_source(**kwargs)#

Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to create a custom source. Security Lake can collect logs and events from third-party custom sources. After creating the appropriate IAM role to invoke Glue crawler, use this API to add a custom source name in Security Lake. This operation creates a partition in the Amazon S3 bucket for Security Lake as the target location for log files from the custom source. In addition, this operation also creates an associated Glue table and an Glue crawler.

See also: AWS API Documentation

Request Syntax

response = client.create_custom_log_source(
    configuration={
        'crawlerConfiguration': {
            'roleArn': 'string'
        },
        'providerIdentity': {
            'externalId': 'string',
            'principal': 'string'
        }
    },
    eventClasses=[
        'string',
    ],
    sourceName='string',
    sourceVersion='string'
)
Parameters:

  • configuration (dict) –

    [REQUIRED]

    The configuration used for the third-party custom source.

    • crawlerConfiguration (dict) – [REQUIRED]

      The configuration used for the Glue Crawler for a third-party custom source.

      • roleArn (string) – [REQUIRED]

        The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be used by the Glue crawler. The recommended IAM policies are:

        • The managed policy AWSGlueServiceRole

        • A custom policy granting access to your Amazon S3 Data Lake

    • providerIdentity (dict) – [REQUIRED]

      The identity of the log provider for the third-party custom source.

      • externalId (string) – [REQUIRED]

        The external ID used to establish trust relationship with the Amazon Web Services identity.

      • principal (string) – [REQUIRED]

        The Amazon Web Services identity principal.

  • eventClasses (list) –

    The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of data that the custom source will send to Security Lake. The supported event classes are:

    • ACCESS_ACTIVITY

    • FILE_ACTIVITY

    • KERNEL_ACTIVITY

    • KERNEL_EXTENSION

    • MEMORY_ACTIVITY

    • MODULE_ACTIVITY

    • PROCESS_ACTIVITY

    • REGISTRY_KEY_ACTIVITY

    • REGISTRY_VALUE_ACTIVITY

    • RESOURCE_ACTIVITY

    • SCHEDULED_JOB_ACTIVITY

    • SECURITY_FINDING

    • ACCOUNT_CHANGE

    • AUTHENTICATION

    • AUTHORIZATION

    • ENTITY_MANAGEMENT_AUDIT

    • DHCP_ACTIVITY

    • NETWORK_ACTIVITY

    • DNS_ACTIVITY

    • FTP_ACTIVITY

    • HTTP_ACTIVITY

    • RDP_ACTIVITY

    • SMB_ACTIVITY

    • SSH_ACTIVITY

    • CONFIG_STATE

    • INVENTORY_INFO

    • EMAIL_ACTIVITY

    • API_ACTIVITY

    • CLOUD_API

    • (string) –

  • sourceName (string) –

    [REQUIRED]

    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.

  • sourceVersion (string) – Specify the source version for the third-party custom source, to limit log collection to a specific version of custom data source.

Return type:

dict

Returns:

Response Syntax

{
    'source': {
        'attributes': {
            'crawlerArn': 'string',
            'databaseArn': 'string',
            'tableArn': 'string'
        },
        'provider': {
            'location': 'string',
            'roleArn': 'string'
        },
        'sourceName': 'string',
        'sourceVersion': 'string'
    }
}

Response Structure

  • (dict) –

    • source (dict) –

      The third-party custom source that was created.

      • attributes (dict) –

        The attributes of a third-party custom source.

        • crawlerArn (string) –

          The ARN of the Glue crawler.

        • databaseArn (string) –

          The ARN of the Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

        • tableArn (string) –

          The ARN of the Glue table.

      • provider (dict) –

        The details of the log provider for a third-party custom source.

        • location (string) –

          The location of the partition in the Amazon S3 bucket for Security Lake.

        • roleArn (string) –

          The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text ‘Security Lake’. The IAM role must trust the logProviderAccountId to assume the role.

      • sourceName (string) –

        The name for a third-party custom source. This must be a Regionally unique value.

      • sourceVersion (string) –

        The version for a third-party custom source. This must be a Regionally unique value.

Exceptions