Struct aws_sdk_athena::input::create_data_catalog_input::Builder

pub struct Builder { /* private fields */ }

A builder for CreateDataCatalogInput.

Implementations

impl Builder

pub fn name(self, input: impl Into<String>) -> Self

The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.

pub fn set_name(self, input: Option<String>) -> Self

The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.

pub fn type(self, input: DataCatalogType) -> Self

The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.

pub fn set_type(self, input: Option<DataCatalogType>) -> Self

The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.

pub fn description(self, input: impl Into<String>) -> Self

A description of the data catalog to be created.

pub fn set_description(self, input: Option<String>) -> Self

A description of the data catalog to be created.

pub fn parameters(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to parameters.

To override the contents of this collection use set_parameters.

Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.

• For the HIVE data catalog type, use the following syntax. The metadata-function parameter is required. The sdk-version parameter is optional and defaults to the currently supported version.

  metadata-function=lambda_arn, sdk-version=version_number

• For the LAMBDA data catalog type, use one of the following sets of required parameters, but not both.

  • If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.

    metadata-function=lambda_arn, record-function=lambda_arn

  • If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.

    function=lambda_arn

• The GLUE type takes a catalog ID parameter and is required. The catalog_id is the account ID of the Amazon Web Services account to which the Glue Data Catalog belongs.

  catalog-id=catalog_id

  • The GLUE data catalog type also applies to the default AwsDataCatalog that already exists in your account, of which you can have only one and cannot modify.

  • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.

  • In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an INVALID_INPUT error.

pub fn set_parameters(self, input: Option<HashMap<String, String>>) -> Self

Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.

• For the HIVE data catalog type, use the following syntax. The metadata-function parameter is required. The sdk-version parameter is optional and defaults to the currently supported version.

  metadata-function=lambda_arn, sdk-version=version_number

• For the LAMBDA data catalog type, use one of the following sets of required parameters, but not both.

  • If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.

    metadata-function=lambda_arn, record-function=lambda_arn

  • If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.

    function=lambda_arn

• The GLUE type takes a catalog ID parameter and is required. The catalog_id is the account ID of the Amazon Web Services account to which the Glue Data Catalog belongs.

  catalog-id=catalog_id

  • The GLUE data catalog type also applies to the default AwsDataCatalog that already exists in your account, of which you can have only one and cannot modify.

  • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.

  • In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an INVALID_INPUT error.

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

A list of comma separated tags to add to the data catalog that is created.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

A list of comma separated tags to add to the data catalog that is created.

pub fn build(self) -> Result<CreateDataCatalogInput, BuildError>

Consumes the builder and constructs a CreateDataCatalogInput.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder