« blib/lib/Paws/AppRunner/RuntimeEnvironmentVariables.pm
↑ Summary
blib/lib/Paws/AppRunner/ServiceSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AppRunner::Service; | ||
| 3 | use Moose; | ||
| 4 | has AutoScalingConfigurationSummary => (is => 'ro', isa => 'Paws::AppRunner::AutoScalingConfigurationSummary', required => 1); | ||
| 5 | has CreatedAt => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has DeletedAt => (is => 'ro', isa => 'Str'); | ||
| 7 | has EncryptionConfiguration => (is => 'ro', isa => 'Paws::AppRunner::EncryptionConfiguration'); | ||
| 8 | has HealthCheckConfiguration => (is => 'ro', isa => 'Paws::AppRunner::HealthCheckConfiguration'); | ||
| 9 | has InstanceConfiguration => (is => 'ro', isa => 'Paws::AppRunner::InstanceConfiguration', required => 1); | ||
| 10 | has ServiceArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has ServiceId => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has ServiceName => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has ServiceUrl => (is => 'ro', isa => 'Str', required => 1); | ||
| 14 | has SourceConfiguration => (is => 'ro', isa => 'Paws::AppRunner::SourceConfiguration', required => 1); | ||
| 15 | has Status => (is => 'ro', isa => 'Str', required => 1); | ||
| 16 | has UpdatedAt => (is => 'ro', isa => 'Str', required => 1); | ||
| 17 | |||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::AppRunner::Service | ||
| 25 | |||
| 26 | =head1 USAGE | ||
| 27 | |||
| 28 | This class represents one of two things: | ||
| 29 | |||
| 30 | =head3 Arguments in a call to a service | ||
| 31 | |||
| 32 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 33 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 34 | |||
| 35 | As an example, if Att1 is expected to be a Paws::AppRunner::Service object: | ||
| 36 | |||
| 37 | $service_obj->Method(Att1 => { AutoScalingConfigurationSummary => $value, ..., UpdatedAt => $value }); | ||
| 38 | |||
| 39 | =head3 Results returned from an API call | ||
| 40 | |||
| 41 | Use accessors for each attribute. If Att1 is expected to be an Paws::AppRunner::Service object: | ||
| 42 | |||
| 43 | $result = $service_obj->Method(...); | ||
| 44 | $result->Att1->AutoScalingConfigurationSummary | ||
| 45 | |||
| 46 | =head1 DESCRIPTION | ||
| 47 | |||
| 48 | Describes an AWS App Runner service. It can describe a service in any | ||
| 49 | state, including deleted services. | ||
| 50 | |||
| 51 | This type contains the full information about a service, including | ||
| 52 | configuration details. It's returned by the CreateService | ||
| 53 | (https://docs.aws.amazon.com/apprunner/latest/api/API_CreateService.html), | ||
| 54 | DescribeService | ||
| 55 | (https://docs.aws.amazon.com/apprunner/latest/api/API_DescribeService.html), | ||
| 56 | and DeleteService | ||
| 57 | (https://docs.aws.amazon.com/apprunner/latest/api/API_DeleteService.html) | ||
| 58 | actions. A subset of this information is returned by the ListServices | ||
| 59 | (https://docs.aws.amazon.com/apprunner/latest/api/API_ListServices.html) | ||
| 60 | action using the ServiceSummary | ||
| 61 | (https://docs.aws.amazon.com/apprunner/latest/api/API_ServiceSummary.html) | ||
| 62 | type. | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> AutoScalingConfigurationSummary => L<Paws::AppRunner::AutoScalingConfigurationSummary> | ||
| 68 | |||
| 69 | Summary information for the App Runner automatic scaling configuration | ||
| 70 | resource that's associated with this service. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> CreatedAt => Str | ||
| 74 | |||
| 75 | The time when the App Runner service was created. It's in the Unix time | ||
| 76 | stamp format. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 DeletedAt => Str | ||
| 80 | |||
| 81 | The time when the App Runner service was deleted. It's in the Unix time | ||
| 82 | stamp format. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 EncryptionConfiguration => L<Paws::AppRunner::EncryptionConfiguration> | ||
| 86 | |||
| 87 | The encryption key that App Runner uses to encrypt the service logs and | ||
| 88 | the copy of the source repository that App Runner maintains for the | ||
| 89 | service. It can be either a customer-provided encryption key or an AWS | ||
| 90 | managed CMK. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 HealthCheckConfiguration => L<Paws::AppRunner::HealthCheckConfiguration> | ||
| 94 | |||
| 95 | The settings for the health check that App Runner performs to monitor | ||
| 96 | the health of this service. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> InstanceConfiguration => L<Paws::AppRunner::InstanceConfiguration> | ||
| 100 | |||
| 101 | The runtime configuration of instances (scaling units) of this service. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 B<REQUIRED> ServiceArn => Str | ||
| 105 | |||
| 106 | The Amazon Resource Name (ARN) of this service. | ||
| 107 | |||
| 108 | |||
| 109 | =head2 B<REQUIRED> ServiceId => Str | ||
| 110 | |||
| 111 | An ID that App Runner generated for this service. It's unique within | ||
| 112 | the AWS Region. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 B<REQUIRED> ServiceName => Str | ||
| 116 | |||
| 117 | The customer-provided service name. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 B<REQUIRED> ServiceUrl => Str | ||
| 121 | |||
| 122 | A subdomain URL that App Runner generated for this service. You can use | ||
| 123 | this URL to access your service web application. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 B<REQUIRED> SourceConfiguration => L<Paws::AppRunner::SourceConfiguration> | ||
| 127 | |||
| 128 | The source deployed to the App Runner service. It can be a code or an | ||
| 129 | image repository. | ||
| 130 | |||
| 131 | |||
| 132 | =head2 B<REQUIRED> Status => Str | ||
| 133 | |||
| 134 | The current state of the App Runner service. These particular values | ||
| 135 | mean the following. | ||
| 136 | |||
| 137 | =over | ||
| 138 | |||
| 139 | =item * | ||
| 140 | |||
| 141 | C<CREATE_FAILED> E<ndash> The service failed to create. To troubleshoot | ||
| 142 | this failure, read the failure events and logs, change any parameters | ||
| 143 | that need to be fixed, and retry the call to create the service. | ||
| 144 | |||
| 145 | The failed service isn't usable, and still counts towards your service | ||
| 146 | quota. When you're done analyzing the failure, delete the service. | ||
| 147 | |||
| 148 | =item * | ||
| 149 | |||
| 150 | C<DELETE_FAILED> E<ndash> The service failed to delete and can't be | ||
| 151 | successfully recovered. Retry the service deletion call to ensure that | ||
| 152 | all related resources are removed. | ||
| 153 | |||
| 154 | =back | ||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head2 B<REQUIRED> UpdatedAt => Str | ||
| 159 | |||
| 160 | The time when the App Runner service was last updated at. It's in the | ||
| 161 | Unix time stamp format. | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | =head1 SEE ALSO | ||
| 166 | |||
| 167 | This class forms part of L<Paws>, describing an object used in L<Paws::AppRunner> | ||
| 168 | |||
| 169 | =head1 BUGS and CONTRIBUTIONS | ||
| 170 | |||
| 171 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 172 | |||
| 173 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 174 | |||
| 175 | =cut | ||
| 176 |