Interface IS3ExternalAnalyticsLink

Provides options for configuring an analytics remote S3 link.

interface IS3ExternalAnalyticsLink {
    accessKeyId: string;
    dataverse: string;
    linkType: S3External;
    name: string;
    region: string;
    secretAccessKey?: string;
    serviceEndpoint?: string;
    sessionToken?: string;
}

Hierarchy (view full)

Implemented by

Properties

accessKeyId dataverse linkType name region secretAccessKey? serviceEndpoint? sessionToken?

Properties

accessKeyId

accessKeyId: string

The AWS S3 access key.

dataverse

dataverse: string

The dataverse that this link belongs to.

linkType

linkType: S3External

Specifies what type of analytics link this represents.

name

name: string

The name of this link.

region

region: string

The AWS S3 region.

Optional secretAccessKey

secretAccessKey?: string

The AWS S3 secret key.

Optional serviceEndpoint

serviceEndpoint?: string

The AWS S3 service endpoint.

Optional sessionToken

sessionToken?: string

The AWS S3 token if temporary credentials are provided. Only available in Couchbase Server 7.0 and above.

Settings

Member Visibility

Theme

On This Page

accessKeyIddataverselinkTypenameregionsecretAccessKeyserviceEndpointsessionToken