Package software.amazon.awscdk.services.athena

Interface CfnNamedQueryProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnNamedQueryProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:04.544Z")
@Stability(Stable)
public interface CfnNamedQueryProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnNamedQuery.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.athena.*;
 CfnNamedQueryProps cfnNamedQueryProps = CfnNamedQueryProps.builder()
         .database("database")
         .queryString("queryString")
         // the properties below are optional
         .description("description")
         .name("name")
         .workGroup("workGroup")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnNamedQueryProps.Builder	A builder for CfnNamedQueryProps
static final class	CfnNamedQueryProps.Jsii$Proxy	An implementation for CfnNamedQueryProps

Method Summary

Modifier and Type	Method	Description
static CfnNamedQueryProps.Builder	builder()
String	getDatabase()	The database to which the query belongs.
default String	getDescription()	The query description.
default String	getName()	The query name.
String	getQueryString()	The SQL statements that make up the query.
default String	getWorkGroup()	The name of the workgroup that contains the named query.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatabase

@Stability(Stable)
@NotNull
String getDatabase()

The database to which the query belongs.

See Also:

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

getQueryString

@Stability(Stable)
@NotNull
String getQueryString()

The SQL statements that make up the query.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The query description.

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The query name.

See Also:

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

getWorkGroup

@Stability(Stable)
@Nullable
default String getWorkGroup()

The name of the workgroup that contains the named query.

See Also:

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

builder

@Stability(Stable)
static CfnNamedQueryProps.Builder builder()

Returns:

a CfnNamedQueryProps.Builder of CfnNamedQueryProps