Show / Hide Table of Contents

Namespace Amazon.CDK.AWS.Events

Classes

ApiDestination

Define an EventBridge Api Destination.

ApiDestinationAttributes

The properties to import an existing Api Destination.

ApiDestinationProps

The event API Destination properties.

Archive

Define an EventBridge Archive.

ArchiveProps

The event archive properties.

Authorization

Authorization type for an API Destination Connection.

BaseArchiveProps

The event archive base properties.

CfnApiDestination

Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.

CfnApiDestinationProps

Properties for defining a CfnApiDestination.

CfnArchive

Creates an archive of events with the specified settings.

CfnArchiveProps

Properties for defining a CfnArchive.

CfnConnection

Creates a connection.

CfnConnection.ApiKeyAuthParametersProperty

The API key authorization parameters for the connection.

CfnConnection.AuthParametersProperty

Tthe authorization parameters to use for the connection.

CfnConnection.BasicAuthParametersProperty

The Basic authorization parameters for the connection.

CfnConnection.ClientParametersProperty

The OAuth authorization parameters to use for the connection.

CfnConnection.ConnectionHttpParametersProperty

Any additional parameters for the connection.

CfnConnection.ConnectivityParametersProperty

If you specify a private OAuth endpoint, the parameters for EventBridge to use when authenticating against the endpoint.

CfnConnection.InvocationConnectivityParametersProperty

For connections to private APIs, the parameters to use for invoking the API.

CfnConnection.OAuthParametersProperty

Contains the OAuth authorization parameters to use for the connection.

CfnConnection.ParameterProperty

Any additional query string parameter for the connection.

CfnConnection.ResourceParametersProperty

The parameters for EventBridge to use when invoking the resource endpoint.

CfnConnectionProps

Properties for defining a CfnConnection.

CfnEndpoint

A global endpoint used to improve your application's availability by making it regional-fault tolerant.

CfnEndpoint.EndpointEventBusProperty

The event buses the endpoint is associated with.

CfnEndpoint.FailoverConfigProperty

The failover configuration for an endpoint.

CfnEndpoint.PrimaryProperty

The primary Region of the endpoint.

CfnEndpoint.ReplicationConfigProperty

Endpoints can replicate all events to the secondary Region.

CfnEndpoint.RoutingConfigProperty

The routing configuration of the endpoint.

CfnEndpoint.SecondaryProperty

The secondary Region that processes events when failover is triggered or replication is enabled.

CfnEndpointProps

Properties for defining a CfnEndpoint.

CfnEventBus

Specifies an event bus within your account.

CfnEventBus.DeadLetterConfigProperty

Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).

CfnEventBus.LogConfigProperty

The logging configuration settings for the event bus.

CfnEventBusPolicy

Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus .

CfnEventBusPolicy.ConditionProperty

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.

CfnEventBusPolicyProps

Properties for defining a CfnEventBusPolicy.

CfnEventBusProps

Properties for defining a CfnEventBus.

CfnRule

Creates or updates the specified rule.

CfnRule.AppSyncParametersProperty

Contains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API.

CfnRule.AwsVpcConfigurationProperty

This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used.

CfnRule.BatchArrayPropertiesProperty

The array properties for the submitted job, such as the size of the array.

CfnRule.BatchParametersProperty

The custom parameters to be used when the target is an AWS Batch job.

CfnRule.BatchRetryStrategyProperty

The retry strategy to use for failed jobs, if the target is an AWS Batch job.

CfnRule.CapacityProviderStrategyItemProperty

The details of a capacity provider strategy.

CfnRule.DeadLetterConfigProperty

Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).

CfnRule.EcsParametersProperty

The custom parameters to be used when the target is an Amazon ECS task.

CfnRule.HttpParametersProperty

These are custom parameter to be used when the target is an API Gateway APIs or EventBridge ApiDestinations.

CfnRule.InputTransformerProperty

Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.

CfnRule.KinesisParametersProperty

This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis data stream, so that you can control the shard to which the event goes.

CfnRule.NetworkConfigurationProperty

This structure specifies the network configuration for an ECS task.

CfnRule.PlacementConstraintProperty

An object representing a constraint on task placement.

CfnRule.PlacementStrategyProperty

The task placement strategy for a task or service.

CfnRule.RedshiftDataParametersProperty

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

