« blib/lib/Paws/MigrationHub/ProgressUpdateStreamSummary.pm
↑ Summary
blib/lib/Paws/MigrationHub/PutResourceAttributesResult.pm »
| 1 | |||
| 2 | package Paws::MigrationHub::PutResourceAttributes; | ||
| 3 | use Moose; | ||
| 4 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 5 | has MigrationTaskName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has ProgressUpdateStream => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has ResourceAttributeList => (is => 'ro', isa => 'ArrayRef[Paws::MigrationHub::ResourceAttribute]', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutResourceAttributes'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MigrationHub::PutResourceAttributesResult'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::MigrationHub::PutResourceAttributes - Arguments for method PutResourceAttributes on L<Paws::MigrationHub> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method PutResourceAttributes on the | ||
| 25 | L<AWS Migration Hub|Paws::MigrationHub> service. Use the attributes of this class | ||
| 26 | as arguments to method PutResourceAttributes. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutResourceAttributes. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $mgh = Paws->service('MigrationHub'); | ||
| 33 | my $PutResourceAttributesResult = $mgh->PutResourceAttributes( | ||
| 34 | MigrationTaskName => 'MyMigrationTaskName', | ||
| 35 | ProgressUpdateStream => 'MyProgressUpdateStream', | ||
| 36 | ResourceAttributeList => [ | ||
| 37 | { | ||
| 38 | Type => 'IPV4_ADDRESS' | ||
| 39 | , # values: IPV4_ADDRESS, IPV6_ADDRESS, MAC_ADDRESS, FQDN, VM_MANAGER_ID, VM_MANAGED_OBJECT_REFERENCE, VM_NAME, VM_PATH, BIOS_ID, MOTHERBOARD_SERIAL_NUMBER | ||
| 40 | Value => 'MyResourceAttributeValue', # min: 1, max: 256 | ||
| 41 | |||
| 42 | }, | ||
| 43 | ... | ||
| 44 | ], | ||
| 45 | DryRun => 1, # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/mgh/PutResourceAttributes> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 DryRun => Bool | ||
| 55 | |||
| 56 | Optional boolean flag to indicate whether any effect should take place. | ||
| 57 | Used to test if the caller has permission to make the call. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> MigrationTaskName => Str | ||
| 62 | |||
| 63 | Unique identifier that references the migration task. I<Do not store | ||
| 64 | personal data in this field.> | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> ProgressUpdateStream => Str | ||
| 69 | |||
| 70 | The name of the ProgressUpdateStream. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> ResourceAttributeList => ArrayRef[L<Paws::MigrationHub::ResourceAttribute>] | ||
| 75 | |||
| 76 | Information about the resource that is being migrated. This data will | ||
| 77 | be used to map the task to a resource in the Application Discovery | ||
| 78 | Service repository. | ||
| 79 | |||
| 80 | Takes the object array of C<ResourceAttribute> where the C<Type> field | ||
| 81 | is reserved for the following values: C<IPV4_ADDRESS | IPV6_ADDRESS | | ||
| 82 | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | | ||
| 83 | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER> where the | ||
| 84 | identifying value can be a string up to 256 characters. | ||
| 85 | |||
| 86 | =over | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | If any "VM" related value is set for a C<ResourceAttribute> object, it | ||
| 91 | is required that C<VM_MANAGER_ID>, as a minimum, is always set. If | ||
| 92 | C<VM_MANAGER_ID> is not set, then all "VM" fields will be discarded and | ||
| 93 | "VM" fields will not be used for matching the migration task to a | ||
| 94 | server in Application Discovery Service repository. See the Example | ||
| 95 | (https://docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#API_PutResourceAttributes_Examples) | ||
| 96 | section below for a use case of specifying "VM" related values. | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | If a server you are trying to match has multiple IP or MAC addresses, | ||
| 101 | you should provide as many as you know in separate type/value pairs | ||
| 102 | passed to the C<ResourceAttributeList> parameter to maximize the | ||
| 103 | chances of matching. | ||
| 104 | |||
| 105 | =back | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head1 SEE ALSO | ||
| 112 | |||
| 113 | This class forms part of L<Paws>, documenting arguments for method PutResourceAttributes in L<Paws::MigrationHub> | ||
| 114 | |||
| 115 | =head1 BUGS and CONTRIBUTIONS | ||
| 116 | |||
| 117 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 118 | |||
| 119 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 120 | |||
| 121 | =cut | ||
| 122 |