Class CfnNamedQuery
The AWS::Athena::NamedQuery
resource specifies an Amazon Athena saved query, where QueryString
contains the SQL query statements that make up the query.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Athena
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnNamedQuery : CfnResource, IInspectable
Syntax (vb)
Public Class CfnNamedQuery
Inherits CfnResource
Implements IInspectable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html
CloudformationResource: AWS::Athena::NamedQuery
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Athena;
var cfnNamedQuery = new CfnNamedQuery(this, "MyCfnNamedQuery", new CfnNamedQueryProps {
Database = "database",
QueryString = "queryString",
// the properties below are optional
Description = "description",
Name = "name",
WorkGroup = "workGroup"
});
Synopsis
Constructors
CfnNamedQuery(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnNamedQuery(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnNamedQuery(Construct, String, ICfnNamedQueryProps) |
Properties
AttrNamedQueryId | The unique ID of the query. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Database | The database to which the query belongs. |
Description | The query description. |
Name | The query name. |
QueryString | The SQL statements that make up the query. |
WorkGroup | The name of the workgroup that contains the named query. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnNamedQuery(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnNamedQuery(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnNamedQuery(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnNamedQuery(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnNamedQuery(Construct, String, ICfnNamedQueryProps)
public CfnNamedQuery(Construct scope, string id, ICfnNamedQueryProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnNamedQueryProps
Resource properties.
Properties
AttrNamedQueryId
The unique ID of the query.
public virtual string AttrNamedQueryId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: NamedQueryId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Database
The database to which the query belongs.
public virtual string Database { get; set; }
Property Value
System.String
Description
The query description.
public virtual string Description { get; set; }
Property Value
System.String
Name
The query name.
public virtual string Name { get; set; }
Property Value
System.String
QueryString
The SQL statements that make up the query.
public virtual string QueryString { get; set; }
Property Value
System.String
WorkGroup
The name of the workgroup that contains the named query.
public virtual string WorkGroup { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>