You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudWatchEvents::Types::PutPermissionRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb

Overview

Note:

When making an API call, you may pass PutPermissionRequest data as a hash:

{
  action: "Action", # required
  principal: "Principal", # required
  statement_id: "StatementId", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

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

Returns:

  • (String)


554
555
556
557
558
559
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 554

class PutPermissionRequest < Struct.new(
  :action,
  :principal,
  :statement_id)
  include Aws::Structure
end

#principalString

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.

Returns:

  • (String)


554
555
556
557
558
559
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 554

class PutPermissionRequest < Struct.new(
  :action,
  :principal,
  :statement_id)
  include Aws::Structure
end

#statement_idString

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.

Returns:

  • (String)


554
555
556
557
558
559
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 554

class PutPermissionRequest < Struct.new(
  :action,
  :principal,
  :statement_id)
  include Aws::Structure
end