github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/networkmanager/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 networkmanager
     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  // Retrieve information about a 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/networkmanager"
    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 := networkmanager.LookupSite(ctx, &networkmanager.LookupSiteArgs{
    32  //				GlobalNetworkId: globalNetworkId,
    33  //				SiteId:          siteId,
    34  //			}, nil)
    35  //			if err != nil {
    36  //				return err
    37  //			}
    38  //			return nil
    39  //		})
    40  //	}
    41  //
    42  // ```
    43  // <!--End PulumiCodeChooser -->
    44  func LookupSite(ctx *pulumi.Context, args *LookupSiteArgs, opts ...pulumi.InvokeOption) (*LookupSiteResult, error) {
    45  	opts = internal.PkgInvokeDefaultOpts(opts)
    46  	var rv LookupSiteResult
    47  	err := ctx.Invoke("aws:networkmanager/getSite:getSite", args, &rv, opts...)
    48  	if err != nil {
    49  		return nil, err
    50  	}
    51  	return &rv, nil
    52  }
    53  
    54  // A collection of arguments for invoking getSite.
    55  type LookupSiteArgs struct {
    56  	// ID of the Global Network of the site to retrieve.
    57  	GlobalNetworkId string `pulumi:"globalNetworkId"`
    58  	// ID of the specific site to retrieve.
    59  	SiteId string `pulumi:"siteId"`
    60  	// Key-value tags for the Site.
    61  	Tags map[string]string `pulumi:"tags"`
    62  }
    63  
    64  // A collection of values returned by getSite.
    65  type LookupSiteResult struct {
    66  	// ARN of the site.
    67  	Arn string `pulumi:"arn"`
    68  	// Description of the site.
    69  	Description     string `pulumi:"description"`
    70  	GlobalNetworkId string `pulumi:"globalNetworkId"`
    71  	// The provider-assigned unique ID for this managed resource.
    72  	Id string `pulumi:"id"`
    73  	// Site location as documented below.
    74  	Locations []GetSiteLocation `pulumi:"locations"`
    75  	SiteId    string            `pulumi:"siteId"`
    76  	// Key-value tags for the Site.
    77  	Tags map[string]string `pulumi:"tags"`
    78  }
    79  
    80  func LookupSiteOutput(ctx *pulumi.Context, args LookupSiteOutputArgs, opts ...pulumi.InvokeOption) LookupSiteResultOutput {
    81  	return pulumi.ToOutputWithContext(context.Background(), args).
    82  		ApplyT(func(v interface{}) (LookupSiteResult, error) {
    83  			args := v.(LookupSiteArgs)
    84  			r, err := LookupSite(ctx, &args, opts...)
    85  			var s LookupSiteResult
    86  			if r != nil {
    87  				s = *r
    88  			}
    89  			return s, err
    90  		}).(LookupSiteResultOutput)
    91  }
    92  
    93  // A collection of arguments for invoking getSite.
    94  type LookupSiteOutputArgs struct {
    95  	// ID of the Global Network of the site to retrieve.
    96  	GlobalNetworkId pulumi.StringInput `pulumi:"globalNetworkId"`
    97  	// ID of the specific site to retrieve.
    98  	SiteId pulumi.StringInput `pulumi:"siteId"`
    99  	// Key-value tags for the Site.
   100  	Tags pulumi.StringMapInput `pulumi:"tags"`
   101  }
   102  
   103  func (LookupSiteOutputArgs) ElementType() reflect.Type {
   104  	return reflect.TypeOf((*LookupSiteArgs)(nil)).Elem()
   105  }
   106  
   107  // A collection of values returned by getSite.
   108  type LookupSiteResultOutput struct{ *pulumi.OutputState }
   109  
   110  func (LookupSiteResultOutput) ElementType() reflect.Type {
   111  	return reflect.TypeOf((*LookupSiteResult)(nil)).Elem()
   112  }
   113  
   114  func (o LookupSiteResultOutput) ToLookupSiteResultOutput() LookupSiteResultOutput {
   115  	return o
   116  }
   117  
   118  func (o LookupSiteResultOutput) ToLookupSiteResultOutputWithContext(ctx context.Context) LookupSiteResultOutput {
   119  	return o
   120  }
   121  
   122  // ARN of the site.
   123  func (o LookupSiteResultOutput) Arn() pulumi.StringOutput {
   124  	return o.ApplyT(func(v LookupSiteResult) string { return v.Arn }).(pulumi.StringOutput)
   125  }
   126  
   127  // Description of the site.
   128  func (o LookupSiteResultOutput) Description() pulumi.StringOutput {
   129  	return o.ApplyT(func(v LookupSiteResult) string { return v.Description }).(pulumi.StringOutput)
   130  }
   131  
   132  func (o LookupSiteResultOutput) GlobalNetworkId() pulumi.StringOutput {
   133  	return o.ApplyT(func(v LookupSiteResult) string { return v.GlobalNetworkId }).(pulumi.StringOutput)
   134  }
   135  
   136  // The provider-assigned unique ID for this managed resource.
   137  func (o LookupSiteResultOutput) Id() pulumi.StringOutput {
   138  	return o.ApplyT(func(v LookupSiteResult) string { return v.Id }).(pulumi.StringOutput)
   139  }
   140  
   141  // Site location as documented below.
   142  func (o LookupSiteResultOutput) Locations() GetSiteLocationArrayOutput {
   143  	return o.ApplyT(func(v LookupSiteResult) []GetSiteLocation { return v.Locations }).(GetSiteLocationArrayOutput)
   144  }
   145  
   146  func (o LookupSiteResultOutput) SiteId() pulumi.StringOutput {
   147  	return o.ApplyT(func(v LookupSiteResult) string { return v.SiteId }).(pulumi.StringOutput)
   148  }
   149  
   150  // Key-value tags for the Site.
   151  func (o LookupSiteResultOutput) Tags() pulumi.StringMapOutput {
   152  	return o.ApplyT(func(v LookupSiteResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
   153  }
   154  
   155  func init() {
   156  	pulumi.RegisterOutputType(LookupSiteResultOutput{})
   157  }