CfnRule.RetryPolicyProperty

A RetryPolicy object that includes information about the retry policy settings.

CfnRule.RunCommandParametersProperty

This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances are to be sent the command.

CfnRule.RunCommandTargetProperty

Information about the EC2 instances that are to be sent the command, specified as key-value pairs.

CfnRule.SageMakerPipelineParameterProperty

Name/Value pair of a parameter to start execution of a SageMaker AI Model Building Pipeline.

CfnRule.SageMakerPipelineParametersProperty

These are custom parameters to use when the target is a SageMaker AI Model Building Pipeline that starts based on EventBridge events.

CfnRule.SqsParametersProperty

The custom parameters for EventBridge to use for a target that is an Amazon SQS fair or FIFO queue.

CfnRule.TagProperty

A key-value pair associated with an ECS Target of an EventBridge rule.

CfnRule.TargetProperty

Targets are the resources to be invoked when a rule is triggered.

CfnRuleProps

Properties for defining a CfnRule.

Connection

Define an EventBridge Connection.

ConnectionAttributes

Interface with properties necessary to import a reusable Connection.

ConnectionProps

An API Destination Connection.

CronOptions

Options to configure a cron expression.

EventBus

Define an EventBridge EventBus.

EventBusAttributes

Interface with properties necessary to import a reusable EventBus.

EventBusGrants

Collection of grant methods for a IEventBusRef.

EventBusPolicy

The policy for an Event Bus.

EventBusPolicyProps

Properties to associate Event Buses with a policy.

EventBusProps

Properties to define an event bus.

EventCommonOptions

Common options for Events.

EventField

Represents a field in the event pattern.

EventPattern

Events in Amazon CloudWatch Events are represented as JSON objects. For more information about JSON objects, see RFC 7159.

HttpParameter

An additional HTTP parameter to send along with the OAuth request.

LogConfig

Interface for Logging Configuration of the Event Bus.

Match

An event pattern matcher.

OAuthAuthorizationProps

Properties for Authorization.oauth().

OnEventOptions

Standard set of options for onXxx event handlers on construct.

Rule

Defines an EventBridge Rule in this stack.

RuleProps

Properties for defining an EventBridge Rule.

RuleTargetConfig

Properties for an event rule target.

RuleTargetInput

The input to send to the event target.

RuleTargetInputProperties

The input properties for an event target.

Schedule

Schedule for scheduled event rules.

Interfaces

CfnConnection.IApiKeyAuthParametersProperty

The API key authorization parameters for the connection.

CfnConnection.IAuthParametersProperty

Tthe authorization parameters to use for the connection.

CfnConnection.IBasicAuthParametersProperty

The Basic authorization parameters for the connection.

CfnConnection.IClientParametersProperty

The OAuth authorization parameters to use for the connection.

CfnConnection.IConnectionHttpParametersProperty

Any additional parameters for the connection.

CfnConnection.IConnectivityParametersProperty

If you specify a private OAuth endpoint, the parameters for EventBridge to use when authenticating against the endpoint.

CfnConnection.IInvocationConnectivityParametersProperty

For connections to private APIs, the parameters to use for invoking the API.

CfnConnection.IOAuthParametersProperty

Contains the OAuth authorization parameters to use for the connection.

CfnConnection.IParameterProperty

Any additional query string parameter for the connection.

CfnConnection.IResourceParametersProperty

The parameters for EventBridge to use when invoking the resource endpoint.

CfnEndpoint.IEndpointEventBusProperty

The event buses the endpoint is associated with.

CfnEndpoint.IFailoverConfigProperty

The failover configuration for an endpoint.

CfnEndpoint.IPrimaryProperty

The primary Region of the endpoint.

CfnEndpoint.IReplicationConfigProperty

Endpoints can replicate all events to the secondary Region.

CfnEndpoint.IRoutingConfigProperty

The routing configuration of the endpoint.

CfnEndpoint.ISecondaryProperty

The secondary Region that processes events when failover is triggered or replication is enabled.

CfnEventBus.IDeadLetterConfigProperty

Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).

CfnEventBus.ILogConfigProperty

The logging configuration settings for the event bus.

CfnEventBusPolicy.IConditionProperty

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.

CfnRule.IAppSyncParametersProperty

Contains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API.

