Documentation ¶
Overview ¶
Package directoryservice provides a client for AWS Directory Service.
Index ¶
- Constants
- type Attribute
- type Computer
- type ConnectDirectoryInput
- type ConnectDirectoryOutput
- type CreateAliasInput
- type CreateAliasOutput
- type CreateComputerInput
- type CreateComputerOutput
- type CreateDirectoryInput
- type CreateDirectoryOutput
- type CreateSnapshotInput
- type CreateSnapshotOutput
- type DeleteDirectoryInput
- type DeleteDirectoryOutput
- type DeleteSnapshotInput
- type DeleteSnapshotOutput
- type DescribeDirectoriesInput
- type DescribeDirectoriesOutput
- type DescribeSnapshotsInput
- type DescribeSnapshotsOutput
- type DirectoryConnectSettings
- type DirectoryConnectSettingsDescription
- type DirectoryDescription
- type DirectoryLimits
- type DirectoryService
- func (c *DirectoryService) ConnectDirectory(input *ConnectDirectoryInput) (*ConnectDirectoryOutput, error)
- func (c *DirectoryService) ConnectDirectoryRequest(input *ConnectDirectoryInput) (req *request.Request, output *ConnectDirectoryOutput)
- func (c *DirectoryService) CreateAlias(input *CreateAliasInput) (*CreateAliasOutput, error)
- func (c *DirectoryService) CreateAliasRequest(input *CreateAliasInput) (req *request.Request, output *CreateAliasOutput)
- func (c *DirectoryService) CreateComputer(input *CreateComputerInput) (*CreateComputerOutput, error)
- func (c *DirectoryService) CreateComputerRequest(input *CreateComputerInput) (req *request.Request, output *CreateComputerOutput)
- func (c *DirectoryService) CreateDirectory(input *CreateDirectoryInput) (*CreateDirectoryOutput, error)
- func (c *DirectoryService) CreateDirectoryRequest(input *CreateDirectoryInput) (req *request.Request, output *CreateDirectoryOutput)
- func (c *DirectoryService) CreateSnapshot(input *CreateSnapshotInput) (*CreateSnapshotOutput, error)
- func (c *DirectoryService) CreateSnapshotRequest(input *CreateSnapshotInput) (req *request.Request, output *CreateSnapshotOutput)
- func (c *DirectoryService) DeleteDirectory(input *DeleteDirectoryInput) (*DeleteDirectoryOutput, error)
- func (c *DirectoryService) DeleteDirectoryRequest(input *DeleteDirectoryInput) (req *request.Request, output *DeleteDirectoryOutput)
- func (c *DirectoryService) DeleteSnapshot(input *DeleteSnapshotInput) (*DeleteSnapshotOutput, error)
- func (c *DirectoryService) DeleteSnapshotRequest(input *DeleteSnapshotInput) (req *request.Request, output *DeleteSnapshotOutput)
- func (c *DirectoryService) DescribeDirectories(input *DescribeDirectoriesInput) (*DescribeDirectoriesOutput, error)
- func (c *DirectoryService) DescribeDirectoriesRequest(input *DescribeDirectoriesInput) (req *request.Request, output *DescribeDirectoriesOutput)
- func (c *DirectoryService) DescribeSnapshots(input *DescribeSnapshotsInput) (*DescribeSnapshotsOutput, error)
- func (c *DirectoryService) DescribeSnapshotsRequest(input *DescribeSnapshotsInput) (req *request.Request, output *DescribeSnapshotsOutput)
- func (c *DirectoryService) DisableRadius(input *DisableRadiusInput) (*DisableRadiusOutput, error)
- func (c *DirectoryService) DisableRadiusRequest(input *DisableRadiusInput) (req *request.Request, output *DisableRadiusOutput)
- func (c *DirectoryService) DisableSso(input *DisableSsoInput) (*DisableSsoOutput, error)
- func (c *DirectoryService) DisableSsoRequest(input *DisableSsoInput) (req *request.Request, output *DisableSsoOutput)
- func (c *DirectoryService) EnableRadius(input *EnableRadiusInput) (*EnableRadiusOutput, error)
- func (c *DirectoryService) EnableRadiusRequest(input *EnableRadiusInput) (req *request.Request, output *EnableRadiusOutput)
- func (c *DirectoryService) EnableSso(input *EnableSsoInput) (*EnableSsoOutput, error)
- func (c *DirectoryService) EnableSsoRequest(input *EnableSsoInput) (req *request.Request, output *EnableSsoOutput)
- func (c *DirectoryService) GetDirectoryLimits(input *GetDirectoryLimitsInput) (*GetDirectoryLimitsOutput, error)
- func (c *DirectoryService) GetDirectoryLimitsRequest(input *GetDirectoryLimitsInput) (req *request.Request, output *GetDirectoryLimitsOutput)
- func (c *DirectoryService) GetSnapshotLimits(input *GetSnapshotLimitsInput) (*GetSnapshotLimitsOutput, error)
- func (c *DirectoryService) GetSnapshotLimitsRequest(input *GetSnapshotLimitsInput) (req *request.Request, output *GetSnapshotLimitsOutput)
- func (c *DirectoryService) RestoreFromSnapshot(input *RestoreFromSnapshotInput) (*RestoreFromSnapshotOutput, error)
- func (c *DirectoryService) RestoreFromSnapshotRequest(input *RestoreFromSnapshotInput) (req *request.Request, output *RestoreFromSnapshotOutput)
- func (c *DirectoryService) UpdateRadius(input *UpdateRadiusInput) (*UpdateRadiusOutput, error)
- func (c *DirectoryService) UpdateRadiusRequest(input *UpdateRadiusInput) (req *request.Request, output *UpdateRadiusOutput)
- type DirectoryVpcSettings
- type DirectoryVpcSettingsDescription
- type DisableRadiusInput
- type DisableRadiusOutput
- type DisableSsoInput
- type DisableSsoOutput
- type EnableRadiusInput
- type EnableRadiusOutput
- type EnableSsoInput
- type EnableSsoOutput
- type GetDirectoryLimitsInput
- type GetDirectoryLimitsOutput
- type GetSnapshotLimitsInput
- type GetSnapshotLimitsOutput
- type RadiusSettings
- type RestoreFromSnapshotInput
- type RestoreFromSnapshotOutput
- type Snapshot
- type SnapshotLimits
- type UpdateRadiusInput
- type UpdateRadiusOutput
Examples ¶
- DirectoryService.ConnectDirectory
- DirectoryService.CreateAlias
- DirectoryService.CreateComputer
- DirectoryService.CreateDirectory
- DirectoryService.CreateSnapshot
- DirectoryService.DeleteDirectory
- DirectoryService.DeleteSnapshot
- DirectoryService.DescribeDirectories
- DirectoryService.DescribeSnapshots
- DirectoryService.DisableRadius
- DirectoryService.DisableSso
- DirectoryService.EnableRadius
- DirectoryService.EnableSso
- DirectoryService.GetDirectoryLimits
- DirectoryService.GetSnapshotLimits
- DirectoryService.RestoreFromSnapshot
- DirectoryService.UpdateRadius
Constants ¶
const ( // @enum DirectorySize DirectorySizeSmall = "Small" // @enum DirectorySize DirectorySizeLarge = "Large" )
const ( // @enum DirectoryStage DirectoryStageRequested = "Requested" // @enum DirectoryStage DirectoryStageCreating = "Creating" // @enum DirectoryStage DirectoryStageCreated = "Created" // @enum DirectoryStage DirectoryStageActive = "Active" // @enum DirectoryStage DirectoryStageInoperable = "Inoperable" // @enum DirectoryStage DirectoryStageImpaired = "Impaired" // @enum DirectoryStage DirectoryStageRestoring = "Restoring" // @enum DirectoryStage DirectoryStageRestoreFailed = "RestoreFailed" // @enum DirectoryStage DirectoryStageDeleting = "Deleting" // @enum DirectoryStage DirectoryStageDeleted = "Deleted" // @enum DirectoryStage DirectoryStageFailed = "Failed" )
const ( // @enum DirectoryType DirectoryTypeSimpleAd = "SimpleAD" // @enum DirectoryType DirectoryTypeAdconnector = "ADConnector" )
const ( // @enum RadiusAuthenticationProtocol RadiusAuthenticationProtocolPap = "PAP" // @enum RadiusAuthenticationProtocol RadiusAuthenticationProtocolChap = "CHAP" // @enum RadiusAuthenticationProtocol RadiusAuthenticationProtocolMsChapv1 = "MS-CHAPv1" // @enum RadiusAuthenticationProtocol RadiusAuthenticationProtocolMsChapv2 = "MS-CHAPv2" )
const ( // @enum RadiusStatus RadiusStatusCreating = "Creating" // @enum RadiusStatus RadiusStatusCompleted = "Completed" // @enum RadiusStatus RadiusStatusFailed = "Failed" )
const ( // @enum SnapshotStatus SnapshotStatusCreating = "Creating" // @enum SnapshotStatus SnapshotStatusCompleted = "Completed" // @enum SnapshotStatus SnapshotStatusFailed = "Failed" )
const ( // @enum SnapshotType SnapshotTypeAuto = "Auto" // @enum SnapshotType SnapshotTypeManual = "Manual" )
const ServiceName = "ds"
A ServiceName is the name of the service the client will make API calls to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Attribute ¶
type Attribute struct { // The name of the attribute. Name *string `min:"1" type:"string"` // The value of the attribute. Value *string `type:"string"` // contains filtered or unexported fields }
Represents a named directory attribute.
type Computer ¶
type Computer struct { // An array of Attribute objects that contain the LDAP attributes that belong // to the computer account. ComputerAttributes []*Attribute `type:"list"` // The identifier of the computer. ComputerId *string `min:"1" type:"string"` // The computer name. ComputerName *string `min:"1" type:"string"` // contains filtered or unexported fields }
Contains information about a computer account in a directory.
type ConnectDirectoryInput ¶
type ConnectDirectoryInput struct { // A DirectoryConnectSettings object that contains additional information for // the operation. ConnectSettings *DirectoryConnectSettings `type:"structure" required:"true"` // A textual description for the directory. Description *string `type:"string"` // The fully-qualified name of the on-premises directory, such as corp.example.com. Name *string `type:"string" required:"true"` // The password for the on-premises user account. Password *string `min:"1" type:"string" required:"true"` // The NetBIOS name of the on-premises directory, such as CORP. ShortName *string `type:"string"` // The size of the directory. Size *string `type:"string" required:"true" enum:"DirectorySize"` // contains filtered or unexported fields }
Contains the inputs for the ConnectDirectory operation.
func (ConnectDirectoryInput) GoString ¶ added in v0.6.6
func (s ConnectDirectoryInput) GoString() string
GoString returns the string representation
func (ConnectDirectoryInput) String ¶ added in v0.6.6
func (s ConnectDirectoryInput) String() string
String returns the string representation
type ConnectDirectoryOutput ¶
type ConnectDirectoryOutput struct { // The identifier of the new directory. DirectoryId *string `type:"string"` // contains filtered or unexported fields }
Contains the results of the ConnectDirectory operation.
func (ConnectDirectoryOutput) GoString ¶ added in v0.6.6
func (s ConnectDirectoryOutput) GoString() string
GoString returns the string representation
func (ConnectDirectoryOutput) String ¶ added in v0.6.6
func (s ConnectDirectoryOutput) String() string
String returns the string representation
type CreateAliasInput ¶
type CreateAliasInput struct { // The requested alias. // // The alias must be unique amongst all aliases in AWS. This operation will // throw an EntityAlreadyExistsException if this alias already exists. Alias *string `min:"1" type:"string" required:"true"` // The identifier of the directory to create the alias for. DirectoryId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Contains the inputs for the CreateAlias operation.
func (CreateAliasInput) GoString ¶ added in v0.6.6
func (s CreateAliasInput) GoString() string
GoString returns the string representation
func (CreateAliasInput) String ¶ added in v0.6.6
func (s CreateAliasInput) String() string
String returns the string representation
type CreateAliasOutput ¶
type CreateAliasOutput struct { // The alias for the directory. Alias *string `min:"1" type:"string"` // The identifier of the directory. DirectoryId *string `type:"string"` // contains filtered or unexported fields }
Contains the results of the CreateAlias operation.
func (CreateAliasOutput) GoString ¶ added in v0.6.6
func (s CreateAliasOutput) GoString() string
GoString returns the string representation
func (CreateAliasOutput) String ¶ added in v0.6.6
func (s CreateAliasOutput) String() string
String returns the string representation
type CreateComputerInput ¶
type CreateComputerInput struct { // An array of Attribute objects that contain any LDAP attributes to apply to // the computer account. ComputerAttributes []*Attribute `type:"list"` // The name of the computer account. ComputerName *string `min:"1" type:"string" required:"true"` // The identifier of the directory to create the computer account in. DirectoryId *string `type:"string" required:"true"` // The fully-qualified distinguished name of the organizational unit to place // the computer account in. OrganizationalUnitDistinguishedName *string `min:"1" type:"string"` // A one-time password that is used to join the computer to the directory. You // should generate a random, strong password to use for this parameter. Password *string `min:"8" type:"string" required:"true"` // contains filtered or unexported fields }
Contains the inputs for the CreateComputer operation.
func (CreateComputerInput) GoString ¶ added in v0.6.6
func (s CreateComputerInput) GoString() string
GoString returns the string representation
func (CreateComputerInput) String ¶ added in v0.6.6
func (s CreateComputerInput) String() string
String returns the string representation
type CreateComputerOutput ¶
type CreateComputerOutput struct { // A Computer object the represents the computer account. Computer *Computer `type:"structure"` // contains filtered or unexported fields }
Contains the results for the CreateComputer operation.
func (CreateComputerOutput) GoString ¶ added in v0.6.6
func (s CreateComputerOutput) GoString() string
GoString returns the string representation
func (CreateComputerOutput) String ¶ added in v0.6.6
func (s CreateComputerOutput) String() string
String returns the string representation
type CreateDirectoryInput ¶
type CreateDirectoryInput struct { // A textual description for the directory. Description *string `type:"string"` // The fully qualified name for the directory, such as corp.example.com. Name *string `type:"string" required:"true"` // The password for the directory administrator. The directory creation process // creates a directory administrator account with the username Administrator // and this password. Password *string `type:"string" required:"true"` // The short name of the directory, such as CORP. ShortName *string `type:"string"` // The size of the directory. Size *string `type:"string" required:"true" enum:"DirectorySize"` // A DirectoryVpcSettings object that contains additional information for the // operation. VpcSettings *DirectoryVpcSettings `type:"structure"` // contains filtered or unexported fields }
Contains the inputs for the CreateDirectory operation.
func (CreateDirectoryInput) GoString ¶ added in v0.6.6
func (s CreateDirectoryInput) GoString() string
GoString returns the string representation
func (CreateDirectoryInput) String ¶ added in v0.6.6
func (s CreateDirectoryInput) String() string
String returns the string representation
type CreateDirectoryOutput ¶
type CreateDirectoryOutput struct { // The identifier of the directory that was created. DirectoryId *string `type:"string"` // contains filtered or unexported fields }
Contains the results of the CreateDirectory operation.
func (CreateDirectoryOutput) GoString ¶ added in v0.6.6
func (s CreateDirectoryOutput) GoString() string
GoString returns the string representation
func (CreateDirectoryOutput) String ¶ added in v0.6.6
func (s CreateDirectoryOutput) String() string
String returns the string representation
type CreateSnapshotInput ¶
type CreateSnapshotInput struct { // The identifier of the directory to take a snapshot of. DirectoryId *string `type:"string" required:"true"` // The descriptive name to apply to the snapshot. Name *string `type:"string"` // contains filtered or unexported fields }
Contains the inputs for the CreateSnapshot operation.
func (CreateSnapshotInput) GoString ¶ added in v0.6.6
func (s CreateSnapshotInput) GoString() string
GoString returns the string representation
func (CreateSnapshotInput) String ¶ added in v0.6.6
func (s CreateSnapshotInput) String() string
String returns the string representation
type CreateSnapshotOutput ¶
type CreateSnapshotOutput struct { // The identifier of the snapshot that was created. SnapshotId *string `type:"string"` // contains filtered or unexported fields }
Contains the results of the CreateSnapshot operation.
func (CreateSnapshotOutput) GoString ¶ added in v0.6.6
func (s CreateSnapshotOutput) GoString() string
GoString returns the string representation
func (CreateSnapshotOutput) String ¶ added in v0.6.6
func (s CreateSnapshotOutput) String() string
String returns the string representation
type DeleteDirectoryInput ¶
type DeleteDirectoryInput struct { // The identifier of the directory to delete. DirectoryId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Contains the inputs for the DeleteDirectory operation.
func (DeleteDirectoryInput) GoString ¶ added in v0.6.6
func (s DeleteDirectoryInput) GoString() string
GoString returns the string representation
func (DeleteDirectoryInput) String ¶ added in v0.6.6
func (s DeleteDirectoryInput) String() string
String returns the string representation
type DeleteDirectoryOutput ¶
type DeleteDirectoryOutput struct { // The directory identifier. DirectoryId *string `type:"string"` // contains filtered or unexported fields }
Contains the results of the DeleteDirectory operation.
func (DeleteDirectoryOutput) GoString ¶ added in v0.6.6
func (s DeleteDirectoryOutput) GoString() string
GoString returns the string representation
func (DeleteDirectoryOutput) String ¶ added in v0.6.6
func (s DeleteDirectoryOutput) String() string
String returns the string representation
type DeleteSnapshotInput ¶
type DeleteSnapshotInput struct { // The identifier of the directory snapshot to be deleted. SnapshotId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Contains the inputs for the DeleteSnapshot operation.
func (DeleteSnapshotInput) GoString ¶ added in v0.6.6
func (s DeleteSnapshotInput) GoString() string
GoString returns the string representation
func (DeleteSnapshotInput) String ¶ added in v0.6.6
func (s DeleteSnapshotInput) String() string
String returns the string representation
type DeleteSnapshotOutput ¶
type DeleteSnapshotOutput struct { // The identifier of the directory snapshot that was deleted. SnapshotId *string `type:"string"` // contains filtered or unexported fields }
Contains the results of the DeleteSnapshot operation.
func (DeleteSnapshotOutput) GoString ¶ added in v0.6.6
func (s DeleteSnapshotOutput) GoString() string
GoString returns the string representation
func (DeleteSnapshotOutput) String ¶ added in v0.6.6
func (s DeleteSnapshotOutput) String() string
String returns the string representation
type DescribeDirectoriesInput ¶
type DescribeDirectoriesInput struct { // A list of identifiers of the directories to obtain the information for. If // this member is null, all directories that belong to the current account are // returned. // // An empty list results in an InvalidParameterException being thrown. DirectoryIds []*string `type:"list"` // The maximum number of items to return. If this value is zero, the maximum // number of items is specified by the limitations of the operation. Limit *int64 `type:"integer"` // The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. // Pass null if this is the first call. NextToken *string `type:"string"` // contains filtered or unexported fields }
Contains the inputs for the DescribeDirectories operation.
func (DescribeDirectoriesInput) GoString ¶ added in v0.6.6
func (s DescribeDirectoriesInput) GoString() string
GoString returns the string representation
func (DescribeDirectoriesInput) String ¶ added in v0.6.6
func (s DescribeDirectoriesInput) String() string
String returns the string representation
type DescribeDirectoriesOutput ¶
type DescribeDirectoriesOutput struct { // The list of DirectoryDescription objects that were retrieved. // // It is possible that this list contains less than the number of items specified // in the Limit member of the request. This occurs if there are less than the // requested number of items left to retrieve, or if the limitations of the // operation have been exceeded. DirectoryDescriptions []*DirectoryDescription `type:"list"` // If not null, more results are available. Pass this value for the NextToken // parameter in a subsequent call to DescribeDirectories to retrieve the next // set of items. NextToken *string `type:"string"` // contains filtered or unexported fields }
Contains the results of the DescribeDirectories operation.
func (DescribeDirectoriesOutput) GoString ¶ added in v0.6.6
func (s DescribeDirectoriesOutput) GoString() string
GoString returns the string representation
func (DescribeDirectoriesOutput) String ¶ added in v0.6.6
func (s DescribeDirectoriesOutput) String() string
String returns the string representation
type DescribeSnapshotsInput ¶
type DescribeSnapshotsInput struct { // The identifier of the directory to retrieve snapshot information for. DirectoryId *string `type:"string"` // The maximum number of objects to return. Limit *int64 `type:"integer"` // The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. // Pass null if this is the first call. NextToken *string `type:"string"` // A list of identifiers of the snapshots to obtain the information for. If // this member is null or empty, all snapshots are returned using the Limit // and NextToken members. SnapshotIds []*string `type:"list"` // contains filtered or unexported fields }
Contains the inputs for the DescribeSnapshots operation.
func (DescribeSnapshotsInput) GoString ¶ added in v0.6.6
func (s DescribeSnapshotsInput) GoString() string
GoString returns the string representation
func (DescribeSnapshotsInput) String ¶ added in v0.6.6
func (s DescribeSnapshotsInput) String() string
String returns the string representation
type DescribeSnapshotsOutput ¶
type DescribeSnapshotsOutput struct { // If not null, more results are available. Pass this value in the NextToken // member of a subsequent call to DescribeSnapshots. NextToken *string `type:"string"` // The list of Snapshot objects that were retrieved. // // It is possible that this list contains less than the number of items specified // in the Limit member of the request. This occurs if there are less than the // requested number of items left to retrieve, or if the limitations of the // operation have been exceeded. Snapshots []*Snapshot `type:"list"` // contains filtered or unexported fields }
Contains the results of the DescribeSnapshots operation.
func (DescribeSnapshotsOutput) GoString ¶ added in v0.6.6
func (s DescribeSnapshotsOutput) GoString() string
GoString returns the string representation
func (DescribeSnapshotsOutput) String ¶ added in v0.6.6
func (s DescribeSnapshotsOutput) String() string
String returns the string representation
type DirectoryConnectSettings ¶
type DirectoryConnectSettings struct { // A list of one or more IP addresses of DNS servers or domain controllers in // the on-premises directory. CustomerDnsIps []*string `type:"list" required:"true"` // The username of an account in the on-premises directory that is used to connect // to the directory. This account must have the following privileges: // // Read users and groups Create computer objects Join computers to the domain CustomerUserName *string `min:"1" type:"string" required:"true"` // A list of subnet identifiers in the VPC that the AD Connector is created // in. SubnetIds []*string `type:"list" required:"true"` // The identifier of the VPC that the AD Connector is created in. VpcId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Contains information for the ConnectDirectory operation when an AD Connector directory is being created.
func (DirectoryConnectSettings) GoString ¶ added in v0.6.6
func (s DirectoryConnectSettings) GoString() string
GoString returns the string representation
func (DirectoryConnectSettings) String ¶ added in v0.6.6
func (s DirectoryConnectSettings) String() string
String returns the string representation
type DirectoryConnectSettingsDescription ¶
type DirectoryConnectSettingsDescription struct { // A list of the Availability Zones that the directory is in. AvailabilityZones []*string `type:"list"` // The IP addresses of the AD Connector servers. ConnectIps []*string `type:"list"` // The username of the service account in the on-premises directory. CustomerUserName *string `min:"1" type:"string"` // The security group identifier for the AD Connector directory. SecurityGroupId *string `type:"string"` // A list of subnet identifiers in the VPC that the AD connector is in. SubnetIds []*string `type:"list"` // The identifier of the VPC that the AD Connector is in. VpcId *string `type:"string"` // contains filtered or unexported fields }
Contains information about an AD Connector directory.
func (DirectoryConnectSettingsDescription) GoString ¶ added in v0.6.6
func (s DirectoryConnectSettingsDescription) GoString() string
GoString returns the string representation
func (DirectoryConnectSettingsDescription) String ¶ added in v0.6.6
func (s DirectoryConnectSettingsDescription) String() string
String returns the string representation
type DirectoryDescription ¶
type DirectoryDescription struct { // The access URL for the directory, such as http://<alias>.awsapps.com. AccessUrl *string `min:"1" type:"string"` // The alias for the directory. Alias *string `min:"1" type:"string"` // A DirectoryConnectSettingsDescription object that contains additional information // about an AD Connector directory. This member is only present if the directory // is an AD Connector directory. ConnectSettings *DirectoryConnectSettingsDescription `type:"structure"` // The textual description for the directory. Description *string `type:"string"` // The directory identifier. DirectoryId *string `type:"string"` // The IP addresses of the DNS servers for the directory. For a Simple AD directory, // these are the IP addresses of the Simple AD directory servers. For an AD // Connector directory, these are the IP addresses of the DNS servers or domain // controllers in the on-premises directory that the AD Connector is connected // to. DnsIpAddrs []*string `type:"list"` // Specifies when the directory was created. LaunchTime *time.Time `type:"timestamp" timestampFormat:"unix"` // The fully-qualified name of the directory. Name *string `type:"string"` // A RadiusSettings object that contains information about the RADIUS server // configured for this directory. RadiusSettings *RadiusSettings `type:"structure"` // The status of the RADIUS MFA server connection. RadiusStatus *string `type:"string" enum:"RadiusStatus"` // The short name of the directory. ShortName *string `type:"string"` // The directory size. Size *string `type:"string" enum:"DirectorySize"` // Indicates if single-sign on is enabled for the directory. For more information, // see EnableSso and DisableSso. SsoEnabled *bool `type:"boolean"` // The current stage of the directory. Stage *string `type:"string" enum:"DirectoryStage"` // The date and time that the stage was last updated. StageLastUpdatedDateTime *time.Time `type:"timestamp" timestampFormat:"unix"` // Additional information about the directory stage. StageReason *string `type:"string"` // The directory size. Type *string `type:"string" enum:"DirectoryType"` // A DirectoryVpcSettingsDescription object that contains additional information // about a Simple AD directory. This member is only present if the directory // is a Simple AD directory. VpcSettings *DirectoryVpcSettingsDescription `type:"structure"` // contains filtered or unexported fields }
Contains information about an AWS Directory Service directory.
func (DirectoryDescription) GoString ¶ added in v0.6.6
func (s DirectoryDescription) GoString() string
GoString returns the string representation
func (DirectoryDescription) String ¶ added in v0.6.6
func (s DirectoryDescription) String() string
String returns the string representation
type DirectoryLimits ¶
type DirectoryLimits struct { // The current number of cloud directories in the region. CloudOnlyDirectoriesCurrentCount *int64 `type:"integer"` // The maximum number of cloud directories allowed in the region. CloudOnlyDirectoriesLimit *int64 `type:"integer"` // Indicates if the cloud directory limit has been reached. CloudOnlyDirectoriesLimitReached *bool `type:"boolean"` // The current number of connected directories in the region. ConnectedDirectoriesCurrentCount *int64 `type:"integer"` // The maximum number of connected directories allowed in the region. ConnectedDirectoriesLimit *int64 `type:"integer"` // Indicates if the connected directory limit has been reached. ConnectedDirectoriesLimitReached *bool `type:"boolean"` // contains filtered or unexported fields }
Contains directory limit information for a region.
func (DirectoryLimits) GoString ¶ added in v0.6.6
func (s DirectoryLimits) GoString() string
GoString returns the string representation
func (DirectoryLimits) String ¶ added in v0.6.6
func (s DirectoryLimits) String() string
String returns the string representation
type DirectoryService ¶
This is the AWS Directory Service API Reference. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *DirectoryService
New creates a new instance of the DirectoryService client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
// Create a DirectoryService client from just a session. svc := directoryservice.New(mySession) // Create a DirectoryService client with additional configuration svc := directoryservice.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*DirectoryService) ConnectDirectory ¶
func (c *DirectoryService) ConnectDirectory(input *ConnectDirectoryInput) (*ConnectDirectoryOutput, error)
Creates an AD Connector to connect an on-premises directory.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { svc := directoryservice.New(session.New()) params := &directoryservice.ConnectDirectoryInput{ ConnectSettings: &directoryservice.DirectoryConnectSettings{ // Required CustomerDnsIps: []*string{ // Required aws.String("IpAddr"), // Required // More values... }, CustomerUserName: aws.String("UserName"), // Required SubnetIds: []*string{ // Required aws.String("SubnetId"), // Required // More values... }, VpcId: aws.String("VpcId"), // Required }, Name: aws.String("DirectoryName"), // Required Password: aws.String("ConnectPassword"), // Required Size: aws.String("DirectorySize"), // Required Description: aws.String("Description"), ShortName: aws.String("DirectoryShortName"), } resp, err := svc.ConnectDirectory(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) ConnectDirectoryRequest ¶
func (c *DirectoryService) ConnectDirectoryRequest(input *ConnectDirectoryInput) (req *request.Request, output *ConnectDirectoryOutput)
ConnectDirectoryRequest generates a request for the ConnectDirectory operation.
func (*DirectoryService) CreateAlias ¶
func (c *DirectoryService) CreateAlias(input *CreateAliasInput) (*CreateAliasOutput, error)
Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://<alias>.awsapps.com.
After an alias has been created, it cannot be deleted or reused, so this
operation should only be used when absolutely necessary.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { svc := directoryservice.New(session.New()) params := &directoryservice.CreateAliasInput{ Alias: aws.String("AliasName"), // Required DirectoryId: aws.String("DirectoryId"), // Required } resp, err := svc.CreateAlias(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) CreateAliasRequest ¶
func (c *DirectoryService) CreateAliasRequest(input *CreateAliasInput) (req *request.Request, output *CreateAliasOutput)
CreateAliasRequest generates a request for the CreateAlias operation.
func (*DirectoryService) CreateComputer ¶
func (c *DirectoryService) CreateComputer(input *CreateComputerInput) (*CreateComputerOutput, error)
Creates a computer account in the specified directory, and joins the computer to the directory.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { svc := directoryservice.New(session.New()) params := &directoryservice.CreateComputerInput{ ComputerName: aws.String("ComputerName"), // Required DirectoryId: aws.String("DirectoryId"), // Required Password: aws.String("ComputerPassword"), // Required ComputerAttributes: []*directoryservice.Attribute{ { // Required Name: aws.String("AttributeName"), Value: aws.String("AttributeValue"), }, // More values... }, OrganizationalUnitDistinguishedName: aws.String("OrganizationalUnitDN"), } resp, err := svc.CreateComputer(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) CreateComputerRequest ¶
func (c *DirectoryService) CreateComputerRequest(input *CreateComputerInput) (req *request.Request, output *CreateComputerOutput)
CreateComputerRequest generates a request for the CreateComputer operation.
func (*DirectoryService) CreateDirectory ¶
func (c *DirectoryService) CreateDirectory(input *CreateDirectoryInput) (*CreateDirectoryOutput, error)
Creates a Simple AD directory.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { svc := directoryservice.New(session.New()) params := &directoryservice.CreateDirectoryInput{ Name: aws.String("DirectoryName"), // Required Password: aws.String("Password"), // Required Size: aws.String("DirectorySize"), // Required Description: aws.String("Description"), ShortName: aws.String("DirectoryShortName"), VpcSettings: &directoryservice.DirectoryVpcSettings{ SubnetIds: []*string{ // Required aws.String("SubnetId"), // Required // More values... }, VpcId: aws.String("VpcId"), // Required }, } resp, err := svc.CreateDirectory(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) CreateDirectoryRequest ¶
func (c *DirectoryService) CreateDirectoryRequest(input *CreateDirectoryInput) (req *request.Request, output *CreateDirectoryOutput)
CreateDirectoryRequest generates a request for the CreateDirectory operation.
func (*DirectoryService) CreateSnapshot ¶
func (c *DirectoryService) CreateSnapshot(input *CreateSnapshotInput) (*CreateSnapshotOutput, error)
Creates a snapshot of an existing directory.
You cannot take snapshots of extended or connected directories.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { svc := directoryservice.New(session.New()) params := &directoryservice.CreateSnapshotInput{ DirectoryId: aws.String("DirectoryId"), // Required Name: aws.String("SnapshotName"), } resp, err := svc.CreateSnapshot(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) CreateSnapshotRequest ¶
func (c *DirectoryService) CreateSnapshotRequest(input *CreateSnapshotInput) (req *request.Request, output *CreateSnapshotOutput)
CreateSnapshotRequest generates a request for the CreateSnapshot operation.
func (*DirectoryService) DeleteDirectory ¶
func (c *DirectoryService) DeleteDirectory(input *DeleteDirectoryInput) (*DeleteDirectoryOutput, error)
Deletes an AWS Directory Service directory.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { svc := directoryservice.New(session.New()) params := &directoryservice.DeleteDirectoryInput{ DirectoryId: aws.String("DirectoryId"), // Required } resp, err := svc.DeleteDirectory(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) DeleteDirectoryRequest ¶
func (c *DirectoryService) DeleteDirectoryRequest(input *DeleteDirectoryInput) (req *request.Request, output *DeleteDirectoryOutput)
DeleteDirectoryRequest generates a request for the DeleteDirectory operation.
func (*DirectoryService) DeleteSnapshot ¶
func (c *DirectoryService) DeleteSnapshot(input *DeleteSnapshotInput) (*DeleteSnapshotOutput, error)
Deletes a directory snapshot.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { svc := directoryservice.New(session.New()) params := &directoryservice.DeleteSnapshotInput{ SnapshotId: aws.String("SnapshotId"), // Required } resp, err := svc.DeleteSnapshot(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) DeleteSnapshotRequest ¶
func (c *DirectoryService) DeleteSnapshotRequest(input *DeleteSnapshotInput) (req *request.Request, output *DeleteSnapshotOutput)
DeleteSnapshotRequest generates a request for the DeleteSnapshot operation.
func (*DirectoryService) DescribeDirectories ¶
func (c *DirectoryService) DescribeDirectories(input *DescribeDirectoriesInput) (*DescribeDirectoriesOutput, error)
Obtains information about the directories that belong to this account.
You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { svc := directoryservice.New(session.New()) params := &directoryservice.DescribeDirectoriesInput{ DirectoryIds: []*string{ aws.String("DirectoryId"), // Required // More values... }, Limit: aws.Int64(1), NextToken: aws.String("NextToken"), } resp, err := svc.DescribeDirectories(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) DescribeDirectoriesRequest ¶
func (c *DirectoryService) DescribeDirectoriesRequest(input *DescribeDirectoriesInput) (req *request.Request, output *DescribeDirectoriesOutput)
DescribeDirectoriesRequest generates a request for the DescribeDirectories operation.
func (*DirectoryService) DescribeSnapshots ¶
func (c *DirectoryService) DescribeSnapshots(input *DescribeSnapshotsInput) (*DescribeSnapshotsOutput, error)
Obtains information about the directory snapshots that belong to this account.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { svc := directoryservice.New(session.New()) params := &directoryservice.DescribeSnapshotsInput{ DirectoryId: aws.String("DirectoryId"), Limit: aws.Int64(1), NextToken: aws.String("NextToken"), SnapshotIds: []*string{ aws.String("SnapshotId"), // Required // More values... }, } resp, err := svc.DescribeSnapshots(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) DescribeSnapshotsRequest ¶
func (c *DirectoryService) DescribeSnapshotsRequest(input *DescribeSnapshotsInput) (req *request.Request, output *DescribeSnapshotsOutput)
DescribeSnapshotsRequest generates a request for the DescribeSnapshots operation.
func (*DirectoryService) DisableRadius ¶
func (c *DirectoryService) DisableRadius(input *DisableRadiusInput) (*DisableRadiusOutput, error)
Disables multi-factor authentication (MFA) with Remote Authentication Dial In User Service (RADIUS) for an AD Connector directory.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { svc := directoryservice.New(session.New()) params := &directoryservice.DisableRadiusInput{ DirectoryId: aws.String("DirectoryId"), // Required } resp, err := svc.DisableRadius(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) DisableRadiusRequest ¶
func (c *DirectoryService) DisableRadiusRequest(input *DisableRadiusInput) (req *request.Request, output *DisableRadiusOutput)
DisableRadiusRequest generates a request for the DisableRadius operation.
func (*DirectoryService) DisableSso ¶ added in v0.9.9
func (c *DirectoryService) DisableSso(input *DisableSsoInput) (*DisableSsoOutput, error)
Disables single-sign on for a directory.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { svc := directoryservice.New(session.New()) params := &directoryservice.DisableSsoInput{ DirectoryId: aws.String("DirectoryId"), // Required Password: aws.String("ConnectPassword"), UserName: aws.String("UserName"), } resp, err := svc.DisableSso(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) DisableSsoRequest ¶ added in v0.9.9
func (c *DirectoryService) DisableSsoRequest(input *DisableSsoInput) (req *request.Request, output *DisableSsoOutput)
DisableSsoRequest generates a request for the DisableSso operation.
func (*DirectoryService) EnableRadius ¶
func (c *DirectoryService) EnableRadius(input *EnableRadiusInput) (*EnableRadiusOutput, error)
Enables multi-factor authentication (MFA) with Remote Authentication Dial In User Service (RADIUS) for an AD Connector directory.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { svc := directoryservice.New(session.New()) params := &directoryservice.EnableRadiusInput{ DirectoryId: aws.String("DirectoryId"), // Required RadiusSettings: &directoryservice.RadiusSettings{ // Required AuthenticationProtocol: aws.String("RadiusAuthenticationProtocol"), DisplayLabel: aws.String("RadiusDisplayLabel"), RadiusPort: aws.Int64(1), RadiusRetries: aws.Int64(1), RadiusServers: []*string{ aws.String("Server"), // Required // More values... }, RadiusTimeout: aws.Int64(1), SharedSecret: aws.String("RadiusSharedSecret"), UseSameUsername: aws.Bool(true), }, } resp, err := svc.EnableRadius(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) EnableRadiusRequest ¶
func (c *DirectoryService) EnableRadiusRequest(input *EnableRadiusInput) (req *request.Request, output *EnableRadiusOutput)
EnableRadiusRequest generates a request for the EnableRadius operation.
func (*DirectoryService) EnableSso ¶ added in v0.9.9
func (c *DirectoryService) EnableSso(input *EnableSsoInput) (*EnableSsoOutput, error)
Enables single-sign on for a directory.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { svc := directoryservice.New(session.New()) params := &directoryservice.EnableSsoInput{ DirectoryId: aws.String("DirectoryId"), // Required Password: aws.String("ConnectPassword"), UserName: aws.String("UserName"), } resp, err := svc.EnableSso(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) EnableSsoRequest ¶ added in v0.9.9
func (c *DirectoryService) EnableSsoRequest(input *EnableSsoInput) (req *request.Request, output *EnableSsoOutput)
EnableSsoRequest generates a request for the EnableSso operation.
func (*DirectoryService) GetDirectoryLimits ¶
func (c *DirectoryService) GetDirectoryLimits(input *GetDirectoryLimitsInput) (*GetDirectoryLimitsOutput, error)
Obtains directory limit information for the current region.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { svc := directoryservice.New(session.New()) var params *directoryservice.GetDirectoryLimitsInput resp, err := svc.GetDirectoryLimits(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) GetDirectoryLimitsRequest ¶
func (c *DirectoryService) GetDirectoryLimitsRequest(input *GetDirectoryLimitsInput) (req *request.Request, output *GetDirectoryLimitsOutput)
GetDirectoryLimitsRequest generates a request for the GetDirectoryLimits operation.
func (*DirectoryService) GetSnapshotLimits ¶
func (c *DirectoryService) GetSnapshotLimits(input *GetSnapshotLimitsInput) (*GetSnapshotLimitsOutput, error)
Obtains the manual snapshot limits for a directory.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { svc := directoryservice.New(session.New()) params := &directoryservice.GetSnapshotLimitsInput{ DirectoryId: aws.String("DirectoryId"), // Required } resp, err := svc.GetSnapshotLimits(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) GetSnapshotLimitsRequest ¶
func (c *DirectoryService) GetSnapshotLimitsRequest(input *GetSnapshotLimitsInput) (req *request.Request, output *GetSnapshotLimitsOutput)
GetSnapshotLimitsRequest generates a request for the GetSnapshotLimits operation.
func (*DirectoryService) RestoreFromSnapshot ¶
func (c *DirectoryService) RestoreFromSnapshot(input *RestoreFromSnapshotInput) (*RestoreFromSnapshotOutput, error)
Restores a directory using an existing directory snapshot.
When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.
This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to Active, the restore operation is complete.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { svc := directoryservice.New(session.New()) params := &directoryservice.RestoreFromSnapshotInput{ SnapshotId: aws.String("SnapshotId"), // Required } resp, err := svc.RestoreFromSnapshot(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) RestoreFromSnapshotRequest ¶
func (c *DirectoryService) RestoreFromSnapshotRequest(input *RestoreFromSnapshotInput) (req *request.Request, output *RestoreFromSnapshotOutput)
RestoreFromSnapshotRequest generates a request for the RestoreFromSnapshot operation.
func (*DirectoryService) UpdateRadius ¶
func (c *DirectoryService) UpdateRadius(input *UpdateRadiusInput) (*UpdateRadiusOutput, error)
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { svc := directoryservice.New(session.New()) params := &directoryservice.UpdateRadiusInput{ DirectoryId: aws.String("DirectoryId"), // Required RadiusSettings: &directoryservice.RadiusSettings{ // Required AuthenticationProtocol: aws.String("RadiusAuthenticationProtocol"), DisplayLabel: aws.String("RadiusDisplayLabel"), RadiusPort: aws.Int64(1), RadiusRetries: aws.Int64(1), RadiusServers: []*string{ aws.String("Server"), // Required // More values... }, RadiusTimeout: aws.Int64(1), SharedSecret: aws.String("RadiusSharedSecret"), UseSameUsername: aws.Bool(true), }, } resp, err := svc.UpdateRadius(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) UpdateRadiusRequest ¶
func (c *DirectoryService) UpdateRadiusRequest(input *UpdateRadiusInput) (req *request.Request, output *UpdateRadiusOutput)
UpdateRadiusRequest generates a request for the UpdateRadius operation.
type DirectoryVpcSettings ¶ added in v0.9.9
type DirectoryVpcSettings struct { // The identifiers of the subnets for the directory servers. The two subnets // must be in different Availability Zones. AWS Directory Service creates a // directory server and a DNS server in each of these subnets. SubnetIds []*string `type:"list" required:"true"` // The identifier of the VPC to create the Simple AD directory in. VpcId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Contains information for the CreateDirectory operation when a Simple AD directory is being created.
func (DirectoryVpcSettings) GoString ¶ added in v0.9.9
func (s DirectoryVpcSettings) GoString() string
GoString returns the string representation
func (DirectoryVpcSettings) String ¶ added in v0.9.9
func (s DirectoryVpcSettings) String() string
String returns the string representation
type DirectoryVpcSettingsDescription ¶ added in v0.9.9
type DirectoryVpcSettingsDescription struct { // The list of Availability Zones that the directory is in. AvailabilityZones []*string `type:"list"` // The security group identifier for the directory. SecurityGroupId *string `type:"string"` // The identifiers of the subnets for the directory servers. SubnetIds []*string `type:"list"` // The identifier of the VPC that the directory is in. VpcId *string `type:"string"` // contains filtered or unexported fields }
Contains information about a Simple AD directory.
func (DirectoryVpcSettingsDescription) GoString ¶ added in v0.9.9
func (s DirectoryVpcSettingsDescription) GoString() string
GoString returns the string representation
func (DirectoryVpcSettingsDescription) String ¶ added in v0.9.9
func (s DirectoryVpcSettingsDescription) String() string
String returns the string representation
type DisableRadiusInput ¶
type DisableRadiusInput struct { // The identifier of the directory to disable MFA for. DirectoryId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Contains the inputs for the DisableRadius operation.
func (DisableRadiusInput) GoString ¶ added in v0.6.6
func (s DisableRadiusInput) GoString() string
GoString returns the string representation
func (DisableRadiusInput) String ¶ added in v0.6.6
func (s DisableRadiusInput) String() string
String returns the string representation
type DisableRadiusOutput ¶
type DisableRadiusOutput struct {
// contains filtered or unexported fields
}
Contains the results of the DisableRadius operation.
func (DisableRadiusOutput) GoString ¶ added in v0.6.6
func (s DisableRadiusOutput) GoString() string
GoString returns the string representation
func (DisableRadiusOutput) String ¶ added in v0.6.6
func (s DisableRadiusOutput) String() string
String returns the string representation
type DisableSsoInput ¶ added in v0.9.9
type DisableSsoInput struct { // The identifier of the directory to disable single-sign on for. DirectoryId *string `type:"string" required:"true"` // The password of an alternate account to use to disable single-sign on. This // is only used for AD Connector directories. See the UserName parameter for // more information. Password *string `min:"1" type:"string"` // The username of an alternate account to use to disable single-sign on. This // is only used for AD Connector directories. This account must have privileges // to remove a service principle name. // // If the AD Connector service account does not have privileges to remove a // service principle name, you can specify an alternate account with the UserName // and Password parameters. These credentials are only used to disable single // sign-on and are not stored by the service. The AD Connector service account // is not changed. UserName *string `min:"1" type:"string"` // contains filtered or unexported fields }
Contains the inputs for the DisableSso operation.
func (DisableSsoInput) GoString ¶ added in v0.9.9
func (s DisableSsoInput) GoString() string
GoString returns the string representation
func (DisableSsoInput) String ¶ added in v0.9.9
func (s DisableSsoInput) String() string
String returns the string representation
type DisableSsoOutput ¶ added in v0.9.9
type DisableSsoOutput struct {
// contains filtered or unexported fields
}
Contains the results of the DisableSso operation.
func (DisableSsoOutput) GoString ¶ added in v0.9.9
func (s DisableSsoOutput) GoString() string
GoString returns the string representation
func (DisableSsoOutput) String ¶ added in v0.9.9
func (s DisableSsoOutput) String() string
String returns the string representation
type EnableRadiusInput ¶
type EnableRadiusInput struct { // The identifier of the directory to enable MFA for. DirectoryId *string `type:"string" required:"true"` // A RadiusSettings object that contains information about the RADIUS server. RadiusSettings *RadiusSettings `type:"structure" required:"true"` // contains filtered or unexported fields }
Contains the inputs for the EnableRadius operation.
func (EnableRadiusInput) GoString ¶ added in v0.6.6
func (s EnableRadiusInput) GoString() string
GoString returns the string representation
func (EnableRadiusInput) String ¶ added in v0.6.6
func (s EnableRadiusInput) String() string
String returns the string representation
type EnableRadiusOutput ¶
type EnableRadiusOutput struct {
// contains filtered or unexported fields
}
Contains the results of the EnableRadius operation.
func (EnableRadiusOutput) GoString ¶ added in v0.6.6
func (s EnableRadiusOutput) GoString() string
GoString returns the string representation
func (EnableRadiusOutput) String ¶ added in v0.6.6
func (s EnableRadiusOutput) String() string
String returns the string representation
type EnableSsoInput ¶ added in v0.9.9
type EnableSsoInput struct { // The identifier of the directory to enable single-sign on for. DirectoryId *string `type:"string" required:"true"` // The password of an alternate account to use to enable single-sign on. This // is only used for AD Connector directories. See the UserName parameter for // more information. Password *string `min:"1" type:"string"` // The username of an alternate account to use to enable single-sign on. This // is only used for AD Connector directories. This account must have privileges // to add a service principle name. // // If the AD Connector service account does not have privileges to add a service // principle name, you can specify an alternate account with the UserName and // Password parameters. These credentials are only used to enable single sign-on // and are not stored by the service. The AD Connector service account is not // changed. UserName *string `min:"1" type:"string"` // contains filtered or unexported fields }
Contains the inputs for the EnableSso operation.
func (EnableSsoInput) GoString ¶ added in v0.9.9
func (s EnableSsoInput) GoString() string
GoString returns the string representation
func (EnableSsoInput) String ¶ added in v0.9.9
func (s EnableSsoInput) String() string
String returns the string representation
type EnableSsoOutput ¶ added in v0.9.9
type EnableSsoOutput struct {
// contains filtered or unexported fields
}
Contains the results of the EnableSso operation.
func (EnableSsoOutput) GoString ¶ added in v0.9.9
func (s EnableSsoOutput) GoString() string
GoString returns the string representation
func (EnableSsoOutput) String ¶ added in v0.9.9
func (s EnableSsoOutput) String() string
String returns the string representation
type GetDirectoryLimitsInput ¶
type GetDirectoryLimitsInput struct {
// contains filtered or unexported fields
}
Contains the inputs for the GetDirectoryLimits operation.
func (GetDirectoryLimitsInput) GoString ¶ added in v0.6.6
func (s GetDirectoryLimitsInput) GoString() string
GoString returns the string representation
func (GetDirectoryLimitsInput) String ¶ added in v0.6.6
func (s GetDirectoryLimitsInput) String() string
String returns the string representation
type GetDirectoryLimitsOutput ¶
type GetDirectoryLimitsOutput struct { // A DirectoryLimits object that contains the directory limits for the current // region. DirectoryLimits *DirectoryLimits `type:"structure"` // contains filtered or unexported fields }
Contains the results of the GetDirectoryLimits operation.
func (GetDirectoryLimitsOutput) GoString ¶ added in v0.6.6
func (s GetDirectoryLimitsOutput) GoString() string
GoString returns the string representation
func (GetDirectoryLimitsOutput) String ¶ added in v0.6.6
func (s GetDirectoryLimitsOutput) String() string
String returns the string representation
type GetSnapshotLimitsInput ¶
type GetSnapshotLimitsInput struct { // Contains the identifier of the directory to obtain the limits for. DirectoryId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Contains the inputs for the GetSnapshotLimits operation.
func (GetSnapshotLimitsInput) GoString ¶ added in v0.6.6
func (s GetSnapshotLimitsInput) GoString() string
GoString returns the string representation
func (GetSnapshotLimitsInput) String ¶ added in v0.6.6
func (s GetSnapshotLimitsInput) String() string
String returns the string representation
type GetSnapshotLimitsOutput ¶
type GetSnapshotLimitsOutput struct { // A SnapshotLimits object that contains the manual snapshot limits for the // specified directory. SnapshotLimits *SnapshotLimits `type:"structure"` // contains filtered or unexported fields }
Contains the results of the GetSnapshotLimits operation.
func (GetSnapshotLimitsOutput) GoString ¶ added in v0.6.6
func (s GetSnapshotLimitsOutput) GoString() string
GoString returns the string representation
func (GetSnapshotLimitsOutput) String ¶ added in v0.6.6
func (s GetSnapshotLimitsOutput) String() string
String returns the string representation
type RadiusSettings ¶
type RadiusSettings struct { // The protocol specified for your RADIUS endpoints. AuthenticationProtocol *string `type:"string" enum:"RadiusAuthenticationProtocol"` // Not currently used. DisplayLabel *string `min:"1" type:"string"` // The port that your RADIUS server is using for communications. Your on-premises // network must allow inbound traffic over this port from the AWS Directory // Service servers. RadiusPort *int64 `min:"1025" type:"integer"` // The maximum number of times that communication with the RADIUS server is // attempted. RadiusRetries *int64 `type:"integer"` // An array of strings that contains the IP addresses of the RADIUS server endpoints, // or the IP addresses of your RADIUS server load balancer. RadiusServers []*string `type:"list"` // The amount of time, in seconds, to wait for the RADIUS server to respond. RadiusTimeout *int64 `min:"1" type:"integer"` // created. SharedSecret *string `min:"8" type:"string"` // Not currently used. UseSameUsername *bool `type:"boolean"` // contains filtered or unexported fields }
Contains information about a Remote Authentication Dial In User Service (RADIUS) server.
func (RadiusSettings) GoString ¶ added in v0.6.6
func (s RadiusSettings) GoString() string
GoString returns the string representation
func (RadiusSettings) String ¶ added in v0.6.6
func (s RadiusSettings) String() string
String returns the string representation
type RestoreFromSnapshotInput ¶
type RestoreFromSnapshotInput struct { // The identifier of the snapshot to restore from. SnapshotId *string `type:"string" required:"true"` // contains filtered or unexported fields }
An object representing the inputs for the RestoreFromSnapshot operation.
func (RestoreFromSnapshotInput) GoString ¶ added in v0.6.6
func (s RestoreFromSnapshotInput) GoString() string
GoString returns the string representation
func (RestoreFromSnapshotInput) String ¶ added in v0.6.6
func (s RestoreFromSnapshotInput) String() string
String returns the string representation
type RestoreFromSnapshotOutput ¶
type RestoreFromSnapshotOutput struct {
// contains filtered or unexported fields
}
Contains the results of the RestoreFromSnapshot operation.
func (RestoreFromSnapshotOutput) GoString ¶ added in v0.6.6
func (s RestoreFromSnapshotOutput) GoString() string
GoString returns the string representation
func (RestoreFromSnapshotOutput) String ¶ added in v0.6.6
func (s RestoreFromSnapshotOutput) String() string
String returns the string representation
type Snapshot ¶
type Snapshot struct { // The directory identifier. DirectoryId *string `type:"string"` // The descriptive name of the snapshot. Name *string `type:"string"` // The snapshot identifier. SnapshotId *string `type:"string"` // The date and time that the snapshot was taken. StartTime *time.Time `type:"timestamp" timestampFormat:"unix"` // The snapshot status. Status *string `type:"string" enum:"SnapshotStatus"` // The snapshot type. Type *string `type:"string" enum:"SnapshotType"` // contains filtered or unexported fields }
Describes a directory snapshot.
type SnapshotLimits ¶
type SnapshotLimits struct { // The current number of manual snapshots of the directory. ManualSnapshotsCurrentCount *int64 `type:"integer"` // The maximum number of manual snapshots allowed. ManualSnapshotsLimit *int64 `type:"integer"` // Indicates if the manual snapshot limit has been reached. ManualSnapshotsLimitReached *bool `type:"boolean"` // contains filtered or unexported fields }
Contains manual snapshot limit information for a directory.
func (SnapshotLimits) GoString ¶ added in v0.6.6
func (s SnapshotLimits) GoString() string
GoString returns the string representation
func (SnapshotLimits) String ¶ added in v0.6.6
func (s SnapshotLimits) String() string
String returns the string representation
type UpdateRadiusInput ¶
type UpdateRadiusInput struct { // The identifier of the directory to update the RADIUS server information for. DirectoryId *string `type:"string" required:"true"` // A RadiusSettings object that contains information about the RADIUS server. RadiusSettings *RadiusSettings `type:"structure" required:"true"` // contains filtered or unexported fields }
Contains the inputs for the UpdateRadius operation.
func (UpdateRadiusInput) GoString ¶ added in v0.6.6
func (s UpdateRadiusInput) GoString() string
GoString returns the string representation
func (UpdateRadiusInput) String ¶ added in v0.6.6
func (s UpdateRadiusInput) String() string
String returns the string representation
type UpdateRadiusOutput ¶
type UpdateRadiusOutput struct {
// contains filtered or unexported fields
}
Contains the results of the UpdateRadius operation.
func (UpdateRadiusOutput) GoString ¶ added in v0.6.6
func (s UpdateRadiusOutput) GoString() string
GoString returns the string representation
func (UpdateRadiusOutput) String ¶ added in v0.6.6
func (s UpdateRadiusOutput) String() string
String returns the string representation
Directories ¶
Path | Synopsis |
---|---|
Package directoryserviceiface provides an interface for the AWS Directory Service.
|
Package directoryserviceiface provides an interface for the AWS Directory Service. |