« blib/lib/Paws/Lightsail/Region.pm
↑ Summary
blib/lib/Paws/Lightsail/RegisterContainerImageResult.pm »
| 1 | |||
| 2 | package Paws::Lightsail::RegisterContainerImage; | ||
| 3 | use Moose; | ||
| 4 | has Digest => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'digest' , required => 1); | ||
| 5 | has Label => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'label' , required => 1); | ||
| 6 | has ServiceName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'serviceName' , required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RegisterContainerImage'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Lightsail::RegisterContainerImageResult'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Lightsail::RegisterContainerImage - Arguments for method RegisterContainerImage on L<Paws::Lightsail> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method RegisterContainerImage on the | ||
| 24 | L<Amazon Lightsail|Paws::Lightsail> service. Use the attributes of this class | ||
| 25 | as arguments to method RegisterContainerImage. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RegisterContainerImage. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $lightsail = Paws->service('Lightsail'); | ||
| 32 | my $RegisterContainerImageResult = $lightsail->RegisterContainerImage( | ||
| 33 | Digest => 'Mystring', | ||
| 34 | Label => 'MyContainerLabel', | ||
| 35 | ServiceName => 'MyContainerServiceName', | ||
| 36 | |||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $ContainerImage = $RegisterContainerImageResult->ContainerImage; | ||
| 41 | |||
| 42 | # Returns a L<Paws::Lightsail::RegisterContainerImageResult> object. | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lightsail/RegisterContainerImage> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> Digest => Str | ||
| 51 | |||
| 52 | The digest of the container image to be registered. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> Label => Str | ||
| 57 | |||
| 58 | The label for the container image when it's registered to the container | ||
| 59 | service. | ||
| 60 | |||
| 61 | Use a descriptive label that you can use to track the different | ||
| 62 | versions of your registered container images. | ||
| 63 | |||
| 64 | Use the C<GetContainerImages> action to return the container images | ||
| 65 | registered to a Lightsail container service. The label is the | ||
| 66 | C<E<lt>imagelabelE<gt>> portion of the following image name example: | ||
| 67 | |||
| 68 | =over | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | C<:container-service-1.E<lt>imagelabelE<gt>.1> | ||
| 73 | |||
| 74 | =back | ||
| 75 | |||
| 76 | If the name of your container service is C<mycontainerservice>, and the | ||
| 77 | label that you specify is C<mystaticwebsite>, then the name of the | ||
| 78 | registered container image will be | ||
| 79 | C<:mycontainerservice.mystaticwebsite.1>. | ||
| 80 | |||
| 81 | The number at the end of these image name examples represents the | ||
| 82 | version of the registered container image. If you push and register | ||
| 83 | another container image to the same Lightsail container service, with | ||
| 84 | the same label, then the version number for the new registered | ||
| 85 | container image will be C<2>. If you push and register another | ||
| 86 | container image, the version number will be C<3>, and so on. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 B<REQUIRED> ServiceName => Str | ||
| 91 | |||
| 92 | The name of the container service for which to register a container | ||
| 93 | image. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head1 SEE ALSO | ||
| 99 | |||
| 100 | This class forms part of L<Paws>, documenting arguments for method RegisterContainerImage in L<Paws::Lightsail> | ||
| 101 | |||
| 102 | =head1 BUGS and CONTRIBUTIONS | ||
| 103 | |||
| 104 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 105 | |||
| 106 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 107 | |||
| 108 | =cut | ||
| 109 |