Class CfnEventBusPolicy
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
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();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnEventBusPolicy
.static interface
A JSON string which you can use to limit the event bus permissions you are granting to only accounts that fulfill the condition.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCfnEventBusPolicy
(Construct scope, String id, CfnEventBusPolicyProps props) Create a newAWS::Events::EventBusPolicy
.protected
CfnEventBusPolicy
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnEventBusPolicy
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe action that you are enabling the other account to perform.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.The name of the event bus associated with the rule.The 12-digit AWS account ID that you are permitting to put events to your default event bus.A JSON string that describes the permission policy statement.An identifier string for the external account that you are granting permissions to.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
The action that you are enabling the other account to perform.void
setCondition
(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.void
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.void
setEventBusName
(String value) The name of the event bus associated with the rule.void
setPrincipal
(String value) The 12-digit AWS account ID that you are permitting to put events to your default event bus.void
setStatement
(Object value) A JSON string that describes the permission policy statement.void
setStatementId
(String value) An identifier string for the external account that you are granting permissions to.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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 newAWS::Events::EventBusPolicy
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getStatement
A JSON string that describes the permission policy statement.You can include a
Policy
parameter in the request instead of using theStatementId
,Action
,Principal
, orCondition
parameters. -
setStatement
A JSON string that describes the permission policy statement.You can include a
Policy
parameter in the request instead of using theStatementId
,Action
,Principal
, orCondition
parameters. -
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
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
The action that you are enabling the other account to perform. -
setAction
The action that you are enabling the other account to perform. -
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 forPrincipal
, you grant permission to all the accounts in the named organization.The
Condition
is a JSON string which must containType
,Key
, andValue
fields. -
setCondition
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 forPrincipal
, you grant permission to all the accounts in the named organization.The
Condition
is a JSON string which must containType
,Key
, andValue
fields. -
setCondition
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 forPrincipal
, you grant permission to all the accounts in the named organization.The
Condition
is a JSON string which must containType
,Key
, andValue
fields. -
getEventBusName
The name of the event bus associated with the rule.If you omit this, the default event bus is used.
-
setEventBusName
The name of the event bus associated with the rule.If you omit this, the default event bus is used.
-
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 anaccount
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
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 anaccount
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.
-