github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/ec2/getNetworkInsightsAnalysis.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 ec2
     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  // `ec2.NetworkInsightsAnalysis` provides details about a specific Network Insights Analysis.
    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/ec2"
    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 := ec2.LookupNetworkInsightsAnalysis(ctx, &ec2.LookupNetworkInsightsAnalysisArgs{
    32  //				NetworkInsightsAnalysisId: pulumi.StringRef(exampleAwsEc2NetworkInsightsAnalysis.Id),
    33  //			}, nil)
    34  //			if err != nil {
    35  //				return err
    36  //			}
    37  //			return nil
    38  //		})
    39  //	}
    40  //
    41  // ```
    42  // <!--End PulumiCodeChooser -->
    43  func LookupNetworkInsightsAnalysis(ctx *pulumi.Context, args *LookupNetworkInsightsAnalysisArgs, opts ...pulumi.InvokeOption) (*LookupNetworkInsightsAnalysisResult, error) {
    44  	opts = internal.PkgInvokeDefaultOpts(opts)
    45  	var rv LookupNetworkInsightsAnalysisResult
    46  	err := ctx.Invoke("aws:ec2/getNetworkInsightsAnalysis:getNetworkInsightsAnalysis", 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 getNetworkInsightsAnalysis.
    54  type LookupNetworkInsightsAnalysisArgs struct {
    55  	// Configuration block(s) for filtering. Detailed below.
    56  	Filters []GetNetworkInsightsAnalysisFilter `pulumi:"filters"`
    57  	// ID of the Network Insights Analysis to select.
    58  	NetworkInsightsAnalysisId *string           `pulumi:"networkInsightsAnalysisId"`
    59  	Tags                      map[string]string `pulumi:"tags"`
    60  }
    61  
    62  // A collection of values returned by getNetworkInsightsAnalysis.
    63  type LookupNetworkInsightsAnalysisResult struct {
    64  	// Potential intermediate components of a feasible path.
    65  	AlternatePathHints []GetNetworkInsightsAnalysisAlternatePathHint `pulumi:"alternatePathHints"`
    66  	// ARN of the selected Network Insights Analysis.
    67  	Arn string `pulumi:"arn"`
    68  	// Explanation codes for an unreachable path.
    69  	Explanations []GetNetworkInsightsAnalysisExplanation `pulumi:"explanations"`
    70  	// ARNs of the AWS resources that the path must traverse.
    71  	FilterInArns []string                           `pulumi:"filterInArns"`
    72  	Filters      []GetNetworkInsightsAnalysisFilter `pulumi:"filters"`
    73  	// The components in the path from source to destination.
    74  	ForwardPathComponents []GetNetworkInsightsAnalysisForwardPathComponent `pulumi:"forwardPathComponents"`
    75  	// The provider-assigned unique ID for this managed resource.
    76  	Id                        string `pulumi:"id"`
    77  	NetworkInsightsAnalysisId string `pulumi:"networkInsightsAnalysisId"`
    78  	// The ID of the path.
    79  	NetworkInsightsPathId string `pulumi:"networkInsightsPathId"`
    80  	// Set to `true` if the destination was reachable.
    81  	PathFound bool `pulumi:"pathFound"`
    82  	// The components in the path from destination to source.
    83  	ReturnPathComponents []GetNetworkInsightsAnalysisReturnPathComponent `pulumi:"returnPathComponents"`
    84  	// Date/time the analysis was started.
    85  	StartDate string `pulumi:"startDate"`
    86  	// Status of the analysis. `succeeded` means the analysis was completed, not that a path was found, for that see `pathFound`.
    87  	Status string `pulumi:"status"`
    88  	// Message to provide more context when the `status` is `failed`.
    89  	StatusMessage string            `pulumi:"statusMessage"`
    90  	Tags          map[string]string `pulumi:"tags"`
    91  	// Warning message.
    92  	WarningMessage string `pulumi:"warningMessage"`
    93  }
    94  
    95  func LookupNetworkInsightsAnalysisOutput(ctx *pulumi.Context, args LookupNetworkInsightsAnalysisOutputArgs, opts ...pulumi.InvokeOption) LookupNetworkInsightsAnalysisResultOutput {
    96  	return pulumi.ToOutputWithContext(context.Background(), args).
    97  		ApplyT(func(v interface{}) (LookupNetworkInsightsAnalysisResult, error) {
    98  			args := v.(LookupNetworkInsightsAnalysisArgs)
    99  			r, err := LookupNetworkInsightsAnalysis(ctx, &args, opts...)
   100  			var s LookupNetworkInsightsAnalysisResult
   101  			if r != nil {
   102  				s = *r
   103  			}
   104  			return s, err
   105  		}).(LookupNetworkInsightsAnalysisResultOutput)
   106  }
   107  
   108  // A collection of arguments for invoking getNetworkInsightsAnalysis.
   109  type LookupNetworkInsightsAnalysisOutputArgs struct {
   110  	// Configuration block(s) for filtering. Detailed below.
   111  	Filters GetNetworkInsightsAnalysisFilterArrayInput `pulumi:"filters"`
   112  	// ID of the Network Insights Analysis to select.
   113  	NetworkInsightsAnalysisId pulumi.StringPtrInput `pulumi:"networkInsightsAnalysisId"`
   114  	Tags                      pulumi.StringMapInput `pulumi:"tags"`
   115  }
   116  
   117  func (LookupNetworkInsightsAnalysisOutputArgs) ElementType() reflect.Type {
   118  	return reflect.TypeOf((*LookupNetworkInsightsAnalysisArgs)(nil)).Elem()
   119  }
   120  
   121  // A collection of values returned by getNetworkInsightsAnalysis.
   122  type LookupNetworkInsightsAnalysisResultOutput struct{ *pulumi.OutputState }
   123  
   124  func (LookupNetworkInsightsAnalysisResultOutput) ElementType() reflect.Type {
   125  	return reflect.TypeOf((*LookupNetworkInsightsAnalysisResult)(nil)).Elem()
   126  }
   127  
   128  func (o LookupNetworkInsightsAnalysisResultOutput) ToLookupNetworkInsightsAnalysisResultOutput() LookupNetworkInsightsAnalysisResultOutput {
   129  	return o
   130  }
   131  
   132  func (o LookupNetworkInsightsAnalysisResultOutput) ToLookupNetworkInsightsAnalysisResultOutputWithContext(ctx context.Context) LookupNetworkInsightsAnalysisResultOutput {
   133  	return o
   134  }
   135  
   136  // Potential intermediate components of a feasible path.
   137  func (o LookupNetworkInsightsAnalysisResultOutput) AlternatePathHints() GetNetworkInsightsAnalysisAlternatePathHintArrayOutput {
   138  	return o.ApplyT(func(v LookupNetworkInsightsAnalysisResult) []GetNetworkInsightsAnalysisAlternatePathHint {
   139  		return v.AlternatePathHints
   140  	}).(GetNetworkInsightsAnalysisAlternatePathHintArrayOutput)
   141  }
   142  
   143  // ARN of the selected Network Insights Analysis.
   144  func (o LookupNetworkInsightsAnalysisResultOutput) Arn() pulumi.StringOutput {
   145  	return o.ApplyT(func(v LookupNetworkInsightsAnalysisResult) string { return v.Arn }).(pulumi.StringOutput)
   146  }
   147  
   148  // Explanation codes for an unreachable path.
   149  func (o LookupNetworkInsightsAnalysisResultOutput) Explanations() GetNetworkInsightsAnalysisExplanationArrayOutput {
   150  	return o.ApplyT(func(v LookupNetworkInsightsAnalysisResult) []GetNetworkInsightsAnalysisExplanation {
   151  		return v.Explanations
   152  	}).(GetNetworkInsightsAnalysisExplanationArrayOutput)
   153  }
   154  
   155  // ARNs of the AWS resources that the path must traverse.
   156  func (o LookupNetworkInsightsAnalysisResultOutput) FilterInArns() pulumi.StringArrayOutput {
   157  	return o.ApplyT(func(v LookupNetworkInsightsAnalysisResult) []string { return v.FilterInArns }).(pulumi.StringArrayOutput)
   158  }
   159  
   160  func (o LookupNetworkInsightsAnalysisResultOutput) Filters() GetNetworkInsightsAnalysisFilterArrayOutput {
   161  	return o.ApplyT(func(v LookupNetworkInsightsAnalysisResult) []GetNetworkInsightsAnalysisFilter { return v.Filters }).(GetNetworkInsightsAnalysisFilterArrayOutput)
   162  }
   163  
   164  // The components in the path from source to destination.
   165  func (o LookupNetworkInsightsAnalysisResultOutput) ForwardPathComponents() GetNetworkInsightsAnalysisForwardPathComponentArrayOutput {
   166  	return o.ApplyT(func(v LookupNetworkInsightsAnalysisResult) []GetNetworkInsightsAnalysisForwardPathComponent {
   167  		return v.ForwardPathComponents
   168  	}).(GetNetworkInsightsAnalysisForwardPathComponentArrayOutput)
   169  }
   170  
   171  // The provider-assigned unique ID for this managed resource.
   172  func (o LookupNetworkInsightsAnalysisResultOutput) Id() pulumi.StringOutput {
   173  	return o.ApplyT(func(v LookupNetworkInsightsAnalysisResult) string { return v.Id }).(pulumi.StringOutput)
   174  }
   175  
   176  func (o LookupNetworkInsightsAnalysisResultOutput) NetworkInsightsAnalysisId() pulumi.StringOutput {
   177  	return o.ApplyT(func(v LookupNetworkInsightsAnalysisResult) string { return v.NetworkInsightsAnalysisId }).(pulumi.StringOutput)
   178  }
   179  
   180  // The ID of the path.
   181  func (o LookupNetworkInsightsAnalysisResultOutput) NetworkInsightsPathId() pulumi.StringOutput {
   182  	return o.ApplyT(func(v LookupNetworkInsightsAnalysisResult) string { return v.NetworkInsightsPathId }).(pulumi.StringOutput)
   183  }
   184  
   185  // Set to `true` if the destination was reachable.
   186  func (o LookupNetworkInsightsAnalysisResultOutput) PathFound() pulumi.BoolOutput {
   187  	return o.ApplyT(func(v LookupNetworkInsightsAnalysisResult) bool { return v.PathFound }).(pulumi.BoolOutput)
   188  }
   189  
   190  // The components in the path from destination to source.
   191  func (o LookupNetworkInsightsAnalysisResultOutput) ReturnPathComponents() GetNetworkInsightsAnalysisReturnPathComponentArrayOutput {
   192  	return o.ApplyT(func(v LookupNetworkInsightsAnalysisResult) []GetNetworkInsightsAnalysisReturnPathComponent {
   193  		return v.ReturnPathComponents
   194  	}).(GetNetworkInsightsAnalysisReturnPathComponentArrayOutput)
   195  }
   196  
   197  // Date/time the analysis was started.
   198  func (o LookupNetworkInsightsAnalysisResultOutput) StartDate() pulumi.StringOutput {
   199  	return o.ApplyT(func(v LookupNetworkInsightsAnalysisResult) string { return v.StartDate }).(pulumi.StringOutput)
   200  }
   201  
   202  // Status of the analysis. `succeeded` means the analysis was completed, not that a path was found, for that see `pathFound`.
   203  func (o LookupNetworkInsightsAnalysisResultOutput) Status() pulumi.StringOutput {
   204  	return o.ApplyT(func(v LookupNetworkInsightsAnalysisResult) string { return v.Status }).(pulumi.StringOutput)
   205  }
   206  
   207  // Message to provide more context when the `status` is `failed`.
   208  func (o LookupNetworkInsightsAnalysisResultOutput) StatusMessage() pulumi.StringOutput {
   209  	return o.ApplyT(func(v LookupNetworkInsightsAnalysisResult) string { return v.StatusMessage }).(pulumi.StringOutput)
   210  }
   211  
   212  func (o LookupNetworkInsightsAnalysisResultOutput) Tags() pulumi.StringMapOutput {
   213  	return o.ApplyT(func(v LookupNetworkInsightsAnalysisResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
   214  }
   215  
   216  // Warning message.
   217  func (o LookupNetworkInsightsAnalysisResultOutput) WarningMessage() pulumi.StringOutput {
   218  	return o.ApplyT(func(v LookupNetworkInsightsAnalysisResult) string { return v.WarningMessage }).(pulumi.StringOutput)
   219  }
   220  
   221  func init() {
   222  	pulumi.RegisterOutputType(LookupNetworkInsightsAnalysisResultOutput{})
   223  }