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

Class: Aws::DirectoryService::Types::StartSchemaExtensionRequest

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

Overview

Note:

When making an API call, you may pass StartSchemaExtensionRequest data as a hash:

{
  directory_id: "DirectoryId", # required
  create_snapshot_before_schema_extension: false, # required
  ldif_content: "LdifContent", # required
  description: "Description", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#create_snapshot_before_schema_extensionBoolean

If true, creates a snapshot of the directory before applying the schema extension.

Returns:

  • (Boolean)


2446
2447
2448
2449
2450
2451
2452
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2446

class StartSchemaExtensionRequest < Struct.new(
  :directory_id,
  :create_snapshot_before_schema_extension,
  :ldif_content,
  :description)
  include Aws::Structure
end

#descriptionString

A description of the schema extension.

Returns:

  • (String)


2446
2447
2448
2449
2450
2451
2452
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2446

class StartSchemaExtensionRequest < Struct.new(
  :directory_id,
  :create_snapshot_before_schema_extension,
  :ldif_content,
  :description)
  include Aws::Structure
end

#directory_idString

The identifier of the directory for which the schema extension will be applied to.

Returns:

  • (String)


2446
2447
2448
2449
2450
2451
2452
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2446

class StartSchemaExtensionRequest < Struct.new(
  :directory_id,
  :create_snapshot_before_schema_extension,
  :ldif_content,
  :description)
  include Aws::Structure
end

#ldif_contentString

The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \n. See the example request below for more details. The file size can be no larger than 1MB.

Returns:

  • (String)


2446
2447
2448
2449
2450
2451
2452
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2446

class StartSchemaExtensionRequest < Struct.new(
  :directory_id,
  :create_snapshot_before_schema_extension,
  :ldif_content,
  :description)
  include Aws::Structure
end