Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.CloudWatchEvents.PutPermission

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Running PutPermission permits the specified AWS account 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.

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

Synopsis

putPermission :: Text -> Text -> Text -> PutPermission
data PutPermission
ppAction :: Lens' PutPermission Text
ppPrincipal :: Lens' PutPermission Text
ppStatementId :: Lens' PutPermission Text
putPermissionResponse :: PutPermissionResponse
data PutPermissionResponse

Creating a Request

putPermission #

Arguments

:: Text	`ppAction`
-> Text	`ppPrincipal`
-> Text	`ppStatementId`
-> PutPermission

Creates a value of PutPermission with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ppAction - The action that you are enabling the other account to perform. Currently, this must be events:PutEvents .
ppPrincipal - 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 "*", 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.
ppStatementId - 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 .

data PutPermission #

See: putPermission smart constructor.

Instances

Eq PutPermission #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission Methods (==) :: PutPermission -> PutPermission -> Bool # (/=) :: PutPermission -> PutPermission -> Bool #
Data PutPermission #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutPermission -> c PutPermission # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutPermission # toConstr :: PutPermission -> Constr # dataTypeOf :: PutPermission -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PutPermission) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutPermission) # gmapT :: (forall b. Data b => b -> b) -> PutPermission -> PutPermission # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutPermission -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutPermission -> r # gmapQ :: (forall d. Data d => d -> u) -> PutPermission -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PutPermission -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutPermission -> m PutPermission # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutPermission -> m PutPermission # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutPermission -> m PutPermission #
Read PutPermission #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission Methods readsPrec :: Int -> ReadS PutPermission # readList :: ReadS [PutPermission] # readPrec :: ReadPrec PutPermission # readListPrec :: ReadPrec [PutPermission] #
Show PutPermission #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission Methods showsPrec :: Int -> PutPermission -> ShowS # show :: PutPermission -> String # showList :: [PutPermission] -> ShowS #
Generic PutPermission #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission Associated Types type Rep PutPermission :: Type -> Type # Methods from :: PutPermission -> Rep PutPermission x # to :: Rep PutPermission x -> PutPermission #
Hashable PutPermission #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission Methods hashWithSalt :: Int -> PutPermission -> Int # hash :: PutPermission -> Int #
ToJSON PutPermission #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission Methods toJSON :: PutPermission -> Value # toEncoding :: PutPermission -> Encoding # toJSONList :: [PutPermission] -> Value # toEncodingList :: [PutPermission] -> Encoding #
AWSRequest PutPermission #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission Associated Types type Rs PutPermission :: Type # Methods request :: PutPermission -> Request PutPermission # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy PutPermission -> ClientResponse -> m (Response PutPermission) #
ToHeaders PutPermission #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission Methods toHeaders :: PutPermission -> [Header] #
ToPath PutPermission #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission Methods toPath :: PutPermission -> ByteString #
ToQuery PutPermission #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission Methods toQuery :: PutPermission -> QueryString #
NFData PutPermission #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission Methods rnf :: PutPermission -> () #
type Rep PutPermission #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission type Rep PutPermission = D1 (MetaData "PutPermission" "Network.AWS.CloudWatchEvents.PutPermission" "amazonka-cloudwatch-events-1.6.1-CoHMjgQmalEK7ihh8e5m1B" False) (C1 (MetaCons "PutPermission'" PrefixI True) (S1 (MetaSel (Just "_ppAction") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_ppPrincipal") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_ppStatementId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs PutPermission #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission type Rs PutPermission = PutPermissionResponse

Request Lenses

ppAction :: Lens' PutPermission Text #

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

ppPrincipal :: Lens' PutPermission Text #

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 "*", 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.

ppStatementId :: Lens' PutPermission 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 .

Destructuring the Response

putPermissionResponse :: PutPermissionResponse #

Creates a value of PutPermissionResponse with the minimum fields required to make a request.

data PutPermissionResponse #

See: putPermissionResponse smart constructor.

Instances

Eq PutPermissionResponse #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission Methods (==) :: PutPermissionResponse -> PutPermissionResponse -> Bool # (/=) :: PutPermissionResponse -> PutPermissionResponse -> Bool #
Data PutPermissionResponse #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutPermissionResponse -> c PutPermissionResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutPermissionResponse # toConstr :: PutPermissionResponse -> Constr # dataTypeOf :: PutPermissionResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PutPermissionResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutPermissionResponse) # gmapT :: (forall b. Data b => b -> b) -> PutPermissionResponse -> PutPermissionResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutPermissionResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutPermissionResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> PutPermissionResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PutPermissionResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutPermissionResponse -> m PutPermissionResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutPermissionResponse -> m PutPermissionResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutPermissionResponse -> m PutPermissionResponse #
Read PutPermissionResponse #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission Methods readsPrec :: Int -> ReadS PutPermissionResponse # readList :: ReadS [PutPermissionResponse] # readPrec :: ReadPrec PutPermissionResponse # readListPrec :: ReadPrec [PutPermissionResponse] #
Show PutPermissionResponse #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission Methods showsPrec :: Int -> PutPermissionResponse -> ShowS # show :: PutPermissionResponse -> String # showList :: [PutPermissionResponse] -> ShowS #
Generic PutPermissionResponse #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission Associated Types type Rep PutPermissionResponse :: Type -> Type # Methods from :: PutPermissionResponse -> Rep PutPermissionResponse x # to :: Rep PutPermissionResponse x -> PutPermissionResponse #
NFData PutPermissionResponse #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission Methods rnf :: PutPermissionResponse -> () #
type Rep PutPermissionResponse #
Instance details Defined in Network.AWS.CloudWatchEvents.PutPermission type Rep PutPermissionResponse = D1 (MetaData "PutPermissionResponse" "Network.AWS.CloudWatchEvents.PutPermission" "amazonka-cloudwatch-events-1.6.1-CoHMjgQmalEK7ihh8e5m1B" False) (C1 (MetaCons "PutPermissionResponse'" PrefixI False) (U1 :: Type -> Type))