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

Class: Aws::WorkMail::Types::CreateOrganizationRequest

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

Overview

Note:

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

{
  directory_id: "DirectoryId",
  alias: "OrganizationName", # required
  client_token: "IdempotencyClientToken",
  domains: [
    {
      domain_name: "DomainName",
      hosted_zone_id: "HostedZoneId",
    },
  ],
  kms_key_arn: "KmsKeyArn",
  enable_interoperability: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#alias ⇒ String

The organization alias.

Returns:

  • (String) —

    The organization alias.

#client_token ⇒ String

The idempotency token associated with the request.

Returns:

  • (String) —

    The idempotency token associated with the request.

#directory_id ⇒ String

The AWS Directory Service directory ID.

Returns:

  • (String) —

    The AWS Directory Service directory ID.

#domains ⇒ Array<Types::Domain>

The email domains to associate with the organization.

Returns:

  • (Array<Types::Domain>) —

    The email domains to associate with the organization.

#enable_interoperability ⇒ Boolean

When true, allows organization interoperability between Amazon WorkMail and Microsoft Exchange. Can only be set to true if an AD Connector directory ID is included in the request.

Returns:

  • (Boolean) —

    When true, allows organization interoperability between Amazon WorkMail and Microsoft Exchange.

#kms_key_arn ⇒ String

The Amazon Resource Name (ARN) of a customer managed master key from AWS KMS.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of a customer managed master key from AWS KMS.