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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dry_run ⇒ Boolean

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) 


886
887
888
889
890
891
892
893
 
# File 'lib/aws-sdk-migrationhub/types.rb', line 886

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

#migration_task_name ⇒ String

Unique identifier that references the migration task. *Do not store personal data in this field.*

Returns:

  • (String) 


886
887
888
889
890
891
892
893
 
# File 'lib/aws-sdk-migrationhub/types.rb', line 886

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

#progress_update_stream ⇒ String

The name of the ProgressUpdateStream.

Returns:

  • (String) 


886
887
888
889
890
891
892
893
 
# File 'lib/aws-sdk-migrationhub/types.rb', line 886

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

#resource_attribute_list ⇒ Array<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 repository.

<note markdown=“1”> 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.

</note>

  • 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 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.

[1]: docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#API_PutResourceAttributes_Examples

Returns:



886
887
888
889
890
891
892
893
 
# File 'lib/aws-sdk-migrationhub/types.rb', line 886

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