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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb

Overview

Note:

When making an API call, you may pass CreateOrganizationRequest data as a 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,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aliasString

The organization alias.

Returns:

  • (String)


459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 459

class CreateOrganizationRequest < Struct.new(
  :directory_id,
  :alias,
  :client_token,
  :domains,
  :kms_key_arn,
  :enable_interoperability)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

The idempotency token associated with the request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 459

class CreateOrganizationRequest < Struct.new(
  :directory_id,
  :alias,
  :client_token,
  :domains,
  :kms_key_arn,
  :enable_interoperability)
  SENSITIVE = []
  include Aws::Structure
end

#directory_idString

The AWS Directory Service directory ID.

Returns:

  • (String)


459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 459

class CreateOrganizationRequest < Struct.new(
  :directory_id,
  :alias,
  :client_token,
  :domains,
  :kms_key_arn,
  :enable_interoperability)
  SENSITIVE = []
  include Aws::Structure
end

#domainsArray<Types::Domain>

The email domains to associate with the organization.

Returns:



459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 459

class CreateOrganizationRequest < Struct.new(
  :directory_id,
  :alias,
  :client_token,
  :domains,
  :kms_key_arn,
  :enable_interoperability)
  SENSITIVE = []
  include Aws::Structure
end

#enable_interoperabilityBoolean

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)


459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 459

class CreateOrganizationRequest < Struct.new(
  :directory_id,
  :alias,
  :client_token,
  :domains,
  :kms_key_arn,
  :enable_interoperability)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arnString

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

Returns:

  • (String)


459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 459

class CreateOrganizationRequest < Struct.new(
  :directory_id,
  :alias,
  :client_token,
  :domains,
  :kms_key_arn,
  :enable_interoperability)
  SENSITIVE = []
  include Aws::Structure
end