@aws-cdk/aws-events

constructor

constructor(scope: Construct, id: string, props: ApiDestinationProps);

property apiDestinationArn

readonly apiDestinationArn: string;

• The ARN of the Api Destination created.

property apiDestinationName

readonly apiDestinationName: string;

• The Name of the Api Destination created.

property connection

readonly connection: IConnection;

• The Connection to associate with Api Destination

constructor

constructor(scope: Construct, id: string, props: ArchiveProps);

property archiveArn

readonly archiveArn: string;

• The ARN of the archive created.

property archiveName

readonly archiveName: string;

• The archive name.

method apiKey

static apiKey: (apiKeyName: string, apiKeyValue: SecretValue) => Authorization;

• Use API key authorization

  API key authorization has two components: an API key name and an API key value. What these are depends on the target of your connection.

method basic

static basic: (username: string, password: SecretValue) => Authorization;

• Use username and password authorization

method oauth

static oauth: (props: OAuthAuthorizationProps) => Authorization;

• Use OAuth authorization

constructor

constructor(scope: cdk.Construct, id: string, props: CfnApiDestinationProps);

• Create a new AWS::Events::ApiDestination.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrArn

readonly attrArn: string;

• The ARN of the API destination that was created by the request. Arn

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property connectionArn

connectionArn: string;

• The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-connectionarn

property description

description: string;

• A description for the API destination to create.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-description

property httpMethod

httpMethod: string;

• The method to use for the request to the HTTP invocation endpoint.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-httpmethod

property invocationEndpoint

invocationEndpoint: string;

• The URL to the HTTP invocation endpoint for the API destination.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationendpoint

property invocationRateLimitPerSecond

invocationRateLimitPerSecond: number;

• The maximum number of requests per second to send to the HTTP invocation endpoint.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationratelimitpersecond

property name

name: string;

• The name for the API destination to create.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-name

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnArchiveProps);

• Create a new AWS::Events::Archive.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property archiveName

archiveName: string;

• The name for the archive to create.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-archivename

property attrArn

readonly attrArn: string;

• The ARN of the archive created. Arn

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property description

description: string;

• A description for the archive.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-description

property eventPattern

eventPattern: any;

• An event pattern to use to filter events sent to the archive.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-eventpattern

property retentionDays

retentionDays: number;

• The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-retentiondays

property sourceArn

sourceArn: string;

• The ARN of the event bus that sends events to the archive.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-sourcearn

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnConnectionProps);

• Create a new AWS::Events::Connection.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrArn

readonly attrArn: string;

• The ARN of the connection that was created by the request. Arn

property attrSecretArn

readonly attrSecretArn: string;

• The ARN for the secret created for the connection. SecretArn

property authorizationType

authorizationType: string;

• The type of authorization to use for the connection.

  > OAUTH tokens are refreshed when a 401 or 407 response is returned.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authorizationtype

property authParameters

authParameters: any;

• A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authparameters

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property description

description: string;

• A description for the connection to create.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-description

property name

name: string;

• The name for the connection to create.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-name

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnEndpointProps);

• Create a new AWS::Events::Endpoint.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrArn

readonly attrArn: string;

• The ARN of the endpoint. Arn

property attrEndpointId

readonly attrEndpointId: string;

• The ID of the endpoint. EndpointId

property attrEndpointUrl

readonly attrEndpointUrl: string;

• The URL of the endpoint. EndpointUrl

property attrState

readonly attrState: string;

• The current state of the endpoint. State

property attrStateReason

readonly attrStateReason: string;

• The reason the endpoint is in its current state. StateReason

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property description

description: string;

• A description for the endpoint.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-description

property eventBuses

eventBuses: any;

• The event buses being used by the endpoint.

  *Exactly* : 2

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-eventbuses

property name

name: string;

• The name of the endpoint.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-name

property replicationConfig

replicationConfig: any;

• Whether event replication was enabled or disabled for this endpoint. The default state is ENABLED which means you must supply a RoleArn . If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-replicationconfig

property roleArn

roleArn: string;

• The ARN of the role used by event replication for the endpoint.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-rolearn

property routingConfig

routingConfig: any;

• The routing configuration of the endpoint.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-routingconfig

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnEventBusProps);

• Create a new AWS::Events::EventBus.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrArn

readonly attrArn: string;

• The ARN of the event bus, such as arn:aws:events:us-east-2:123456789012:event-bus/aws.partner/PartnerName/acct1/repo1 . Arn

property attrName

readonly attrName: string;

