github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/location/getRouteCalculator.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 location
     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 Location Service Route Calculator.
    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/location"
    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 := location.GetRouteCalculator(ctx, &location.GetRouteCalculatorArgs{
    32  //				CalculatorName: "example",
    33  //			}, nil)
    34  //			if err != nil {
    35  //				return err
    36  //			}
    37  //			return nil
    38  //		})
    39  //	}
    40  //
    41  // ```
    42  // <!--End PulumiCodeChooser -->
    43  func GetRouteCalculator(ctx *pulumi.Context, args *GetRouteCalculatorArgs, opts ...pulumi.InvokeOption) (*GetRouteCalculatorResult, error) {
    44  	opts = internal.PkgInvokeDefaultOpts(opts)
    45  	var rv GetRouteCalculatorResult
    46  	err := ctx.Invoke("aws:location/getRouteCalculator:getRouteCalculator", 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 getRouteCalculator.
    54  type GetRouteCalculatorArgs struct {
    55  	// Name of the route calculator resource.
    56  	CalculatorName string `pulumi:"calculatorName"`
    57  	// Key-value map of resource tags for the route calculator.
    58  	Tags map[string]string `pulumi:"tags"`
    59  }
    60  
    61  // A collection of values returned by getRouteCalculator.
    62  type GetRouteCalculatorResult struct {
    63  	// ARN for the Route calculator resource. Use the ARN when you specify a resource across AWS.
    64  	CalculatorArn  string `pulumi:"calculatorArn"`
    65  	CalculatorName string `pulumi:"calculatorName"`
    66  	// Timestamp for when the route calculator resource was created in ISO 8601 format.
    67  	CreateTime string `pulumi:"createTime"`
    68  	// Data provider of traffic and road network data.
    69  	DataSource string `pulumi:"dataSource"`
    70  	// Optional description of the route calculator resource.
    71  	Description string `pulumi:"description"`
    72  	// The provider-assigned unique ID for this managed resource.
    73  	Id string `pulumi:"id"`
    74  	// Key-value map of resource tags for the route calculator.
    75  	Tags map[string]string `pulumi:"tags"`
    76  	// Timestamp for when the route calculator resource was last updated in ISO 8601 format.
    77  	UpdateTime string `pulumi:"updateTime"`
    78  }
    79  
    80  func GetRouteCalculatorOutput(ctx *pulumi.Context, args GetRouteCalculatorOutputArgs, opts ...pulumi.InvokeOption) GetRouteCalculatorResultOutput {
    81  	return pulumi.ToOutputWithContext(context.Background(), args).
    82  		ApplyT(func(v interface{}) (GetRouteCalculatorResult, error) {
    83  			args := v.(GetRouteCalculatorArgs)
    84  			r, err := GetRouteCalculator(ctx, &args, opts...)
    85  			var s GetRouteCalculatorResult
    86  			if r != nil {
    87  				s = *r
    88  			}
    89  			return s, err
    90  		}).(GetRouteCalculatorResultOutput)
    91  }
    92  
    93  // A collection of arguments for invoking getRouteCalculator.
    94  type GetRouteCalculatorOutputArgs struct {
    95  	// Name of the route calculator resource.
    96  	CalculatorName pulumi.StringInput `pulumi:"calculatorName"`
    97  	// Key-value map of resource tags for the route calculator.
    98  	Tags pulumi.StringMapInput `pulumi:"tags"`
    99  }
   100  
   101  func (GetRouteCalculatorOutputArgs) ElementType() reflect.Type {
   102  	return reflect.TypeOf((*GetRouteCalculatorArgs)(nil)).Elem()
   103  }
   104  
   105  // A collection of values returned by getRouteCalculator.
   106  type GetRouteCalculatorResultOutput struct{ *pulumi.OutputState }
   107  
   108  func (GetRouteCalculatorResultOutput) ElementType() reflect.Type {
   109  	return reflect.TypeOf((*GetRouteCalculatorResult)(nil)).Elem()
   110  }
   111  
   112  func (o GetRouteCalculatorResultOutput) ToGetRouteCalculatorResultOutput() GetRouteCalculatorResultOutput {
   113  	return o
   114  }
   115  
   116  func (o GetRouteCalculatorResultOutput) ToGetRouteCalculatorResultOutputWithContext(ctx context.Context) GetRouteCalculatorResultOutput {
   117  	return o
   118  }
   119  
   120  // ARN for the Route calculator resource. Use the ARN when you specify a resource across AWS.
   121  func (o GetRouteCalculatorResultOutput) CalculatorArn() pulumi.StringOutput {
   122  	return o.ApplyT(func(v GetRouteCalculatorResult) string { return v.CalculatorArn }).(pulumi.StringOutput)
   123  }
   124  
   125  func (o GetRouteCalculatorResultOutput) CalculatorName() pulumi.StringOutput {
   126  	return o.ApplyT(func(v GetRouteCalculatorResult) string { return v.CalculatorName }).(pulumi.StringOutput)
   127  }
   128  
   129  // Timestamp for when the route calculator resource was created in ISO 8601 format.
   130  func (o GetRouteCalculatorResultOutput) CreateTime() pulumi.StringOutput {
   131  	return o.ApplyT(func(v GetRouteCalculatorResult) string { return v.CreateTime }).(pulumi.StringOutput)
   132  }
   133  
   134  // Data provider of traffic and road network data.
   135  func (o GetRouteCalculatorResultOutput) DataSource() pulumi.StringOutput {
   136  	return o.ApplyT(func(v GetRouteCalculatorResult) string { return v.DataSource }).(pulumi.StringOutput)
   137  }
   138  
   139  // Optional description of the route calculator resource.
   140  func (o GetRouteCalculatorResultOutput) Description() pulumi.StringOutput {
   141  	return o.ApplyT(func(v GetRouteCalculatorResult) string { return v.Description }).(pulumi.StringOutput)
   142  }
   143  
   144  // The provider-assigned unique ID for this managed resource.
   145  func (o GetRouteCalculatorResultOutput) Id() pulumi.StringOutput {
   146  	return o.ApplyT(func(v GetRouteCalculatorResult) string { return v.Id }).(pulumi.StringOutput)
   147  }
   148  
   149  // Key-value map of resource tags for the route calculator.
   150  func (o GetRouteCalculatorResultOutput) Tags() pulumi.StringMapOutput {
   151  	return o.ApplyT(func(v GetRouteCalculatorResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
   152  }
   153  
   154  // Timestamp for when the route calculator resource was last updated in ISO 8601 format.
   155  func (o GetRouteCalculatorResultOutput) UpdateTime() pulumi.StringOutput {
   156  	return o.ApplyT(func(v GetRouteCalculatorResult) string { return v.UpdateTime }).(pulumi.StringOutput)
   157  }
   158  
   159  func init() {
   160  	pulumi.RegisterOutputType(GetRouteCalculatorResultOutput{})
   161  }