software.amazon.awscdk.services.athena

Class CfnNamedQuery

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.athena.CfnNamedQuery

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.495Z")
public class CfnNamedQuery
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Athena::NamedQuery`.

The AWS::Athena::NamedQuery resource specifies an Amazon Athena saved query, where QueryString contains the SQL query statements that make up the query.

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.*;
 CfnNamedQuery cfnNamedQuery = CfnNamedQuery.Builder.create(this, "MyCfnNamedQuery")
         .database("database")
         .queryString("queryString")
         // the properties below are optional
         .description("description")
         .name("name")
         .workGroup("workGroup")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnNamedQuery.Builder A fluent builder for CfnNamedQuery.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnNamedQuery(Construct scope, java.lang.String id, CfnNamedQueryProps props) Create a new `AWS::Athena::NamedQuery`.
protected	CfnNamedQuery(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnNamedQuery(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrNamedQueryId() The unique ID of the query.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDatabase() The database to which the query belongs.
java.lang.String	getDescription() The query description.
java.lang.String	getName() The query name.
java.lang.String	getQueryString() The SQL statements that make up the query.
java.lang.String	getWorkGroup() The name of the workgroup that contains the named query.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDatabase(java.lang.String value) The database to which the query belongs.
void	setDescription(java.lang.String value) The query description.
void	setName(java.lang.String value) The query name.
void	setQueryString(java.lang.String value) The SQL statements that make up the query.
void	setWorkGroup(java.lang.String value) The name of the workgroup that contains the named query.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnNamedQuery

protected CfnNamedQuery(software.amazon.jsii.JsiiObjectRef objRef)

CfnNamedQuery

protected CfnNamedQuery(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnNamedQuery

public CfnNamedQuery(Construct scope,
                     java.lang.String id,
                     CfnNamedQueryProps props)

Create a new `AWS::Athena::NamedQuery`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrNamedQueryId

public java.lang.String getAttrNamedQueryId()

The unique ID of the query.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDatabase

public java.lang.String getDatabase()

The database to which the query belongs.

setDatabase

public void setDatabase(java.lang.String value)

The database to which the query belongs.

getQueryString

public java.lang.String getQueryString()

The SQL statements that make up the query.

setQueryString

public void setQueryString(java.lang.String value)

The SQL statements that make up the query.

getDescription

public java.lang.String getDescription()

The query description.

setDescription

public void setDescription(java.lang.String value)

The query description.

getName

public java.lang.String getName()

The query name.

setName

public void setName(java.lang.String value)

The query name.

getWorkGroup

public java.lang.String getWorkGroup()

The name of the workgroup that contains the named query.

setWorkGroup

public void setWorkGroup(java.lang.String value)

The name of the workgroup that contains the named query.