github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/networkmanager/getLinks.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 link.
    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.GetLinks(ctx, &networkmanager.GetLinksArgs{
    32  //				GlobalNetworkId: globalNetworkId,
    33  //				Tags: map[string]interface{}{
    34  //					"Env": "test",
    35  //				},
    36  //			}, nil)
    37  //			if err != nil {
    38  //				return err
    39  //			}
    40  //			return nil
    41  //		})
    42  //	}
    43  //
    44  // ```
    45  // <!--End PulumiCodeChooser -->
    46  func GetLinks(ctx *pulumi.Context, args *GetLinksArgs, opts ...pulumi.InvokeOption) (*GetLinksResult, error) {
    47  	opts = internal.PkgInvokeDefaultOpts(opts)
    48  	var rv GetLinksResult
    49  	err := ctx.Invoke("aws:networkmanager/getLinks:getLinks", args, &rv, opts...)
    50  	if err != nil {
    51  		return nil, err
    52  	}
    53  	return &rv, nil
    54  }
    55  
    56  // A collection of arguments for invoking getLinks.
    57  type GetLinksArgs struct {
    58  	// ID of the Global Network of the links to retrieve.
    59  	GlobalNetworkId string `pulumi:"globalNetworkId"`
    60  	// Link provider to retrieve.
    61  	ProviderName *string `pulumi:"providerName"`
    62  	// ID of the site of the links to retrieve.
    63  	SiteId *string `pulumi:"siteId"`
    64  	// Restricts the list to the links with these tags.
    65  	Tags map[string]string `pulumi:"tags"`
    66  	// Link type to retrieve.
    67  	Type *string `pulumi:"type"`
    68  }
    69  
    70  // A collection of values returned by getLinks.
    71  type GetLinksResult struct {
    72  	GlobalNetworkId string `pulumi:"globalNetworkId"`
    73  	// The provider-assigned unique ID for this managed resource.
    74  	Id string `pulumi:"id"`
    75  	// IDs of the links.
    76  	Ids          []string          `pulumi:"ids"`
    77  	ProviderName *string           `pulumi:"providerName"`
    78  	SiteId       *string           `pulumi:"siteId"`
    79  	Tags         map[string]string `pulumi:"tags"`
    80  	Type         *string           `pulumi:"type"`
    81  }
    82  
    83  func GetLinksOutput(ctx *pulumi.Context, args GetLinksOutputArgs, opts ...pulumi.InvokeOption) GetLinksResultOutput {
    84  	return pulumi.ToOutputWithContext(context.Background(), args).
    85  		ApplyT(func(v interface{}) (GetLinksResult, error) {
    86  			args := v.(GetLinksArgs)
    87  			r, err := GetLinks(ctx, &args, opts...)
    88  			var s GetLinksResult
    89  			if r != nil {
    90  				s = *r
    91  			}
    92  			return s, err
    93  		}).(GetLinksResultOutput)
    94  }
    95  
    96  // A collection of arguments for invoking getLinks.
    97  type GetLinksOutputArgs struct {
    98  	// ID of the Global Network of the links to retrieve.
    99  	GlobalNetworkId pulumi.StringInput `pulumi:"globalNetworkId"`
   100  	// Link provider to retrieve.
   101  	ProviderName pulumi.StringPtrInput `pulumi:"providerName"`
   102  	// ID of the site of the links to retrieve.
   103  	SiteId pulumi.StringPtrInput `pulumi:"siteId"`
   104  	// Restricts the list to the links with these tags.
   105  	Tags pulumi.StringMapInput `pulumi:"tags"`
   106  	// Link type to retrieve.
   107  	Type pulumi.StringPtrInput `pulumi:"type"`
   108  }
   109  
   110  func (GetLinksOutputArgs) ElementType() reflect.Type {
   111  	return reflect.TypeOf((*GetLinksArgs)(nil)).Elem()
   112  }
   113  
   114  // A collection of values returned by getLinks.
   115  type GetLinksResultOutput struct{ *pulumi.OutputState }
   116  
   117  func (GetLinksResultOutput) ElementType() reflect.Type {
   118  	return reflect.TypeOf((*GetLinksResult)(nil)).Elem()
   119  }
   120  
   121  func (o GetLinksResultOutput) ToGetLinksResultOutput() GetLinksResultOutput {
   122  	return o
   123  }
   124  
   125  func (o GetLinksResultOutput) ToGetLinksResultOutputWithContext(ctx context.Context) GetLinksResultOutput {
   126  	return o
   127  }
   128  
   129  func (o GetLinksResultOutput) GlobalNetworkId() pulumi.StringOutput {
   130  	return o.ApplyT(func(v GetLinksResult) string { return v.GlobalNetworkId }).(pulumi.StringOutput)
   131  }
   132  
   133  // The provider-assigned unique ID for this managed resource.
   134  func (o GetLinksResultOutput) Id() pulumi.StringOutput {
   135  	return o.ApplyT(func(v GetLinksResult) string { return v.Id }).(pulumi.StringOutput)
   136  }
   137  
   138  // IDs of the links.
   139  func (o GetLinksResultOutput) Ids() pulumi.StringArrayOutput {
   140  	return o.ApplyT(func(v GetLinksResult) []string { return v.Ids }).(pulumi.StringArrayOutput)
   141  }
   142  
   143  func (o GetLinksResultOutput) ProviderName() pulumi.StringPtrOutput {
   144  	return o.ApplyT(func(v GetLinksResult) *string { return v.ProviderName }).(pulumi.StringPtrOutput)
   145  }
   146  
   147  func (o GetLinksResultOutput) SiteId() pulumi.StringPtrOutput {
   148  	return o.ApplyT(func(v GetLinksResult) *string { return v.SiteId }).(pulumi.StringPtrOutput)
   149  }
   150  
   151  func (o GetLinksResultOutput) Tags() pulumi.StringMapOutput {
   152  	return o.ApplyT(func(v GetLinksResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
   153  }
   154  
   155  func (o GetLinksResultOutput) Type() pulumi.StringPtrOutput {
   156  	return o.ApplyT(func(v GetLinksResult) *string { return v.Type }).(pulumi.StringPtrOutput)
   157  }
   158  
   159  func init() {
   160  	pulumi.RegisterOutputType(GetLinksResultOutput{})
   161  }