@aws-cdk/aws-events
- Version 1.204.0
- Published
- 1.99 MB
- 3 dependencies
- Apache-2.0 license
Install
npm i @aws-cdk/aws-events
yarn add @aws-cdk/aws-events
pnpm add @aws-cdk/aws-events
Overview
Amazon EventBridge Construct Library
Index
Classes
Interfaces
Enums
Namespaces
CfnRule
- AwsVpcConfigurationProperty
- BatchArrayPropertiesProperty
- BatchParametersProperty
- BatchRetryStrategyProperty
- CapacityProviderStrategyItemProperty
- DeadLetterConfigProperty
- EcsParametersProperty
- HttpParametersProperty
- InputTransformerProperty
- KinesisParametersProperty
- NetworkConfigurationProperty
- PlacementConstraintProperty
- PlacementStrategyProperty
- RedshiftDataParametersProperty
- RetryPolicyProperty
- RunCommandParametersProperty
- RunCommandTargetProperty
- SageMakerPipelineParameterProperty
- SageMakerPipelineParametersProperty
- SqsParametersProperty
- TagProperty
- TargetProperty
Classes
class ApiDestination
class ApiDestination extends Resource implements IApiDestination {}
Define an EventBridge Api Destination
AWS::Events::ApiDestination
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
class Archive
class Archive extends Resource {}
Define an EventBridge Archive
AWS::Events::Archive
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.
class Authorization
abstract class Authorization {}
Authorization type for an API Destination Connection
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
class CfnApiDestination
class CfnApiDestination extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::Events::ApiDestination
Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.
When using ApiDesinations with OAuth authentication we recommend these best practices:
- Create a secret in Secrets Manager with your OAuth credentials. - Reference that secret in your CloudFormation template for
AWS::Events::Connection
using CloudFormation dynamic reference syntax. For more information, see [Secrets Manager secrets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) .When the Connection resource is created the secret will be passed to EventBridge and stored in the customer account using “Service Linked Secrets,” effectively creating two secrets. This will minimize the cost because the original secret is only accessed when a CloudFormation template is created or updated, not every time an event is sent to the ApiDestination. The secret stored in the customer account by EventBridge is the one used for each event sent to the ApiDestination and AWS is responsible for the fees.
> The secret stored in the customer account by EventBridge can’t be updated directly, only when a CloudFormation template is updated.
For examples of CloudFormation templates that use secrets, see [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#aws-resource-events-connection--examples) .
AWS::Events::ApiDestination external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html
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;};
class CfnArchive
class CfnArchive extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::Events::Archive
Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive.
AWS::Events::Archive external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html
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;};
class CfnConnection
class CfnConnection extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::Events::Connection
Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
AWS::Events::Connection external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html
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;};
class CfnEndpoint
class CfnEndpoint extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::Events::Endpoint
A global endpoint used to improve your application's availability by making it regional-fault tolerant. For more information about global endpoints, see [Making applications Regional-fault tolerant with global endpoints and event replication](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html) in the *Amazon EventBridge User Guide* .
AWS::Events::Endpoint external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html
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 aRoleArn
. If you don't have aRoleArn
or you don't want event replication enabled, set the state toDISABLED
.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;};
class CfnEventBus
class CfnEventBus extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::Events::EventBus
Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source.
AWS::Events::EventBus external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html
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;};
class CfnEventBusPolicy
class CfnEventBusPolicy extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
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 runPutPermission
once specifyingPrincipal
as "*" and specifying the AWS organization ID inCondition
, 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 usePutTarget
to add your account's event bus as a target. 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* .The permission policy on the event bus cannot exceed 10 KB in size.
AWS::Events::EventBusPolicy external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html
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 forPrincipal
, you grant permission to all the accounts in the named organization.The
Condition
is a JSON string which must containType
,Key
, andValue
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 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.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 theStatementId
,Action
,Principal
, orCondition
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;};
class CfnRule
class CfnRule extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::Events::Rule
Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using [DisableRule](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html) .
A single rule watches for events from a single event bus. Events generated by AWS services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see [CreateEventBus](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html) .
If you are updating an existing rule, the rule is replaced with what you specify in this
PutRule
command. If you omit arguments inPutRule
, the old values for those arguments are not kept. Instead, they are replaced with null values.When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect.
A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.
Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.
To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.
An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see [Managing Your Costs with Budgets](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html) .
AWS::Events::Rule external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html
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 theTarget
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 theKinesisParameters
argument. To invoke a command on multiple EC2 instances with one rule, you can use theRunCommandParameters
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 inPutTargets
.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 theArn
value when you runPutTargets
. 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
, andInputTransformer
are not available withPutTarget
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 theTarget
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 (sameId
andArn
) 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
orInputTransformer
, 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 inFailedEntries
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;};
class Connection
class Connection extends Resource implements IConnection {}
Define an EventBridge Connection
AWS::Events::Connection
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
class EventBus
class EventBus extends EventBusBase {}
Define an EventBridge EventBus
AWS::Events::EventBus
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
class EventField
class EventField implements IResolvable {}
Represents a field in the event pattern
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;
class HttpParameter
abstract class HttpParameter {}
An additional HTTP parameter to send along with the OAuth request
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.
class Rule
class Rule extends Resource implements IRule {}
Defines an EventBridge Rule in this stack.
AWS::Events::Rule
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[];
class RuleTargetInput
abstract class RuleTargetInput {}
The input to send to the event target
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.
class Schedule
abstract class Schedule {}
Schedule for scheduled event rules
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
Interfaces
interface ApiDestinationProps
interface ApiDestinationProps {}
The event API Destination properties
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
interface ArchiveProps
interface ArchiveProps extends BaseArchiveProps {}
The event archive properties
property sourceEventBus
readonly sourceEventBus: IEventBus;
The event source associated with the archive.
interface BaseArchiveProps
interface BaseArchiveProps {}
The event archive base properties
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
interface CfnApiDestinationProps
interface CfnApiDestinationProps {}
Properties for defining a
CfnApiDestination
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html
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
interface CfnArchiveProps
interface CfnArchiveProps {}
Properties for defining a
CfnArchive
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html
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
interface CfnConnectionProps
interface CfnConnectionProps {}
Properties for defining a
CfnConnection
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html
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
interface CfnEndpointProps
interface CfnEndpointProps {}
Properties for defining a
CfnEndpoint
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html
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 aRoleArn
. If you don't have aRoleArn
or you don't want event replication enabled, set the state toDISABLED
.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
interface CfnEventBusPolicyProps
interface CfnEventBusPolicyProps {}
Properties for defining a
CfnEventBusPolicy
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html
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 forPrincipal
, you grant permission to all the accounts in the named organization.The
Condition
is a JSON string which must containType
,Key
, andValue
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 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.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 theStatementId
,Action
,Principal
, orCondition
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
interface CfnEventBusProps
interface CfnEventBusProps {}
Properties for defining a
CfnEventBus
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html
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
interface CfnRuleProps
interface CfnRuleProps {}
Properties for defining a
CfnRule
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html
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 theTarget
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 theKinesisParameters
argument. To invoke a command on multiple EC2 instances with one rule, you can use theRunCommandParameters
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 inPutTargets
.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 theArn
value when you runPutTargets
. 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
, andInputTransformer
are not available withPutTarget
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 theTarget
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 (sameId
andArn
) 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
orInputTransformer
, 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 inFailedEntries
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
interface ConnectionAttributes
interface ConnectionAttributes {}
Interface with properties necessary to import a reusable Connection
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.
interface ConnectionProps
interface ConnectionProps {}
An API Destination Connection
A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
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
interface CronOptions
interface CronOptions {}
Options to configure a cron expression
All fields are strings so you can use complex expressions. Absence of a field implies '*' or '?', whichever one is appropriate.
See Also
https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html#cron-expressions
property day
readonly day?: string;
The day of the month to run this rule at
- Every day of the month
property hour
readonly hour?: string;
The hour to run this rule at
- Every hour
property minute
readonly minute?: string;
The minute to run this rule at
- Every minute
property month
readonly month?: string;
The month to run this rule at
- Every month
property weekDay
readonly weekDay?: string;
The day of the week to run this rule at
- Any day of the week
property year
readonly year?: string;
The year to run this rule at
- Every year
interface EventBusAttributes
interface EventBusAttributes {}
Interface with properties necessary to import a reusable EventBus
property eventBusArn
readonly eventBusArn: string;
The ARN of this event bus resource
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#Arn-fn::getatt
property eventBusName
readonly eventBusName: string;
The physical ID of this event bus resource
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name
property eventBusPolicy
readonly eventBusPolicy: string;
The JSON policy of this event bus resource
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#Policy-fn::getatt
property eventSourceName
readonly eventSourceName?: string;
The partner event source to associate with this event bus resource
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename - no partner event source
interface EventBusProps
interface EventBusProps {}
Properties to define an event bus
property eventBusName
readonly eventBusName?: string;
The name of the event bus you are creating Note: If 'eventSourceName' is passed in, you cannot set this
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name - automatically generated name
property eventSourceName
readonly eventSourceName?: string;
The partner event source to associate with this event bus resource Note: If 'eventBusName' is passed in, you cannot set this
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename - no partner event source
interface EventPattern
interface EventPattern {}
Events in Amazon CloudWatch Events are represented as JSON objects. For more information about JSON objects, see RFC 7159.
**Important**: this class can only be used with a
Rule
class. In particular, do not use it withCfnRule
class: your pattern will not be rendered correctly. In aCfnRule
class, write the pattern as you normally would when directly writing CloudFormation.Rules use event patterns to select events and route them to targets. A pattern either matches an event or it doesn't. Event patterns are represented as JSON objects with a structure that is similar to that of events.
It is important to remember the following about event pattern matching:
- For a pattern to match an event, the event must contain all the field names listed in the pattern. The field names must appear in the event with the same nesting structure.
- Other fields of the event not mentioned in the pattern are ignored; effectively, there is a ``"*": "*"`` wildcard for fields not mentioned.
- The matching is exact (character-by-character), without case-folding or any other string normalization.
- The values being matched follow JSON rules: Strings enclosed in quotes, numbers, and the unquoted keywords true, false, and null.
- Number matching is at the string representation level. For example, 300, 300.0, and 3.0e2 are not considered equal.
See Also
https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html
property account
readonly account?: string[];
The 12-digit number identifying an AWS account.
- No filtering on account
property detail
readonly detail?: { [key: string]: any;};
A JSON object, whose content is at the discretion of the service originating the event.
- No filtering on detail
property detailType
readonly detailType?: string[];
Identifies, in combination with the source field, the fields and values that appear in the detail field.
Represents the "detail-type" event field.
- No filtering on detail type
property id
readonly id?: string[];
A unique value is generated for every event. This can be helpful in tracing events as they move through rules to targets, and are processed.
- No filtering on id
property region
readonly region?: string[];
Identifies the AWS region where the event originated.
- No filtering on region
property resources
readonly resources?: string[];
This JSON array contains ARNs that identify resources that are involved in the event. Inclusion of these ARNs is at the discretion of the service.
For example, Amazon EC2 instance state-changes include Amazon EC2 instance ARNs, Auto Scaling events include ARNs for both instances and Auto Scaling groups, but API calls with AWS CloudTrail do not include resource ARNs.
- No filtering on resource
property source
readonly source?: string[];
Identifies the service that sourced the event. All events sourced from within AWS begin with "aws." Customer-generated events can have any value here, as long as it doesn't begin with "aws." We recommend the use of Java package-name style reverse domain-name strings.
To find the correct value for source for an AWS service, see the table in AWS Service Namespaces. For example, the source value for Amazon CloudFront is aws.cloudfront.
See Also
http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces - No filtering on source
property time
readonly time?: string[];
The event timestamp, which can be specified by the service originating the event. If the event spans a time interval, the service might choose to report the start time, so this value can be noticeably before the time the event is actually received.
- No filtering on time
property version
readonly version?: string[];
By default, this is set to 0 (zero) in all events.
- No filtering on version
interface IApiDestination
interface IApiDestination extends IResource {}
Interface for API Destinations
property apiDestinationArn
readonly apiDestinationArn: string;
The ARN of the Api Destination created.
property apiDestinationName
readonly apiDestinationName: string;
The Name of the Api Destination created.
interface IConnection
interface IConnection extends IResource {}
Interface for EventBus Connections
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.
interface IEventBus
interface IEventBus extends IResource {}
Interface which all EventBus based classes MUST implement
property eventBusArn
readonly eventBusArn: string;
The ARN of this event bus resource
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#Arn-fn::getatt
property eventBusName
readonly eventBusName: string;
The physical ID of this event bus resource
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name
property eventBusPolicy
readonly eventBusPolicy: string;
The JSON policy of this event bus resource
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#Policy-fn::getatt
property eventSourceName
readonly eventSourceName?: string;
The partner event source to associate with this event bus resource
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename
method archive
archive: (id: string, props: BaseArchiveProps) => Archive;
Create an EventBridge archive to send events to. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect.
Parameter props
Properties of the archive
method grantPutEventsTo
grantPutEventsTo: (grantee: iam.IGrantable) => iam.Grant;
Grants an IAM Principal to send custom events to the eventBus so that they can be matched to rules.
Parameter grantee
The principal (no-op if undefined)
interface IRule
interface IRule extends IResource {}
Represents an EventBridge Rule
interface IRuleTarget
interface IRuleTarget {}
An abstract target for EventRules.
method bind
bind: (rule: IRule, id?: string) => RuleTargetConfig;
Returns the rule target specification. NOTE: Do not use the various
inputXxx
options. They can be set in a call toaddTarget
.Parameter rule
The EventBridge Rule that would trigger this target.
Parameter id
The id of the target that will be attached to the rule.
interface OAuthAuthorizationProps
interface OAuthAuthorizationProps {}
Properties for
Authorization.oauth()
property authorizationEndpoint
readonly authorizationEndpoint: string;
The URL to the authorization endpoint
property bodyParameters
readonly bodyParameters?: Record<string, HttpParameter>;
Additional string parameters to add to the OAuth request body
- No additional parameters
property clientId
readonly clientId: string;
The client ID to use for OAuth authorization for the connection.
property clientSecret
readonly clientSecret: SecretValue;
The client secret associated with the client ID to use for OAuth authorization for the connection.
property headerParameters
readonly headerParameters?: Record<string, HttpParameter>;
Additional string parameters to add to the OAuth request header
- No additional parameters
property httpMethod
readonly httpMethod: HttpMethod;
The method to use for the authorization request.
(Can only choose POST, GET or PUT).
property queryStringParameters
readonly queryStringParameters?: Record<string, HttpParameter>;
Additional string parameters to add to the OAuth request query string
- No additional parameters
interface OnEventOptions
interface OnEventOptions {}
Standard set of options for
onXxx
event handlers on construct
property description
readonly description?: string;
A description of the rule's purpose.
- No description
property eventPattern
readonly eventPattern?: EventPattern;
Additional restrictions for the event to route to the specified target
The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering.
- No additional filtering based on an event pattern.
See Also
https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
property ruleName
readonly ruleName?: string;
A name for the rule.
AWS CloudFormation generates a unique physical ID.
property target
readonly target?: IRuleTarget;
The target to register for the event
- No target is added to the rule. Use
addTarget()
to add a target.
interface RuleProps
interface RuleProps {}
Properties for defining an EventBridge Rule
property description
readonly description?: string;
A description of the rule's purpose.
- No description.
property enabled
readonly enabled?: boolean;
Indicates whether the rule is enabled.
true
property eventBus
readonly eventBus?: IEventBus;
The event bus to associate with this rule.
- The default event bus.
property eventPattern
readonly eventPattern?: EventPattern;
Describes which events EventBridge routes to the specified target. These routed events are matched events. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
See Also
https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
You must specify this property (either via props or via
addEventPattern
), thescheduleExpression
property, or both. The methodaddEventPattern
can be used to add filter values to the event pattern.- None.
property ruleName
readonly ruleName?: string;
A name for the rule.
- AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type.
property schedule
readonly schedule?: Schedule;
The schedule or rate (frequency) that determines when EventBridge runs the rule. For more information, see Schedule Expression Syntax for Rules in the Amazon EventBridge User Guide.
See Also
https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html
You must specify this property, the
eventPattern
property, or both.- None.
property targets
readonly targets?: IRuleTarget[];
Targets to invoke when this rule matches an event.
Input will be the full matched event. If you wish to specify custom target input, use
addTarget(target[, inputOptions])
.- No targets.
interface RuleTargetConfig
interface RuleTargetConfig {}
Properties for an event rule target
property arn
readonly arn: string;
The Amazon Resource Name (ARN) of the target.
property batchParameters
readonly batchParameters?: CfnRule.BatchParametersProperty;
Parameters used when the rule invokes Amazon AWS Batch Job/Queue no parameters set
property deadLetterConfig
readonly deadLetterConfig?: CfnRule.DeadLetterConfigProperty;
Contains information about a dead-letter queue configuration. no dead-letter queue set
property ecsParameters
readonly ecsParameters?: CfnRule.EcsParametersProperty;
The Amazon ECS task definition and task count to use, if the event target is an Amazon ECS task.
property httpParameters
readonly httpParameters?: CfnRule.HttpParametersProperty;
Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge API destination. - None
property id
readonly id?: string;
A unique, user-defined identifier for the target. Acceptable values include alphanumeric characters, periods (.), hyphens (-), and underscores (_).
- an auto-generated id
Deprecated
no replacement. we will always use an autogenerated id.
property input
readonly input?: RuleTargetInput;
What input to send to the event target
the entire event
property kinesisParameters
readonly kinesisParameters?: CfnRule.KinesisParametersProperty;
Settings that control shard assignment, when the target is a Kinesis stream. If you don't include this parameter, eventId is used as the partition key.
property retryPolicy
readonly retryPolicy?: CfnRule.RetryPolicyProperty;
A RetryPolicy object that includes information about the retry policy settings. EventBridge default retry policy
property role
readonly role?: iam.IRole;
Role to use to invoke this event target
property runCommandParameters
readonly runCommandParameters?: CfnRule.RunCommandParametersProperty;
Parameters used when the rule invokes Amazon EC2 Systems Manager Run Command.
property sqsParameters
readonly sqsParameters?: CfnRule.SqsParametersProperty;
Parameters used when the FIFO sqs queue is used an event target by the rule.
property targetResource
readonly targetResource?: IConstruct;
The resource that is backing this target. This is the resource that will actually have some action performed on it when used as a target (for example, start a build for a CodeBuild project). We need it to determine whether the rule belongs to a different account than the target - if so, we generate a more complex setup, including an additional stack containing the EventBusPolicy.
See Also
https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html the target is not backed by any resource
interface RuleTargetInputProperties
interface RuleTargetInputProperties {}
The input properties for an event target
property input
readonly input?: string;
Literal input to the target service (must be valid JSON)
- input for the event target. If the input contains a paths map values wil be extracted from event and inserted into the
inputTemplate
.
property inputPath
readonly inputPath?: string;
JsonPath to take input from the input event
- None. The entire matched event is passed as input
property inputPathsMap
readonly inputPathsMap?: { [key: string]: string;};
Paths map to extract values from event and insert into
inputTemplate
- No values extracted from event.
property inputTemplate
readonly inputTemplate?: string;
Input template to insert paths map into
- None.
Enums
enum HttpMethod
enum HttpMethod { POST = 'POST', GET = 'GET', HEAD = 'HEAD', OPTIONS = 'OPTIONS', PUT = 'PUT', PATCH = 'PATCH', DELETE = 'DELETE',}
Supported HTTP operations.
Namespaces
namespace CfnConnection
namespace CfnConnection {}
interface ApiKeyAuthParametersProperty
interface ApiKeyAuthParametersProperty {}
Contains the API key authorization parameters for the connection.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html
property apiKeyName
readonly apiKeyName: string;
The name of the API key to use for authorization.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html#cfn-events-connection-apikeyauthparameters-apikeyname
property apiKeyValue
readonly apiKeyValue: string;
The value for the API key to use for authorization.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html#cfn-events-connection-apikeyauthparameters-apikeyvalue
interface AuthParametersProperty
interface AuthParametersProperty {}
Contains the authorization parameters to use for the connection.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html
property apiKeyAuthParameters
readonly apiKeyAuthParameters?: | CfnConnection.ApiKeyAuthParametersProperty | cdk.IResolvable;
The API Key parameters to use for authorization.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-apikeyauthparameters
property basicAuthParameters
readonly basicAuthParameters?: | CfnConnection.BasicAuthParametersProperty | cdk.IResolvable;
The authorization parameters for Basic authorization.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-basicauthparameters
property invocationHttpParameters
readonly invocationHttpParameters?: | CfnConnection.ConnectionHttpParametersProperty | cdk.IResolvable;
Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-invocationhttpparameters
property oAuthParameters
readonly oAuthParameters?: | CfnConnection.OAuthParametersProperty | cdk.IResolvable;
The OAuth parameters to use for authorization.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-oauthparameters
interface BasicAuthParametersProperty
interface BasicAuthParametersProperty {}
Contains the Basic authorization parameters for the connection.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html
property password
readonly password: string;
The password associated with the user name to use for Basic authorization.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html#cfn-events-connection-basicauthparameters-password
property username
readonly username: string;
The user name to use for Basic authorization.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html#cfn-events-connection-basicauthparameters-username
interface ClientParametersProperty
interface ClientParametersProperty {}
Contains the OAuth authorization parameters to use for the connection.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html
property clientId
readonly clientId: string;
The client ID to use for OAuth authorization.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html#cfn-events-connection-clientparameters-clientid
property clientSecret
readonly clientSecret: string;
The client secret assciated with the client ID to use for OAuth authorization.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html#cfn-events-connection-clientparameters-clientsecret
interface ConnectionHttpParametersProperty
interface ConnectionHttpParametersProperty {}
Contains additional parameters for the connection.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html
property bodyParameters
readonly bodyParameters?: | Array<CfnConnection.ParameterProperty | cdk.IResolvable> | cdk.IResolvable;
Contains additional body string parameters for the connection.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-bodyparameters
property headerParameters
readonly headerParameters?: | Array<CfnConnection.ParameterProperty | cdk.IResolvable> | cdk.IResolvable;
Contains additional header parameters for the connection.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-headerparameters
property queryStringParameters
readonly queryStringParameters?: | Array<CfnConnection.ParameterProperty | cdk.IResolvable> | cdk.IResolvable;
Contains additional query string parameters for the connection.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-querystringparameters
interface OAuthParametersProperty
interface OAuthParametersProperty {}
Contains the OAuth authorization parameters to use for the connection.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html
property authorizationEndpoint
readonly authorizationEndpoint: string;
The URL to the authorization endpoint when OAuth is specified as the authorization type.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-authorizationendpoint
property clientParameters
readonly clientParameters: | CfnConnection.ClientParametersProperty | cdk.IResolvable;
A
CreateConnectionOAuthClientRequestParameters
object that contains the client parameters for OAuth authorization.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-clientparameters
property httpMethod
readonly httpMethod: string;
The method to use for the authorization request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-httpmethod
property oAuthHttpParameters
readonly oAuthHttpParameters?: | CfnConnection.ConnectionHttpParametersProperty | cdk.IResolvable;
A
ConnectionHttpParameters
object that contains details about the additional parameters to use for the connection.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-oauthhttpparameters
interface ParameterProperty
interface ParameterProperty {}
Additional query string parameter for the connection. You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html
property isValueSecret
readonly isValueSecret?: boolean | cdk.IResolvable;
Specifies whether the value is secret.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html#cfn-events-connection-parameter-isvaluesecret
property key
readonly key: string;
The key for a query string parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html#cfn-events-connection-parameter-key
property value
readonly value: string;
The value associated with the key for the query string parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html#cfn-events-connection-parameter-value
namespace CfnEndpoint
namespace CfnEndpoint {}
interface EndpointEventBusProperty
interface EndpointEventBusProperty {}
The event buses the endpoint is associated with.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-endpointeventbus.html
property eventBusArn
readonly eventBusArn: string;
The ARN of the event bus the endpoint is associated with.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-endpointeventbus.html#cfn-events-endpoint-endpointeventbus-eventbusarn
interface FailoverConfigProperty
interface FailoverConfigProperty {}
The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-failoverconfig.html
property primary
readonly primary: CfnEndpoint.PrimaryProperty | cdk.IResolvable;
The main Region of the endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-failoverconfig.html#cfn-events-endpoint-failoverconfig-primary
property secondary
readonly secondary: CfnEndpoint.SecondaryProperty | cdk.IResolvable;
The Region that events are routed to when failover is triggered or event replication is enabled.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-failoverconfig.html#cfn-events-endpoint-failoverconfig-secondary
interface PrimaryProperty
interface PrimaryProperty {}
The primary Region of the endpoint.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-primary.html
property healthCheck
readonly healthCheck: string;
The ARN of the health check used by the endpoint to determine whether failover is triggered.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-primary.html#cfn-events-endpoint-primary-healthcheck
interface ReplicationConfigProperty
interface ReplicationConfigProperty {}
Endpoints can replicate all events to the secondary Region.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-replicationconfig.html
property state
readonly state: string;
The state of event replication.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-replicationconfig.html#cfn-events-endpoint-replicationconfig-state
interface RoutingConfigProperty
interface RoutingConfigProperty {}
The routing configuration of the endpoint.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-routingconfig.html
property failoverConfig
readonly failoverConfig: CfnEndpoint.FailoverConfigProperty | cdk.IResolvable;
The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-routingconfig.html#cfn-events-endpoint-routingconfig-failoverconfig
interface SecondaryProperty
interface SecondaryProperty {}
The secondary Region that processes events when failover is triggered or replication is enabled.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-secondary.html
property route
readonly route: string;
Defines the secondary Region.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-secondary.html#cfn-events-endpoint-secondary-route
namespace CfnEventBus
namespace CfnEventBus {}
interface TagEntryProperty
interface TagEntryProperty {}
A key-value pair associated with an AWS resource. In EventBridge, rules and event buses support tagging.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-tagentry.html
property key
readonly key: string;
A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-tagentry.html#cfn-events-eventbus-tagentry-key
property value
readonly value: string;
The value for the specified tag key.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-tagentry.html#cfn-events-eventbus-tagentry-value
namespace CfnEventBusPolicy
namespace CfnEventBusPolicy {}
interface ConditionProperty
interface ConditionProperty {}
A JSON string which you can use to limit the event bus permissions you are granting to only accounts that fulfill the condition. Currently, the only supported condition is membership in a certain AWS organization. The string must contain
Type
,Key
, andValue
fields. TheValue
field specifies the ID of the AWS organization. Following is an example value forCondition
:'{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value": "o-1234567890"}'
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html
property key
readonly key?: string;
Specifies the key for the condition. Currently the only supported key is
aws:PrincipalOrgID
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html#cfn-events-eventbuspolicy-condition-key
property type
readonly type?: string;
Specifies the type of condition. Currently the only supported value is
StringEquals
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html#cfn-events-eventbuspolicy-condition-type
property value
readonly value?: string;
Specifies the value for the key. Currently, this must be the ID of the organization.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html#cfn-events-eventbuspolicy-condition-value
namespace CfnRule
namespace CfnRule {}
interface AwsVpcConfigurationProperty
interface AwsVpcConfigurationProperty {}
This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the
awsvpc
network mode.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html
property assignPublicIp
readonly assignPublicIp?: string;
Specifies whether the task's elastic network interface receives a public IP address. You can specify
ENABLED
only whenLaunchType
inEcsParameters
is set toFARGATE
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-assignpublicip
property securityGroups
readonly securityGroups?: string[];
Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-securitygroups
property subnets
readonly subnets: string[];
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-subnets
interface BatchArrayPropertiesProperty
interface BatchArrayPropertiesProperty {}
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batcharrayproperties.html
property size
readonly size?: number;
The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batcharrayproperties.html#cfn-events-rule-batcharrayproperties-size
interface BatchParametersProperty
interface BatchParametersProperty {}
The custom parameters to be used when the target is an AWS Batch job.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html
property arrayProperties
readonly arrayProperties?: | CfnRule.BatchArrayPropertiesProperty | cdk.IResolvable;
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-arrayproperties
property jobDefinition
readonly jobDefinition: string;
The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-jobdefinition
property jobName
readonly jobName: string;
The name to use for this execution of the job, if the target is an AWS Batch job.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-jobname
property retryStrategy
readonly retryStrategy?: CfnRule.BatchRetryStrategyProperty | cdk.IResolvable;
The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-retrystrategy
interface BatchRetryStrategyProperty
interface BatchRetryStrategyProperty {}
The retry strategy to use for failed jobs, if the target is an AWS Batch job. If you specify a retry strategy here, it overrides the retry strategy defined in the job definition.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchretrystrategy.html
property attempts
readonly attempts?: number;
The number of times to attempt to retry, if the job fails. Valid values are 1–10.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchretrystrategy.html#cfn-events-rule-batchretrystrategy-attempts
interface CapacityProviderStrategyItemProperty
interface CapacityProviderStrategyItemProperty {}
The details of a capacity provider strategy. To learn more, see [CapacityProviderStrategyItem](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) in the Amazon ECS API Reference.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html
property base
readonly base?: number;
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html#cfn-events-rule-capacityproviderstrategyitem-base
property capacityProvider
readonly capacityProvider: string;
The short name of the capacity provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html#cfn-events-rule-capacityproviderstrategyitem-capacityprovider
property weight
readonly weight?: number;
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html#cfn-events-rule-capacityproviderstrategyitem-weight
interface DeadLetterConfigProperty
interface DeadLetterConfigProperty {}
A
DeadLetterConfig
object that contains information about a dead-letter queue configuration.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html
property arn
readonly arn?: string;
The ARN of the SQS queue specified as the target for the dead-letter queue.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn
interface EcsParametersProperty
interface EcsParametersProperty {}
The custom parameters to be used when the target is an Amazon ECS task.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html
property capacityProviderStrategy
readonly capacityProviderStrategy?: | Array<CfnRule.CapacityProviderStrategyItemProperty | cdk.IResolvable> | cdk.IResolvable;
The capacity provider strategy to use for the task.
If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
or launchType is specified, thedefaultCapacityProviderStrategy
for the cluster is used.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-capacityproviderstrategy
property enableEcsManagedTags
readonly enableEcsManagedTags?: boolean | cdk.IResolvable;
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the Amazon Elastic Container Service Developer Guide.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-enableecsmanagedtags
property enableExecuteCommand
readonly enableExecuteCommand?: boolean | cdk.IResolvable;
Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-enableexecutecommand
property group
readonly group?: string;
Specifies an ECS task group for the task. The maximum length is 255 characters.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-group
property launchType
readonly launchType?: string;
Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The
FARGATE
value is supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more information, see [AWS Fargate on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) in the *Amazon Elastic Container Service Developer Guide* .http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-launchtype
property networkConfiguration
readonly networkConfiguration?: | CfnRule.NetworkConfigurationProperty | cdk.IResolvable;
Use this structure if the Amazon ECS task uses the
awsvpc
network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required ifLaunchType
isFARGATE
because theawsvpc
mode is required for Fargate tasks.If you specify
NetworkConfiguration
when the target ECS task does not use theawsvpc
network mode, the task fails.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-networkconfiguration
property placementConstraints
readonly placementConstraints?: | Array<CfnRule.PlacementConstraintProperty | cdk.IResolvable> | cdk.IResolvable;
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-placementconstraints
property placementStrategies
readonly placementStrategies?: | Array<CfnRule.PlacementStrategyProperty | cdk.IResolvable> | cdk.IResolvable;
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-placementstrategies
property platformVersion
readonly platformVersion?: string;
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as
1.1.0
.This structure is used only if
LaunchType
isFARGATE
. For more information about valid platform versions, see [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide* .http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-platformversion
property propagateTags
readonly propagateTags?: string;
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-propagatetags
property referenceId
readonly referenceId?: string;
The reference ID to use for the task.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-referenceid
property tagList
readonly tagList?: Array<cdk.CfnTag | cdk.IResolvable> | cdk.IResolvable;
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) in the Amazon ECS API Reference.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taglist
property taskCount
readonly taskCount?: number;
The number of tasks to create based on
TaskDefinition
. The default is 1.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskcount
property taskDefinitionArn
readonly taskDefinitionArn: string;
The ARN of the task definition to use if the event target is an Amazon ECS task.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskdefinitionarn
interface HttpParametersProperty
interface HttpParametersProperty {}
These are custom parameter to be used when the target is an API Gateway APIs or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html
property headerParameters
readonly headerParameters?: | { [key: string]: string; } | cdk.IResolvable;
The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-headerparameters
property pathParameterValues
readonly pathParameterValues?: string[];
The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-pathparametervalues
property queryStringParameters
readonly queryStringParameters?: | { [key: string]: string; } | cdk.IResolvable;
The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-querystringparameters
interface InputTransformerProperty
interface 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.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html
property inputPathsMap
readonly inputPathsMap?: | { [key: string]: string; } | cdk.IResolvable;
Map of JSON paths to be extracted from the event. You can then insert these in the template in
InputTemplate
to produce the output you want to be sent to the target.InputPathsMap
is an array key-value pairs, where each value is a valid JSON path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket notation.The keys cannot start with " AWS ."
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html#cfn-events-rule-inputtransformer-inputpathsmap
property inputTemplate
readonly inputTemplate: string;
Input template where you specify placeholders that will be filled with the values of the keys from
InputPathsMap
to customize the data sent to the target. Enclose eachInputPathsMaps
value in brackets: < *value* >If
InputTemplate
is a JSON object (surrounded by curly braces), the following restrictions apply:- The placeholder cannot be used as an object key.
The following example shows the syntax for using
InputPathsMap
andInputTemplate
."InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": "<instance> is in state <status>"
}
To have the
InputTemplate
include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": "<instance> is in state \"<status>\""
}
The
InputTemplate
can also be valid JSON with varibles in quotes or out, as in the following example:"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": '{"myInstance": <instance>,"myStatus": "<instance> is in state \"<status>\""}'
}
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html#cfn-events-rule-inputtransformer-inputtemplate
interface KinesisParametersProperty
interface 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. If you do not include this parameter, the default is to use the
eventId
as the partition key.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html
property partitionKeyPath
readonly partitionKeyPath: string;
The JSON path to be extracted from the event and used as the partition key. For more information, see [Amazon Kinesis Streams Key Concepts](https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key) in the *Amazon Kinesis Streams Developer Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html#cfn-events-rule-kinesisparameters-partitionkeypath
interface NetworkConfigurationProperty
interface NetworkConfigurationProperty {}
This structure specifies the network configuration for an ECS task.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-networkconfiguration.html
property awsVpcConfiguration
readonly awsVpcConfiguration?: | CfnRule.AwsVpcConfigurationProperty | cdk.IResolvable;
Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the
awsvpc
network mode.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-networkconfiguration.html#cfn-events-rule-networkconfiguration-awsvpcconfiguration
interface PlacementConstraintProperty
interface PlacementConstraintProperty {}
An object representing a constraint on task placement. To learn more, see [Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the Amazon Elastic Container Service Developer Guide.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementconstraint.html
property expression
readonly expression?: string;
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is
distinctInstance
. To learn more, see [Cluster Query Language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the Amazon Elastic Container Service Developer Guide.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementconstraint.html#cfn-events-rule-placementconstraint-expression
property type
readonly type?: string;
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementconstraint.html#cfn-events-rule-placementconstraint-type
interface PlacementStrategyProperty
interface PlacementStrategyProperty {}
The task placement strategy for a task or service. To learn more, see [Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the Amazon Elastic Container Service Service Developer Guide.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementstrategy.html
property field
readonly field?: string;
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementstrategy.html#cfn-events-rule-placementstrategy-field
property type
readonly type?: string;
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementstrategy.html#cfn-events-rule-placementstrategy-type
interface RedshiftDataParametersProperty
interface 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.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html
property database
readonly database: string;
The name of the database. Required when authenticating using temporary credentials.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-database
property dbUser
readonly dbUser?: string;
The database user name. Required when authenticating using temporary credentials.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-dbuser
property secretManagerArn
readonly secretManagerArn?: string;
The name or ARN of the secret that enables access to the database. Required when authenticating using AWS Secrets Manager.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-secretmanagerarn
property sql
readonly sql: string;
The SQL statement text to run.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-sql
property statementName
readonly statementName?: string;
The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-statementname
property withEvent
readonly withEvent?: boolean | cdk.IResolvable;
Indicates whether to send an event back to EventBridge after the SQL statement runs.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-withevent
interface RetryPolicyProperty
interface RetryPolicyProperty {}
A
RetryPolicy
object that includes information about the retry policy settings.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-retrypolicy.html
property maximumEventAgeInSeconds
readonly maximumEventAgeInSeconds?: number;
The maximum amount of time, in seconds, to continue to make retry attempts.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-retrypolicy.html#cfn-events-rule-retrypolicy-maximumeventageinseconds
property maximumRetryAttempts
readonly maximumRetryAttempts?: number;
The maximum number of retry attempts to make before the request fails. Retry attempts continue until either the maximum number of attempts is made or until the duration of the
MaximumEventAgeInSeconds
is met.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-retrypolicy.html#cfn-events-rule-retrypolicy-maximumretryattempts
interface RunCommandParametersProperty
interface RunCommandParametersProperty {}
This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances are to be sent the command.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandparameters.html
property runCommandTargets
readonly runCommandTargets: | Array<CfnRule.RunCommandTargetProperty | cdk.IResolvable> | cdk.IResolvable;
Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandparameters.html#cfn-events-rule-runcommandparameters-runcommandtargets
interface RunCommandTargetProperty
interface RunCommandTargetProperty {}
Information about the EC2 instances that are to be sent the command, specified as key-value pairs. Each
RunCommandTarget
block can include only one key, but this key may specify multiple values.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html
property key
readonly key: string;
Can be either
tag:
*tag-key* orInstanceIds
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html#cfn-events-rule-runcommandtarget-key
property values
readonly values: string[];
If
Key
istag:
*tag-key* ,Values
is a list of tag values. IfKey
isInstanceIds
,Values
is a list of Amazon EC2 instance IDs.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html#cfn-events-rule-runcommandtarget-values
interface SageMakerPipelineParameterProperty
interface SageMakerPipelineParameterProperty {}
Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameter.html
property name
readonly name: string;
Name of parameter to start execution of a SageMaker Model Building Pipeline.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameter.html#cfn-events-rule-sagemakerpipelineparameter-name
property value
readonly value: string;
Value of parameter to start execution of a SageMaker Model Building Pipeline.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameter.html#cfn-events-rule-sagemakerpipelineparameter-value
interface SageMakerPipelineParametersProperty
interface SageMakerPipelineParametersProperty {}
These are custom parameters to use when the target is a SageMaker Model Building Pipeline that starts based on EventBridge events.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameters.html
property pipelineParameterList
readonly pipelineParameterList?: | Array<CfnRule.SageMakerPipelineParameterProperty | cdk.IResolvable> | cdk.IResolvable;
List of Parameter names and values for SageMaker Model Building Pipeline execution.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameters.html#cfn-events-rule-sagemakerpipelineparameters-pipelineparameterlist
interface SqsParametersProperty
interface SqsParametersProperty {}
This structure includes the custom parameter to be used when the target is an SQS FIFO queue.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sqsparameters.html
property messageGroupId
readonly messageGroupId: string;
The FIFO message group ID to use as the target.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sqsparameters.html#cfn-events-rule-sqsparameters-messagegroupid
interface TagProperty
interface TagProperty {}
A key-value pair associated with an ECS Target of an EventBridge rule. The tag will be propagated to ECS by EventBridge when starting an ECS task based on a matched event.
> Currently, tags are only available when using ECS with EventBridge .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-tag.html
property key
readonly key?: string;
A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-tag.html#cfn-events-rule-tag-key
property value
readonly value?: string;
The value for the specified tag key.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-tag.html#cfn-events-rule-tag-value
interface TargetProperty
interface TargetProperty {}
Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see [PutTargets](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html) .
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 theTarget
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* .external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html
property arn
readonly arn: string;
The Amazon Resource Name (ARN) of the target.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-arn
property batchParameters
readonly batchParameters?: CfnRule.BatchParametersProperty | cdk.IResolvable;
If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see [Jobs](https://docs.aws.amazon.com/batch/latest/userguide/jobs.html) in the *AWS Batch User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-batchparameters
property deadLetterConfig
readonly deadLetterConfig?: CfnRule.DeadLetterConfigProperty | cdk.IResolvable;
The
DeadLetterConfig
that defines the target queue to send dead-letter queue events to.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig
property ecsParameters
readonly ecsParameters?: CfnRule.EcsParametersProperty | cdk.IResolvable;
Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see [Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon EC2 Container Service Developer Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-ecsparameters
property httpParameters
readonly httpParameters?: CfnRule.HttpParametersProperty | cdk.IResolvable;
Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.
If you specify an API Gateway API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-httpparameters
property id
readonly id: string;
The ID of the target within the specified rule. Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id
property input
readonly input?: string;
Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see [The JavaScript Object Notation (JSON) Data Interchange Format](https://docs.aws.amazon.com/http://www.rfc-editor.org/rfc/rfc7159.txt) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input
property inputPath
readonly inputPath?: string;
The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You may use JSON dot notation or bracket notation. For more information about JSON paths, see [JSONPath](https://docs.aws.amazon.com/http://goessner.net/articles/JsonPath/) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath
property inputTransformer
readonly inputTransformer?: CfnRule.InputTransformerProperty | cdk.IResolvable;
Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputtransformer
property kinesisParameters
readonly kinesisParameters?: CfnRule.KinesisParametersProperty | cdk.IResolvable;
The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If you do not include this parameter, the default is to use the
eventId
as the partition key.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-kinesisparameters
property redshiftDataParameters
readonly redshiftDataParameters?: | CfnRule.RedshiftDataParametersProperty | cdk.IResolvable;
Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.
If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-redshiftdataparameters
property retryPolicy
readonly retryPolicy?: CfnRule.RetryPolicyProperty | cdk.IResolvable;
The
RetryPolicy
object that contains the retry policy configuration to use for the dead-letter queue.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy
property roleArn
readonly roleArn?: string;
The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-rolearn
property runCommandParameters
readonly runCommandParameters?: | CfnRule.RunCommandParametersProperty | cdk.IResolvable;
Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-runcommandparameters
property sageMakerPipelineParameters
readonly sageMakerPipelineParameters?: | CfnRule.SageMakerPipelineParametersProperty | cdk.IResolvable;
Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.
If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-sagemakerpipelineparameters
property sqsParameters
readonly sqsParameters?: CfnRule.SqsParametersProperty | cdk.IResolvable;
Contains the message group ID to use when the target is a FIFO queue.
If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-sqsparameters
Package Files (13)
Dependencies (3)
Dev Dependencies (6)
Peer Dependencies (3)
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@aws-cdk/aws-events
.
- Markdown[](https://www.jsdocs.io/package/@aws-cdk/aws-events)
- HTML<a href="https://www.jsdocs.io/package/@aws-cdk/aws-events"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3969 ms. - Missing or incorrect documentation? Open an issue for this package.