• The name of the event bus, such as PartnerName/acct1/repo1 . Name

property attrPolicy

readonly attrPolicy: string;

• The policy for the event bus in JSON form. Policy

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property eventSourceName

eventSourceName: string;

• If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename

property name

name: string;

• The name of the new event bus.

  Custom event bus names can't contain the / character, but you can use the / character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.

  You can't use the name default for a custom event bus, as this name is already used for your account's default event bus.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name

property tags

tags: CfnEventBus.TagEntryProperty[];

• Tags to associate with the event bus.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnEventBusPolicyProps);

• Create a new AWS::Events::EventBusPolicy.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property action

action: string;

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

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

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property condition

condition: any;

• 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](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html) 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.

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

property eventBusName

eventBusName: string;

• The name of the event bus associated with the rule. If you omit this, the default event bus is used.

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

property principal

principal: string;

• 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.

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

property statement

statement: any;

• 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.

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

property statementId

statementId: string;

• 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](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html) .

  > Each StatementId must be unique.

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

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props?: CfnRuleProps);

• Create a new AWS::Events::Rule.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrArn

readonly attrArn: string;

• The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example . Arn

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property description

description: string;

• The description of the rule.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description

property eventBusName

eventBusName: string;

• The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

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

property eventPattern

eventPattern: any;

• The event pattern of the rule. For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern

property name

name: string;

• The name of the rule.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name

property roleArn

roleArn: string;

• The Amazon Resource Name (ARN) of the role that is used for target invocation.

  If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-rolearn

property scheduleExpression

scheduleExpression: string;

• The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see [Creating an Amazon EventBridge rule that runs on a schedule](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression

property state

state: string;

• The state of the rule.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state

property targets

targets: any;

• Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.

  Targets are the resources that are invoked when a rule is triggered.

  The maximum number of entries per request is 10.

  > Each rule can have up to five (5) targets associated with it at one time.

  For a list of services you can configure as targets for events, see [EventBridge targets](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html) in the *Amazon EventBridge User Guide* .

  Creating rules with built-in targets is supported only in the AWS Management Console . The built-in targets are:

  - Amazon EBS CreateSnapshot API call - Amazon EC2 RebootInstances API call - Amazon EC2 StopInstances API call - Amazon EC2 TerminateInstances API call

  For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.

  To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions:

  - For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. - For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets .

  For more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the *Amazon EventBridge User Guide* .

  If another AWS account is in the same region and has granted you permission (using PutPermission ), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets . If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see [Amazon EventBridge Pricing](https://docs.aws.amazon.com/eventbridge/pricing/) .

  > Input , InputPath , and InputTransformer are not available with PutTarget if the target is an event bus of a different AWS account.

  If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide* .

  > If you have an IAM role on a cross-account event bus target, a PutTargets call without a role on the same target (same Id and Arn ) will not remove the role.

  For more information about enabling cross-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html) .

  *Input* , *InputPath* , and *InputTransformer* are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:

  - If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target). - If *Input* is specified in the form of valid JSON, then the matched event is overridden with this constant. - If *InputPath* is specified in the form of JSONPath (for example, $.detail ), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed). - If *InputTransformer* is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.

  When you specify InputPath or InputTransformer , you must use JSON dot notation, not bracket notation.

  When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.

  This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: Construct, id: string, props: ConnectionProps);

property connectionArn

readonly connectionArn: string;

• The ARN of the connection created.

property connectionName

readonly connectionName: string;

• The Name for the connection.

property connectionSecretArn

readonly connectionSecretArn: string;

• The ARN for the secret created for the connection.

method fromConnectionAttributes

static fromConnectionAttributes: (
    scope: Construct,
    id: string,
    attrs: ConnectionAttributes
) => IConnection;

• Import an existing connection resource

  Parameter scope

  Parent construct

  Parameter id

  Construct ID

  Parameter attrs

  Imported connection properties

method fromEventBusArn

static fromEventBusArn: (
    scope: Construct,
    id: string,
    connectionArn: string,
    connectionSecretArn: string
) => IConnection;

• Import an existing connection resource

  Parameter scope

  Parent construct

  Parameter id

  Construct ID

  Parameter connectionArn

  ARN of imported connection

constructor

constructor(scope: Construct, id: string, props?: EventBusProps);

property eventBusArn

readonly eventBusArn: string;

• The ARN of the event bus, such as: arn:aws:events:us-east-2:123456789012:event-bus/aws.partner/PartnerName/acct1/repo1.

property eventBusName

readonly eventBusName: string;

