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
- Struct
- Aws::DirectoryService::Types::ShareDirectoryRequest
- Defined in:
- (unknown)
Overview
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
-
#directory_id ⇒ String
Identifier of the AWS Managed Microsoft AD directory that you want to share with other AWS accounts.
-
#share_method ⇒ 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_notes ⇒ String
A directory share request that is sent by the directory owner to the directory consumer.
-
#share_target ⇒ Types::ShareTarget
Identifier for the directory consumer account with whom the directory is to be shared.
Instance Attribute Details
#directory_id ⇒ String
Identifier of the AWS Managed Microsoft AD directory that you want to share with other AWS accounts.
#share_method ⇒ 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
).
Possible values:
- ORGANIZATIONS
- HANDSHAKE
#share_notes ⇒ String
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.
#share_target ⇒ Types::ShareTarget
Identifier for the directory consumer account with whom the directory is to be shared.