« blib/lib/Paws/Batch/CancelJobResponse.pm
↑ Summary
blib/lib/Paws/Batch/ComputeEnvironmentOrder.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Batch::ComputeEnvironmentDetail; | ||
| 3 | use Moose; | ||
| 4 | has ComputeEnvironmentArn => (is => 'ro', isa => 'Str', request_name => 'computeEnvironmentArn', traits => ['NameInRequest'], required => 1); | ||
| 5 | has ComputeEnvironmentName => (is => 'ro', isa => 'Str', request_name => 'computeEnvironmentName', traits => ['NameInRequest'], required => 1); | ||
| 6 | has ComputeResources => (is => 'ro', isa => 'Paws::Batch::ComputeResource', request_name => 'computeResources', traits => ['NameInRequest']); | ||
| 7 | has EcsClusterArn => (is => 'ro', isa => 'Str', request_name => 'ecsClusterArn', traits => ['NameInRequest'], required => 1); | ||
| 8 | has ServiceRole => (is => 'ro', isa => 'Str', request_name => 'serviceRole', traits => ['NameInRequest']); | ||
| 9 | has State => (is => 'ro', isa => 'Str', request_name => 'state', traits => ['NameInRequest']); | ||
| 10 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 11 | has StatusReason => (is => 'ro', isa => 'Str', request_name => 'statusReason', traits => ['NameInRequest']); | ||
| 12 | has Tags => (is => 'ro', isa => 'Paws::Batch::TagrisTagsMap', request_name => 'tags', traits => ['NameInRequest']); | ||
| 13 | has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest']); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Batch::ComputeEnvironmentDetail | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::Batch::ComputeEnvironmentDetail object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { ComputeEnvironmentArn => $value, ..., Type => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::Batch::ComputeEnvironmentDetail object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->ComputeEnvironmentArn | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | An object representing an AWS Batch compute environment. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> ComputeEnvironmentArn => Str | ||
| 51 | |||
| 52 | The Amazon Resource Name (ARN) of the compute environment. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> ComputeEnvironmentName => Str | ||
| 56 | |||
| 57 | The name of the compute environment. Up to 128 letters (uppercase and | ||
| 58 | lowercase), numbers, hyphens, and underscores are allowed. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 ComputeResources => L<Paws::Batch::ComputeResource> | ||
| 62 | |||
| 63 | The compute resources defined for the compute environment. For more | ||
| 64 | information, see Compute Environments | ||
| 65 | (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) | ||
| 66 | in the I<AWS Batch User Guide>. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> EcsClusterArn => Str | ||
| 70 | |||
| 71 | The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster | ||
| 72 | used by the compute environment. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 ServiceRole => Str | ||
| 76 | |||
| 77 | The service role associated with the compute environment that allows | ||
| 78 | AWS Batch to make calls to AWS API operations on your behalf. For more | ||
| 79 | information, see AWS Batch service IAM role | ||
| 80 | (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html) | ||
| 81 | in the I<AWS Batch User Guide>. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 State => Str | ||
| 85 | |||
| 86 | The state of the compute environment. The valid values are C<ENABLED> | ||
| 87 | or C<DISABLED>. | ||
| 88 | |||
| 89 | If the state is C<ENABLED>, then the AWS Batch scheduler can attempt to | ||
| 90 | place jobs from an associated job queue on the compute resources within | ||
| 91 | the environment. If the compute environment is managed, then it can | ||
| 92 | scale its instances out or in automatically, based on the job queue | ||
| 93 | demand. | ||
| 94 | |||
| 95 | If the state is C<DISABLED>, then the AWS Batch scheduler doesn't | ||
| 96 | attempt to place jobs within the environment. Jobs in a C<STARTING> or | ||
| 97 | C<RUNNING> state continue to progress normally. Managed compute | ||
| 98 | environments in the C<DISABLED> state don't scale out. However, they | ||
| 99 | scale in to C<minvCpus> value after instances become idle. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 Status => Str | ||
| 103 | |||
| 104 | The current status of the compute environment (for example, C<CREATING> | ||
| 105 | or C<VALID>). | ||
| 106 | |||
| 107 | |||
| 108 | =head2 StatusReason => Str | ||
| 109 | |||
| 110 | A short, human-readable string to provide additional details about the | ||
| 111 | current status of the compute environment. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 Tags => L<Paws::Batch::TagrisTagsMap> | ||
| 115 | |||
| 116 | The tags applied to the compute environment. | ||
| 117 | |||
| 118 | |||
| 119 | =head2 Type => Str | ||
| 120 | |||
| 121 | The type of the compute environment: C<MANAGED> or C<UNMANAGED>. For | ||
| 122 | more information, see Compute Environments | ||
| 123 | (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) | ||
| 124 | in the I<AWS Batch User Guide>. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head1 SEE ALSO | ||
| 129 | |||
| 130 | This class forms part of L<Paws>, describing an object used in L<Paws::Batch> | ||
| 131 | |||
| 132 | =head1 BUGS and CONTRIBUTIONS | ||
| 133 | |||
| 134 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 135 | |||
| 136 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 137 | |||
| 138 | =cut | ||
| 139 |