NamedQuery class
Provides an Athena Named Query resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const hoge = new aws.s3.Bucket("hoge", {bucket: "tf-test"});
const test = new aws.kms.Key("test", {
deletionWindowInDays: 7,
description: "Athena KMS Key",
});
const testWorkgroup = new aws.athena.Workgroup("test", {
configuration: {
resultConfiguration: {
encryptionConfiguration: {
encryptionOption: "SSE_KMS",
kmsKeyArn: test.arn,
},
},
},
name: "example",
});
const hogeDatabase = new aws.athena.Database("hoge", {
name: "users",
bucket: hoge.id,
});
const foo = new aws.athena.NamedQuery("foo", {
name: "bar",
workgroup: testWorkgroup.id,
database: hogeDatabase.name,
query: pulumi.interpolate`SELECT * FROM ${hogeDatabase.name} limit 10;`,
});
import pulumi
import pulumi_aws as aws
hoge = aws.s3.Bucket("hoge", bucket="tf-test")
test = aws.kms.Key("test",
deletion_window_in_days=7,
description="Athena KMS Key")
test_workgroup = aws.athena.Workgroup("test",
configuration={
"result_configuration": {
"encryption_configuration": {
"encryption_option": "SSE_KMS",
"kms_key_arn": test.arn,
},
},
},
name="example")
hoge_database = aws.athena.Database("hoge",
name="users",
bucket=hoge.id)
foo = aws.athena.NamedQuery("foo",
name="bar",
workgroup=test_workgroup.id,
database=hoge_database.name,
query=hoge_database.name.apply(lambda name: f"SELECT * FROM {name} limit 10;"))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var hoge = new Aws.S3.Bucket("hoge", new()
{
BucketName = "tf-test",
});
var test = new Aws.Kms.Key("test", new()
{
DeletionWindowInDays = 7,
Description = "Athena KMS Key",
});
var testWorkgroup = new Aws.Athena.Workgroup("test", new()
{
Configuration = new Aws.Athena.Inputs.WorkgroupConfigurationArgs
{
ResultConfiguration = new Aws.Athena.Inputs.WorkgroupConfigurationResultConfigurationArgs
{
EncryptionConfiguration = new Aws.Athena.Inputs.WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs
{
EncryptionOption = "SSE_KMS",
KmsKeyArn = test.Arn,
},
},
},
Name = "example",
});
var hogeDatabase = new Aws.Athena.Database("hoge", new()
{
Name = "users",
Bucket = hoge.Id,
});
var foo = new Aws.Athena.NamedQuery("foo", new()
{
Name = "bar",
Workgroup = testWorkgroup.Id,
Database = hogeDatabase.Name,
Query = hogeDatabase.Name.Apply(name => $"SELECT * FROM {name} limit 10;"),
});
});
package main
import (
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/athena"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/kms"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
hoge, err := s3.NewBucket(ctx, "hoge", &s3.BucketArgs{
Bucket: pulumi.String("tf-test"),
})
if err != nil {
return err
}
test, err := kms.NewKey(ctx, "test", &kms.KeyArgs{
DeletionWindowInDays: pulumi.Int(7),
Description: pulumi.String("Athena KMS Key"),
})
if err != nil {
return err
}
testWorkgroup, err := athena.NewWorkgroup(ctx, "test", &athena.WorkgroupArgs{
Configuration: &athena.WorkgroupConfigurationArgs{
ResultConfiguration: &athena.WorkgroupConfigurationResultConfigurationArgs{
EncryptionConfiguration: &athena.WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs{
EncryptionOption: pulumi.String("SSE_KMS"),
KmsKeyArn: test.Arn,
},
},
},
Name: pulumi.String("example"),
})
if err != nil {
return err
}
hogeDatabase, err := athena.NewDatabase(ctx, "hoge", &athena.DatabaseArgs{
Name: pulumi.String("users"),
Bucket: hoge.ID().ToIDOutput().ToStringOutput(),
})
if err != nil {
return err
}
_, err = athena.NewNamedQuery(ctx, "foo", &athena.NamedQueryArgs{
Name: pulumi.String("bar"),
Workgroup: testWorkgroup.ID().ToIDOutput().ToStringOutput(),
Database: hogeDatabase.Name,
Query: hogeDatabase.Name.ApplyT(func(name string) (string, error) {
return fmt.Sprintf("SELECT * FROM %v limit 10;", name), nil
}).(pulumi.StringOutput),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_s3_bucket" "hoge" {
bucket = "tf-test"
}
resource "aws_kms_key" "test" {
deletion_window_in_days = 7
description = "Athena KMS Key"
}
resource "aws_athena_workgroup" "test" {
configuration = {
result_configuration = {
encryption_configuration = {
encryption_option = "SSE_KMS"
kms_key_arn = aws_kms_key.test.arn
}
}
}
name = "example"
}
resource "aws_athena_database" "hoge" {
name = "users"
bucket = aws_s3_bucket.hoge.id
}
resource "aws_athena_namedquery" "foo" {
name = "bar"
workgroup = aws_athena_workgroup.test.id
database = aws_athena_database.hoge.name
query ="SELECT * FROM ${aws_athena_database.hoge.name} limit 10;"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.Bucket;
import com.pulumi.aws.s3.BucketArgs;
import com.pulumi.aws.kms.Key;
import com.pulumi.aws.kms.KeyArgs;
import com.pulumi.aws.athena.Workgroup;
import com.pulumi.aws.athena.WorkgroupArgs;
import com.pulumi.aws.athena.inputs.WorkgroupConfigurationArgs;
import com.pulumi.aws.athena.inputs.WorkgroupConfigurationResultConfigurationArgs;
import com.pulumi.aws.athena.inputs.WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs;
import com.pulumi.aws.athena.Database;
import com.pulumi.aws.athena.DatabaseArgs;
import com.pulumi.aws.athena.NamedQuery;
import com.pulumi.aws.athena.NamedQueryArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var hoge = new Bucket("hoge", BucketArgs.builder()
.bucket("tf-test")
.build());
var test = new Key("test", KeyArgs.builder()
.deletionWindowInDays(7)
.description("Athena KMS Key")
.build());
var testWorkgroup = new Workgroup("testWorkgroup", WorkgroupArgs.builder()
.configuration(WorkgroupConfigurationArgs.builder()
.resultConfiguration(WorkgroupConfigurationResultConfigurationArgs.builder()
.encryptionConfiguration(WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs.builder()
.encryptionOption("SSE_KMS")
.kmsKeyArn(test.arn())
.build())
.build())
.build())
.name("example")
.build());
var hogeDatabase = new Database("hogeDatabase", DatabaseArgs.builder()
.name("users")
.bucket(hoge.id())
.build());
var foo = new NamedQuery("foo", NamedQueryArgs.builder()
.name("bar")
.workgroup(testWorkgroup.id())
.database(hogeDatabase.name())
.query(hogeDatabase.name().applyValue(_name -> String.format("SELECT * FROM %s limit 10;", _name)))
.build());
}
}
resources:
hoge:
type: aws:s3:Bucket
properties:
bucket: tf-test
test:
type: aws:kms:Key
properties:
deletionWindowInDays: 7
description: Athena KMS Key
testWorkgroup:
type: aws:athena:Workgroup
name: test
properties:
configuration:
resultConfiguration:
encryptionConfiguration:
encryptionOption: SSE_KMS
kmsKeyArn: ${test.arn}
name: example
hogeDatabase:
type: aws:athena:Database
name: hoge
properties:
name: users
bucket: ${hoge.id}
foo:
type: aws:athena:NamedQuery
properties:
name: bar
workgroup: ${testWorkgroup.id}
database: ${hogeDatabase.name}
query: SELECT * FROM ${hogeDatabase.name} limit 10;
Import
Using pulumi import, import Athena Named Query using the query ID. For example:
$ pulumi import aws:athena/namedQuery:NamedQuery example 0123456789
Constructors
- NamedQuery(String name, {NamedQueryArgs? args, CustomResourceOptions? options})
-
Creates a new NamedQuery.
nameThe Pulumi resource name.argsArguments used to configure this NamedQuery. The set of arguments for NamedQuery.optionsResource options controlling this resource's behavior. - NamedQuery.reference(String urn)
- Creates a typed reference to an existing NamedQuery resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
database
↔ Output<
String> -
Database to which the query belongs.
latefinal
-
description
↔ Output<
String?> -
Brief explanation of the query. Maximum length of 1024.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
Plain language name for the query. Maximum length of 128.
latefinal
-
query
↔ Output<
String> -
Text of the query itself. In other words, all query statements. Maximum length of 262144.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
workgroup
↔ Output<
String?> -
Workgroup to which the query belongs. Defaults to
primarylatefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {NamedQueryState? state, CustomResourceOptions? options}) → NamedQuery -
Gets an existing NamedQuery resource's state with the given
nameandid.