• The physical ID of this event bus resource

property eventBusPolicy

readonly eventBusPolicy: string;

• The policy for the event bus in JSON form.

property eventSourceName

readonly eventSourceName?: string;

• The name of the partner event source

method fromEventBusArn

static fromEventBusArn: (
    scope: Construct,
    id: string,
    eventBusArn: string
) => IEventBus;

• Import an existing event bus resource

  Parameter scope

  Parent construct

  Parameter id

  Construct ID

  Parameter eventBusArn

  ARN of imported event bus

method fromEventBusAttributes

static fromEventBusAttributes: (
    scope: Construct,
    id: string,
    attrs: EventBusAttributes
) => IEventBus;

• Import an existing event bus resource

  Parameter scope

  Parent construct

  Parameter id

  Construct ID

  Parameter attrs

  Imported event bus properties

method fromEventBusName

static fromEventBusName: (
    scope: Construct,
    id: string,
    eventBusName: string
) => IEventBus;

• Import an existing event bus resource

  Parameter scope

  Parent construct

  Parameter id

  Construct ID

  Parameter eventBusName

  Name of imported event bus

method grantAllPutEvents

static grantAllPutEvents: (grantee: iam.IGrantable) => iam.Grant;

• Permits an IAM Principal to send custom events to EventBridge so that they can be matched to rules.

  Parameter grantee

  The principal (no-op if undefined)

method grantPutEvents

static grantPutEvents: (grantee: iam.IGrantable) => iam.Grant;

• Permits an IAM Principal to send custom events to EventBridge so that they can be matched to rules.

  Parameter grantee

  The principal (no-op if undefined)

  Deprecated

  use grantAllPutEvents instead

property account

static readonly account: string;

• Extract the account from the event

property creationStack

readonly creationStack: string[];

property detailType

static readonly detailType: string;

• Extract the detail type from the event

property displayHint

readonly displayHint: string;

• Human readable display hint about the event pattern

property eventId

static readonly eventId: string;

• Extract the event ID from the event

property path

readonly path: string;

property region

static readonly region: string;

• Extract the region from the event

property source

static readonly source: string;

• Extract the source from the event

property time

static readonly time: string;

• Extract the time from the event

method fromPath

static fromPath: (path: string) => string;

• Extract a custom JSON path from the event

method resolve

resolve: (_ctx: IResolveContext) => any;

method toJSON

toJSON: () => string;

• Convert the path to the field in the event pattern to JSON

method toString

toString: () => string;

method fromSecret

static fromSecret: (value: SecretValue) => HttpParameter;

• Make an OAuthParameter from a secret

method fromString

static fromString: (value: string) => HttpParameter;

• Make an OAuthParameter from a string value

  The value is not treated as a secret.

constructor

constructor(scope: Construct, id: string, props?: RuleProps);

property ruleArn

readonly ruleArn: string;

property ruleName

readonly ruleName: string;

method addEventPattern

addEventPattern: (eventPattern?: EventPattern) => void;

• Adds an event pattern filter to this rule. If a pattern was already specified, these values are merged into the existing pattern.

  For example, if the rule already contains the pattern:

  { "resources": [ "r1" ], "detail": { "hello": [ 1 ] } }

  And addEventPattern is called with the pattern:

  { "resources": [ "r2" ], "detail": { "foo": [ "bar" ] } }

  The resulting event pattern will be:

  { "resources": [ "r1", "r2" ], "detail": { "hello": [ 1 ], "foo": [ "bar" ] } }

method addTarget

addTarget: (target?: IRuleTarget) => void;

• Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

  No-op if target is undefined.

method fromEventRuleArn

static fromEventRuleArn: (
    scope: Construct,
    id: string,
    eventRuleArn: string
) => IRule;

• Import an existing EventBridge Rule provided an ARN

  Parameter scope

  The parent creating construct (usually this).

  Parameter id

  The construct's name.

  Parameter eventRuleArn

  Event Rule ARN (i.e. arn:aws:events:::rule/MyScheduledRule).

method validate

protected validate: () => string[];

constructor

protected constructor();

method bind

abstract bind: (rule: IRule) => RuleTargetInputProperties;

• Return the input properties for this input object

method fromEventPath

static fromEventPath: (path: string) => RuleTargetInput;

• Take the event target input from a path in the event JSON

method fromMultilineText

static fromMultilineText: (text: string) => RuleTargetInput;

• Pass text to the event target, splitting on newlines.

  This is only useful when passing to a target that does not take a single argument.

  May contain strings returned by EventField.from() to substitute in parts of the matched event.

