| 1 | |||
| 2 | package Paws::EFS::PutFileSystemPolicy; | ||
| 3 | use Moose; | ||
| 4 | has BypassPolicyLockoutSafetyCheck => (is => 'ro', isa => 'Bool'); | ||
| 5 | has FileSystemId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'FileSystemId', required => 1); | ||
| 6 | has Policy => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutFileSystemPolicy'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/2015-02-01/file-systems/{FileSystemId}/policy'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EFS::FileSystemPolicyDescription'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::EFS::PutFileSystemPolicy - Arguments for method PutFileSystemPolicy on L<Paws::EFS> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method PutFileSystemPolicy on the | ||
| 25 | L<Amazon Elastic File System|Paws::EFS> service. Use the attributes of this class | ||
| 26 | as arguments to method PutFileSystemPolicy. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutFileSystemPolicy. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $elasticfilesystem = Paws->service('EFS'); | ||
| 33 | my $FileSystemPolicyDescription = $elasticfilesystem->PutFileSystemPolicy( | ||
| 34 | FileSystemId => 'MyFileSystemId', | ||
| 35 | Policy => 'MyPolicy', | ||
| 36 | BypassPolicyLockoutSafetyCheck => 1, # OPTIONAL | ||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $FileSystemId = $FileSystemPolicyDescription->FileSystemId; | ||
| 41 | my $Policy = $FileSystemPolicyDescription->Policy; | ||
| 42 | |||
| 43 | # Returns a L<Paws::EFS::FileSystemPolicyDescription> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem/PutFileSystemPolicy> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 BypassPolicyLockoutSafetyCheck => Bool | ||
| 52 | |||
| 53 | (Optional) A flag to indicate whether to bypass the C<FileSystemPolicy> | ||
| 54 | lockout safety check. The policy lockout safety check determines | ||
| 55 | whether the policy in the request will prevent the principal making the | ||
| 56 | request will be locked out from making future C<PutFileSystemPolicy> | ||
| 57 | requests on the file system. Set C<BypassPolicyLockoutSafetyCheck> to | ||
| 58 | C<True> only when you intend to prevent the principal that is making | ||
| 59 | the request from making a subsequent C<PutFileSystemPolicy> request on | ||
| 60 | the file system. The default value is False. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> FileSystemId => Str | ||
| 65 | |||
| 66 | The ID of the EFS file system that you want to create or update the | ||
| 67 | C<FileSystemPolicy> for. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 B<REQUIRED> Policy => Str | ||
| 72 | |||
| 73 | The C<FileSystemPolicy> that you're creating. Accepts a JSON formatted | ||
| 74 | policy definition. EFS file system policies have a 20,000 character | ||
| 75 | limit. To find out more about the elements that make up a file system | ||
| 76 | policy, see EFS Resource-based Policies | ||
| 77 | (https://docs.aws.amazon.com/efs/latest/ug/access-control-overview.html#access-control-manage-access-intro-resource-policies). | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head1 SEE ALSO | ||
| 83 | |||
| 84 | This class forms part of L<Paws>, documenting arguments for method PutFileSystemPolicy in L<Paws::EFS> | ||
| 85 | |||
| 86 | =head1 BUGS and CONTRIBUTIONS | ||
| 87 | |||
| 88 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 89 | |||
| 90 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 91 | |||
| 92 | =cut | ||
| 93 |