Package software.amazon.awscdk.services.events

Interface CfnEventBusPolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEventBusPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-11T03:45:54.735Z")
@Stability(Stable)
public interface CfnEventBusPolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnEventBusPolicy.

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;
 CfnEventBusPolicyProps cfnEventBusPolicyProps = CfnEventBusPolicyProps.builder()
         .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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEventBusPolicyProps.Builder	A builder for CfnEventBusPolicyProps
static final class	CfnEventBusPolicyProps.Jsii$Proxy	An implementation for CfnEventBusPolicyProps

Method Summary

Modifier and Type	Method	Description
static CfnEventBusPolicyProps.Builder	builder()
default String	getAction()	The action that you are enabling the other account to perform.
default 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.
default String	getEventBusName()	The name of the event bus associated with the rule.
default String	getPrincipal()	The 12-digit AWS account ID that you are permitting to put events to your default event bus.
default Object	getStatement()	A JSON string that describes the permission policy statement.
String	getStatementId()	An identifier string for the external account that you are granting permissions to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStatementId

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

See Also:

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

getAction

@Stability(Stable)
@Nullable
default String getAction()

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

See Also:

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

getCondition

@Stability(Stable)
@Nullable
default 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.

See Also:

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

getEventBusName

@Stability(Stable)
@Nullable
default String getEventBusName()

The name of the event bus associated with the rule.

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

See Also:

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

getPrincipal

@Stability(Stable)
@Nullable
default 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.

See Also:

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

getStatement

@Stability(Stable)
@Nullable
default 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.

See Also:

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

builder

@Stability(Stable)
static CfnEventBusPolicyProps.Builder builder()

Returns:

a CfnEventBusPolicyProps.Builder of CfnEventBusPolicyProps