libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudWatchEvents.PutPermission

Description

Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus. Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account.

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

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

If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.

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

Synopsis

Creating a Request

data PutPermission Source #

See: newPutPermission smart constructor.

Constructors

PutPermission' 

Fields

  • action :: Maybe Text

    The action that you are enabling the other account to perform.

  • eventBusName :: Maybe Text

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

  • principal :: Maybe Text

    The 12-digit Amazon Web Services 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.

  • policy :: Maybe Text

    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.

  • statementId :: Maybe Text

    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.

  • condition :: Maybe Condition

    This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain Amazon Web Services organization. For more information about Amazon Web Services Organizations, see What Is Amazon Web Services Organizations in the Amazon Web Services Organizations User Guide.

    If you specify Condition with an Amazon Web Services 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.

Instances

Instances details
Eq PutPermission Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutPermission

Read PutPermission Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutPermission

Show PutPermission Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutPermission

Generic PutPermission Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutPermission

Associated Types

type Rep PutPermission :: Type -> Type #

NFData PutPermission Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutPermission

Methods

rnf :: PutPermission -> () #

Hashable PutPermission Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutPermission

ToJSON PutPermission Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutPermission

AWSRequest PutPermission Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutPermission

Associated Types

type AWSResponse PutPermission #

ToHeaders PutPermission Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutPermission

ToPath PutPermission Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutPermission

ToQuery PutPermission Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutPermission

type Rep PutPermission Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutPermission

type Rep PutPermission = D1 ('MetaData "PutPermission" "Amazonka.CloudWatchEvents.PutPermission" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "PutPermission'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "eventBusName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "principal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "statementId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "condition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Condition))))))
type AWSResponse PutPermission Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutPermission

newPutPermission :: PutPermission Source #

Create a value of PutPermission with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:action:PutPermission', putPermission_action - The action that you are enabling the other account to perform.

$sel:eventBusName:PutPermission', putPermission_eventBusName - The name of the event bus associated with the rule. If you omit this, the default event bus is used.

$sel:principal:PutPermission', putPermission_principal - The 12-digit Amazon Web Services 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.

$sel:policy:PutPermission', putPermission_policy - 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.

$sel:statementId:PutPermission', putPermission_statementId - 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.

$sel:condition:PutPermission', putPermission_condition - This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain Amazon Web Services organization. For more information about Amazon Web Services Organizations, see What Is Amazon Web Services Organizations in the Amazon Web Services Organizations User Guide.

If you specify Condition with an Amazon Web Services 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.

Request Lenses

putPermission_action :: Lens' PutPermission (Maybe Text) Source #

The action that you are enabling the other account to perform.

putPermission_eventBusName :: Lens' PutPermission (Maybe Text) Source #

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

putPermission_principal :: Lens' PutPermission (Maybe Text) Source #

The 12-digit Amazon Web Services 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.

putPermission_policy :: Lens' PutPermission (Maybe Text) Source #

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.

putPermission_statementId :: Lens' PutPermission (Maybe Text) Source #

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.

putPermission_condition :: Lens' PutPermission (Maybe Condition) Source #

This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain Amazon Web Services organization. For more information about Amazon Web Services Organizations, see What Is Amazon Web Services Organizations in the Amazon Web Services Organizations User Guide.

If you specify Condition with an Amazon Web Services 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.

Destructuring the Response

data PutPermissionResponse Source #

See: newPutPermissionResponse smart constructor.

Instances

Instances details
Eq PutPermissionResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutPermission

Read PutPermissionResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutPermission

Show PutPermissionResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutPermission

Generic PutPermissionResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutPermission

Associated Types

type Rep PutPermissionResponse :: Type -> Type #

NFData PutPermissionResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutPermission

Methods

rnf :: PutPermissionResponse -> () #

type Rep PutPermissionResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutPermission

type Rep PutPermissionResponse = D1 ('MetaData "PutPermissionResponse" "Amazonka.CloudWatchEvents.PutPermission" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "PutPermissionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutPermissionResponse :: PutPermissionResponse Source #

Create a value of PutPermissionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.