« blib/lib/Paws/CloudWatchEvents/PutPartnerEventsResultEntry.pm
↑ Summary
blib/lib/Paws/CloudWatchEvents/PutRule.pm »
| 1 | |||
| 2 | package Paws::CloudWatchEvents::PutPermission; | ||
| 3 | use Moose; | ||
| 4 | has Action => (is => 'ro', isa => 'Str'); | ||
| 5 | has Condition => (is => 'ro', isa => 'Paws::CloudWatchEvents::Condition'); | ||
| 6 | has EventBusName => (is => 'ro', isa => 'Str'); | ||
| 7 | has Policy => (is => 'ro', isa => 'Str'); | ||
| 8 | has Principal => (is => 'ro', isa => 'Str'); | ||
| 9 | has StatementId => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutPermission'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::CloudWatchEvents::PutPermission - Arguments for method PutPermission on L<Paws::CloudWatchEvents> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method PutPermission on the | ||
| 27 | L<Amazon EventBridge|Paws::CloudWatchEvents> service. Use the attributes of this class | ||
| 28 | as arguments to method PutPermission. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutPermission. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $events = Paws->service('CloudWatchEvents'); | ||
| 35 | $events->PutPermission( | ||
| 36 | Action => 'MyAction', # OPTIONAL | ||
| 37 | Condition => { | ||
| 38 | Key => 'MyString', | ||
| 39 | Type => 'MyString', | ||
| 40 | Value => 'MyString', | ||
| 41 | |||
| 42 | }, # OPTIONAL | ||
| 43 | EventBusName => 'MyNonPartnerEventBusName', # OPTIONAL | ||
| 44 | Policy => 'MyString', # OPTIONAL | ||
| 45 | Principal => 'MyPrincipal', # OPTIONAL | ||
| 46 | StatementId => 'MyStatementId', # OPTIONAL | ||
| 47 | ); | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/events/PutPermission> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 Action => Str | ||
| 56 | |||
| 57 | The action that you are enabling the other account to perform. | ||
| 58 | Currently, this must be C<events:PutEvents>. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 Condition => L<Paws::CloudWatchEvents::Condition> | ||
| 63 | |||
| 64 | This parameter enables you to limit the permission to accounts that | ||
| 65 | fulfill a certain condition, such as being a member of a certain AWS | ||
| 66 | organization. For more information about AWS Organizations, see What Is | ||
| 67 | AWS Organizations | ||
| 68 | (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html) | ||
| 69 | in the I<AWS Organizations User Guide>. | ||
| 70 | |||
| 71 | If you specify C<Condition> with an AWS organization ID, and specify | ||
| 72 | "*" as the value for C<Principal>, you grant permission to all the | ||
| 73 | accounts in the named organization. | ||
| 74 | |||
| 75 | The C<Condition> is a JSON string which must contain C<Type>, C<Key>, | ||
| 76 | and C<Value> fields. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 EventBusName => Str | ||
| 81 | |||
| 82 | The name of the event bus associated with the rule. If you omit this, | ||
| 83 | the default event bus is used. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 Policy => Str | ||
| 88 | |||
| 89 | A JSON string that describes the permission policy statement. You can | ||
| 90 | include a C<Policy> parameter in the request instead of using the | ||
| 91 | C<StatementId>, C<Action>, C<Principal>, or C<Condition> parameters. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 Principal => Str | ||
| 96 | |||
| 97 | The 12-digit AWS account ID that you are permitting to put events to | ||
| 98 | your default event bus. Specify "*" to permit any account to put events | ||
| 99 | to your default event bus. | ||
| 100 | |||
| 101 | If you specify "*" without specifying C<Condition>, avoid creating | ||
| 102 | rules that may match undesirable events. To create more secure rules, | ||
| 103 | make sure that the event pattern for each rule contains an C<account> | ||
| 104 | field with a specific account ID from which to receive events. Rules | ||
| 105 | with an account field do not match any events sent from other accounts. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 StatementId => Str | ||
| 110 | |||
| 111 | An identifier string for the external account that you are granting | ||
| 112 | permissions to. If you later want to revoke the permission for this | ||
| 113 | external account, specify this C<StatementId> when you run | ||
| 114 | RemovePermission. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head1 SEE ALSO | ||
| 120 | |||
| 121 | This class forms part of L<Paws>, documenting arguments for method PutPermission in L<Paws::CloudWatchEvents> | ||
| 122 | |||
| 123 | =head1 BUGS and CONTRIBUTIONS | ||
| 124 | |||
| 125 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 126 | |||
| 127 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 128 | |||
| 129 | =cut | ||
| 130 |