Databricks SDK for JavaScript
    Preparing search index...

    Interface S3StorageInfo

    A storage location in Amazon S3

    interface S3StorageInfo {
        cannedAcl?: string;
        destination?: string;
        enableEncryption?: boolean;
        encryptionType?: string;
        endpoint?: string;
        kmsKey?: string;
        region?: string;
    }
    Index

    Properties

    cannedAcl? destination? enableEncryption? encryptionType? endpoint? kmsKey? region?

    Properties

    cannedAcl?: string

    (Optional) Set canned access control list for the logs, e.g. bucket-owner-full-control. If canned_cal is set, please make sure the cluster iam role has s3:PutObjectAcl permission on the destination bucket and prefix. The full list of possible canned acl can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl. Please also note that by default only the object owner gets full controls. If you are using cross account role for writing data, you may want to set bucket-owner-full-control to make bucket owner able to read the logs.

    destination?: string

    S3 destination, e.g. s3://my-bucket/some-prefix Note that logs will be delivered using cluster iam role, please make sure you set cluster iam role and the role has write access to the destination. Please also note that you cannot use AWS keys to deliver logs.

    enableEncryption?: boolean

    (Optional) Flag to enable server side encryption, false by default.

    encryptionType?: string

    (Optional) The encryption type, it could be sse-s3 or sse-kms. It will be used only when encryption is enabled and the default type is sse-s3.

    endpoint?: string

    S3 endpoint, e.g. https://s3-us-west-2.amazonaws.com. Either region or endpoint needs to be set. If both are set, endpoint will be used.

    kmsKey?: string

    (Optional) Kms key which will be used if encryption is enabled and encryption type is set to sse-kms.

    region?: string

    S3 region, e.g. us-west-2. Either region or endpoint needs to be set. If both are set, endpoint will be used.

    Settings

    Member Visibility

    On This Page

    Properties