method fromObject

static fromObject: (obj: any) => RuleTargetInput;

• Pass a JSON object to the event target

  May contain strings returned by EventField.from() to substitute in parts of the matched event.

method fromText

static fromText: (text: string) => RuleTargetInput;

• Pass text to the event target

  May contain strings returned by EventField.from() to substitute in parts of the matched event.

  The Rule Target input value will be a single string: the string you pass here. Do not use this method to pass a complex value like a JSON object to a Rule Target. Use RuleTargetInput.fromObject() instead.

constructor

protected constructor();

property expressionString

abstract readonly expressionString: string;

• Retrieve the expression for this schedule

method cron

static cron: (options: CronOptions) => Schedule;

• Create a schedule from a set of cron fields

method expression

static expression: (expression: string) => Schedule;

• Construct a schedule from a literal schedule expression

  Parameter expression

  The expression to use. Must be in a format that EventBridge will recognize

method rate

static rate: (duration: Duration) => Schedule;

• Construct a schedule from an interval and a time unit

property apiDestinationName

readonly apiDestinationName?: string;

• The name for the API destination. - A unique name will be generated

property connection

readonly connection: IConnection;

• The ARN of the connection to use for the API destination

property description

readonly description?: string;

• A description for the API destination.

  - none

property endpoint

readonly endpoint: string;

• The URL to the HTTP invocation endpoint for the API destination..

property httpMethod

readonly httpMethod?: HttpMethod;

• The method to use for the request to the HTTP invocation endpoint.

  HttpMethod.POST

property rateLimitPerSecond

readonly rateLimitPerSecond?: number;

• The maximum number of requests per second to send to the HTTP invocation endpoint.

  - Not rate limited

property sourceEventBus

readonly sourceEventBus: IEventBus;

• The event source associated with the archive.

property archiveName

readonly archiveName?: string;

• The name of the archive.

  - Automatically generated

property description

readonly description?: string;

• A description for the archive.

  - none

property eventPattern

readonly eventPattern: EventPattern;

• An event pattern to use to filter events sent to the archive.

property retention

readonly retention?: Duration;

• The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely. - Infinite

property connectionArn

readonly connectionArn: string;

• The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-connectionarn

property description

readonly description?: string;

• A description for the API destination to create.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-description

property httpMethod

readonly httpMethod: string;

• The method to use for the request to the HTTP invocation endpoint.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-httpmethod

property invocationEndpoint

readonly invocationEndpoint: string;

• The URL to the HTTP invocation endpoint for the API destination.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationendpoint

property invocationRateLimitPerSecond

readonly invocationRateLimitPerSecond?: number;

• The maximum number of requests per second to send to the HTTP invocation endpoint.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationratelimitpersecond

property name

readonly name?: string;

• The name for the API destination to create.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-name

property archiveName

readonly archiveName?: string;

• The name for the archive to create.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-archivename

property description

readonly description?: string;

• A description for the archive.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-description

property eventPattern

readonly eventPattern?: any | cdk.IResolvable;

• An event pattern to use to filter events sent to the archive.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-eventpattern

property retentionDays

readonly retentionDays?: number;

• The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-retentiondays

property sourceArn

readonly sourceArn: string;

• The ARN of the event bus that sends events to the archive.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-sourcearn

property authorizationType

readonly authorizationType: string;

• The type of authorization to use for the connection.

  > OAUTH tokens are refreshed when a 401 or 407 response is returned.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authorizationtype

property authParameters

readonly authParameters: CfnConnection.AuthParametersProperty | cdk.IResolvable;

• A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authparameters

property description

readonly description?: string;

• A description for the connection to create.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-description

property name

readonly name?: string;

• The name for the connection to create.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-name

property description

readonly description?: string;

• A description for the endpoint.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-description

property eventBuses

readonly eventBuses:
    | Array<CfnEndpoint.EndpointEventBusProperty | cdk.IResolvable>
    | cdk.IResolvable;

• The event buses being used by the endpoint.

  *Exactly* : 2

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-eventbuses

property name

readonly name?: string;

• The name of the endpoint.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-name

property replicationConfig

readonly replicationConfig?:
    | CfnEndpoint.ReplicationConfigProperty
    | cdk.IResolvable;

• Whether event replication was enabled or disabled for this endpoint. The default state is ENABLED which means you must supply a RoleArn . If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-replicationconfig

property roleArn

readonly roleArn?: string;

• The ARN of the role used by event replication for the endpoint.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-rolearn

