Class CfnEventBusPolicy

Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus .

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnEventBusPolicy
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEventBusPolicy : CfnResource, IInspectable, IEventBusPolicyRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class CfnEventBusPolicy Inherits CfnResource Implements IInspectable, IEventBusPolicyRef, IConstruct, IDependable, IEnvironmentAware
Remarks

Amazon EventBridge 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 AWS 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 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.

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 AWS Accounts in the Amazon EventBridge User Guide .

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html

CloudformationResource: AWS::Events::EventBusPolicy

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 cfnEventBusPolicy = new CfnEventBusPolicy(this, "MyCfnEventBusPolicy", 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

CfnEventBusPolicy(Construct, string, ICfnEventBusPolicyProps)

Create a new AWS::Events::EventBusPolicy.

Properties

Action

(deprecated) The action that you are enabling the other account to perform.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties

Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus .
Condition

(deprecated) 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.
EventBusPolicyRef

A reference to a EventBusPolicy resource.
Principal

(deprecated) 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.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnEventBusPolicy(object)

Checks whether the given object is a CfnEventBusPolicy.
RenderProperties(IDictionary<string, object>)

Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus .

Constructors

CfnEventBusPolicy(Construct, string, ICfnEventBusPolicyProps)

Create a new AWS::Events::EventBusPolicy.

public CfnEventBusPolicy(Construct scope, string id, ICfnEventBusPolicyProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnEventBusPolicyProps

Resource properties.

Remarks

Amazon EventBridge 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 AWS 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 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.

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 AWS Accounts in the Amazon EventBridge User Guide .

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html

CloudformationResource: AWS::Events::EventBusPolicy

ExampleMetadata: fixture=_generated

Properties

Action

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

[Obsolete("this property has been deprecated")]
public virtual string? Action { get; set; }
Property Value

string

Remarks

Stability: Deprecated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

Amazon EventBridge 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 AWS 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 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.

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 AWS Accounts in the Amazon EventBridge User Guide .

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html

CloudformationResource: AWS::Events::EventBusPolicy

ExampleMetadata: fixture=_generated

CfnProperties

Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus .

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

Amazon EventBridge 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 AWS 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 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.

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 AWS Accounts in the Amazon EventBridge User Guide .

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html

CloudformationResource: AWS::Events::EventBusPolicy

ExampleMetadata: fixture=_generated

Condition

(deprecated) 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.

[Obsolete("this property has been deprecated")]
public virtual object? Condition { get; set; }
Property Value

object

Remarks

Stability: Deprecated

Type union: either IResolvable or CfnEventBusPolicy.IConditionProperty

EventBusName

The name of the event bus associated with the rule.

public virtual string? EventBusName { get; set; }
Property Value

string

Remarks

Amazon EventBridge 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 AWS 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 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.

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 AWS Accounts in the Amazon EventBridge User Guide .

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html

CloudformationResource: AWS::Events::EventBusPolicy

ExampleMetadata: fixture=_generated

EventBusPolicyRef

A reference to a EventBusPolicy resource.

public virtual IEventBusPolicyReference EventBusPolicyRef { get; }
Property Value

IEventBusPolicyReference

Remarks

Amazon EventBridge 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 AWS 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 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.

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 AWS Accounts in the Amazon EventBridge User Guide .

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html

CloudformationResource: AWS::Events::EventBusPolicy

ExampleMetadata: fixture=_generated

Principal

(deprecated) The 12-digit AWS account ID that you are permitting to put events to your default event bus.

[Obsolete("this property has been deprecated")]
public virtual string? Principal { get; set; }
Property Value

string

Remarks

Stability: Deprecated

Statement

A JSON string that describes the permission policy statement.

public virtual object? Statement { get; set; }
Property Value

object

Remarks

Amazon EventBridge 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 AWS 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 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.

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 AWS Accounts in the Amazon EventBridge User Guide .

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html

CloudformationResource: AWS::Events::EventBusPolicy

ExampleMetadata: fixture=_generated

StatementId

An identifier string for the external account that you are granting permissions to.

public virtual string StatementId { get; set; }
Property Value

string

Remarks

Amazon EventBridge 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 AWS 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 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.

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 AWS Accounts in the Amazon EventBridge User Guide .

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html

CloudformationResource: AWS::Events::EventBusPolicy

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

Amazon EventBridge 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 AWS 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 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.

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 AWS Accounts in the Amazon EventBridge User Guide .

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html

CloudformationResource: AWS::Events::EventBusPolicy

ExampleMetadata: fixture=_generated

IsCfnEventBusPolicy(object)

Checks whether the given object is a CfnEventBusPolicy.

public static bool IsCfnEventBusPolicy(object x)
Parameters
x object
Returns

bool

Remarks

Amazon EventBridge 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 AWS 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 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.

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 AWS Accounts in the Amazon EventBridge User Guide .

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html

CloudformationResource: AWS::Events::EventBusPolicy

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus .

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

Amazon EventBridge 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 AWS 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 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.

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 AWS Accounts in the Amazon EventBridge User Guide .

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html

CloudformationResource: AWS::Events::EventBusPolicy

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable