github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/outposts/getSite.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 outposts
     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 details about an Outposts Site.
    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/outposts"
    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 := outposts.GetSite(ctx, &outposts.GetSiteArgs{
    32  //				Name: pulumi.StringRef("example"),
    33  //			}, nil)
    34  //			if err != nil {
    35  //				return err
    36  //			}
    37  //			return nil
    38  //		})
    39  //	}
    40  //
    41  // ```
    42  // <!--End PulumiCodeChooser -->
    43  func GetSite(ctx *pulumi.Context, args *GetSiteArgs, opts ...pulumi.InvokeOption) (*GetSiteResult, error) {
    44  	opts = internal.PkgInvokeDefaultOpts(opts)
    45  	var rv GetSiteResult
    46  	err := ctx.Invoke("aws:outposts/getSite:getSite", 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 getSite.
    54  type GetSiteArgs struct {
    55  	// Identifier of the Site.
    56  	Id *string `pulumi:"id"`
    57  	// Name of the Site.
    58  	Name *string `pulumi:"name"`
    59  }
    60  
    61  // A collection of values returned by getSite.
    62  type GetSiteResult struct {
    63  	// AWS Account identifier.
    64  	AccountId string `pulumi:"accountId"`
    65  	// Description.
    66  	Description string `pulumi:"description"`
    67  	Id          string `pulumi:"id"`
    68  	Name        string `pulumi:"name"`
    69  }
    70  
    71  func GetSiteOutput(ctx *pulumi.Context, args GetSiteOutputArgs, opts ...pulumi.InvokeOption) GetSiteResultOutput {
    72  	return pulumi.ToOutputWithContext(context.Background(), args).
    73  		ApplyT(func(v interface{}) (GetSiteResult, error) {
    74  			args := v.(GetSiteArgs)
    75  			r, err := GetSite(ctx, &args, opts...)
    76  			var s GetSiteResult
    77  			if r != nil {
    78  				s = *r
    79  			}
    80  			return s, err
    81  		}).(GetSiteResultOutput)
    82  }
    83  
    84  // A collection of arguments for invoking getSite.
    85  type GetSiteOutputArgs struct {
    86  	// Identifier of the Site.
    87  	Id pulumi.StringPtrInput `pulumi:"id"`
    88  	// Name of the Site.
    89  	Name pulumi.StringPtrInput `pulumi:"name"`
    90  }
    91  
    92  func (GetSiteOutputArgs) ElementType() reflect.Type {
    93  	return reflect.TypeOf((*GetSiteArgs)(nil)).Elem()
    94  }
    95  
    96  // A collection of values returned by getSite.
    97  type GetSiteResultOutput struct{ *pulumi.OutputState }
    98  
    99  func (GetSiteResultOutput) ElementType() reflect.Type {
   100  	return reflect.TypeOf((*GetSiteResult)(nil)).Elem()
   101  }
   102  
   103  func (o GetSiteResultOutput) ToGetSiteResultOutput() GetSiteResultOutput {
   104  	return o
   105  }
   106  
   107  func (o GetSiteResultOutput) ToGetSiteResultOutputWithContext(ctx context.Context) GetSiteResultOutput {
   108  	return o
   109  }
   110  
   111  // AWS Account identifier.
   112  func (o GetSiteResultOutput) AccountId() pulumi.StringOutput {
   113  	return o.ApplyT(func(v GetSiteResult) string { return v.AccountId }).(pulumi.StringOutput)
   114  }
   115  
   116  // Description.
   117  func (o GetSiteResultOutput) Description() pulumi.StringOutput {
   118  	return o.ApplyT(func(v GetSiteResult) string { return v.Description }).(pulumi.StringOutput)
   119  }
   120  
   121  func (o GetSiteResultOutput) Id() pulumi.StringOutput {
   122  	return o.ApplyT(func(v GetSiteResult) string { return v.Id }).(pulumi.StringOutput)
   123  }
   124  
   125  func (o GetSiteResultOutput) Name() pulumi.StringOutput {
   126  	return o.ApplyT(func(v GetSiteResult) string { return v.Name }).(pulumi.StringOutput)
   127  }
   128  
   129  func init() {
   130  	pulumi.RegisterOutputType(GetSiteResultOutput{})
   131  }