« blib/lib/Paws/SageMaker/PipelineSummary.pm
↑ Summary
blib/lib/Paws/SageMaker/ProcessingEnvironmentMap.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::ProcessingClusterConfig; | ||
| 3 | use Moose; | ||
| 4 | has InstanceCount => (is => 'ro', isa => 'Int', required => 1); | ||
| 5 | has InstanceType => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has VolumeKmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 7 | has VolumeSizeInGB => (is => 'ro', isa => 'Int', required => 1); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::SageMaker::ProcessingClusterConfig | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::SageMaker::ProcessingClusterConfig object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { InstanceCount => $value, ..., VolumeSizeInGB => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::ProcessingClusterConfig object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->InstanceCount | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Configuration for the cluster used to run a processing job. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 B<REQUIRED> InstanceCount => Int | ||
| 45 | |||
| 46 | The number of ML compute instances to use in the processing job. For | ||
| 47 | distributed processing jobs, specify a value greater than 1. The | ||
| 48 | default value is 1. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> InstanceType => Str | ||
| 52 | |||
| 53 | The ML compute instance type for the processing job. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 VolumeKmsKeyId => Str | ||
| 57 | |||
| 58 | The Amazon Web Services Key Management Service (Amazon Web Services | ||
| 59 | KMS) key that Amazon SageMaker uses to encrypt data on the storage | ||
| 60 | volume attached to the ML compute instance(s) that run the processing | ||
| 61 | job. | ||
| 62 | |||
| 63 | Certain Nitro-based instances include local storage, dependent on the | ||
| 64 | instance type. Local storage volumes are encrypted using a hardware | ||
| 65 | module on the instance. You can't request a C<VolumeKmsKeyId> when | ||
| 66 | using an instance type with local storage. | ||
| 67 | |||
| 68 | For a list of instance types that support local instance storage, see | ||
| 69 | Instance Store Volumes | ||
| 70 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes). | ||
| 71 | |||
| 72 | For more information about local instance storage encryption, see SSD | ||
| 73 | Instance Store Volumes | ||
| 74 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html). | ||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> VolumeSizeInGB => Int | ||
| 78 | |||
| 79 | The size of the ML storage volume in gigabytes that you want to | ||
| 80 | provision. You must specify sufficient ML storage for your scenario. | ||
| 81 | |||
| 82 | Certain Nitro-based instances include local storage with a fixed total | ||
| 83 | size, dependent on the instance type. When using these instances for | ||
| 84 | processing, Amazon SageMaker mounts the local instance storage instead | ||
| 85 | of Amazon EBS gp2 storage. You can't request a C<VolumeSizeInGB> | ||
| 86 | greater than the total size of the local instance storage. | ||
| 87 | |||
| 88 | For a list of instance types that support local instance storage, | ||
| 89 | including the total size per instance type, see Instance Store Volumes | ||
| 90 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes). | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head1 SEE ALSO | ||
| 95 | |||
| 96 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 97 | |||
| 98 | =head1 BUGS and CONTRIBUTIONS | ||
| 99 | |||
| 100 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 101 | |||
| 102 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 103 | |||
| 104 | =cut | ||
| 105 |