github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/workspaces/getDirectory.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 workspaces
     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 an AWS WorkSpaces directory.
    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/workspaces"
    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 := workspaces.LookupDirectory(ctx, &workspaces.LookupDirectoryArgs{
    32  //				DirectoryId: "d-9067783251",
    33  //			}, nil)
    34  //			if err != nil {
    35  //				return err
    36  //			}
    37  //			return nil
    38  //		})
    39  //	}
    40  //
    41  // ```
    42  // <!--End PulumiCodeChooser -->
    43  func LookupDirectory(ctx *pulumi.Context, args *LookupDirectoryArgs, opts ...pulumi.InvokeOption) (*LookupDirectoryResult, error) {
    44  	opts = internal.PkgInvokeDefaultOpts(opts)
    45  	var rv LookupDirectoryResult
    46  	err := ctx.Invoke("aws:workspaces/getDirectory:getDirectory", 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 getDirectory.
    54  type LookupDirectoryArgs struct {
    55  	// Directory identifier for registration in WorkSpaces service.
    56  	DirectoryId string `pulumi:"directoryId"`
    57  	// A map of tags assigned to the WorkSpaces directory.
    58  	Tags map[string]string `pulumi:"tags"`
    59  }
    60  
    61  // A collection of values returned by getDirectory.
    62  type LookupDirectoryResult struct {
    63  	// Directory alias.
    64  	Alias string `pulumi:"alias"`
    65  	// User name for the service account.
    66  	CustomerUserName string `pulumi:"customerUserName"`
    67  	DirectoryId      string `pulumi:"directoryId"`
    68  	// Name of the directory.
    69  	DirectoryName string `pulumi:"directoryName"`
    70  	// Directory type.
    71  	DirectoryType string `pulumi:"directoryType"`
    72  	// IP addresses of the DNS servers for the directory.
    73  	DnsIpAddresses []string `pulumi:"dnsIpAddresses"`
    74  	// Identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.
    75  	IamRoleId string `pulumi:"iamRoleId"`
    76  	// The provider-assigned unique ID for this managed resource.
    77  	Id string `pulumi:"id"`
    78  	// Identifiers of the IP access control groups associated with the directory.
    79  	IpGroupIds []string `pulumi:"ipGroupIds"`
    80  	// Registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
    81  	RegistrationCode string `pulumi:"registrationCode"`
    82  	// The permissions to enable or disable self-service capabilities.
    83  	SelfServicePermissions []GetDirectorySelfServicePermission `pulumi:"selfServicePermissions"`
    84  	// Identifiers of the subnets where the directory resides.
    85  	SubnetIds []string `pulumi:"subnetIds"`
    86  	// A map of tags assigned to the WorkSpaces directory.
    87  	Tags map[string]string `pulumi:"tags"`
    88  	// (Optional) Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below.
    89  	WorkspaceAccessProperties []GetDirectoryWorkspaceAccessProperty `pulumi:"workspaceAccessProperties"`
    90  	// The default properties that are used for creating WorkSpaces. Defined below.
    91  	WorkspaceCreationProperties []GetDirectoryWorkspaceCreationProperty `pulumi:"workspaceCreationProperties"`
    92  	// The identifier of the security group that is assigned to new WorkSpaces. Defined below.
    93  	WorkspaceSecurityGroupId string `pulumi:"workspaceSecurityGroupId"`
    94  }
    95  
    96  func LookupDirectoryOutput(ctx *pulumi.Context, args LookupDirectoryOutputArgs, opts ...pulumi.InvokeOption) LookupDirectoryResultOutput {
    97  	return pulumi.ToOutputWithContext(context.Background(), args).
    98  		ApplyT(func(v interface{}) (LookupDirectoryResult, error) {
    99  			args := v.(LookupDirectoryArgs)
   100  			r, err := LookupDirectory(ctx, &args, opts...)
   101  			var s LookupDirectoryResult
   102  			if r != nil {
   103  				s = *r
   104  			}
   105  			return s, err
   106  		}).(LookupDirectoryResultOutput)
   107  }
   108  
   109  // A collection of arguments for invoking getDirectory.
   110  type LookupDirectoryOutputArgs struct {
   111  	// Directory identifier for registration in WorkSpaces service.
   112  	DirectoryId pulumi.StringInput `pulumi:"directoryId"`
   113  	// A map of tags assigned to the WorkSpaces directory.
   114  	Tags pulumi.StringMapInput `pulumi:"tags"`
   115  }
   116  
   117  func (LookupDirectoryOutputArgs) ElementType() reflect.Type {
   118  	return reflect.TypeOf((*LookupDirectoryArgs)(nil)).Elem()
   119  }
   120  
   121  // A collection of values returned by getDirectory.
   122  type LookupDirectoryResultOutput struct{ *pulumi.OutputState }
   123  
   124  func (LookupDirectoryResultOutput) ElementType() reflect.Type {
   125  	return reflect.TypeOf((*LookupDirectoryResult)(nil)).Elem()
   126  }
   127  
   128  func (o LookupDirectoryResultOutput) ToLookupDirectoryResultOutput() LookupDirectoryResultOutput {
   129  	return o
   130  }
   131  
   132  func (o LookupDirectoryResultOutput) ToLookupDirectoryResultOutputWithContext(ctx context.Context) LookupDirectoryResultOutput {
   133  	return o
   134  }
   135  
   136  // Directory alias.
   137  func (o LookupDirectoryResultOutput) Alias() pulumi.StringOutput {
   138  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.Alias }).(pulumi.StringOutput)
   139  }
   140  
   141  // User name for the service account.
   142  func (o LookupDirectoryResultOutput) CustomerUserName() pulumi.StringOutput {
   143  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.CustomerUserName }).(pulumi.StringOutput)
   144  }
   145  
   146  func (o LookupDirectoryResultOutput) DirectoryId() pulumi.StringOutput {
   147  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.DirectoryId }).(pulumi.StringOutput)
   148  }
   149  
   150  // Name of the directory.
   151  func (o LookupDirectoryResultOutput) DirectoryName() pulumi.StringOutput {
   152  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.DirectoryName }).(pulumi.StringOutput)
   153  }
   154  
   155  // Directory type.
   156  func (o LookupDirectoryResultOutput) DirectoryType() pulumi.StringOutput {
   157  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.DirectoryType }).(pulumi.StringOutput)
   158  }
   159  
   160  // IP addresses of the DNS servers for the directory.
   161  func (o LookupDirectoryResultOutput) DnsIpAddresses() pulumi.StringArrayOutput {
   162  	return o.ApplyT(func(v LookupDirectoryResult) []string { return v.DnsIpAddresses }).(pulumi.StringArrayOutput)
   163  }
   164  
   165  // Identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.
   166  func (o LookupDirectoryResultOutput) IamRoleId() pulumi.StringOutput {
   167  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.IamRoleId }).(pulumi.StringOutput)
   168  }
   169  
   170  // The provider-assigned unique ID for this managed resource.
   171  func (o LookupDirectoryResultOutput) Id() pulumi.StringOutput {
   172  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.Id }).(pulumi.StringOutput)
   173  }
   174  
   175  // Identifiers of the IP access control groups associated with the directory.
   176  func (o LookupDirectoryResultOutput) IpGroupIds() pulumi.StringArrayOutput {
   177  	return o.ApplyT(func(v LookupDirectoryResult) []string { return v.IpGroupIds }).(pulumi.StringArrayOutput)
   178  }
   179  
   180  // Registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
   181  func (o LookupDirectoryResultOutput) RegistrationCode() pulumi.StringOutput {
   182  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.RegistrationCode }).(pulumi.StringOutput)
   183  }
   184  
   185  // The permissions to enable or disable self-service capabilities.
   186  func (o LookupDirectoryResultOutput) SelfServicePermissions() GetDirectorySelfServicePermissionArrayOutput {
   187  	return o.ApplyT(func(v LookupDirectoryResult) []GetDirectorySelfServicePermission { return v.SelfServicePermissions }).(GetDirectorySelfServicePermissionArrayOutput)
   188  }
   189  
   190  // Identifiers of the subnets where the directory resides.
   191  func (o LookupDirectoryResultOutput) SubnetIds() pulumi.StringArrayOutput {
   192  	return o.ApplyT(func(v LookupDirectoryResult) []string { return v.SubnetIds }).(pulumi.StringArrayOutput)
   193  }
   194  
   195  // A map of tags assigned to the WorkSpaces directory.
   196  func (o LookupDirectoryResultOutput) Tags() pulumi.StringMapOutput {
   197  	return o.ApplyT(func(v LookupDirectoryResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
   198  }
   199  
   200  // (Optional) Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below.
   201  func (o LookupDirectoryResultOutput) WorkspaceAccessProperties() GetDirectoryWorkspaceAccessPropertyArrayOutput {
   202  	return o.ApplyT(func(v LookupDirectoryResult) []GetDirectoryWorkspaceAccessProperty {
   203  		return v.WorkspaceAccessProperties
   204  	}).(GetDirectoryWorkspaceAccessPropertyArrayOutput)
   205  }
   206  
   207  // The default properties that are used for creating WorkSpaces. Defined below.
   208  func (o LookupDirectoryResultOutput) WorkspaceCreationProperties() GetDirectoryWorkspaceCreationPropertyArrayOutput {
   209  	return o.ApplyT(func(v LookupDirectoryResult) []GetDirectoryWorkspaceCreationProperty {
   210  		return v.WorkspaceCreationProperties
   211  	}).(GetDirectoryWorkspaceCreationPropertyArrayOutput)
   212  }
   213  
   214  // The identifier of the security group that is assigned to new WorkSpaces. Defined below.
   215  func (o LookupDirectoryResultOutput) WorkspaceSecurityGroupId() pulumi.StringOutput {
   216  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.WorkspaceSecurityGroupId }).(pulumi.StringOutput)
   217  }
   218  
   219  func init() {
   220  	pulumi.RegisterOutputType(LookupDirectoryResultOutput{})
   221  }