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

Class: Aws::CloudDirectory::Types::UpgradeAppliedSchemaRequest

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

Overview

Note:

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

{
  published_schema_arn: "Arn", # required
  directory_arn: "Arn", # required
  dry_run: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#directory_arnString

The ARN for the directory to which the upgraded schema will be applied.

Returns:

  • (String)


7615
7616
7617
7618
7619
7620
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 7615

class UpgradeAppliedSchemaRequest < Struct.new(
  :published_schema_arn,
  :directory_arn,
  :dry_run)
  include Aws::Structure
end

#dry_runBoolean

Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.

Returns:

  • (Boolean)


7615
7616
7617
7618
7619
7620
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 7615

class UpgradeAppliedSchemaRequest < Struct.new(
  :published_schema_arn,
  :directory_arn,
  :dry_run)
  include Aws::Structure
end

#published_schema_arnString

The revision of the published schema to upgrade the directory to.

Returns:

  • (String)


7615
7616
7617
7618
7619
7620
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 7615

class UpgradeAppliedSchemaRequest < Struct.new(
  :published_schema_arn,
  :directory_arn,
  :dry_run)
  include Aws::Structure
end