property routingConfig

readonly routingConfig: CfnEndpoint.RoutingConfigProperty | cdk.IResolvable;

• The routing configuration of the endpoint.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-routingconfig

property action

readonly action?: string;

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

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

property condition

readonly condition?: CfnEventBusPolicy.ConditionProperty | cdk.IResolvable;

• 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](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html) 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.

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

property eventBusName

readonly eventBusName?: string;

• The name of the event bus associated with the rule. If you omit this, the default event bus is used.

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

property principal

readonly principal?: string;

• 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.

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

property statement

readonly statement?: any | cdk.IResolvable;

• 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.

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

property statementId

readonly statementId: string;

• 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](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html) .

  > Each StatementId must be unique.

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

property eventSourceName

readonly eventSourceName?: string;

• If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename

property name

readonly name: string;

• The name of the new event bus.

  Custom event bus names can't contain the / character, but you can use the / character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.

  You can't use the name default for a custom event bus, as this name is already used for your account's default event bus.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name

property tags

readonly tags?: CfnEventBus.TagEntryProperty[];

• Tags to associate with the event bus.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-tags

property description

readonly description?: string;

• The description of the rule.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description

property eventBusName

readonly eventBusName?: string;

• The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

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

property eventPattern

readonly eventPattern?: any | cdk.IResolvable;

• The event pattern of the rule. For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern

property name

readonly name?: string;

• The name of the rule.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name

property roleArn

readonly roleArn?: string;

• The Amazon Resource Name (ARN) of the role that is used for target invocation.

  If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-rolearn

property scheduleExpression

readonly scheduleExpression?: string;

• The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see [Creating an Amazon EventBridge rule that runs on a schedule](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression

property state

readonly state?: string;

• The state of the rule.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state

property targets

readonly targets?:
    | Array<CfnRule.TargetProperty | cdk.IResolvable>
    | cdk.IResolvable;

• Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.

  Targets are the resources that are invoked when a rule is triggered.

  The maximum number of entries per request is 10.

  > Each rule can have up to five (5) targets associated with it at one time.

  For a list of services you can configure as targets for events, see [EventBridge targets](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html) in the *Amazon EventBridge User Guide* .

  Creating rules with built-in targets is supported only in the AWS Management Console . The built-in targets are:

  - Amazon EBS CreateSnapshot API call - Amazon EC2 RebootInstances API call - Amazon EC2 StopInstances API call - Amazon EC2 TerminateInstances API call

  For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.

  To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions:

  - For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. - For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets .

  For more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the *Amazon EventBridge User Guide* .

  If another AWS account is in the same region and has granted you permission (using PutPermission ), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets . If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see [Amazon EventBridge Pricing](https://docs.aws.amazon.com/eventbridge/pricing/) .

  > Input , InputPath , and InputTransformer are not available with PutTarget if the target is an event bus of a different AWS account.

  If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide* .

  > If you have an IAM role on a cross-account event bus target, a PutTargets call without a role on the same target (same Id and Arn ) will not remove the role.

  For more information about enabling cross-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html) .

  *Input* , *InputPath* , and *InputTransformer* are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:

  - If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target). - If *Input* is specified in the form of valid JSON, then the matched event is overridden with this constant. - If *InputPath* is specified in the form of JSONPath (for example, $.detail ), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed). - If *InputTransformer* is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.

  When you specify InputPath or InputTransformer , you must use JSON dot notation, not bracket notation.

  When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.

  This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets

property connectionArn

readonly connectionArn: string;

• The ARN of the connection created.

property connectionName

readonly connectionName: string;

• The Name for the connection.

property connectionSecretArn

readonly connectionSecretArn: string;

• The ARN for the secret created for the connection.

property authorization

readonly authorization: Authorization;

• The authorization type for the connection.

property bodyParameters

readonly bodyParameters?: Record<string, HttpParameter>;

• Additional string parameters to add to the invocation bodies

  - No additional parameters

property connectionName

readonly connectionName?: string;

• The name of the connection.

  - A name is automatically generated

property description

readonly description?: string;

• The name of the connection.

  - none

property headerParameters

readonly headerParameters?: Record<string, HttpParameter>;

• Additional string parameters to add to the invocation headers

  - No additional parameters

property queryStringParameters

readonly queryStringParameters?: Record<string, HttpParameter>;

• Additional string parameters to add to the invocation query strings

  - No additional parameters

property day

readonly day?: string;

• The day of the month to run this rule at

  - Every day of the month