view release on metacpan or  search on metacpan

lib/Amazon/CloudFront/SignedURL.pm  view on Meta::CPAN

=head1 NAME

Amazon::CloudFront::SignedURL - A module to generate AWS CloudFront signed URLs.

=head1 SYNOPSIS

    use Amazon::CloudFront::SignedURL;

    my $signed_url = Amazon::CloudFront::SignedURL->new(
        private_key_string => {PRIVATE_KEY},
        key_pair_id        => {KEY_PAIR_ID}
    );

    # create signed url with canned policy
    $signed_url->generate( resource => {RESOURCE_PATH}, expires => {EXPIRES} );

    # create signed url with custom policy
    $signed_url->generate( resource => {RESOURCE_PATH}, policy => {CUSTOM_POLICY} );

=head1 DESCRIPTION

Amazon::CloudFront::SignedURL generates AWS CloudFront signed URLs.

=head1 METHODS

=over 4

=item C<Amazon::CloudFront::SignedURL-E<gt>new(\%args: HashRef)>

Creates a new instance.

Arguments can be:

=over 4

=item * private_key_string

The private key strings.

=item * key_pair_id

The AWS Portal assigned key pair identifier.

=back

=item C<$signed_url-E<gt>generate(\%args: HashRef)>

Generate a signed URL.

Arguments can be:

=over 4

=item * resource

The URL or stream. (required)

=item * expires

The Unix epoch time when the URL is to expire. (xor policy)

=item * policy

The CloudFront policy document. (xor expires)

=back

=back

=head1 LICENSE

Copyright (C) zoncoen.

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.

=head1 AUTHOR

zoncoen E<lt>zoncoen@gmail.comE<gt>

=cut