CfnRule.IAwsVpcConfigurationProperty

This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used.

CfnRule.IBatchArrayPropertiesProperty

The array properties for the submitted job, such as the size of the array.

CfnRule.IBatchParametersProperty

The custom parameters to be used when the target is an AWS Batch job.

CfnRule.IBatchRetryStrategyProperty

The retry strategy to use for failed jobs, if the target is an AWS Batch job.

CfnRule.ICapacityProviderStrategyItemProperty

The details of a capacity provider strategy.

CfnRule.IDeadLetterConfigProperty

Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).

CfnRule.IEcsParametersProperty

The custom parameters to be used when the target is an Amazon ECS task.

CfnRule.IHttpParametersProperty

These are custom parameter to be used when the target is an API Gateway APIs or EventBridge ApiDestinations.

CfnRule.IInputTransformerProperty

Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.

CfnRule.IKinesisParametersProperty

This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis data stream, so that you can control the shard to which the event goes.

CfnRule.INetworkConfigurationProperty

This structure specifies the network configuration for an ECS task.

CfnRule.IPlacementConstraintProperty

An object representing a constraint on task placement.

CfnRule.IPlacementStrategyProperty

The task placement strategy for a task or service.

CfnRule.IRedshiftDataParametersProperty

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

CfnRule.IRetryPolicyProperty

A RetryPolicy object that includes information about the retry policy settings.

CfnRule.IRunCommandParametersProperty

This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances are to be sent the command.

CfnRule.IRunCommandTargetProperty

Information about the EC2 instances that are to be sent the command, specified as key-value pairs.

CfnRule.ISageMakerPipelineParameterProperty

Name/Value pair of a parameter to start execution of a SageMaker AI Model Building Pipeline.

CfnRule.ISageMakerPipelineParametersProperty

These are custom parameters to use when the target is a SageMaker AI Model Building Pipeline that starts based on EventBridge events.

CfnRule.ISqsParametersProperty

The custom parameters for EventBridge to use for a target that is an Amazon SQS fair or FIFO queue.

CfnRule.ITagProperty

A key-value pair associated with an ECS Target of an EventBridge rule.

CfnRule.ITargetProperty

Targets are the resources to be invoked when a rule is triggered.

IApiDestination

Interface for API Destinations.

IApiDestinationAttributes

The properties to import an existing Api Destination.

IApiDestinationProps

The event API Destination properties.

IArchiveProps

The event archive properties.

IBaseArchiveProps

The event archive base properties.

ICfnApiDestinationProps

Properties for defining a CfnApiDestination.

ICfnArchiveProps

Properties for defining a CfnArchive.

ICfnConnectionProps

Properties for defining a CfnConnection.

ICfnEndpointProps

Properties for defining a CfnEndpoint.

ICfnEventBusPolicyProps

Properties for defining a CfnEventBusPolicy.

ICfnEventBusProps

Properties for defining a CfnEventBus.

ICfnRuleProps

Properties for defining a CfnRule.

IConnection

Interface for EventBus Connections.

IConnectionAttributes

Interface with properties necessary to import a reusable Connection.

IConnectionProps

An API Destination Connection.

ICronOptions

Options to configure a cron expression.

IEventBus

Interface which all EventBus based classes MUST implement.

IEventBusAttributes

Interface with properties necessary to import a reusable EventBus.

IEventBusPolicyProps

Properties to associate Event Buses with a policy.

IEventBusProps

Properties to define an event bus.

IEventCommonOptions

Common options for Events.

IEventPattern

Events in Amazon CloudWatch Events are represented as JSON objects. For more information about JSON objects, see RFC 7159.

ILogConfig

Interface for Logging Configuration of the Event Bus.

IOAuthAuthorizationProps

Properties for Authorization.oauth().

IOnEventOptions

Standard set of options for onXxx event handlers on construct.

IRule

Represents an EventBridge Rule.

IRuleProps

Properties for defining an EventBridge Rule.

IRuleTarget

An abstract target for EventRules.

IRuleTargetConfig

Properties for an event rule target.

IRuleTargetInputProperties

The input properties for an event target.

Enums

HttpMethod

Supported HTTP operations.

IncludeDetail

Whether EventBridge include detailed event information in the records it generates.

Level

The level of logging detail to include.

Back to top Generated by DocFX