Databricks SDK for JavaScript
    Preparing search index...

    Interface CreateLogDeliveryConfigurationParams

    Log Delivery Configuration

    interface CreateLogDeliveryConfigurationParams {
        accountId?: string;
        configId?: string;
        configName?: string;
        creationTime?: bigint;
        credentialsId?: string;
        deliveryPathPrefix?: string;
        deliveryStartTime?: string;
        logDeliveryStatus?: LogDeliveryStatus;
        logType?: LogDeliveryType;
        outputFormat?: LogDeliveryOutputFormat;
        status?: LogDeliveryConfigStatus;
        storageConfigurationId?: string;
        updateTime?: bigint;
        workspaceIdsFilter?: bigint[];
    }
    Index

    Properties

    accountId? configId? configName? creationTime? credentialsId? deliveryPathPrefix? deliveryStartTime? logDeliveryStatus? logType? outputFormat? status? storageConfigurationId? updateTime? workspaceIdsFilter?

    Properties

    accountId?: string

    account ID.

    configId?: string

    The unique UUID of log delivery configuration

    configName?: string

    The optional human-readable name of the log delivery configuration. Defaults to empty.

    creationTime?: bigint

    Time in epoch milliseconds when the log delivery configuration was created.

    credentialsId?: string

    The ID for a method:credentials/create that represents the AWS IAM role with policy and trust relationship as described in the main billable usage documentation page. See Configure billable usage delivery.

    deliveryPathPrefix?: string

    The optional delivery path prefix within Amazon S3 storage. Defaults to empty, which means that logs are delivered to the root of the bucket. This must be a valid S3 object key. This must not start or end with a slash character.

    deliveryStartTime?: string

    This field applies only if log_type is BILLABLE_USAGE. This is the optional start month and year for delivery, specified in YYYY-MM format. Defaults to current year and month. BILLABLE_USAGE logs are not available for usage before March 2019 (2019-03).

    logDeliveryStatus?: LogDeliveryStatus

    The LogDeliveryStatus of this log delivery configuration

    logType?: LogDeliveryType

    Log delivery type. Supported values are:

    outputFormat?: LogDeliveryOutputFormat

    The file type of log delivery.

    • If log_type is BILLABLE_USAGE, this value must be CSV. Only the CSV (comma-separated values) format is supported. For the schema, see the View billable usage
    • If log_type is AUDIT_LOGS, this value must be JSON. Only the JSON (JavaScript Object Notation) format is supported. For the schema, see the Configuring audit logs.
    status?: LogDeliveryConfigStatus

    Status of log delivery configuration. Set to ENABLED (enabled) or DISABLED (disabled). Defaults to ENABLED. You can enable or disable the configuration later. Deletion of a configuration is not supported, so disable a log delivery configuration that is no longer needed.

    storageConfigurationId?: string

    The ID for a method:storage/create that represents the S3 bucket with bucket policy as described in the main billable usage documentation page. See Configure billable usage delivery.

    updateTime?: bigint

    Time in epoch milliseconds when the log delivery configuration was updated.

    workspaceIdsFilter?: bigint[]

    Optional filter that specifies workspace IDs to deliver logs for. By default the workspace filter is empty and log delivery applies at the account level, delivering workspace-level logs for all workspaces in your account, plus account level logs. You can optionally set this field to an array of workspace IDs (each one is an int64) to which log delivery should apply, in which case only workspace-level logs relating to the specified workspaces are delivered. If you plan to use different log delivery configurations for different workspaces, set this field explicitly. Be aware that delivery configurations mentioning specific workspaces won't apply to new workspaces created in the future, and delivery won't include account level logs. For some types of deployments there is only one workspace per account ID, so this field is unnecessary.

    Settings

    Member Visibility

    On This Page

    Properties