Documentation
¶
Overview ¶
nolint: lll Package directoryservice exports types, functions, subpackages for provisioning directoryservice resources.
> This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-aws) > distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature, > first check the [`pulumi/pulumi-aws` repo](https://github.com/pulumi/pulumi-aws/issues); however, if that doesn't turn up anything, > please consult the source [`terraform-providers/terraform-provider-aws` repo](https://github.com/terraform-providers/terraform-provider-aws/issues).
Index ¶
- type ConditionalForwader
- type ConditionalForwaderArgs
- type ConditionalForwaderState
- type Directory
- func (r *Directory) AccessUrl() *pulumi.StringOutput
- func (r *Directory) Alias() *pulumi.StringOutput
- func (r *Directory) ConnectSettings() *pulumi.Output
- func (r *Directory) Description() *pulumi.StringOutput
- func (r *Directory) DnsIpAddresses() *pulumi.ArrayOutput
- func (r *Directory) Edition() *pulumi.StringOutput
- func (r *Directory) EnableSso() *pulumi.BoolOutput
- func (r *Directory) ID() *pulumi.IDOutput
- func (r *Directory) Name() *pulumi.StringOutput
- func (r *Directory) Password() *pulumi.StringOutput
- func (r *Directory) SecurityGroupId() *pulumi.StringOutput
- func (r *Directory) ShortName() *pulumi.StringOutput
- func (r *Directory) Size() *pulumi.StringOutput
- func (r *Directory) Tags() *pulumi.MapOutput
- func (r *Directory) Type() *pulumi.StringOutput
- func (r *Directory) URN() *pulumi.URNOutput
- func (r *Directory) VpcSettings() *pulumi.Output
- type DirectoryArgs
- type DirectoryState
- type LogService
- type LogServiceArgs
- type LogServiceState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ConditionalForwader ¶
type ConditionalForwader struct {
// contains filtered or unexported fields
}
Provides a conditional forwarder for managed Microsoft AD in AWS Directory Service.
> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/directory_service_conditional_forwarder.html.markdown.
func GetConditionalForwader ¶
func GetConditionalForwader(ctx *pulumi.Context, name string, id pulumi.ID, state *ConditionalForwaderState, opts ...pulumi.ResourceOpt) (*ConditionalForwader, error)
GetConditionalForwader gets an existing ConditionalForwader resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewConditionalForwader ¶
func NewConditionalForwader(ctx *pulumi.Context, name string, args *ConditionalForwaderArgs, opts ...pulumi.ResourceOpt) (*ConditionalForwader, error)
NewConditionalForwader registers a new resource with the given unique name, arguments, and options.
func (*ConditionalForwader) DirectoryId ¶
func (r *ConditionalForwader) DirectoryId() *pulumi.StringOutput
The id of directory.
func (*ConditionalForwader) DnsIps ¶
func (r *ConditionalForwader) DnsIps() *pulumi.ArrayOutput
A list of forwarder IP addresses.
func (*ConditionalForwader) ID ¶
func (r *ConditionalForwader) ID() *pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*ConditionalForwader) RemoteDomainName ¶
func (r *ConditionalForwader) RemoteDomainName() *pulumi.StringOutput
The fully qualified domain name of the remote domain for which forwarders will be used.
func (*ConditionalForwader) URN ¶
func (r *ConditionalForwader) URN() *pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
type ConditionalForwaderArgs ¶
type ConditionalForwaderArgs struct { // The id of directory. DirectoryId interface{} // A list of forwarder IP addresses. DnsIps interface{} // The fully qualified domain name of the remote domain for which forwarders will be used. RemoteDomainName interface{} }
The set of arguments for constructing a ConditionalForwader resource.
type ConditionalForwaderState ¶
type ConditionalForwaderState struct { // The id of directory. DirectoryId interface{} // A list of forwarder IP addresses. DnsIps interface{} // The fully qualified domain name of the remote domain for which forwarders will be used. RemoteDomainName interface{} }
Input properties used for looking up and filtering ConditionalForwader resources.
type Directory ¶
type Directory struct {
// contains filtered or unexported fields
}
Provides a Simple or Managed Microsoft directory in AWS Directory Service.
> **Note:** All arguments including the password and customer username will be stored in the raw state as plain-text. [Read more about sensitive data in state](https://www.terraform.io/docs/state/sensitive-data.html).
> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/directory_service_directory.html.markdown.
func GetDirectory ¶
func GetDirectory(ctx *pulumi.Context, name string, id pulumi.ID, state *DirectoryState, opts ...pulumi.ResourceOpt) (*Directory, error)
GetDirectory gets an existing Directory resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewDirectory ¶
func NewDirectory(ctx *pulumi.Context, name string, args *DirectoryArgs, opts ...pulumi.ResourceOpt) (*Directory, error)
NewDirectory registers a new resource with the given unique name, arguments, and options.
func (*Directory) AccessUrl ¶
func (r *Directory) AccessUrl() *pulumi.StringOutput
The access URL for the directory, such as `http://alias.awsapps.com`.
func (*Directory) Alias ¶
func (r *Directory) Alias() *pulumi.StringOutput
The alias for the directory (must be unique amongst all aliases in AWS). Required for `enable_sso`.
func (*Directory) ConnectSettings ¶
Connector related information about the directory. Fields documented below.
func (*Directory) Description ¶
func (r *Directory) Description() *pulumi.StringOutput
A textual description for the directory.
func (*Directory) DnsIpAddresses ¶
func (r *Directory) DnsIpAddresses() *pulumi.ArrayOutput
A list of IP addresses of the DNS servers for the directory or connector.
func (*Directory) Edition ¶
func (r *Directory) Edition() *pulumi.StringOutput
The MicrosoftAD edition (`Standard` or `Enterprise`). Defaults to `Enterprise` (applies to MicrosoftAD type only).
func (*Directory) EnableSso ¶
func (r *Directory) EnableSso() *pulumi.BoolOutput
Whether to enable single-sign on for the directory. Requires `alias`. Defaults to `false`.
func (*Directory) Name ¶
func (r *Directory) Name() *pulumi.StringOutput
The fully qualified name for the directory, such as `corp.example.com`
func (*Directory) Password ¶
func (r *Directory) Password() *pulumi.StringOutput
The password for the directory administrator or connector user.
func (*Directory) SecurityGroupId ¶
func (r *Directory) SecurityGroupId() *pulumi.StringOutput
The ID of the security group created by the directory.
func (*Directory) ShortName ¶
func (r *Directory) ShortName() *pulumi.StringOutput
The short name of the directory, such as `CORP`.
func (*Directory) Size ¶
func (r *Directory) Size() *pulumi.StringOutput
The size of the directory (`Small` or `Large` are accepted values).
func (*Directory) Type ¶
func (r *Directory) Type() *pulumi.StringOutput
The directory type (`SimpleAD`, `ADConnector` or `MicrosoftAD` are accepted values). Defaults to `SimpleAD`.
func (*Directory) VpcSettings ¶
VPC related information about the directory. Fields documented below.
type DirectoryArgs ¶
type DirectoryArgs struct { // The alias for the directory (must be unique amongst all aliases in AWS). Required for `enable_sso`. Alias interface{} // Connector related information about the directory. Fields documented below. ConnectSettings interface{} // A textual description for the directory. Description interface{} // The MicrosoftAD edition (`Standard` or `Enterprise`). Defaults to `Enterprise` (applies to MicrosoftAD type only). Edition interface{} // Whether to enable single-sign on for the directory. Requires `alias`. Defaults to `false`. EnableSso interface{} // The fully qualified name for the directory, such as `corp.example.com` Name interface{} // The password for the directory administrator or connector user. Password interface{} // The short name of the directory, such as `CORP`. ShortName interface{} // The size of the directory (`Small` or `Large` are accepted values). Size interface{} // A mapping of tags to assign to the resource. Tags interface{} // The directory type (`SimpleAD`, `ADConnector` or `MicrosoftAD` are accepted values). Defaults to `SimpleAD`. Type interface{} // VPC related information about the directory. Fields documented below. VpcSettings interface{} }
The set of arguments for constructing a Directory resource.
type DirectoryState ¶
type DirectoryState struct { // The access URL for the directory, such as `http://alias.awsapps.com`. AccessUrl interface{} // The alias for the directory (must be unique amongst all aliases in AWS). Required for `enable_sso`. Alias interface{} // Connector related information about the directory. Fields documented below. ConnectSettings interface{} // A textual description for the directory. Description interface{} // A list of IP addresses of the DNS servers for the directory or connector. DnsIpAddresses interface{} // The MicrosoftAD edition (`Standard` or `Enterprise`). Defaults to `Enterprise` (applies to MicrosoftAD type only). Edition interface{} // Whether to enable single-sign on for the directory. Requires `alias`. Defaults to `false`. EnableSso interface{} // The fully qualified name for the directory, such as `corp.example.com` Name interface{} // The password for the directory administrator or connector user. Password interface{} // The ID of the security group created by the directory. SecurityGroupId interface{} // The short name of the directory, such as `CORP`. ShortName interface{} // The size of the directory (`Small` or `Large` are accepted values). Size interface{} // A mapping of tags to assign to the resource. Tags interface{} // The directory type (`SimpleAD`, `ADConnector` or `MicrosoftAD` are accepted values). Defaults to `SimpleAD`. Type interface{} // VPC related information about the directory. Fields documented below. VpcSettings interface{} }
Input properties used for looking up and filtering Directory resources.
type LogService ¶ added in v0.18.21
type LogService struct {
// contains filtered or unexported fields
}
Provides a Log subscription for AWS Directory Service that pushes logs to cloudwatch.
> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/directory_service_log_subscription.html.markdown.
func GetLogService ¶ added in v0.18.21
func GetLogService(ctx *pulumi.Context, name string, id pulumi.ID, state *LogServiceState, opts ...pulumi.ResourceOpt) (*LogService, error)
GetLogService gets an existing LogService resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewLogService ¶ added in v0.18.21
func NewLogService(ctx *pulumi.Context, name string, args *LogServiceArgs, opts ...pulumi.ResourceOpt) (*LogService, error)
NewLogService registers a new resource with the given unique name, arguments, and options.
func (*LogService) DirectoryId ¶ added in v0.18.21
func (r *LogService) DirectoryId() *pulumi.StringOutput
The id of directory.
func (*LogService) ID ¶ added in v0.18.21
func (r *LogService) ID() *pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*LogService) LogGroupName ¶ added in v0.18.21
func (r *LogService) LogGroupName() *pulumi.StringOutput
Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time.
func (*LogService) URN ¶ added in v0.18.21
func (r *LogService) URN() *pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
type LogServiceArgs ¶ added in v0.18.21
type LogServiceArgs struct { // The id of directory. DirectoryId interface{} // Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time. LogGroupName interface{} }
The set of arguments for constructing a LogService resource.
type LogServiceState ¶ added in v0.18.21
type LogServiceState struct { // The id of directory. DirectoryId interface{} // Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time. LogGroupName interface{} }
Input properties used for looking up and filtering LogService resources.