github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/athena/getNamedQuery.go (about)

     1  // Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
     2  // *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
     3  
     4  package athena
     5  
     6  import (
     7  	"context"
     8  	"reflect"
     9  
    10  	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
    11  	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    12  )
    13  
    14  // Provides an Athena Named Query data source.
    15  //
    16  // ## Example Usage
    17  //
    18  // <!--Start PulumiCodeChooser -->
    19  // ```go
    20  // package main
    21  //
    22  // import (
    23  //
    24  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/athena"
    25  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    26  //
    27  // )
    28  //
    29  //	func main() {
    30  //		pulumi.Run(func(ctx *pulumi.Context) error {
    31  //			_, err := athena.LookupNamedQuery(ctx, &athena.LookupNamedQueryArgs{
    32  //				Name: "athenaQueryName",
    33  //			}, nil)
    34  //			if err != nil {
    35  //				return err
    36  //			}
    37  //			return nil
    38  //		})
    39  //	}
    40  //
    41  // ```
    42  // <!--End PulumiCodeChooser -->
    43  func LookupNamedQuery(ctx *pulumi.Context, args *LookupNamedQueryArgs, opts ...pulumi.InvokeOption) (*LookupNamedQueryResult, error) {
    44  	opts = internal.PkgInvokeDefaultOpts(opts)
    45  	var rv LookupNamedQueryResult
    46  	err := ctx.Invoke("aws:athena/getNamedQuery:getNamedQuery", args, &rv, opts...)
    47  	if err != nil {
    48  		return nil, err
    49  	}
    50  	return &rv, nil
    51  }
    52  
    53  // A collection of arguments for invoking getNamedQuery.
    54  type LookupNamedQueryArgs struct {
    55  	// The plain language name for the query. Maximum length of 128.
    56  	Name string `pulumi:"name"`
    57  	// The workgroup to which the query belongs. Defaults to `primary`.
    58  	Workgroup *string `pulumi:"workgroup"`
    59  }
    60  
    61  // A collection of values returned by getNamedQuery.
    62  type LookupNamedQueryResult struct {
    63  	// Database to which the query belongs.
    64  	Database string `pulumi:"database"`
    65  	// Brief explanation of the query.
    66  	Description string `pulumi:"description"`
    67  	// The provider-assigned unique ID for this managed resource.
    68  	Id          string  `pulumi:"id"`
    69  	Name        string  `pulumi:"name"`
    70  	Querystring string  `pulumi:"querystring"`
    71  	Workgroup   *string `pulumi:"workgroup"`
    72  }
    73  
    74  func LookupNamedQueryOutput(ctx *pulumi.Context, args LookupNamedQueryOutputArgs, opts ...pulumi.InvokeOption) LookupNamedQueryResultOutput {
    75  	return pulumi.ToOutputWithContext(context.Background(), args).
    76  		ApplyT(func(v interface{}) (LookupNamedQueryResult, error) {
    77  			args := v.(LookupNamedQueryArgs)
    78  			r, err := LookupNamedQuery(ctx, &args, opts...)
    79  			var s LookupNamedQueryResult
    80  			if r != nil {
    81  				s = *r
    82  			}
    83  			return s, err
    84  		}).(LookupNamedQueryResultOutput)
    85  }
    86  
    87  // A collection of arguments for invoking getNamedQuery.
    88  type LookupNamedQueryOutputArgs struct {
    89  	// The plain language name for the query. Maximum length of 128.
    90  	Name pulumi.StringInput `pulumi:"name"`
    91  	// The workgroup to which the query belongs. Defaults to `primary`.
    92  	Workgroup pulumi.StringPtrInput `pulumi:"workgroup"`
    93  }
    94  
    95  func (LookupNamedQueryOutputArgs) ElementType() reflect.Type {
    96  	return reflect.TypeOf((*LookupNamedQueryArgs)(nil)).Elem()
    97  }
    98  
    99  // A collection of values returned by getNamedQuery.
   100  type LookupNamedQueryResultOutput struct{ *pulumi.OutputState }
   101  
   102  func (LookupNamedQueryResultOutput) ElementType() reflect.Type {
   103  	return reflect.TypeOf((*LookupNamedQueryResult)(nil)).Elem()
   104  }
   105  
   106  func (o LookupNamedQueryResultOutput) ToLookupNamedQueryResultOutput() LookupNamedQueryResultOutput {
   107  	return o
   108  }
   109  
   110  func (o LookupNamedQueryResultOutput) ToLookupNamedQueryResultOutputWithContext(ctx context.Context) LookupNamedQueryResultOutput {
   111  	return o
   112  }
   113  
   114  // Database to which the query belongs.
   115  func (o LookupNamedQueryResultOutput) Database() pulumi.StringOutput {
   116  	return o.ApplyT(func(v LookupNamedQueryResult) string { return v.Database }).(pulumi.StringOutput)
   117  }
   118  
   119  // Brief explanation of the query.
   120  func (o LookupNamedQueryResultOutput) Description() pulumi.StringOutput {
   121  	return o.ApplyT(func(v LookupNamedQueryResult) string { return v.Description }).(pulumi.StringOutput)
   122  }
   123  
   124  // The provider-assigned unique ID for this managed resource.
   125  func (o LookupNamedQueryResultOutput) Id() pulumi.StringOutput {
   126  	return o.ApplyT(func(v LookupNamedQueryResult) string { return v.Id }).(pulumi.StringOutput)
   127  }
   128  
   129  func (o LookupNamedQueryResultOutput) Name() pulumi.StringOutput {
   130  	return o.ApplyT(func(v LookupNamedQueryResult) string { return v.Name }).(pulumi.StringOutput)
   131  }
   132  
   133  func (o LookupNamedQueryResultOutput) Querystring() pulumi.StringOutput {
   134  	return o.ApplyT(func(v LookupNamedQueryResult) string { return v.Querystring }).(pulumi.StringOutput)
   135  }
   136  
   137  func (o LookupNamedQueryResultOutput) Workgroup() pulumi.StringPtrOutput {
   138  	return o.ApplyT(func(v LookupNamedQueryResult) *string { return v.Workgroup }).(pulumi.StringPtrOutput)
   139  }
   140  
   141  func init() {
   142  	pulumi.RegisterOutputType(LookupNamedQueryResultOutput{})
   143  }