« blib/lib/Paws/WorkMail/Permission.pm
↑ Summary
blib/lib/Paws/WorkMail/PutAccessControlRuleResponse.pm »
| 1 | |||
| 2 | package Paws::WorkMail::PutAccessControlRule; | ||
| 3 | use Moose; | ||
| 4 | has Actions => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Effect => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has IpRanges => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has NotActions => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 10 | has NotIpRanges => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 11 | has NotUserIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 12 | has OrganizationId => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has UserIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutAccessControlRule'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkMail::PutAccessControlRuleResponse'); | ||
| 19 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::WorkMail::PutAccessControlRule - Arguments for method PutAccessControlRule on L<Paws::WorkMail> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method PutAccessControlRule on the | ||
| 31 | L<Amazon WorkMail|Paws::WorkMail> service. Use the attributes of this class | ||
| 32 | as arguments to method PutAccessControlRule. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutAccessControlRule. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $workmail = Paws->service('WorkMail'); | ||
| 39 | my $PutAccessControlRuleResponse = $workmail->PutAccessControlRule( | ||
| 40 | Description => 'MyAccessControlRuleDescription', | ||
| 41 | Effect => 'ALLOW', | ||
| 42 | Name => 'MyAccessControlRuleName', | ||
| 43 | OrganizationId => 'MyOrganizationId', | ||
| 44 | Actions => [ | ||
| 45 | 'MyAccessControlRuleAction', ... # min: 1, max: 64 | ||
| 46 | ], # OPTIONAL | ||
| 47 | IpRanges => [ | ||
| 48 | 'MyIpRange', ... # min: 1, max: 18 | ||
| 49 | ], # OPTIONAL | ||
| 50 | NotActions => [ | ||
| 51 | 'MyAccessControlRuleAction', ... # min: 1, max: 64 | ||
| 52 | ], # OPTIONAL | ||
| 53 | NotIpRanges => [ | ||
| 54 | 'MyIpRange', ... # min: 1, max: 18 | ||
| 55 | ], # OPTIONAL | ||
| 56 | NotUserIds => [ | ||
| 57 | 'MyWorkMailIdentifier', ... # min: 12, max: 256 | ||
| 58 | ], # OPTIONAL | ||
| 59 | UserIds => [ | ||
| 60 | 'MyWorkMailIdentifier', ... # min: 12, max: 256 | ||
| 61 | ], # OPTIONAL | ||
| 62 | ); | ||
| 63 | |||
| 64 | 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. | ||
| 65 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/workmail/PutAccessControlRule> | ||
| 66 | |||
| 67 | =head1 ATTRIBUTES | ||
| 68 | |||
| 69 | |||
| 70 | =head2 Actions => ArrayRef[Str|Undef] | ||
| 71 | |||
| 72 | Access protocol actions to include in the rule. Valid values include | ||
| 73 | C<ActiveSync>, C<AutoDiscover>, C<EWS>, C<IMAP>, C<SMTP>, | ||
| 74 | C<WindowsOutlook>, and C<WebMail>. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> Description => Str | ||
| 79 | |||
| 80 | The rule description. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> Effect => Str | ||
| 85 | |||
| 86 | The rule effect. | ||
| 87 | |||
| 88 | Valid values are: C<"ALLOW">, C<"DENY"> | ||
| 89 | |||
| 90 | =head2 IpRanges => ArrayRef[Str|Undef] | ||
| 91 | |||
| 92 | IPv4 CIDR ranges to include in the rule. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 B<REQUIRED> Name => Str | ||
| 97 | |||
| 98 | The rule name. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 NotActions => ArrayRef[Str|Undef] | ||
| 103 | |||
| 104 | Access protocol actions to exclude from the rule. Valid values include | ||
| 105 | C<ActiveSync>, C<AutoDiscover>, C<EWS>, C<IMAP>, C<SMTP>, | ||
| 106 | C<WindowsOutlook>, and C<WebMail>. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 NotIpRanges => ArrayRef[Str|Undef] | ||
| 111 | |||
| 112 | IPv4 CIDR ranges to exclude from the rule. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 NotUserIds => ArrayRef[Str|Undef] | ||
| 117 | |||
| 118 | User IDs to exclude from the rule. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 B<REQUIRED> OrganizationId => Str | ||
| 123 | |||
| 124 | The identifier of the organization. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 UserIds => ArrayRef[Str|Undef] | ||
| 129 | |||
| 130 | User IDs to include in the rule. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head1 SEE ALSO | ||
| 136 | |||
| 137 | This class forms part of L<Paws>, documenting arguments for method PutAccessControlRule in L<Paws::WorkMail> | ||
| 138 | |||
| 139 | =head1 BUGS and CONTRIBUTIONS | ||
| 140 | |||
| 141 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 142 | |||
| 143 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 144 | |||
| 145 | =cut | ||
| 146 |