Package software.amazon.awscdk.services.athena

Class CfnPreparedStatement

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.775Z") @Stability(Stable) 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();

  • 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 Construct scope, @NotNull String id, @NotNull 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 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.