« blib/lib/Paws/S3/QueueConfigurationDeprecated.pm
↑ Summary
blib/lib/Paws/S3/RedirectAllRequestsTo.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::S3::Redirect; | ||
| 3 | use Moose; | ||
| 4 | has HostName => (is => 'ro', isa => 'Str'); | ||
| 5 | has HttpRedirectCode => (is => 'ro', isa => 'Str'); | ||
| 6 | has Protocol => (is => 'ro', isa => 'Str'); | ||
| 7 | has ReplaceKeyPrefixWith => (is => 'ro', isa => 'Str'); | ||
| 8 | has ReplaceKeyWith => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::S3::Redirect | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::S3::Redirect object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { HostName => $value, ..., ReplaceKeyWith => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::S3::Redirect object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->HostName | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Specifies how requests are redirected. In the event of an error, you | ||
| 41 | can specify a different error code to return. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 HostName => Str | ||
| 47 | |||
| 48 | The host name to use in the redirect request. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 HttpRedirectCode => Str | ||
| 52 | |||
| 53 | The HTTP redirect code to use on the response. Not required if one of | ||
| 54 | the siblings is present. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 Protocol => Str | ||
| 58 | |||
| 59 | Protocol to use when redirecting requests. The default is the protocol | ||
| 60 | that is used in the original request. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 ReplaceKeyPrefixWith => Str | ||
| 64 | |||
| 65 | The object key prefix to use in the redirect request. For example, to | ||
| 66 | redirect requests for all pages with prefix C<docs/> (objects in the | ||
| 67 | C<docs/> folder) to C<documents/>, you can set a condition block with | ||
| 68 | C<KeyPrefixEquals> set to C<docs/> and in the Redirect set | ||
| 69 | C<ReplaceKeyPrefixWith> to C</documents>. Not required if one of the | ||
| 70 | siblings is present. Can be present only if C<ReplaceKeyWith> is not | ||
| 71 | provided. | ||
| 72 | |||
| 73 | Replacement must be made for object keys containing special characters | ||
| 74 | (such as carriage returns) when using XML requests. For more | ||
| 75 | information, see XML related object key constraints | ||
| 76 | (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). | ||
| 77 | |||
| 78 | |||
| 79 | =head2 ReplaceKeyWith => Str | ||
| 80 | |||
| 81 | The specific object key to use in the redirect request. For example, | ||
| 82 | redirect request to C<error.html>. Not required if one of the siblings | ||
| 83 | is present. Can be present only if C<ReplaceKeyPrefixWith> is not | ||
| 84 | provided. | ||
| 85 | |||
| 86 | Replacement must be made for object keys containing special characters | ||
| 87 | (such as carriage returns) when using XML requests. For more | ||
| 88 | information, see XML related object key constraints | ||
| 89 | (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head1 SEE ALSO | ||
| 94 | |||
| 95 | This class forms part of L<Paws>, describing an object used in L<Paws::S3> | ||
| 96 | |||
| 97 | =head1 BUGS and CONTRIBUTIONS | ||
| 98 | |||
| 99 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 100 | |||
| 101 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 102 | |||
| 103 | =cut | ||
| 104 |