Package software.amazon.awscdk.services.athena

Class CfnNamedQuery

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.CfnNamedQuery
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.759Z") @Stability(Stable) 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();

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