/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CloudWatchEvents::PutPermission

NAME

Paws::CloudWatchEvents::PutPermission - Arguments for method PutPermission on Paws::CloudWatchEvents

DESCRIPTION

This class represents the parameters used for calling the method PutPermission on the Amazon EventBridge service. Use the attributes of this class as arguments to method PutPermission.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutPermission.

SYNOPSIS

my $events = Paws->service('CloudWatchEvents');
$events->PutPermission(
  Action    => 'MyAction',    # OPTIONAL
  Condition => {
    Key   => 'MyString',
    Type  => 'MyString',
    Value => 'MyString',

  },                          # OPTIONAL
  EventBusName => 'MyNonPartnerEventBusName',    # OPTIONAL
  Policy       => 'MyString',                    # OPTIONAL
  Principal    => 'MyPrincipal',                 # OPTIONAL
  StatementId  => 'MyStatementId',               # OPTIONAL
);

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/events/PutPermission

ATTRIBUTES

Action => Str

The action that you are enabling the other account to perform. Currently, this must be events:PutEvents.

Condition => Paws::CloudWatchEvents::Condition

This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization. For more information about AWS Organizations, see What Is AWS Organizations (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html) in the AWS Organizations User Guide.

If you specify Condition with an AWS organization ID, and specify "*" as the value for Principal, you grant permission to all the accounts in the named organization.

The Condition is a JSON string which must contain Type, Key, and Value fields.

EventBusName => Str

The name of the event bus associated with the rule. If you omit this, the default event bus is used.

Policy => Str

A JSON string that describes the permission policy statement. You can include a Policy parameter in the request instead of using the StatementId, Action, Principal, or Condition parameters.

Principal => Str

The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.

If you specify "*" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.

StatementId => Str

An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.

SEE ALSO

This class forms part of Paws, documenting arguments for method PutPermission in Paws::CloudWatchEvents

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues