github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/efs/getAccessPoint.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 efs
     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  // Provides information about an Elastic File System (EFS) Access Point.
    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/efs"
    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 := efs.LookupAccessPoint(ctx, &efs.LookupAccessPointArgs{
    32  //				AccessPointId: "fsap-12345678",
    33  //			}, nil)
    34  //			if err != nil {
    35  //				return err
    36  //			}
    37  //			return nil
    38  //		})
    39  //	}
    40  //
    41  // ```
    42  // <!--End PulumiCodeChooser -->
    43  func LookupAccessPoint(ctx *pulumi.Context, args *LookupAccessPointArgs, opts ...pulumi.InvokeOption) (*LookupAccessPointResult, error) {
    44  	opts = internal.PkgInvokeDefaultOpts(opts)
    45  	var rv LookupAccessPointResult
    46  	err := ctx.Invoke("aws:efs/getAccessPoint:getAccessPoint", 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 getAccessPoint.
    54  type LookupAccessPointArgs struct {
    55  	// ID that identifies the file system.
    56  	AccessPointId string `pulumi:"accessPointId"`
    57  	// Key-value mapping of resource tags.
    58  	Tags map[string]string `pulumi:"tags"`
    59  }
    60  
    61  // A collection of values returned by getAccessPoint.
    62  type LookupAccessPointResult struct {
    63  	AccessPointId string `pulumi:"accessPointId"`
    64  	// Amazon Resource Name of the file system.
    65  	Arn string `pulumi:"arn"`
    66  	// Amazon Resource Name of the file system.
    67  	FileSystemArn string `pulumi:"fileSystemArn"`
    68  	// ID of the file system for which the access point is intended.
    69  	FileSystemId string `pulumi:"fileSystemId"`
    70  	// The provider-assigned unique ID for this managed resource.
    71  	Id      string `pulumi:"id"`
    72  	OwnerId string `pulumi:"ownerId"`
    73  	// Single element list containing operating system user and group applied to all file system requests made using the access point.
    74  	PosixUsers []GetAccessPointPosixUser `pulumi:"posixUsers"`
    75  	// Single element list containing information on the directory on the Amazon EFS file system that the access point provides access to.
    76  	RootDirectories []GetAccessPointRootDirectory `pulumi:"rootDirectories"`
    77  	// Key-value mapping of resource tags.
    78  	Tags map[string]string `pulumi:"tags"`
    79  }
    80  
    81  func LookupAccessPointOutput(ctx *pulumi.Context, args LookupAccessPointOutputArgs, opts ...pulumi.InvokeOption) LookupAccessPointResultOutput {
    82  	return pulumi.ToOutputWithContext(context.Background(), args).
    83  		ApplyT(func(v interface{}) (LookupAccessPointResult, error) {
    84  			args := v.(LookupAccessPointArgs)
    85  			r, err := LookupAccessPoint(ctx, &args, opts...)
    86  			var s LookupAccessPointResult
    87  			if r != nil {
    88  				s = *r
    89  			}
    90  			return s, err
    91  		}).(LookupAccessPointResultOutput)
    92  }
    93  
    94  // A collection of arguments for invoking getAccessPoint.
    95  type LookupAccessPointOutputArgs struct {
    96  	// ID that identifies the file system.
    97  	AccessPointId pulumi.StringInput `pulumi:"accessPointId"`
    98  	// Key-value mapping of resource tags.
    99  	Tags pulumi.StringMapInput `pulumi:"tags"`
   100  }
   101  
   102  func (LookupAccessPointOutputArgs) ElementType() reflect.Type {
   103  	return reflect.TypeOf((*LookupAccessPointArgs)(nil)).Elem()
   104  }
   105  
   106  // A collection of values returned by getAccessPoint.
   107  type LookupAccessPointResultOutput struct{ *pulumi.OutputState }
   108  
   109  func (LookupAccessPointResultOutput) ElementType() reflect.Type {
   110  	return reflect.TypeOf((*LookupAccessPointResult)(nil)).Elem()
   111  }
   112  
   113  func (o LookupAccessPointResultOutput) ToLookupAccessPointResultOutput() LookupAccessPointResultOutput {
   114  	return o
   115  }
   116  
   117  func (o LookupAccessPointResultOutput) ToLookupAccessPointResultOutputWithContext(ctx context.Context) LookupAccessPointResultOutput {
   118  	return o
   119  }
   120  
   121  func (o LookupAccessPointResultOutput) AccessPointId() pulumi.StringOutput {
   122  	return o.ApplyT(func(v LookupAccessPointResult) string { return v.AccessPointId }).(pulumi.StringOutput)
   123  }
   124  
   125  // Amazon Resource Name of the file system.
   126  func (o LookupAccessPointResultOutput) Arn() pulumi.StringOutput {
   127  	return o.ApplyT(func(v LookupAccessPointResult) string { return v.Arn }).(pulumi.StringOutput)
   128  }
   129  
   130  // Amazon Resource Name of the file system.
   131  func (o LookupAccessPointResultOutput) FileSystemArn() pulumi.StringOutput {
   132  	return o.ApplyT(func(v LookupAccessPointResult) string { return v.FileSystemArn }).(pulumi.StringOutput)
   133  }
   134  
   135  // ID of the file system for which the access point is intended.
   136  func (o LookupAccessPointResultOutput) FileSystemId() pulumi.StringOutput {
   137  	return o.ApplyT(func(v LookupAccessPointResult) string { return v.FileSystemId }).(pulumi.StringOutput)
   138  }
   139  
   140  // The provider-assigned unique ID for this managed resource.
   141  func (o LookupAccessPointResultOutput) Id() pulumi.StringOutput {
   142  	return o.ApplyT(func(v LookupAccessPointResult) string { return v.Id }).(pulumi.StringOutput)
   143  }
   144  
   145  func (o LookupAccessPointResultOutput) OwnerId() pulumi.StringOutput {
   146  	return o.ApplyT(func(v LookupAccessPointResult) string { return v.OwnerId }).(pulumi.StringOutput)
   147  }
   148  
   149  // Single element list containing operating system user and group applied to all file system requests made using the access point.
   150  func (o LookupAccessPointResultOutput) PosixUsers() GetAccessPointPosixUserArrayOutput {
   151  	return o.ApplyT(func(v LookupAccessPointResult) []GetAccessPointPosixUser { return v.PosixUsers }).(GetAccessPointPosixUserArrayOutput)
   152  }
   153  
   154  // Single element list containing information on the directory on the Amazon EFS file system that the access point provides access to.
   155  func (o LookupAccessPointResultOutput) RootDirectories() GetAccessPointRootDirectoryArrayOutput {
   156  	return o.ApplyT(func(v LookupAccessPointResult) []GetAccessPointRootDirectory { return v.RootDirectories }).(GetAccessPointRootDirectoryArrayOutput)
   157  }
   158  
   159  // Key-value mapping of resource tags.
   160  func (o LookupAccessPointResultOutput) Tags() pulumi.StringMapOutput {
   161  	return o.ApplyT(func(v LookupAccessPointResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
   162  }
   163  
   164  func init() {
   165  	pulumi.RegisterOutputType(LookupAccessPointResultOutput{})
   166  }