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

Class: Aws::MigrationHub::Types::PutResourceAttributesRequest

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

Overview

Note:

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

{
  progress_update_stream: "ProgressUpdateStream", # required
  migration_task_name: "MigrationTaskName", # required
  resource_attribute_list: [ # required
    {
      type: "IPV4_ADDRESS", # required, accepts IPV4_ADDRESS, IPV6_ADDRESS, MAC_ADDRESS, FQDN, VM_MANAGER_ID, VM_MANAGED_OBJECT_REFERENCE, VM_NAME, VM_PATH, BIOS_ID, MOTHERBOARD_SERIAL_NUMBER
      value: "ResourceAttributeValue", # required
    },
  ],
  dry_run: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Returns:

  • (Boolean)


857
858
859
860
861
862
863
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/types.rb', line 857

class PutResourceAttributesRequest < Struct.new(
  :progress_update_stream,
  :migration_task_name,
  :resource_attribute_list,
  :dry_run)
  include Aws::Structure
end

#migration_task_nameString

Unique identifier that references the migration task.

Returns:

  • (String)


857
858
859
860
861
862
863
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/types.rb', line 857

class PutResourceAttributesRequest < Struct.new(
  :progress_update_stream,
  :migration_task_name,
  :resource_attribute_list,
  :dry_run)
  include Aws::Structure
end

#progress_update_streamString

The name of the ProgressUpdateStream.

Returns:

  • (String)


857
858
859
860
861
862
863
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/types.rb', line 857

class PutResourceAttributesRequest < Struct.new(
  :progress_update_stream,
  :migration_task_name,
  :resource_attribute_list,
  :dry_run)
  include Aws::Structure
end

#resource_attribute_listArray<Types::ResourceAttribute>

Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service (ADS)'s repository.

Takes the object array of ResourceAttribute where the Type field is reserved for the following values: IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER where the identifying value can be a string up to 256 characters.

  • If any "VM" related value is set for a ResourceAttribute object, it is required that VM_MANAGER_ID, as a minimum, is always set. If VM_MANAGER_ID is not set, then all "VM" fields will be discarded and "VM" fields will not be used for matching the migration task to a server in Application Discovery Service (ADS)'s repository. See the Example section below for a use case of specifying "VM" related values.

  • If a server you are trying to match has multiple IP or MAC addresses, you should provide as many as you know in separate type/value pairs passed to the ResourceAttributeList parameter to maximize the chances of matching.

Returns:



857
858
859
860
861
862
863
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/types.rb', line 857

class PutResourceAttributesRequest < Struct.new(
  :progress_update_stream,
  :migration_task_name,
  :resource_attribute_list,
  :dry_run)
  include Aws::Structure
end