Amazon CloudWatch Events

2018/10/17 - Amazon CloudWatch Events - 1 updated api methods

Changes  AWS Events - AWS Organizations Support in Event-Bus Policies. This release introduces a new parameter in the PutPermission API named Condition. Using the Condition parameter, customers can allow one or more AWS Organizations to access their CloudWatch Events Event-Bus resource.

PutPermission (updated) Link ΒΆ
Changes (request)
{'Condition': {'Key': 'string', 'Type': 'string', 'Value': 'string'}}

Running PutPermission permits the specified AWS account or AWS organization to put events to your account's default event bus . CloudWatch Events rules in your account are triggered by these events arriving to your default event bus.

For another account to send events to your account, that external account must have a CloudWatch Events rule with your account's default event bus as a target.

To enable multiple AWS accounts to put events to your default event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run PutPermission once specifying Principal as "*" and specifying the AWS organization ID in Condition , to grant permissions to all accounts in that organization.

The permission policy on the default event bus cannot exceed 10 KB in size.

See also: AWS API Documentation

Request Syntax

client.put_permission(
    Action='string',
    Principal='string',
    StatementId='string',
    Condition={
        'Type': 'string',
        'Key': 'string',
        'Value': 'string'
    }
)
type Action

string

param Action

[REQUIRED]

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

type Principal

string

param Principal

[REQUIRED]

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.

type StatementId

string

param StatementId

[REQUIRED]

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 .

type Condition

dict

param 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 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.

  • Type (string) -- [REQUIRED]

    Specifies the type of condition. Currently the only supported value is StringEquals .

  • Key (string) -- [REQUIRED]

    Specifies the key for the condition. Currently the only supported key is aws:PrincipalOrgID .

  • Value (string) -- [REQUIRED]

    Specifies the value for the key. Currently, this must be the ID of the organization.

returns

None