You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DirectoryService::Types::ShareDirectoryRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ShareDirectoryRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  directory_id: "DirectoryId", # required
  share_notes: "Notes",
  share_target: { # required
    id: "TargetId", # required
    type: "ACCOUNT", # required, accepts ACCOUNT
  },
  share_method: "ORGANIZATIONS", # required, accepts ORGANIZATIONS, HANDSHAKE
}

Instance Attribute Summary collapse

Instance Attribute Details

#directory_idString

Identifier of the AWS Managed Microsoft AD directory that you want to share with other AWS accounts.

Returns:

  • (String)

    Identifier of the AWS Managed Microsoft AD directory that you want to share with other AWS accounts.

#share_methodString

The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS) or with any AWS account by sending a directory sharing request (HANDSHAKE).

Possible values:

  • ORGANIZATIONS
  • HANDSHAKE

Returns:

  • (String)

    The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS) or with any AWS account by sending a directory sharing request (HANDSHAKE).

#share_notesString

A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.

Returns:

  • (String)

    A directory share request that is sent by the directory owner to the directory consumer.

#share_targetTypes::ShareTarget

Identifier for the directory consumer account with whom the directory is to be shared.

Returns:

  • (Types::ShareTarget)

    Identifier for the directory consumer account with whom the directory is to be shared.