aws-native logo
AWS Native v0.53.0, Mar 14 23

aws-native.athena.getDataCatalog

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)
// Output-based functions aren't available in Java yet
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:

Description string

A description of the data catalog to be created.

Parameters object

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

Tags List<Pulumi.AwsNative.Athena.Outputs.DataCatalogTag>

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.

Description string

A description of the data catalog to be created.

Parameters interface{}

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

Tags []DataCatalogTag

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.

description String

A description of the data catalog to be created.

parameters Object

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

tags List<DataCatalogTag>

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.

description string

A description of the data catalog to be created.

parameters any

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

tags DataCatalogTag[]

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.

description str

A description of the data catalog to be created.

parameters Any

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

tags Sequence[DataCatalogTag]

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.

description String

A description of the data catalog to be created.

parameters Any

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

tags List<Property Map>

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

type "LAMBDA" | "GLUE" | "HIVE"

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

Supporting Types

DataCatalogTag

Key string
Value string
Key string
Value string
key String
value String
key string
value string
key str
value str
key String
value String

DataCatalogType

Package Details

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