Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. athena
  5. getDataCatalog

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.athena.getDataCatalog

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::Athena::DataCatalog

    Using getDataCatalog

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDataCatalog(args: GetDataCatalogArgs, opts?: InvokeOptions): Promise<GetDataCatalogResult>
function getDataCatalogOutput(args: GetDataCatalogOutputArgs, opts?: InvokeOptions): Output<GetDataCatalogResult>
    def get_data_catalog(name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetDataCatalogResult
def get_data_catalog_output(name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetDataCatalogResult]
    func LookupDataCatalog(ctx *Context, args *LookupDataCatalogArgs, opts ...InvokeOption) (*LookupDataCatalogResult, error)
func LookupDataCatalogOutput(ctx *Context, args *LookupDataCatalogOutputArgs, opts ...InvokeOption) LookupDataCatalogResultOutput

    > Note: This function is named LookupDataCatalog in the Go SDK.

    public static class GetDataCatalog 
{
    public static Task<GetDataCatalogResult> InvokeAsync(GetDataCatalogArgs args, InvokeOptions? opts = null)
    public static Output<GetDataCatalogResult> Invoke(GetDataCatalogInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDataCatalogResult> getDataCatalog(GetDataCatalogArgs args, InvokeOptions options)
public static Output<GetDataCatalogResult> getDataCatalog(GetDataCatalogArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:athena:getDataCatalog
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the data catalog to create. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
    Name string
    The name of the data catalog to create. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
    name String
    The name of the data catalog to create. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
    name string
    The name of the data catalog to create. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
    name str
    The name of the data catalog to create. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
    name String
    The name of the data catalog to create. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

    getDataCatalog Result

    The following output properties are available:

    ConnectionType string
    The type of connection for a FEDERATED data catalog
    Description string
    A description of the data catalog to be created.
    Error string
    Text of the error that occurred during data catalog creation or deletion.
    Parameters Dictionary<string, string>
    Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.
    Status Pulumi.AwsNative.Athena.DataCatalogStatus
    The status of the creation or deletion of the data catalog. LAMBDA, GLUE, and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED. The FEDERATED data catalog type is created asynchronously.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A list of comma separated tags to add to the data catalog that is created.
    Type Pulumi.AwsNative.Athena.DataCatalogType
    The type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore. FEDERATED is a federated catalog for which Athena creates the connection and the Lambda function for you based on the parameters that you pass.
    ConnectionType string
    The type of connection for a FEDERATED data catalog
    Description string
    A description of the data catalog to be created.
    Error string
    Text of the error that occurred during data catalog creation or deletion.
    Parameters map[string]string
    Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.
    Status DataCatalogStatus
    The status of the creation or deletion of the data catalog. LAMBDA, GLUE, and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED. The FEDERATED data catalog type is created asynchronously.
    Tags Tag
    A list of comma separated tags to add to the data catalog that is created.
    Type DataCatalogType
    The type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore. FEDERATED is a federated catalog for which Athena creates the connection and the Lambda function for you based on the parameters that you pass.
    connectionType String
    The type of connection for a FEDERATED data catalog
    description String
    A description of the data catalog to be created.
    error String
    Text of the error that occurred during data catalog creation or deletion.
    parameters Map<String,String>
    Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.
    status DataCatalogStatus
    The status of the creation or deletion of the data catalog. LAMBDA, GLUE, and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED. The FEDERATED data catalog type is created asynchronously.
    tags List<Tag>
    A list of comma separated tags to add to the data catalog that is created.
    type DataCatalogType
    The type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore. FEDERATED is a federated catalog for which Athena creates the connection and the Lambda function for you based on the parameters that you pass.
    connectionType string
    The type of connection for a FEDERATED data catalog
    description string
    A description of the data catalog to be created.
    error string
    Text of the error that occurred during data catalog creation or deletion.
    parameters {[key: string]: string}
    Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.
    status DataCatalogStatus
    The status of the creation or deletion of the data catalog. LAMBDA, GLUE, and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED. The FEDERATED data catalog type is created asynchronously.
    tags Tag[]
    A list of comma separated tags to add to the data catalog that is created.
    type DataCatalogType
    The type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore. FEDERATED is a federated catalog for which Athena creates the connection and the Lambda function for you based on the parameters that you pass.
    connection_type str
    The type of connection for a FEDERATED data catalog
    description str
    A description of the data catalog to be created.
    error str
    Text of the error that occurred during data catalog creation or deletion.
    parameters Mapping[str, str]
    Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.
    status DataCatalogStatus
    The status of the creation or deletion of the data catalog. LAMBDA, GLUE, and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED. The FEDERATED data catalog type is created asynchronously.
    tags Sequence[root_Tag]
    A list of comma separated tags to add to the data catalog that is created.
    type DataCatalogType
    The type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore. FEDERATED is a federated catalog for which Athena creates the connection and the Lambda function for you based on the parameters that you pass.
    connectionType String
    The type of connection for a FEDERATED data catalog
    description String
    A description of the data catalog to be created.
    error String
    Text of the error that occurred during data catalog creation or deletion.
    parameters Map<String>
    Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.
    status "CREATE_IN_PROGRESS" | "CREATE_COMPLETE" | "CREATE_FAILED" | "CREATE_FAILED_CLEANUP_IN_PROGRESS" | "CREATE_FAILED_CLEANUP_COMPLETE" | "CREATE_FAILED_CLEANUP_FAILED" | "DELETE_IN_PROGRESS" | "DELETE_COMPLETE" | "DELETE_FAILED"
    The status of the creation or deletion of the data catalog. LAMBDA, GLUE, and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED. The FEDERATED data catalog type is created asynchronously.
    tags List<Property Map>
    A list of comma separated tags to add to the data catalog that is created.
    type "LAMBDA" | "GLUE" | "HIVE" | "FEDERATED"
    The type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore. FEDERATED is a federated catalog for which Athena creates the connection and the Lambda function for you based on the parameters that you pass.

    Supporting Types

    DataCatalogStatus

    DataCatalogType

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi
    pulumi/pulumi-aws-native