github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/directoryservice/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 directoryservice
     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  // Get attributes of AWS Directory Service directory (SimpleAD, Managed AD, AD Connector). It's especially useful to refer AWS Managed AD or on-premise AD in AD Connector configuration.
    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/directoryservice"
    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 := directoryservice.LookupDirectory(ctx, &directoryservice.LookupDirectoryArgs{
    32  //				DirectoryId: main.Id,
    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:directoryservice/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  	// ID of the directory.
    56  	DirectoryId string `pulumi:"directoryId"`
    57  	// A map of tags assigned to the directory/connector.
    58  	Tags map[string]string `pulumi:"tags"`
    59  }
    60  
    61  // A collection of values returned by getDirectory.
    62  type LookupDirectoryResult struct {
    63  	// Access URL for the directory/connector, such as http://alias.awsapps.com.
    64  	AccessUrl string `pulumi:"accessUrl"`
    65  	// Alias for the directory/connector, such as `d-991708b282.awsapps.com`.
    66  	Alias           string                       `pulumi:"alias"`
    67  	ConnectSettings []GetDirectoryConnectSetting `pulumi:"connectSettings"`
    68  	// Textual description for the directory/connector.
    69  	Description string `pulumi:"description"`
    70  	DirectoryId string `pulumi:"directoryId"`
    71  	// List of IP addresses of the DNS servers for the directory/connector.
    72  	DnsIpAddresses []string `pulumi:"dnsIpAddresses"`
    73  	// (for `MicrosoftAD`) Microsoft AD edition (`Standard` or `Enterprise`).
    74  	Edition string `pulumi:"edition"`
    75  	// Directory/connector single-sign on status.
    76  	EnableSso bool `pulumi:"enableSso"`
    77  	// The provider-assigned unique ID for this managed resource.
    78  	Id string `pulumi:"id"`
    79  	// Fully qualified name for the directory/connector.
    80  	Name           string                      `pulumi:"name"`
    81  	RadiusSettings []GetDirectoryRadiusSetting `pulumi:"radiusSettings"`
    82  	// ID of the security group created by the directory/connector.
    83  	SecurityGroupId string `pulumi:"securityGroupId"`
    84  	// Short name of the directory/connector, such as `CORP`.
    85  	ShortName string `pulumi:"shortName"`
    86  	// (for `SimpleAD` and `ADConnector`) Size of the directory/connector (`Small` or `Large`).
    87  	Size string `pulumi:"size"`
    88  	// A map of tags assigned to the directory/connector.
    89  	Tags map[string]string `pulumi:"tags"`
    90  	// Directory type (`SimpleAD`, `ADConnector` or `MicrosoftAD`).
    91  	Type        string                   `pulumi:"type"`
    92  	VpcSettings []GetDirectoryVpcSetting `pulumi:"vpcSettings"`
    93  }
    94  
    95  func LookupDirectoryOutput(ctx *pulumi.Context, args LookupDirectoryOutputArgs, opts ...pulumi.InvokeOption) LookupDirectoryResultOutput {
    96  	return pulumi.ToOutputWithContext(context.Background(), args).
    97  		ApplyT(func(v interface{}) (LookupDirectoryResult, error) {
    98  			args := v.(LookupDirectoryArgs)
    99  			r, err := LookupDirectory(ctx, &args, opts...)
   100  			var s LookupDirectoryResult
   101  			if r != nil {
   102  				s = *r
   103  			}
   104  			return s, err
   105  		}).(LookupDirectoryResultOutput)
   106  }
   107  
   108  // A collection of arguments for invoking getDirectory.
   109  type LookupDirectoryOutputArgs struct {
   110  	// ID of the directory.
   111  	DirectoryId pulumi.StringInput `pulumi:"directoryId"`
   112  	// A map of tags assigned to the directory/connector.
   113  	Tags pulumi.StringMapInput `pulumi:"tags"`
   114  }
   115  
   116  func (LookupDirectoryOutputArgs) ElementType() reflect.Type {
   117  	return reflect.TypeOf((*LookupDirectoryArgs)(nil)).Elem()
   118  }
   119  
   120  // A collection of values returned by getDirectory.
   121  type LookupDirectoryResultOutput struct{ *pulumi.OutputState }
   122  
   123  func (LookupDirectoryResultOutput) ElementType() reflect.Type {
   124  	return reflect.TypeOf((*LookupDirectoryResult)(nil)).Elem()
   125  }
   126  
   127  func (o LookupDirectoryResultOutput) ToLookupDirectoryResultOutput() LookupDirectoryResultOutput {
   128  	return o
   129  }
   130  
   131  func (o LookupDirectoryResultOutput) ToLookupDirectoryResultOutputWithContext(ctx context.Context) LookupDirectoryResultOutput {
   132  	return o
   133  }
   134  
   135  // Access URL for the directory/connector, such as http://alias.awsapps.com.
   136  func (o LookupDirectoryResultOutput) AccessUrl() pulumi.StringOutput {
   137  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.AccessUrl }).(pulumi.StringOutput)
   138  }
   139  
   140  // Alias for the directory/connector, such as `d-991708b282.awsapps.com`.
   141  func (o LookupDirectoryResultOutput) Alias() pulumi.StringOutput {
   142  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.Alias }).(pulumi.StringOutput)
   143  }
   144  
   145  func (o LookupDirectoryResultOutput) ConnectSettings() GetDirectoryConnectSettingArrayOutput {
   146  	return o.ApplyT(func(v LookupDirectoryResult) []GetDirectoryConnectSetting { return v.ConnectSettings }).(GetDirectoryConnectSettingArrayOutput)
   147  }
   148  
   149  // Textual description for the directory/connector.
   150  func (o LookupDirectoryResultOutput) Description() pulumi.StringOutput {
   151  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.Description }).(pulumi.StringOutput)
   152  }
   153  
   154  func (o LookupDirectoryResultOutput) DirectoryId() pulumi.StringOutput {
   155  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.DirectoryId }).(pulumi.StringOutput)
   156  }
   157  
   158  // List of IP addresses of the DNS servers for the directory/connector.
   159  func (o LookupDirectoryResultOutput) DnsIpAddresses() pulumi.StringArrayOutput {
   160  	return o.ApplyT(func(v LookupDirectoryResult) []string { return v.DnsIpAddresses }).(pulumi.StringArrayOutput)
   161  }
   162  
   163  // (for `MicrosoftAD`) Microsoft AD edition (`Standard` or `Enterprise`).
   164  func (o LookupDirectoryResultOutput) Edition() pulumi.StringOutput {
   165  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.Edition }).(pulumi.StringOutput)
   166  }
   167  
   168  // Directory/connector single-sign on status.
   169  func (o LookupDirectoryResultOutput) EnableSso() pulumi.BoolOutput {
   170  	return o.ApplyT(func(v LookupDirectoryResult) bool { return v.EnableSso }).(pulumi.BoolOutput)
   171  }
   172  
   173  // The provider-assigned unique ID for this managed resource.
   174  func (o LookupDirectoryResultOutput) Id() pulumi.StringOutput {
   175  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.Id }).(pulumi.StringOutput)
   176  }
   177  
   178  // Fully qualified name for the directory/connector.
   179  func (o LookupDirectoryResultOutput) Name() pulumi.StringOutput {
   180  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.Name }).(pulumi.StringOutput)
   181  }
   182  
   183  func (o LookupDirectoryResultOutput) RadiusSettings() GetDirectoryRadiusSettingArrayOutput {
   184  	return o.ApplyT(func(v LookupDirectoryResult) []GetDirectoryRadiusSetting { return v.RadiusSettings }).(GetDirectoryRadiusSettingArrayOutput)
   185  }
   186  
   187  // ID of the security group created by the directory/connector.
   188  func (o LookupDirectoryResultOutput) SecurityGroupId() pulumi.StringOutput {
   189  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.SecurityGroupId }).(pulumi.StringOutput)
   190  }
   191  
   192  // Short name of the directory/connector, such as `CORP`.
   193  func (o LookupDirectoryResultOutput) ShortName() pulumi.StringOutput {
   194  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.ShortName }).(pulumi.StringOutput)
   195  }
   196  
   197  // (for `SimpleAD` and `ADConnector`) Size of the directory/connector (`Small` or `Large`).
   198  func (o LookupDirectoryResultOutput) Size() pulumi.StringOutput {
   199  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.Size }).(pulumi.StringOutput)
   200  }
   201  
   202  // A map of tags assigned to the directory/connector.
   203  func (o LookupDirectoryResultOutput) Tags() pulumi.StringMapOutput {
   204  	return o.ApplyT(func(v LookupDirectoryResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
   205  }
   206  
   207  // Directory type (`SimpleAD`, `ADConnector` or `MicrosoftAD`).
   208  func (o LookupDirectoryResultOutput) Type() pulumi.StringOutput {
   209  	return o.ApplyT(func(v LookupDirectoryResult) string { return v.Type }).(pulumi.StringOutput)
   210  }
   211  
   212  func (o LookupDirectoryResultOutput) VpcSettings() GetDirectoryVpcSettingArrayOutput {
   213  	return o.ApplyT(func(v LookupDirectoryResult) []GetDirectoryVpcSetting { return v.VpcSettings }).(GetDirectoryVpcSettingArrayOutput)
   214  }
   215  
   216  func init() {
   217  	pulumi.RegisterOutputType(LookupDirectoryResultOutput{})
   218  }