Package software.amazon.awscdk.services.athena

Class CfnNamedQuery

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.athena.CfnNamedQuery

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:38.977Z")
@Stability(Stable)
public class CfnNamedQuery
extends CfnResource
implements IInspectable

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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnNamedQuery(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnNamedQuery(software.amazon.jsii.JsiiObjectRef objRef)
	CfnNamedQuery(software.constructs.Construct scope, String id, CfnNamedQueryProps props)

Method Summary

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

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnNamedQuery

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

CfnNamedQuery

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

CfnNamedQuery

@Stability(Stable)
public CfnNamedQuery(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnNamedQueryProps props)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 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

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrNamedQueryId

@Stability(Stable)
@NotNull
public String getAttrNamedQueryId()

The unique ID of the query.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDatabase

@Stability(Stable)
@NotNull
public String getDatabase()

The database to which the query belongs.

setDatabase

@Stability(Stable)
public void setDatabase(@NotNull
 String value)

The database to which the query belongs.

getQueryString

@Stability(Stable)
@NotNull
public String getQueryString()

The SQL statements that make up the query.

setQueryString

@Stability(Stable)
public void setQueryString(@NotNull
 String value)

The SQL statements that make up the query.

getDescription

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

The query description.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The query description.

getName

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

The query name.

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

The query name.

getWorkGroup

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

The name of the workgroup that contains the named query.

setWorkGroup

@Stability(Stable)
public void setWorkGroup(@Nullable
 String value)

The name of the workgroup that contains the named query.