aws_sdk_appflow/types/

_glue_data_catalog_config.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>Specifies the configuration that Amazon AppFlow uses when it catalogs your data with the Glue Data Catalog. When Amazon AppFlow catalogs your data, it stores metadata in Data Catalog tables. This metadata represents the data that's transferred by the flow that you configure with these settings.</p><note>
/// <p>You can configure a flow with these settings only when the flow destination is Amazon S3.</p>
/// </note>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct GlueDataCatalogConfig {
    /// <p>The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data Catalog tables, databases, and partitions.</p>
    /// <p>For an example IAM policy that has the required permissions, see <a href="https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_id-based-policy-examples.html">Identity-based policy examples for Amazon AppFlow</a>.</p>
    pub role_arn: ::std::string::String,
    /// <p>The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon Web Services account. These tables contain metadata for the data that's transferred by the flow that you configure with this parameter.</p><note>
    /// <p>When you configure a new flow with this parameter, you must specify an existing database.</p>
    /// </note>
    pub database_name: ::std::string::String,
    /// <p>A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this setting. Amazon AppFlow adds the prefix to the beginning of the each table name.</p>
    pub table_prefix: ::std::string::String,
}
impl GlueDataCatalogConfig {
    /// <p>The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data Catalog tables, databases, and partitions.</p>
    /// <p>For an example IAM policy that has the required permissions, see <a href="https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_id-based-policy-examples.html">Identity-based policy examples for Amazon AppFlow</a>.</p>
    pub fn role_arn(&self) -> &str {
        use std::ops::Deref;
        self.role_arn.deref()
    }
    /// <p>The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon Web Services account. These tables contain metadata for the data that's transferred by the flow that you configure with this parameter.</p><note>
    /// <p>When you configure a new flow with this parameter, you must specify an existing database.</p>
    /// </note>
    pub fn database_name(&self) -> &str {
        use std::ops::Deref;
        self.database_name.deref()
    }
    /// <p>A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this setting. Amazon AppFlow adds the prefix to the beginning of the each table name.</p>
    pub fn table_prefix(&self) -> &str {
        use std::ops::Deref;
        self.table_prefix.deref()
    }
}
impl GlueDataCatalogConfig {
    /// Creates a new builder-style object to manufacture [`GlueDataCatalogConfig`](crate::types::GlueDataCatalogConfig).
    pub fn builder() -> crate::types::builders::GlueDataCatalogConfigBuilder {
        crate::types::builders::GlueDataCatalogConfigBuilder::default()
    }
}

/// A builder for [`GlueDataCatalogConfig`](crate::types::GlueDataCatalogConfig).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct GlueDataCatalogConfigBuilder {
    pub(crate) role_arn: ::std::option::Option<::std::string::String>,
    pub(crate) database_name: ::std::option::Option<::std::string::String>,
    pub(crate) table_prefix: ::std::option::Option<::std::string::String>,
}
impl GlueDataCatalogConfigBuilder {
    /// <p>The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data Catalog tables, databases, and partitions.</p>
    /// <p>For an example IAM policy that has the required permissions, see <a href="https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_id-based-policy-examples.html">Identity-based policy examples for Amazon AppFlow</a>.</p>
    /// This field is required.
    pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.role_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data Catalog tables, databases, and partitions.</p>
    /// <p>For an example IAM policy that has the required permissions, see <a href="https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_id-based-policy-examples.html">Identity-based policy examples for Amazon AppFlow</a>.</p>
    pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.role_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data Catalog tables, databases, and partitions.</p>
    /// <p>For an example IAM policy that has the required permissions, see <a href="https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_id-based-policy-examples.html">Identity-based policy examples for Amazon AppFlow</a>.</p>
    pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.role_arn
    }
    /// <p>The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon Web Services account. These tables contain metadata for the data that's transferred by the flow that you configure with this parameter.</p><note>
    /// <p>When you configure a new flow with this parameter, you must specify an existing database.</p>
    /// </note>
    /// This field is required.
    pub fn database_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.database_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon Web Services account. These tables contain metadata for the data that's transferred by the flow that you configure with this parameter.</p><note>
    /// <p>When you configure a new flow with this parameter, you must specify an existing database.</p>
    /// </note>
    pub fn set_database_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.database_name = input;
        self
    }
    /// <p>The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon Web Services account. These tables contain metadata for the data that's transferred by the flow that you configure with this parameter.</p><note>
    /// <p>When you configure a new flow with this parameter, you must specify an existing database.</p>
    /// </note>
    pub fn get_database_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.database_name
    }
    /// <p>A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this setting. Amazon AppFlow adds the prefix to the beginning of the each table name.</p>
    /// This field is required.
    pub fn table_prefix(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.table_prefix = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this setting. Amazon AppFlow adds the prefix to the beginning of the each table name.</p>
    pub fn set_table_prefix(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.table_prefix = input;
        self
    }
    /// <p>A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this setting. Amazon AppFlow adds the prefix to the beginning of the each table name.</p>
    pub fn get_table_prefix(&self) -> &::std::option::Option<::std::string::String> {
        &self.table_prefix
    }
    /// Consumes the builder and constructs a [`GlueDataCatalogConfig`](crate::types::GlueDataCatalogConfig).
    /// This method will fail if any of the following fields are not set:
    /// - [`role_arn`](crate::types::builders::GlueDataCatalogConfigBuilder::role_arn)
    /// - [`database_name`](crate::types::builders::GlueDataCatalogConfigBuilder::database_name)
    /// - [`table_prefix`](crate::types::builders::GlueDataCatalogConfigBuilder::table_prefix)
    pub fn build(self) -> ::std::result::Result<crate::types::GlueDataCatalogConfig, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::types::GlueDataCatalogConfig {
            role_arn: self.role_arn.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "role_arn",
                    "role_arn was not specified but it is required when building GlueDataCatalogConfig",
                )
            })?,
            database_name: self.database_name.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "database_name",
                    "database_name was not specified but it is required when building GlueDataCatalogConfig",
                )
            })?,
            table_prefix: self.table_prefix.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "table_prefix",
                    "table_prefix was not specified but it is required when building GlueDataCatalogConfig",
                )
            })?,
        })
    }
}