s3_external_analytics_link Struct Reference

#include <couchbase/management/analytics_link.hxx>

Inheritance diagram for s3_external_analytics_link:

Public Member Functions
auto	link_type () const -> analytics_link_type override
	Returns the type of this analytics link.
	s3_external_analytics_link ()=default
	Constructs an empty external S3 analytics link.
	s3_external_analytics_link (std::string name, std::string dataverse_name, std::string access_key_id, std::string secret_access_key, std::string region, std::optional< std::string > session_token={}, std::optional< std::string > service_endpoint={})
	Constructs and initializes an external S3 analytics link with the given parameters.
Public Member Functions inherited from analytics_link
virtual	~analytics_link ()=default
	analytics_link ()=default
	analytics_link (std::string name, std::string dataverse_name)

Public Attributes
std::string	access_key_id
std::string	secret_access_key
std::string	region
std::optional< std::string >	session_token {}
std::optional< std::string >	service_endpoint {}
Public Attributes inherited from analytics_link
std::string	name
std::string	dataverse_name

Constructor & Destructor Documentation

s3_external_analytics_link() [1/2]

s3_external_analytics_link ( )

default

Constructs an empty external S3 analytics link.

Committed

Generally available API and should be preferred in production

Since

1.0.0

s3_external_analytics_link() [2/2]

s3_external_analytics_link	(	std::string	name,
		std::string	dataverse_name,
		std::string	access_key_id,
		std::string	secret_access_key,
		std::string	region,
		std::optional< std::string >	session_token = {},
		std::optional< std::string >	service_endpoint = {} )

Constructs and initializes an external S3 analytics link with the given parameters.

Parameters

name	the name of the link
dataverse_name	the name of the dataverse the link belongs to
access_key_id	the AWS S3 access key
secret_access_key	the AWS S3 secret key
region	the AWS S3 region
session_token	the AWS S3 token if temporary credentials are provided
service_endpoint	the AWS S3 service endpoint

Committed

Generally available API and should be preferred in production

Since

1.0.0

Member Function Documentation

link_type()

auto link_type ( ) const -> analytics_link_type

inlineoverridevirtual

Returns the type of this analytics link.

Returns

the link type

Implements analytics_link.

Member Data Documentation

access_key_id

std::string access_key_id

region

std::string region

secret_access_key

std::string secret_access_key

service_endpoint

std::optional<std::string> service_endpoint {}

session_token

std::optional<std::string> session_token {}

---

The documentation for this struct was generated from the following file:

• couchbase/management/analytics_link.hxx