Class CfnEventBusPolicy

A CloudFormation AWS::Events::EventBusPolicy.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnEventBusPolicy

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.Events

Assembly: Amazon.CDK.AWS.Events.dll

Syntax (csharp)

public class CfnEventBusPolicy : CfnResource, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnEventBusPolicy
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable

Remarks

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

CloudformationResource: AWS::Events::EventBusPolicy

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

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`.
CfnEventBusPolicy(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnEventBusPolicy(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

Properties

Action	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
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.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

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 System.String

scoped id of the resource.

props ICfnEventBusPolicyProps

resource properties.

CfnEventBusPolicy(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnEventBusPolicy(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnEventBusPolicy(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnEventBusPolicy(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Properties

Action

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

public virtual string Action { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-action

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

System.String

CfnProperties

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

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

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 virtual 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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-condition

EventBusName

The name of the event bus associated with the rule.

public virtual string EventBusName { get; set; }

Property Value

System.String

Remarks

If you omit this, the default event bus is used.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-eventbusname

Principal

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

public virtual 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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-principal

Statement

A JSON string that describes the permission policy statement.

public virtual 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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statement

StatementId

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

public virtual 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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statementid

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.

RenderProperties(IDictionary<String, Object>)

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

Parameters

props System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable