Package software.amazon.awscdk.services.events

Class CfnEventBusPolicy

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.events.CfnEventBusPolicy
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:36.983Z") @Stability(Stable) public class CfnEventBusPolicy extends CfnResource implements IInspectable
A CloudFormation AWS::Events::EventBusPolicy.

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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.events.*;
 Object statement;
 CfnEventBusPolicy cfnEventBusPolicy = CfnEventBusPolicy.Builder.create(this, "MyCfnEventBusPolicy")
         .statementId("statementId")
         // the properties below are optional
         .action("action")
         .condition(ConditionProperty.builder()
                 .key("key")
                 .type("type")
                 .value("value")
                 .build())
         .eventBusName("eventBusName")
         .principal("principal")
         .statement(statement)
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEventBusPolicy

      protected CfnEventBusPolicy(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnEventBusPolicy

      protected CfnEventBusPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnEventBusPolicy

      @Stability(Stable) public CfnEventBusPolicy(@NotNull Construct scope, @NotNull String id, @NotNull CfnEventBusPolicyProps props)
      Create a new AWS::Events::EventBusPolicy.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getStatement

      @Stability(Stable) @NotNull public Object getStatement()
      A JSON string that describes the permission policy statement.

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

    • setStatement

      @Stability(Stable) public void setStatement(@NotNull Object value)
      A JSON string that describes the permission policy statement.

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

    • getStatementId

      @Stability(Stable) @NotNull public String getStatementId()
      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 .

      Each StatementId must be unique.

    • setStatementId

      @Stability(Stable) public void setStatementId(@NotNull String value)
      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 .

      Each StatementId must be unique.

    • getAction

      @Stability(Stable) @Nullable public String getAction()
      The action that you are enabling the other account to perform.

    • setAction

      @Stability(Stable) public void setAction(@Nullable String value)
      The action that you are enabling the other account to perform.

    • getCondition

      @Stability(Stable) @Nullable public Object getCondition()
      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.

      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.

    • setCondition

      @Stability(Stable) public void setCondition(@Nullable IResolvable value)
      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.

      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.

    • setCondition

      @Stability(Stable) public void setCondition(@Nullable CfnEventBusPolicy.ConditionProperty value)
      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.

      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.

    • getEventBusName

      @Stability(Stable) @Nullable public String getEventBusName()
      The name of the event bus associated with the rule.

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

    • setEventBusName

      @Stability(Stable) public void setEventBusName(@Nullable String value)
      The name of the event bus associated with the rule.

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

    • getPrincipal

      @Stability(Stable) @Nullable public String getPrincipal()
      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 "*" 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.

    • setPrincipal

      @Stability(Stable) public void setPrincipal(@Nullable String value)
      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 "*" 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.