Class CfnEventBusPolicyProps
Properties for defining a CfnEventBusPolicy
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEventBusPolicyProps : Object, ICfnEventBusPolicyProps
Syntax (vb)
Public Class CfnEventBusPolicyProps
Inherits Object
Implements ICfnEventBusPolicyProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Events;
var statement;
var cfnEventBusPolicyProps = new CfnEventBusPolicyProps {
StatementId = "statementId",
// the properties below are optional
Action = "action",
Condition = new ConditionProperty {
Key = "key",
Type = "type",
Value = "value"
},
EventBusName = "eventBusName",
Principal = "principal",
Statement = statement
};
Synopsis
Constructors
CfnEventBusPolicyProps() |
Properties
Action | The action that you are enabling the other account to perform. |
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. |
EventBusName | The name of the event bus associated with the rule. |
Principal | The 12-digit AWS account ID that you are permitting to put events to your default event bus. |
Statement | A JSON string that describes the permission policy statement. |
StatementId | An identifier string for the external account that you are granting permissions to. |
Constructors
CfnEventBusPolicyProps()
public CfnEventBusPolicyProps()
Properties
Action
The action that you are enabling the other account to perform.
public string Action { get; set; }
Property Value
System.String
Remarks
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.
public object Condition { get; set; }
Property Value
System.Object
Remarks
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.
EventBusName
The name of the event bus associated with the rule.
public string EventBusName { get; set; }
Property Value
System.String
Remarks
If you omit this, the default event bus is used.
Principal
The 12-digit AWS account ID that you are permitting to put events to your default event bus.
public string Principal { get; set; }
Property Value
System.String
Remarks
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.
Statement
A JSON string that describes the permission policy statement.
public object Statement { get; set; }
Property Value
System.Object
Remarks
You can include a Policy
parameter in the request instead of using the StatementId
, Action
, Principal
, or Condition
parameters.
StatementId
An identifier string for the external account that you are granting permissions to.
public string StatementId { get; set; }
Property Value
System.String
Remarks
If you later want to revoke the permission for this external account, specify this StatementId
when you run RemovePermission .
Each StatementId
must be unique.