Package software.amazon.awscdk.services.events

Class CfnEventBusPolicy.Builder

java.lang.Object

software.amazon.awscdk.services.events.CfnEventBusPolicy.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEventBusPolicy>

Enclosing class:

CfnEventBusPolicy

@Stability(Stable)
public static final class CfnEventBusPolicy.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEventBusPolicy>

A fluent builder for CfnEventBusPolicy.

Method Summary

Modifier and Type	Method	Description
CfnEventBusPolicy.Builder	action(String action)	The action that you are enabling the other account to perform.
CfnEventBusPolicy	build()
CfnEventBusPolicy.Builder	condition(IResolvable 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.
CfnEventBusPolicy.Builder	condition(CfnEventBusPolicy.ConditionProperty 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.
static CfnEventBusPolicy.Builder	create(software.constructs.Construct scope, String id)
CfnEventBusPolicy.Builder	eventBusName(String eventBusName)	The name of the event bus associated with the rule.
CfnEventBusPolicy.Builder	principal(String principal)	The 12-digit AWS account ID that you are permitting to put events to your default event bus.
CfnEventBusPolicy.Builder	statement(Object statement)	A JSON string that describes the permission policy statement.
CfnEventBusPolicy.Builder	statementId(String statementId)	An identifier string for the external account that you are granting permissions to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnEventBusPolicy.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnEventBusPolicy.Builder.

statementId

@Stability(Stable)
public CfnEventBusPolicy.Builder statementId(String statementId)

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.

Parameters:

statementId - An identifier string for the external account that you are granting permissions to. This parameter is required.

Returns:

this

See Also:

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

action

@Stability(Stable)
public CfnEventBusPolicy.Builder action(String action)

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

Parameters:

action - The action that you are enabling the other account to perform. This parameter is required.

Returns:

this

See Also:

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

condition

@Stability(Stable)
public CfnEventBusPolicy.Builder condition(IResolvable 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 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.

Parameters:

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. This parameter is required.

Returns:

this

See Also:

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

condition

@Stability(Stable)
public CfnEventBusPolicy.Builder condition(CfnEventBusPolicy.ConditionProperty 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 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.

Parameters:

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. This parameter is required.

Returns:

this

See Also:

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

eventBusName

@Stability(Stable)
public CfnEventBusPolicy.Builder eventBusName(String eventBusName)

The name of the event bus associated with the rule.

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

Parameters:

eventBusName - The name of the event bus associated with the rule. This parameter is required.

Returns:

this

See Also:

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

principal

@Stability(Stable)
public CfnEventBusPolicy.Builder principal(String 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 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.

Parameters:

principal - The 12-digit AWS account ID that you are permitting to put events to your default event bus. This parameter is required.

Returns:

this

See Also:

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

statement

@Stability(Stable)
public CfnEventBusPolicy.Builder statement(Object statement)

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.

Parameters:

statement - A JSON string that describes the permission policy statement. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnEventBusPolicy build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnEventBusPolicy>

Returns:

a newly built instance of CfnEventBusPolicy.