github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/directconnect/getRouterConfiguration.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 directconnect
     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  // Data source for retrieving Router Configuration instructions for a given AWS Direct Connect Virtual Interface and Router Type.
    15  //
    16  // ## Example Usage
    17  //
    18  // ### Basic Usage
    19  //
    20  // <!--Start PulumiCodeChooser -->
    21  // ```go
    22  // package main
    23  //
    24  // import (
    25  //
    26  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/directconnect"
    27  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    28  //
    29  // )
    30  //
    31  //	func main() {
    32  //		pulumi.Run(func(ctx *pulumi.Context) error {
    33  //			_, err := directconnect.GetRouterConfiguration(ctx, &directconnect.GetRouterConfigurationArgs{
    34  //				VirtualInterfaceId:   "dxvif-abcde123",
    35  //				RouterTypeIdentifier: "CiscoSystemsInc-2900SeriesRouters-IOS124",
    36  //			}, nil)
    37  //			if err != nil {
    38  //				return err
    39  //			}
    40  //			return nil
    41  //		})
    42  //	}
    43  //
    44  // ```
    45  // <!--End PulumiCodeChooser -->
    46  func GetRouterConfiguration(ctx *pulumi.Context, args *GetRouterConfigurationArgs, opts ...pulumi.InvokeOption) (*GetRouterConfigurationResult, error) {
    47  	opts = internal.PkgInvokeDefaultOpts(opts)
    48  	var rv GetRouterConfigurationResult
    49  	err := ctx.Invoke("aws:directconnect/getRouterConfiguration:getRouterConfiguration", 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 getRouterConfiguration.
    57  type GetRouterConfigurationArgs struct {
    58  	// ID of the Router Type. For example: `CiscoSystemsInc-2900SeriesRouters-IOS124`
    59  	//
    60  	// There is currently no AWS API to retrieve the full list of `routerTypeIdentifier` values. Here is a list of known `RouterType` objects that can be used:
    61  	RouterTypeIdentifier string `pulumi:"routerTypeIdentifier"`
    62  	// ID of the Direct Connect Virtual Interface
    63  	VirtualInterfaceId string `pulumi:"virtualInterfaceId"`
    64  }
    65  
    66  // A collection of values returned by getRouterConfiguration.
    67  type GetRouterConfigurationResult struct {
    68  	// Instructions for configuring your router
    69  	CustomerRouterConfig string `pulumi:"customerRouterConfig"`
    70  	// The provider-assigned unique ID for this managed resource.
    71  	Id string `pulumi:"id"`
    72  	// Router type identifier
    73  	RouterTypeIdentifier string `pulumi:"routerTypeIdentifier"`
    74  	// Block of the router type details
    75  	Routers              []GetRouterConfigurationRouter `pulumi:"routers"`
    76  	VirtualInterfaceId   string                         `pulumi:"virtualInterfaceId"`
    77  	VirtualInterfaceName string                         `pulumi:"virtualInterfaceName"`
    78  }
    79  
    80  func GetRouterConfigurationOutput(ctx *pulumi.Context, args GetRouterConfigurationOutputArgs, opts ...pulumi.InvokeOption) GetRouterConfigurationResultOutput {
    81  	return pulumi.ToOutputWithContext(context.Background(), args).
    82  		ApplyT(func(v interface{}) (GetRouterConfigurationResult, error) {
    83  			args := v.(GetRouterConfigurationArgs)
    84  			r, err := GetRouterConfiguration(ctx, &args, opts...)
    85  			var s GetRouterConfigurationResult
    86  			if r != nil {
    87  				s = *r
    88  			}
    89  			return s, err
    90  		}).(GetRouterConfigurationResultOutput)
    91  }
    92  
    93  // A collection of arguments for invoking getRouterConfiguration.
    94  type GetRouterConfigurationOutputArgs struct {
    95  	// ID of the Router Type. For example: `CiscoSystemsInc-2900SeriesRouters-IOS124`
    96  	//
    97  	// There is currently no AWS API to retrieve the full list of `routerTypeIdentifier` values. Here is a list of known `RouterType` objects that can be used:
    98  	RouterTypeIdentifier pulumi.StringInput `pulumi:"routerTypeIdentifier"`
    99  	// ID of the Direct Connect Virtual Interface
   100  	VirtualInterfaceId pulumi.StringInput `pulumi:"virtualInterfaceId"`
   101  }
   102  
   103  func (GetRouterConfigurationOutputArgs) ElementType() reflect.Type {
   104  	return reflect.TypeOf((*GetRouterConfigurationArgs)(nil)).Elem()
   105  }
   106  
   107  // A collection of values returned by getRouterConfiguration.
   108  type GetRouterConfigurationResultOutput struct{ *pulumi.OutputState }
   109  
   110  func (GetRouterConfigurationResultOutput) ElementType() reflect.Type {
   111  	return reflect.TypeOf((*GetRouterConfigurationResult)(nil)).Elem()
   112  }
   113  
   114  func (o GetRouterConfigurationResultOutput) ToGetRouterConfigurationResultOutput() GetRouterConfigurationResultOutput {
   115  	return o
   116  }
   117  
   118  func (o GetRouterConfigurationResultOutput) ToGetRouterConfigurationResultOutputWithContext(ctx context.Context) GetRouterConfigurationResultOutput {
   119  	return o
   120  }
   121  
   122  // Instructions for configuring your router
   123  func (o GetRouterConfigurationResultOutput) CustomerRouterConfig() pulumi.StringOutput {
   124  	return o.ApplyT(func(v GetRouterConfigurationResult) string { return v.CustomerRouterConfig }).(pulumi.StringOutput)
   125  }
   126  
   127  // The provider-assigned unique ID for this managed resource.
   128  func (o GetRouterConfigurationResultOutput) Id() pulumi.StringOutput {
   129  	return o.ApplyT(func(v GetRouterConfigurationResult) string { return v.Id }).(pulumi.StringOutput)
   130  }
   131  
   132  // Router type identifier
   133  func (o GetRouterConfigurationResultOutput) RouterTypeIdentifier() pulumi.StringOutput {
   134  	return o.ApplyT(func(v GetRouterConfigurationResult) string { return v.RouterTypeIdentifier }).(pulumi.StringOutput)
   135  }
   136  
   137  // Block of the router type details
   138  func (o GetRouterConfigurationResultOutput) Routers() GetRouterConfigurationRouterArrayOutput {
   139  	return o.ApplyT(func(v GetRouterConfigurationResult) []GetRouterConfigurationRouter { return v.Routers }).(GetRouterConfigurationRouterArrayOutput)
   140  }
   141  
   142  func (o GetRouterConfigurationResultOutput) VirtualInterfaceId() pulumi.StringOutput {
   143  	return o.ApplyT(func(v GetRouterConfigurationResult) string { return v.VirtualInterfaceId }).(pulumi.StringOutput)
   144  }
   145  
   146  func (o GetRouterConfigurationResultOutput) VirtualInterfaceName() pulumi.StringOutput {
   147  	return o.ApplyT(func(v GetRouterConfigurationResult) string { return v.VirtualInterfaceName }).(pulumi.StringOutput)
   148  }
   149  
   150  func init() {
   151  	pulumi.RegisterOutputType(GetRouterConfigurationResultOutput{})
   152  }