github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/fsx/getOntapStorageVirtualMachine.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 fsx
     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 on FSx ONTAP Storage Virtual Machine (SVM).
    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/fsx"
    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 := fsx.LookupOntapStorageVirtualMachine(ctx, &fsx.LookupOntapStorageVirtualMachineArgs{
    34  //				Id: pulumi.StringRef("svm-12345678"),
    35  //			}, nil)
    36  //			if err != nil {
    37  //				return err
    38  //			}
    39  //			return nil
    40  //		})
    41  //	}
    42  //
    43  // ```
    44  // <!--End PulumiCodeChooser -->
    45  //
    46  // ### Filter Example
    47  //
    48  // <!--Start PulumiCodeChooser -->
    49  // ```go
    50  // package main
    51  //
    52  // import (
    53  //
    54  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/fsx"
    55  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    56  //
    57  // )
    58  //
    59  //	func main() {
    60  //		pulumi.Run(func(ctx *pulumi.Context) error {
    61  //			_, err := fsx.LookupOntapStorageVirtualMachine(ctx, &fsx.LookupOntapStorageVirtualMachineArgs{
    62  //				Filters: []fsx.GetOntapStorageVirtualMachineFilter{
    63  //					{
    64  //						Name: "file-system-id",
    65  //						Values: []string{
    66  //							"fs-12345678",
    67  //						},
    68  //					},
    69  //				},
    70  //			}, nil)
    71  //			if err != nil {
    72  //				return err
    73  //			}
    74  //			return nil
    75  //		})
    76  //	}
    77  //
    78  // ```
    79  // <!--End PulumiCodeChooser -->
    80  func LookupOntapStorageVirtualMachine(ctx *pulumi.Context, args *LookupOntapStorageVirtualMachineArgs, opts ...pulumi.InvokeOption) (*LookupOntapStorageVirtualMachineResult, error) {
    81  	opts = internal.PkgInvokeDefaultOpts(opts)
    82  	var rv LookupOntapStorageVirtualMachineResult
    83  	err := ctx.Invoke("aws:fsx/getOntapStorageVirtualMachine:getOntapStorageVirtualMachine", args, &rv, opts...)
    84  	if err != nil {
    85  		return nil, err
    86  	}
    87  	return &rv, nil
    88  }
    89  
    90  // A collection of arguments for invoking getOntapStorageVirtualMachine.
    91  type LookupOntapStorageVirtualMachineArgs struct {
    92  	// Configuration block. Detailed below.
    93  	Filters []GetOntapStorageVirtualMachineFilter `pulumi:"filters"`
    94  	// Identifier of the storage virtual machine (e.g. `svm-12345678`).
    95  	Id   *string           `pulumi:"id"`
    96  	Tags map[string]string `pulumi:"tags"`
    97  }
    98  
    99  // A collection of values returned by getOntapStorageVirtualMachine.
   100  type LookupOntapStorageVirtualMachineResult struct {
   101  	// The Microsoft Active Directory configuration to which the SVM is joined, if applicable. See Active Directory Configuration below.
   102  	ActiveDirectoryConfigurations []GetOntapStorageVirtualMachineActiveDirectoryConfiguration `pulumi:"activeDirectoryConfigurations"`
   103  	// Amazon Resource Name of the SVM.
   104  	Arn string `pulumi:"arn"`
   105  	// The time that the SVM was created.
   106  	CreationTime string `pulumi:"creationTime"`
   107  	// The endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi, Management, Nfs, and Smb endpoints. See SVM Endpoints below.
   108  	Endpoints []GetOntapStorageVirtualMachineEndpoint `pulumi:"endpoints"`
   109  	// Identifier of the file system (e.g. `fs-12345678`).
   110  	FileSystemId string                                `pulumi:"fileSystemId"`
   111  	Filters      []GetOntapStorageVirtualMachineFilter `pulumi:"filters"`
   112  	// The SVM's system generated unique ID.
   113  	Id string `pulumi:"id"`
   114  	// The SVM's lifecycle status.
   115  	LifecycleStatus string `pulumi:"lifecycleStatus"`
   116  	// Describes why the SVM lifecycle state changed. See Lifecycle Transition Reason below.
   117  	LifecycleTransitionReasons []GetOntapStorageVirtualMachineLifecycleTransitionReason `pulumi:"lifecycleTransitionReasons"`
   118  	// The name of the SVM, if provisioned.
   119  	Name string `pulumi:"name"`
   120  	// The SVM's subtype.
   121  	Subtype string            `pulumi:"subtype"`
   122  	Tags    map[string]string `pulumi:"tags"`
   123  	// The SVM's UUID.
   124  	Uuid string `pulumi:"uuid"`
   125  }
   126  
   127  func LookupOntapStorageVirtualMachineOutput(ctx *pulumi.Context, args LookupOntapStorageVirtualMachineOutputArgs, opts ...pulumi.InvokeOption) LookupOntapStorageVirtualMachineResultOutput {
   128  	return pulumi.ToOutputWithContext(context.Background(), args).
   129  		ApplyT(func(v interface{}) (LookupOntapStorageVirtualMachineResult, error) {
   130  			args := v.(LookupOntapStorageVirtualMachineArgs)
   131  			r, err := LookupOntapStorageVirtualMachine(ctx, &args, opts...)
   132  			var s LookupOntapStorageVirtualMachineResult
   133  			if r != nil {
   134  				s = *r
   135  			}
   136  			return s, err
   137  		}).(LookupOntapStorageVirtualMachineResultOutput)
   138  }
   139  
   140  // A collection of arguments for invoking getOntapStorageVirtualMachine.
   141  type LookupOntapStorageVirtualMachineOutputArgs struct {
   142  	// Configuration block. Detailed below.
   143  	Filters GetOntapStorageVirtualMachineFilterArrayInput `pulumi:"filters"`
   144  	// Identifier of the storage virtual machine (e.g. `svm-12345678`).
   145  	Id   pulumi.StringPtrInput `pulumi:"id"`
   146  	Tags pulumi.StringMapInput `pulumi:"tags"`
   147  }
   148  
   149  func (LookupOntapStorageVirtualMachineOutputArgs) ElementType() reflect.Type {
   150  	return reflect.TypeOf((*LookupOntapStorageVirtualMachineArgs)(nil)).Elem()
   151  }
   152  
   153  // A collection of values returned by getOntapStorageVirtualMachine.
   154  type LookupOntapStorageVirtualMachineResultOutput struct{ *pulumi.OutputState }
   155  
   156  func (LookupOntapStorageVirtualMachineResultOutput) ElementType() reflect.Type {
   157  	return reflect.TypeOf((*LookupOntapStorageVirtualMachineResult)(nil)).Elem()
   158  }
   159  
   160  func (o LookupOntapStorageVirtualMachineResultOutput) ToLookupOntapStorageVirtualMachineResultOutput() LookupOntapStorageVirtualMachineResultOutput {
   161  	return o
   162  }
   163  
   164  func (o LookupOntapStorageVirtualMachineResultOutput) ToLookupOntapStorageVirtualMachineResultOutputWithContext(ctx context.Context) LookupOntapStorageVirtualMachineResultOutput {
   165  	return o
   166  }
   167  
   168  // The Microsoft Active Directory configuration to which the SVM is joined, if applicable. See Active Directory Configuration below.
   169  func (o LookupOntapStorageVirtualMachineResultOutput) ActiveDirectoryConfigurations() GetOntapStorageVirtualMachineActiveDirectoryConfigurationArrayOutput {
   170  	return o.ApplyT(func(v LookupOntapStorageVirtualMachineResult) []GetOntapStorageVirtualMachineActiveDirectoryConfiguration {
   171  		return v.ActiveDirectoryConfigurations
   172  	}).(GetOntapStorageVirtualMachineActiveDirectoryConfigurationArrayOutput)
   173  }
   174  
   175  // Amazon Resource Name of the SVM.
   176  func (o LookupOntapStorageVirtualMachineResultOutput) Arn() pulumi.StringOutput {
   177  	return o.ApplyT(func(v LookupOntapStorageVirtualMachineResult) string { return v.Arn }).(pulumi.StringOutput)
   178  }
   179  
   180  // The time that the SVM was created.
   181  func (o LookupOntapStorageVirtualMachineResultOutput) CreationTime() pulumi.StringOutput {
   182  	return o.ApplyT(func(v LookupOntapStorageVirtualMachineResult) string { return v.CreationTime }).(pulumi.StringOutput)
   183  }
   184  
   185  // The endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi, Management, Nfs, and Smb endpoints. See SVM Endpoints below.
   186  func (o LookupOntapStorageVirtualMachineResultOutput) Endpoints() GetOntapStorageVirtualMachineEndpointArrayOutput {
   187  	return o.ApplyT(func(v LookupOntapStorageVirtualMachineResult) []GetOntapStorageVirtualMachineEndpoint {
   188  		return v.Endpoints
   189  	}).(GetOntapStorageVirtualMachineEndpointArrayOutput)
   190  }
   191  
   192  // Identifier of the file system (e.g. `fs-12345678`).
   193  func (o LookupOntapStorageVirtualMachineResultOutput) FileSystemId() pulumi.StringOutput {
   194  	return o.ApplyT(func(v LookupOntapStorageVirtualMachineResult) string { return v.FileSystemId }).(pulumi.StringOutput)
   195  }
   196  
   197  func (o LookupOntapStorageVirtualMachineResultOutput) Filters() GetOntapStorageVirtualMachineFilterArrayOutput {
   198  	return o.ApplyT(func(v LookupOntapStorageVirtualMachineResult) []GetOntapStorageVirtualMachineFilter { return v.Filters }).(GetOntapStorageVirtualMachineFilterArrayOutput)
   199  }
   200  
   201  // The SVM's system generated unique ID.
   202  func (o LookupOntapStorageVirtualMachineResultOutput) Id() pulumi.StringOutput {
   203  	return o.ApplyT(func(v LookupOntapStorageVirtualMachineResult) string { return v.Id }).(pulumi.StringOutput)
   204  }
   205  
   206  // The SVM's lifecycle status.
   207  func (o LookupOntapStorageVirtualMachineResultOutput) LifecycleStatus() pulumi.StringOutput {
   208  	return o.ApplyT(func(v LookupOntapStorageVirtualMachineResult) string { return v.LifecycleStatus }).(pulumi.StringOutput)
   209  }
   210  
   211  // Describes why the SVM lifecycle state changed. See Lifecycle Transition Reason below.
   212  func (o LookupOntapStorageVirtualMachineResultOutput) LifecycleTransitionReasons() GetOntapStorageVirtualMachineLifecycleTransitionReasonArrayOutput {
   213  	return o.ApplyT(func(v LookupOntapStorageVirtualMachineResult) []GetOntapStorageVirtualMachineLifecycleTransitionReason {
   214  		return v.LifecycleTransitionReasons
   215  	}).(GetOntapStorageVirtualMachineLifecycleTransitionReasonArrayOutput)
   216  }
   217  
   218  // The name of the SVM, if provisioned.
   219  func (o LookupOntapStorageVirtualMachineResultOutput) Name() pulumi.StringOutput {
   220  	return o.ApplyT(func(v LookupOntapStorageVirtualMachineResult) string { return v.Name }).(pulumi.StringOutput)
   221  }
   222  
   223  // The SVM's subtype.
   224  func (o LookupOntapStorageVirtualMachineResultOutput) Subtype() pulumi.StringOutput {
   225  	return o.ApplyT(func(v LookupOntapStorageVirtualMachineResult) string { return v.Subtype }).(pulumi.StringOutput)
   226  }
   227  
   228  func (o LookupOntapStorageVirtualMachineResultOutput) Tags() pulumi.StringMapOutput {
   229  	return o.ApplyT(func(v LookupOntapStorageVirtualMachineResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
   230  }
   231  
   232  // The SVM's UUID.
   233  func (o LookupOntapStorageVirtualMachineResultOutput) Uuid() pulumi.StringOutput {
   234  	return o.ApplyT(func(v LookupOntapStorageVirtualMachineResult) string { return v.Uuid }).(pulumi.StringOutput)
   235  }
   236  
   237  func init() {
   238  	pulumi.RegisterOutputType(LookupOntapStorageVirtualMachineResultOutput{})
   239  }