software.amazon.awscdk.services.athena

Class CfnPreparedStatement

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:21.092Z")
public class CfnPreparedStatement
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Athena::PreparedStatement`.

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

Nested Class Summary

Nested Classes

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

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
	CfnPreparedStatement(Construct scope, java.lang.String id, CfnPreparedStatementProps props) Create a new `AWS::Athena::PreparedStatement`.
protected	CfnPreparedStatement(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPreparedStatement(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() The description of the prepared statement.
java.lang.String	getQueryStatement() The query string for the prepared statement.
java.lang.String	getStatementName() The name of the prepared statement.
java.lang.String	getWorkGroup() The workgroup to which the prepared statement belongs.
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	setDescription(java.lang.String value) The description of the prepared statement.
void	setQueryStatement(java.lang.String value) The query string for the prepared statement.
void	setStatementName(java.lang.String value) The name of the prepared statement.
void	setWorkGroup(java.lang.String value) The workgroup to which the prepared statement belongs.

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

CfnPreparedStatement

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

CfnPreparedStatement

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

CfnPreparedStatement

public CfnPreparedStatement(Construct scope,
                            java.lang.String id,
                            CfnPreparedStatementProps props)

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

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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getQueryStatement

public java.lang.String getQueryStatement()

The query string for the prepared statement.

setQueryStatement

public void setQueryStatement(java.lang.String value)

The query string for the prepared statement.

getStatementName

public java.lang.String getStatementName()

The name of the prepared statement.

setStatementName

public void setStatementName(java.lang.String value)

The name of the prepared statement.

getWorkGroup

public java.lang.String getWorkGroup()

The workgroup to which the prepared statement belongs.

setWorkGroup

public void setWorkGroup(java.lang.String value)

The workgroup to which the prepared statement belongs.

getDescription

public java.lang.String getDescription()

The description of the prepared statement.

setDescription

public void setDescription(java.lang.String value)

The description of the prepared statement.