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

Class: Aws::CloudDirectory::Types::UpgradePublishedSchemaRequest

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 UpgradePublishedSchemaRequest data as a hash:

{
  development_schema_arn: "Arn", # required
  published_schema_arn: "Arn", # required
  minor_version: "Version", # required
  dry_run: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#development_schema_arnString

The ARN of the development schema with the changes used for the upgrade.

Returns:

  • (String)


7673
7674
7675
7676
7677
7678
7679
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 7673

class UpgradePublishedSchemaRequest < Struct.new(
  :development_schema_arn,
  :published_schema_arn,
  :minor_version,
  :dry_run)
  include Aws::Structure
end

#dry_runBoolean

Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.

Returns:

  • (Boolean)


7673
7674
7675
7676
7677
7678
7679
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 7673

class UpgradePublishedSchemaRequest < Struct.new(
  :development_schema_arn,
  :published_schema_arn,
  :minor_version,
  :dry_run)
  include Aws::Structure
end

#minor_versionString

Identifies the minor version of the published schema that will be created. This parameter is NOT optional.

Returns:

  • (String)


7673
7674
7675
7676
7677
7678
7679
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 7673

class UpgradePublishedSchemaRequest < Struct.new(
  :development_schema_arn,
  :published_schema_arn,
  :minor_version,
  :dry_run)
  include Aws::Structure
end

#published_schema_arnString

The ARN of the published schema to be upgraded.

Returns:

  • (String)


7673
7674
7675
7676
7677
7678
7679
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 7673

class UpgradePublishedSchemaRequest < Struct.new(
  :development_schema_arn,
  :published_schema_arn,
  :minor_version,
  :dry_run)
  include Aws::Structure
end