github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/dynamodb/getTable.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 dynamodb
     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 information about a DynamoDB table.
    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/dynamodb"
    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 := dynamodb.LookupTable(ctx, &dynamodb.LookupTableArgs{
    32  //				Name: "tableName",
    33  //			}, nil)
    34  //			if err != nil {
    35  //				return err
    36  //			}
    37  //			return nil
    38  //		})
    39  //	}
    40  //
    41  // ```
    42  // <!--End PulumiCodeChooser -->
    43  func LookupTable(ctx *pulumi.Context, args *LookupTableArgs, opts ...pulumi.InvokeOption) (*LookupTableResult, error) {
    44  	opts = internal.PkgInvokeDefaultOpts(opts)
    45  	var rv LookupTableResult
    46  	err := ctx.Invoke("aws:dynamodb/getTable:getTable", 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 getTable.
    54  type LookupTableArgs struct {
    55  	// Name of the DynamoDB table.
    56  	Name                 string                        `pulumi:"name"`
    57  	ServerSideEncryption *GetTableServerSideEncryption `pulumi:"serverSideEncryption"`
    58  	Tags                 map[string]string             `pulumi:"tags"`
    59  }
    60  
    61  // A collection of values returned by getTable.
    62  type LookupTableResult struct {
    63  	Arn                       string                         `pulumi:"arn"`
    64  	Attributes                []GetTableAttribute            `pulumi:"attributes"`
    65  	BillingMode               string                         `pulumi:"billingMode"`
    66  	DeletionProtectionEnabled bool                           `pulumi:"deletionProtectionEnabled"`
    67  	GlobalSecondaryIndexes    []GetTableGlobalSecondaryIndex `pulumi:"globalSecondaryIndexes"`
    68  	HashKey                   string                         `pulumi:"hashKey"`
    69  	// The provider-assigned unique ID for this managed resource.
    70  	Id                    string                        `pulumi:"id"`
    71  	LocalSecondaryIndexes []GetTableLocalSecondaryIndex `pulumi:"localSecondaryIndexes"`
    72  	Name                  string                        `pulumi:"name"`
    73  	PointInTimeRecovery   GetTablePointInTimeRecovery   `pulumi:"pointInTimeRecovery"`
    74  	RangeKey              string                        `pulumi:"rangeKey"`
    75  	ReadCapacity          int                           `pulumi:"readCapacity"`
    76  	Replicas              []GetTableReplicaType         `pulumi:"replicas"`
    77  	ServerSideEncryption  GetTableServerSideEncryption  `pulumi:"serverSideEncryption"`
    78  	StreamArn             string                        `pulumi:"streamArn"`
    79  	StreamEnabled         bool                          `pulumi:"streamEnabled"`
    80  	StreamLabel           string                        `pulumi:"streamLabel"`
    81  	StreamViewType        string                        `pulumi:"streamViewType"`
    82  	TableClass            string                        `pulumi:"tableClass"`
    83  	Tags                  map[string]string             `pulumi:"tags"`
    84  	Ttl                   GetTableTtl                   `pulumi:"ttl"`
    85  	WriteCapacity         int                           `pulumi:"writeCapacity"`
    86  }
    87  
    88  func LookupTableOutput(ctx *pulumi.Context, args LookupTableOutputArgs, opts ...pulumi.InvokeOption) LookupTableResultOutput {
    89  	return pulumi.ToOutputWithContext(context.Background(), args).
    90  		ApplyT(func(v interface{}) (LookupTableResult, error) {
    91  			args := v.(LookupTableArgs)
    92  			r, err := LookupTable(ctx, &args, opts...)
    93  			var s LookupTableResult
    94  			if r != nil {
    95  				s = *r
    96  			}
    97  			return s, err
    98  		}).(LookupTableResultOutput)
    99  }
   100  
   101  // A collection of arguments for invoking getTable.
   102  type LookupTableOutputArgs struct {
   103  	// Name of the DynamoDB table.
   104  	Name                 pulumi.StringInput                   `pulumi:"name"`
   105  	ServerSideEncryption GetTableServerSideEncryptionPtrInput `pulumi:"serverSideEncryption"`
   106  	Tags                 pulumi.StringMapInput                `pulumi:"tags"`
   107  }
   108  
   109  func (LookupTableOutputArgs) ElementType() reflect.Type {
   110  	return reflect.TypeOf((*LookupTableArgs)(nil)).Elem()
   111  }
   112  
   113  // A collection of values returned by getTable.
   114  type LookupTableResultOutput struct{ *pulumi.OutputState }
   115  
   116  func (LookupTableResultOutput) ElementType() reflect.Type {
   117  	return reflect.TypeOf((*LookupTableResult)(nil)).Elem()
   118  }
   119  
   120  func (o LookupTableResultOutput) ToLookupTableResultOutput() LookupTableResultOutput {
   121  	return o
   122  }
   123  
   124  func (o LookupTableResultOutput) ToLookupTableResultOutputWithContext(ctx context.Context) LookupTableResultOutput {
   125  	return o
   126  }
   127  
   128  func (o LookupTableResultOutput) Arn() pulumi.StringOutput {
   129  	return o.ApplyT(func(v LookupTableResult) string { return v.Arn }).(pulumi.StringOutput)
   130  }
   131  
   132  func (o LookupTableResultOutput) Attributes() GetTableAttributeArrayOutput {
   133  	return o.ApplyT(func(v LookupTableResult) []GetTableAttribute { return v.Attributes }).(GetTableAttributeArrayOutput)
   134  }
   135  
   136  func (o LookupTableResultOutput) BillingMode() pulumi.StringOutput {
   137  	return o.ApplyT(func(v LookupTableResult) string { return v.BillingMode }).(pulumi.StringOutput)
   138  }
   139  
   140  func (o LookupTableResultOutput) DeletionProtectionEnabled() pulumi.BoolOutput {
   141  	return o.ApplyT(func(v LookupTableResult) bool { return v.DeletionProtectionEnabled }).(pulumi.BoolOutput)
   142  }
   143  
   144  func (o LookupTableResultOutput) GlobalSecondaryIndexes() GetTableGlobalSecondaryIndexArrayOutput {
   145  	return o.ApplyT(func(v LookupTableResult) []GetTableGlobalSecondaryIndex { return v.GlobalSecondaryIndexes }).(GetTableGlobalSecondaryIndexArrayOutput)
   146  }
   147  
   148  func (o LookupTableResultOutput) HashKey() pulumi.StringOutput {
   149  	return o.ApplyT(func(v LookupTableResult) string { return v.HashKey }).(pulumi.StringOutput)
   150  }
   151  
   152  // The provider-assigned unique ID for this managed resource.
   153  func (o LookupTableResultOutput) Id() pulumi.StringOutput {
   154  	return o.ApplyT(func(v LookupTableResult) string { return v.Id }).(pulumi.StringOutput)
   155  }
   156  
   157  func (o LookupTableResultOutput) LocalSecondaryIndexes() GetTableLocalSecondaryIndexArrayOutput {
   158  	return o.ApplyT(func(v LookupTableResult) []GetTableLocalSecondaryIndex { return v.LocalSecondaryIndexes }).(GetTableLocalSecondaryIndexArrayOutput)
   159  }
   160  
   161  func (o LookupTableResultOutput) Name() pulumi.StringOutput {
   162  	return o.ApplyT(func(v LookupTableResult) string { return v.Name }).(pulumi.StringOutput)
   163  }
   164  
   165  func (o LookupTableResultOutput) PointInTimeRecovery() GetTablePointInTimeRecoveryOutput {
   166  	return o.ApplyT(func(v LookupTableResult) GetTablePointInTimeRecovery { return v.PointInTimeRecovery }).(GetTablePointInTimeRecoveryOutput)
   167  }
   168  
   169  func (o LookupTableResultOutput) RangeKey() pulumi.StringOutput {
   170  	return o.ApplyT(func(v LookupTableResult) string { return v.RangeKey }).(pulumi.StringOutput)
   171  }
   172  
   173  func (o LookupTableResultOutput) ReadCapacity() pulumi.IntOutput {
   174  	return o.ApplyT(func(v LookupTableResult) int { return v.ReadCapacity }).(pulumi.IntOutput)
   175  }
   176  
   177  func (o LookupTableResultOutput) Replicas() GetTableReplicaTypeArrayOutput {
   178  	return o.ApplyT(func(v LookupTableResult) []GetTableReplicaType { return v.Replicas }).(GetTableReplicaTypeArrayOutput)
   179  }
   180  
   181  func (o LookupTableResultOutput) ServerSideEncryption() GetTableServerSideEncryptionOutput {
   182  	return o.ApplyT(func(v LookupTableResult) GetTableServerSideEncryption { return v.ServerSideEncryption }).(GetTableServerSideEncryptionOutput)
   183  }
   184  
   185  func (o LookupTableResultOutput) StreamArn() pulumi.StringOutput {
   186  	return o.ApplyT(func(v LookupTableResult) string { return v.StreamArn }).(pulumi.StringOutput)
   187  }
   188  
   189  func (o LookupTableResultOutput) StreamEnabled() pulumi.BoolOutput {
   190  	return o.ApplyT(func(v LookupTableResult) bool { return v.StreamEnabled }).(pulumi.BoolOutput)
   191  }
   192  
   193  func (o LookupTableResultOutput) StreamLabel() pulumi.StringOutput {
   194  	return o.ApplyT(func(v LookupTableResult) string { return v.StreamLabel }).(pulumi.StringOutput)
   195  }
   196  
   197  func (o LookupTableResultOutput) StreamViewType() pulumi.StringOutput {
   198  	return o.ApplyT(func(v LookupTableResult) string { return v.StreamViewType }).(pulumi.StringOutput)
   199  }
   200  
   201  func (o LookupTableResultOutput) TableClass() pulumi.StringOutput {
   202  	return o.ApplyT(func(v LookupTableResult) string { return v.TableClass }).(pulumi.StringOutput)
   203  }
   204  
   205  func (o LookupTableResultOutput) Tags() pulumi.StringMapOutput {
   206  	return o.ApplyT(func(v LookupTableResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
   207  }
   208  
   209  func (o LookupTableResultOutput) Ttl() GetTableTtlOutput {
   210  	return o.ApplyT(func(v LookupTableResult) GetTableTtl { return v.Ttl }).(GetTableTtlOutput)
   211  }
   212  
   213  func (o LookupTableResultOutput) WriteCapacity() pulumi.IntOutput {
   214  	return o.ApplyT(func(v LookupTableResult) int { return v.WriteCapacity }).(pulumi.IntOutput)
   215  }
   216  
   217  func init() {
   218  	pulumi.RegisterOutputType(LookupTableResultOutput{})
   219  }