Package software.amazon.awscdk.services.athena

Class CfnPreparedStatement

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.CfnPreparedStatement

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:02.993Z")
@Stability(Stable)
public class CfnPreparedStatement
extends CfnResource
implements IInspectable

Specifies a prepared statement for use with SQL queries in Athena.

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.*;
 CfnPreparedStatement cfnPreparedStatement = CfnPreparedStatement.Builder.create(this, "MyCfnPreparedStatement")
         .queryStatement("queryStatement")
         .statementName("statementName")
         .workGroup("workGroup")
         // the properties below are optional
         .description("description")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

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	CfnPreparedStatement(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPreparedStatement(software.amazon.jsii.JsiiObjectRef objRef)
	CfnPreparedStatement(software.constructs.Construct scope, String id, CfnPreparedStatementProps props)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
String	getDescription()	The description of the prepared statement.
String	getQueryStatement()	The query string for the prepared statement.
String	getStatementName()	The name of the prepared statement.
String	getWorkGroup()	The workgroup to which the prepared statement belongs.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	The description of the prepared statement.
void	setQueryStatement(String value)	The query string for the prepared statement.
void	setStatementName(String value)	The name of the prepared statement.
void	setWorkGroup(String value)	The workgroup to which the prepared statement belongs.

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

CfnPreparedStatement

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

CfnPreparedStatement

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

CfnPreparedStatement

@Stability(Stable)
public CfnPreparedStatement(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnPreparedStatementProps 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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getQueryStatement

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

The query string for the prepared statement.

setQueryStatement

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

The query string for the prepared statement.

getStatementName

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

The name of the prepared statement.

setStatementName

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

The name of the prepared statement.

getWorkGroup

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

The workgroup to which the prepared statement belongs.

setWorkGroup

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

The workgroup to which the prepared statement belongs.

getDescription

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

The description of the prepared statement.

setDescription

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

The description of the prepared statement.