CfnNamedQueryProps

class aws_cdk.aws_athena.CfnNamedQueryProps(*, database, query_string, description=None, name=None, work_group=None)

Bases: object

Properties for defining a CfnNamedQuery.

Parameters
  • database (str) – The database to which the query belongs.

  • query_string (str) – The SQL statements that make up the query.

  • description (Optional[str]) – The query description.

  • name (Optional[str]) – The query name.

  • work_group (Optional[str]) – The name of the workgroup that contains the named query.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_athena as athena

cfn_named_query_props = athena.CfnNamedQueryProps(
    database="database",
    query_string="queryString",

    # the properties below are optional
    description="description",
    name="name",
    work_group="workGroup"
)

Attributes

database

The database to which the query belongs.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html#cfn-athena-namedquery-database

Return type

str

description

The query description.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html#cfn-athena-namedquery-description

Return type

Optional[str]

name

The query name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html#cfn-athena-namedquery-name

Return type

Optional[str]

query_string

The SQL statements that make up the query.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html#cfn-athena-namedquery-querystring

Return type

str

work_group

The name of the workgroup that contains the named query.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html#cfn-athena-namedquery-workgroup

Return type

Optional[str]