Class CfnEventBusPolicyProps

Properties for defining a CfnEventBusPolicy.

Inheritance

object

CfnEventBusPolicyProps

Implements

ICfnEventBusPolicyProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Events

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnEventBusPolicyProps : ICfnEventBusPolicyProps

Syntax (vb)

Public Class CfnEventBusPolicyProps Implements ICfnEventBusPolicyProps

Remarks

See: 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 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 for defining a CfnEventBusPolicy.

Properties

Action	(deprecated) The action that you are enabling the other account to perform.
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.
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.

Constructors

CfnEventBusPolicyProps()

Properties for defining a CfnEventBusPolicy.

public CfnEventBusPolicyProps()

Remarks

See: 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 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
             };

Properties

Action

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

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

Property Value

string

Remarks

Stability: Deprecated

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

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 object? Condition { get; set; }

Property Value

object

Remarks

Stability: Deprecated

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

Type union: either IResolvable or CfnEventBusPolicy.IConditionProperty

EventBusName

The name of the event bus associated with the rule.

public string? EventBusName { get; set; }

Property Value

string

Remarks

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

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

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 string? Principal { get; set; }

Property Value

string

Remarks

Specify "*" to permit any account to put events to your default event bus.

Stability: Deprecated

See: 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 object? Statement { get; set; }

Property Value

object

Remarks

You can include a Policy parameter in the request instead of using the StatementId , Action , Principal , or Condition parameters.

See: 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 string StatementId { get; set; }

Property Value

string

Remarks

If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission .

Each <code>StatementId</code> must be unique.

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

Implements

ICfnEventBusPolicyProps