github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/fsx/getWindowsFileSystem.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 Windows File System.
    15  //
    16  // ## Example Usage
    17  //
    18  // ### Root volume Example
    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.LookupWindowsFileSystem(ctx, &fsx.LookupWindowsFileSystemArgs{
    34  //				Id: "fs-12345678",
    35  //			}, nil)
    36  //			if err != nil {
    37  //				return err
    38  //			}
    39  //			return nil
    40  //		})
    41  //	}
    42  //
    43  // ```
    44  // <!--End PulumiCodeChooser -->
    45  func LookupWindowsFileSystem(ctx *pulumi.Context, args *LookupWindowsFileSystemArgs, opts ...pulumi.InvokeOption) (*LookupWindowsFileSystemResult, error) {
    46  	opts = internal.PkgInvokeDefaultOpts(opts)
    47  	var rv LookupWindowsFileSystemResult
    48  	err := ctx.Invoke("aws:fsx/getWindowsFileSystem:getWindowsFileSystem", args, &rv, opts...)
    49  	if err != nil {
    50  		return nil, err
    51  	}
    52  	return &rv, nil
    53  }
    54  
    55  // A collection of arguments for invoking getWindowsFileSystem.
    56  type LookupWindowsFileSystemArgs struct {
    57  	// Identifier of the file system (e.g. `fs-12345678`).
    58  	Id string `pulumi:"id"`
    59  	// The tags to associate with the file system.
    60  	Tags map[string]string `pulumi:"tags"`
    61  }
    62  
    63  // A collection of values returned by getWindowsFileSystem.
    64  type LookupWindowsFileSystemResult struct {
    65  	// The ID for Microsoft Active Directory instance that the file system is join to.
    66  	ActiveDirectoryId string `pulumi:"activeDirectoryId"`
    67  	// An array DNS alias names associated with the Amazon FSx file system.
    68  	Aliases []string `pulumi:"aliases"`
    69  	// Amazon Resource Name of the file system.
    70  	Arn string `pulumi:"arn"`
    71  	// The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.
    72  	AuditLogConfigurations []GetWindowsFileSystemAuditLogConfiguration `pulumi:"auditLogConfigurations"`
    73  	// The number of days to retain automatic backups.
    74  	AutomaticBackupRetentionDays int    `pulumi:"automaticBackupRetentionDays"`
    75  	BackupId                     string `pulumi:"backupId"`
    76  	// A boolean flag indicating whether tags on the file system should be copied to backups.
    77  	CopyTagsToBackups bool `pulumi:"copyTagsToBackups"`
    78  	// The preferred time (in `HH:MM` format) to take daily automatic backups, in the UTC time zone.
    79  	DailyAutomaticBackupStartTime string `pulumi:"dailyAutomaticBackupStartTime"`
    80  	// The file system deployment type.
    81  	DeploymentType string `pulumi:"deploymentType"`
    82  	// The SSD IOPS configuration for the file system.
    83  	DiskIopsConfigurations []GetWindowsFileSystemDiskIopsConfiguration `pulumi:"diskIopsConfigurations"`
    84  	// DNS name for the file system (e.g. `fs-12345678.corp.example.com`).
    85  	DnsName string `pulumi:"dnsName"`
    86  	// Identifier of the file system (e.g. `fs-12345678`).
    87  	Id string `pulumi:"id"`
    88  	// ARN for the KMS Key to encrypt the file system at rest.
    89  	KmsKeyId            string   `pulumi:"kmsKeyId"`
    90  	NetworkInterfaceIds []string `pulumi:"networkInterfaceIds"`
    91  	// AWS account identifier that created the file system.
    92  	OwnerId string `pulumi:"ownerId"`
    93  	// The IP address of the primary, or preferred, file server.
    94  	PreferredFileServerIp string `pulumi:"preferredFileServerIp"`
    95  	// Specifies the subnet in which you want the preferred file server to be located.
    96  	PreferredSubnetId string   `pulumi:"preferredSubnetId"`
    97  	SecurityGroupIds  []string `pulumi:"securityGroupIds"`
    98  	SkipFinalBackup   bool     `pulumi:"skipFinalBackup"`
    99  	// The storage capacity of the file system in gibibytes (GiB).
   100  	StorageCapacity int `pulumi:"storageCapacity"`
   101  	// The type of storage the file system is using. If set to `SSD`, the file system uses solid state drive storage. If set to `HDD`, the file system uses hard disk drive storage.
   102  	StorageType string `pulumi:"storageType"`
   103  	// Specifies the IDs of the subnets that the file system is accessible from.
   104  	SubnetIds []string `pulumi:"subnetIds"`
   105  	// The tags to associate with the file system.
   106  	Tags map[string]string `pulumi:"tags"`
   107  	// Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of `8` and maximum of `2048`.
   108  	ThroughputCapacity int `pulumi:"throughputCapacity"`
   109  	// The ID of the primary virtual private cloud (VPC) for the file system.
   110  	VpcId string `pulumi:"vpcId"`
   111  	// The preferred start time (in `d:HH:MM` format) to perform weekly maintenance, in the UTC time zone.
   112  	WeeklyMaintenanceStartTime string `pulumi:"weeklyMaintenanceStartTime"`
   113  }
   114  
   115  func LookupWindowsFileSystemOutput(ctx *pulumi.Context, args LookupWindowsFileSystemOutputArgs, opts ...pulumi.InvokeOption) LookupWindowsFileSystemResultOutput {
   116  	return pulumi.ToOutputWithContext(context.Background(), args).
   117  		ApplyT(func(v interface{}) (LookupWindowsFileSystemResult, error) {
   118  			args := v.(LookupWindowsFileSystemArgs)
   119  			r, err := LookupWindowsFileSystem(ctx, &args, opts...)
   120  			var s LookupWindowsFileSystemResult
   121  			if r != nil {
   122  				s = *r
   123  			}
   124  			return s, err
   125  		}).(LookupWindowsFileSystemResultOutput)
   126  }
   127  
   128  // A collection of arguments for invoking getWindowsFileSystem.
   129  type LookupWindowsFileSystemOutputArgs struct {
   130  	// Identifier of the file system (e.g. `fs-12345678`).
   131  	Id pulumi.StringInput `pulumi:"id"`
   132  	// The tags to associate with the file system.
   133  	Tags pulumi.StringMapInput `pulumi:"tags"`
   134  }
   135  
   136  func (LookupWindowsFileSystemOutputArgs) ElementType() reflect.Type {
   137  	return reflect.TypeOf((*LookupWindowsFileSystemArgs)(nil)).Elem()
   138  }
   139  
   140  // A collection of values returned by getWindowsFileSystem.
   141  type LookupWindowsFileSystemResultOutput struct{ *pulumi.OutputState }
   142  
   143  func (LookupWindowsFileSystemResultOutput) ElementType() reflect.Type {
   144  	return reflect.TypeOf((*LookupWindowsFileSystemResult)(nil)).Elem()
   145  }
   146  
   147  func (o LookupWindowsFileSystemResultOutput) ToLookupWindowsFileSystemResultOutput() LookupWindowsFileSystemResultOutput {
   148  	return o
   149  }
   150  
   151  func (o LookupWindowsFileSystemResultOutput) ToLookupWindowsFileSystemResultOutputWithContext(ctx context.Context) LookupWindowsFileSystemResultOutput {
   152  	return o
   153  }
   154  
   155  // The ID for Microsoft Active Directory instance that the file system is join to.
   156  func (o LookupWindowsFileSystemResultOutput) ActiveDirectoryId() pulumi.StringOutput {
   157  	return o.ApplyT(func(v LookupWindowsFileSystemResult) string { return v.ActiveDirectoryId }).(pulumi.StringOutput)
   158  }
   159  
   160  // An array DNS alias names associated with the Amazon FSx file system.
   161  func (o LookupWindowsFileSystemResultOutput) Aliases() pulumi.StringArrayOutput {
   162  	return o.ApplyT(func(v LookupWindowsFileSystemResult) []string { return v.Aliases }).(pulumi.StringArrayOutput)
   163  }
   164  
   165  // Amazon Resource Name of the file system.
   166  func (o LookupWindowsFileSystemResultOutput) Arn() pulumi.StringOutput {
   167  	return o.ApplyT(func(v LookupWindowsFileSystemResult) string { return v.Arn }).(pulumi.StringOutput)
   168  }
   169  
   170  // The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.
   171  func (o LookupWindowsFileSystemResultOutput) AuditLogConfigurations() GetWindowsFileSystemAuditLogConfigurationArrayOutput {
   172  	return o.ApplyT(func(v LookupWindowsFileSystemResult) []GetWindowsFileSystemAuditLogConfiguration {
   173  		return v.AuditLogConfigurations
   174  	}).(GetWindowsFileSystemAuditLogConfigurationArrayOutput)
   175  }
   176  
   177  // The number of days to retain automatic backups.
   178  func (o LookupWindowsFileSystemResultOutput) AutomaticBackupRetentionDays() pulumi.IntOutput {
   179  	return o.ApplyT(func(v LookupWindowsFileSystemResult) int { return v.AutomaticBackupRetentionDays }).(pulumi.IntOutput)
   180  }
   181  
   182  func (o LookupWindowsFileSystemResultOutput) BackupId() pulumi.StringOutput {
   183  	return o.ApplyT(func(v LookupWindowsFileSystemResult) string { return v.BackupId }).(pulumi.StringOutput)
   184  }
   185  
   186  // A boolean flag indicating whether tags on the file system should be copied to backups.
   187  func (o LookupWindowsFileSystemResultOutput) CopyTagsToBackups() pulumi.BoolOutput {
   188  	return o.ApplyT(func(v LookupWindowsFileSystemResult) bool { return v.CopyTagsToBackups }).(pulumi.BoolOutput)
   189  }
   190  
   191  // The preferred time (in `HH:MM` format) to take daily automatic backups, in the UTC time zone.
   192  func (o LookupWindowsFileSystemResultOutput) DailyAutomaticBackupStartTime() pulumi.StringOutput {
   193  	return o.ApplyT(func(v LookupWindowsFileSystemResult) string { return v.DailyAutomaticBackupStartTime }).(pulumi.StringOutput)
   194  }
   195  
   196  // The file system deployment type.
   197  func (o LookupWindowsFileSystemResultOutput) DeploymentType() pulumi.StringOutput {
   198  	return o.ApplyT(func(v LookupWindowsFileSystemResult) string { return v.DeploymentType }).(pulumi.StringOutput)
   199  }
   200  
   201  // The SSD IOPS configuration for the file system.
   202  func (o LookupWindowsFileSystemResultOutput) DiskIopsConfigurations() GetWindowsFileSystemDiskIopsConfigurationArrayOutput {
   203  	return o.ApplyT(func(v LookupWindowsFileSystemResult) []GetWindowsFileSystemDiskIopsConfiguration {
   204  		return v.DiskIopsConfigurations
   205  	}).(GetWindowsFileSystemDiskIopsConfigurationArrayOutput)
   206  }
   207  
   208  // DNS name for the file system (e.g. `fs-12345678.corp.example.com`).
   209  func (o LookupWindowsFileSystemResultOutput) DnsName() pulumi.StringOutput {
   210  	return o.ApplyT(func(v LookupWindowsFileSystemResult) string { return v.DnsName }).(pulumi.StringOutput)
   211  }
   212  
   213  // Identifier of the file system (e.g. `fs-12345678`).
   214  func (o LookupWindowsFileSystemResultOutput) Id() pulumi.StringOutput {
   215  	return o.ApplyT(func(v LookupWindowsFileSystemResult) string { return v.Id }).(pulumi.StringOutput)
   216  }
   217  
   218  // ARN for the KMS Key to encrypt the file system at rest.
   219  func (o LookupWindowsFileSystemResultOutput) KmsKeyId() pulumi.StringOutput {
   220  	return o.ApplyT(func(v LookupWindowsFileSystemResult) string { return v.KmsKeyId }).(pulumi.StringOutput)
   221  }
   222  
   223  func (o LookupWindowsFileSystemResultOutput) NetworkInterfaceIds() pulumi.StringArrayOutput {
   224  	return o.ApplyT(func(v LookupWindowsFileSystemResult) []string { return v.NetworkInterfaceIds }).(pulumi.StringArrayOutput)
   225  }
   226  
   227  // AWS account identifier that created the file system.
   228  func (o LookupWindowsFileSystemResultOutput) OwnerId() pulumi.StringOutput {
   229  	return o.ApplyT(func(v LookupWindowsFileSystemResult) string { return v.OwnerId }).(pulumi.StringOutput)
   230  }
   231  
   232  // The IP address of the primary, or preferred, file server.
   233  func (o LookupWindowsFileSystemResultOutput) PreferredFileServerIp() pulumi.StringOutput {
   234  	return o.ApplyT(func(v LookupWindowsFileSystemResult) string { return v.PreferredFileServerIp }).(pulumi.StringOutput)
   235  }
   236  
   237  // Specifies the subnet in which you want the preferred file server to be located.
   238  func (o LookupWindowsFileSystemResultOutput) PreferredSubnetId() pulumi.StringOutput {
   239  	return o.ApplyT(func(v LookupWindowsFileSystemResult) string { return v.PreferredSubnetId }).(pulumi.StringOutput)
   240  }
   241  
   242  func (o LookupWindowsFileSystemResultOutput) SecurityGroupIds() pulumi.StringArrayOutput {
   243  	return o.ApplyT(func(v LookupWindowsFileSystemResult) []string { return v.SecurityGroupIds }).(pulumi.StringArrayOutput)
   244  }
   245  
   246  func (o LookupWindowsFileSystemResultOutput) SkipFinalBackup() pulumi.BoolOutput {
   247  	return o.ApplyT(func(v LookupWindowsFileSystemResult) bool { return v.SkipFinalBackup }).(pulumi.BoolOutput)
   248  }
   249  
   250  // The storage capacity of the file system in gibibytes (GiB).
   251  func (o LookupWindowsFileSystemResultOutput) StorageCapacity() pulumi.IntOutput {
   252  	return o.ApplyT(func(v LookupWindowsFileSystemResult) int { return v.StorageCapacity }).(pulumi.IntOutput)
   253  }
   254  
   255  // The type of storage the file system is using. If set to `SSD`, the file system uses solid state drive storage. If set to `HDD`, the file system uses hard disk drive storage.
   256  func (o LookupWindowsFileSystemResultOutput) StorageType() pulumi.StringOutput {
   257  	return o.ApplyT(func(v LookupWindowsFileSystemResult) string { return v.StorageType }).(pulumi.StringOutput)
   258  }
   259  
   260  // Specifies the IDs of the subnets that the file system is accessible from.
   261  func (o LookupWindowsFileSystemResultOutput) SubnetIds() pulumi.StringArrayOutput {
   262  	return o.ApplyT(func(v LookupWindowsFileSystemResult) []string { return v.SubnetIds }).(pulumi.StringArrayOutput)
   263  }
   264  
   265  // The tags to associate with the file system.
   266  func (o LookupWindowsFileSystemResultOutput) Tags() pulumi.StringMapOutput {
   267  	return o.ApplyT(func(v LookupWindowsFileSystemResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
   268  }
   269  
   270  // Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of `8` and maximum of `2048`.
   271  func (o LookupWindowsFileSystemResultOutput) ThroughputCapacity() pulumi.IntOutput {
   272  	return o.ApplyT(func(v LookupWindowsFileSystemResult) int { return v.ThroughputCapacity }).(pulumi.IntOutput)
   273  }
   274  
   275  // The ID of the primary virtual private cloud (VPC) for the file system.
   276  func (o LookupWindowsFileSystemResultOutput) VpcId() pulumi.StringOutput {
   277  	return o.ApplyT(func(v LookupWindowsFileSystemResult) string { return v.VpcId }).(pulumi.StringOutput)
   278  }
   279  
   280  // The preferred start time (in `d:HH:MM` format) to perform weekly maintenance, in the UTC time zone.
   281  func (o LookupWindowsFileSystemResultOutput) WeeklyMaintenanceStartTime() pulumi.StringOutput {
   282  	return o.ApplyT(func(v LookupWindowsFileSystemResult) string { return v.WeeklyMaintenanceStartTime }).(pulumi.StringOutput)
   283  }
   284  
   285  func init() {
   286  	pulumi.RegisterOutputType(LookupWindowsFileSystemResultOutput{})
   287  }