CfnEventBusPolicyProps
- class aws_cdk.aws_events.CfnEventBusPolicyProps(*, statement_id, action=None, condition=None, event_bus_name=None, principal=None, statement=None)
Bases:
object
Properties for defining a
CfnEventBusPolicy
.- Parameters:
statement_id (
str
) – 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 thisStatementId
when you run RemovePermission . .. epigraph:: EachStatementId
must be unique.action (
Optional
[str
]) – The action that you are enabling the other account to perform.condition (
Union
[IResolvable
,ConditionProperty
,Dict
[str
,Any
],None
]) – 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 specifyCondition
with an AWS organization ID, and specify “*” as the value forPrincipal
, you grant permission to all the accounts in the named organization. TheCondition
is a JSON string which must containType
,Key
, andValue
fields.event_bus_name (
Optional
[str
]) – The name of the event bus associated with the rule. If you omit this, the default event bus is used.principal (
Optional
[str
]) – 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 specifyingCondition
, 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.statement (
Any
) – A JSON string that describes the permission policy statement. You can include aPolicy
parameter in the request instead of using theStatementId
,Action
,Principal
, orCondition
parameters.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_events as events # statement: Any cfn_event_bus_policy_props = events.CfnEventBusPolicyProps( statement_id="statementId", # the properties below are optional action="action", condition=events.CfnEventBusPolicy.ConditionProperty( key="key", type="type", value="value" ), event_bus_name="eventBusName", principal="principal", statement=statement )
Attributes
- action
The action that you are enabling the other account to perform.
- 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.
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.
- event_bus_name
The name of the event bus associated with the rule.
If you omit this, the default event bus is used.
- principal
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.
- statement
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.
- statement_id
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 . .. epigraph:Each ``StatementId`` must be unique.