{ "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "dependencies": { "@aws-cdk/aws-iam": "1.64.0", "@aws-cdk/core": "1.64.0", "constructs": "^3.0.4" }, "dependencyClosure": { "@aws-cdk/aws-iam": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.IAM", "packageId": "Amazon.CDK.AWS.IAM", "signAssembly": true }, "java": { "maven": { "artifactId": "iam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.iam" }, "js": { "npm": "@aws-cdk/aws-iam" }, "python": { "distName": "aws-cdk.aws-iam", "module": "aws_cdk.aws_iam" } } }, "@aws-cdk/cloud-assembly-schema": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CloudAssembly.Schema", "packageId": "Amazon.CDK.CloudAssembly.Schema", "signAssembly": true }, "java": { "maven": { "artifactId": "cdk-cloud-assembly-schema", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cloudassembly.schema" }, "js": { "npm": "@aws-cdk/cloud-assembly-schema" }, "python": { "distName": "aws-cdk.cloud-assembly-schema", "module": "aws_cdk.cloud_assembly_schema" } } }, "@aws-cdk/core": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK", "packageId": "Amazon.CDK", "signAssembly": true }, "java": { "maven": { "artifactId": "core", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.core" }, "js": { "npm": "@aws-cdk/core" }, "python": { "distName": "aws-cdk.core", "module": "aws_cdk.core" } } }, "@aws-cdk/cx-api": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CXAPI", "packageId": "Amazon.CDK.CXAPI", "signAssembly": true }, "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" }, "python": { "distName": "aws-cdk.cx-api", "module": "aws_cdk.cx_api" } } }, "@aws-cdk/region-info": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.RegionInfo", "packageId": "Amazon.CDK.RegionInfo", "signAssembly": true }, "java": { "maven": { "artifactId": "cdk-region-info", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.regioninfo" }, "js": { "npm": "@aws-cdk/region-info" }, "python": { "distName": "aws-cdk.region-info", "module": "aws_cdk.region_info" } } }, "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "java": { "maven": { "artifactId": "constructs", "groupId": "software.constructs" }, "package": "software.constructs" }, "js": { "npm": "constructs" }, "python": { "distName": "constructs", "module": "constructs" } } } }, "description": "Amazon EventBridge Construct Library", "docs": { "stability": "stable" }, "homepage": "https://github.com/aws/aws-cdk", "jsiiVersion": "1.12.0 (build 5ddc9f2)", "keywords": [ "aws", "cdk", "constructs", "cloudwatch", "events", "eventbridge" ], "license": "Apache-2.0", "name": "@aws-cdk/aws-events", "readme": { "markdown": "## Amazon EventBridge Construct Library\n\n---\n\n![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)\n\n![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge)\n\n---\n\n\nAmazon EventBridge delivers a near real-time stream of system events that\ndescribe changes in AWS resources. For example, an AWS CodePipeline emits the\n[State\nChange](https://docs.aws.amazon.com/eventbridge/latest/userguide/event-types.html#codepipeline-event-type)\nevent when the pipeline changes it's state.\n\n* __Events__: An event indicates a change in your AWS environment. AWS resources\n can generate events when their state changes. For example, Amazon EC2\n generates an event when the state of an EC2 instance changes from pending to\n running, and Amazon EC2 Auto Scaling generates events when it launches or\n terminates instances. AWS CloudTrail publishes events when you make API calls.\n You can generate custom application-level events and publish them to\n EventBridge. You can also set up scheduled events that are generated on\n a periodic basis. For a list of services that generate events, and sample\n events from each service, see [EventBridge Event Examples From Each\n Supported\n Service](https://docs.aws.amazon.com/eventbridge/latest/userguide/event-types.html).\n* __Targets__: A target processes events. Targets can include Amazon EC2\n instances, AWS Lambda functions, Kinesis streams, Amazon ECS tasks, Step\n Functions state machines, Amazon SNS topics, Amazon SQS queues, and built-in\n targets. A target receives events in JSON format.\n* __Rules__: A rule matches incoming events and routes them to targets for\n processing. A single rule can route to multiple targets, all of which are\n processed in parallel. Rules are not processed in a particular order. This\n enables different parts of an organization to look for and process the events\n that are of interest to them. A rule can customize the JSON sent to the\n target, by passing only certain parts or by overwriting it with a constant.\n* __EventBuses__: An event bus can receive events from your own custom applications\n or it can receive events from applications and services created by AWS SaaS partners.\n See [Creating an Event Bus](https://docs.aws.amazon.com/eventbridge/latest/userguide/create-event-bus.html).\n\n## Rule\n\nThe `Rule` construct defines an EventBridge rule which monitors an\nevent based on an [event\npattern](https://docs.aws.amazon.com/eventbridge/latest/userguide/filtering-examples-structure.html)\nand invoke __event targets__ when the pattern is matched against a triggered\nevent. Event targets are objects that implement the `IRuleTarget` interface.\n\nNormally, you will use one of the `source.onXxx(name[, target[, options]]) ->\nRule` methods on the event source to define an event rule associated with\nthe specific activity. You can targets either via props, or add targets using\n`rule.addTarget`.\n\nFor example, to define an rule that triggers a CodeBuild project build when a\ncommit is pushed to the \"master\" branch of a CodeCommit repository:\n\n```ts\nconst onCommitRule = repo.onCommit('OnCommit', {\n target: new targets.CodeBuildProject(project),\n branches: ['master']\n});\n```\n\nYou can add additional targets, with optional [input\ntransformer](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_InputTransformer.html)\nusing `eventRule.addTarget(target[, input])`. For example, we can add a SNS\ntopic target which formats a human-readable message for the commit.\n\nFor example, this adds an SNS topic as a target:\n\n```ts\nonCommitRule.addTarget(new targets.SnsTopic(topic, {\n message: events.RuleTargetInput.fromText(\n `A commit was pushed to the repository ${codecommit.ReferenceEvent.repositoryName} on branch ${codecommit.ReferenceEvent.referenceName}`\n )\n}));\n```\n\n## Scheduling\n\nYou can configure a Rule to run on a schedule (cron or rate).\n\nThe following example runs a task every day at 4am:\n\n```ts\nimport { Rule, Schedule } from '@aws-cdk/aws-events';\nimport { EcsTask } from '@aws-cdk/aws-events-targets';\n...\n\nconst ecsTaskTarget = new EcsTask({ cluster, taskDefinition, role });\n\nnew Rule(this, 'ScheduleRule', {\n schedule: Schedule.cron({ minute: '0', hour: '4' }),\n targets: [ecsTaskTarget],\n});\n```\n\nIf you want to specify Fargate platform version, set `platformVersion` in EcsTask's props like the following example:\n```ts\nconst platformVersion = ecs.FargatePlatformVersion.VERSION1_4;\nconst ecsTaskTarget = new EcsTask({ cluster, taskDefinition, role, platformVersion });\n```\n\n## Event Targets\n\nThe `@aws-cdk/aws-events-targets` module includes classes that implement the `IRuleTarget`\ninterface for various AWS services.\n\nThe following targets are supported:\n\n* `targets.CodeBuildProject`: Start an AWS CodeBuild build\n* `targets.CodePipeline`: Start an AWS CodePipeline pipeline execution\n* `targets.EcsTask`: Start a task on an Amazon ECS cluster\n* `targets.LambdaFunction`: Invoke an AWS Lambda function\n* `targets.SnsTopic`: Publish into an SNS topic\n* `targets.SqsQueue`: Send a message to an Amazon SQS Queue\n* `targets.SfnStateMachine`: Trigger an AWS Step Functions state machine\n* `targets.BatchJob`: Queue an AWS Batch Job\n* `targets.AwsApi`: Make an AWS API call\n\n### Cross-account targets\n\nIt's possible to have the source of the event and a target in separate AWS accounts:\n\n```typescript\nimport { App, Stack } from '@aws-cdk/core';\nimport * as codebuild from '@aws-cdk/aws-codebuild';\nimport * as codecommit from '@aws-cdk/aws-codecommit';\nimport * as targets from '@aws-cdk/aws-events-targets';\n\nconst app = new App();\n\nconst stack1 = new Stack(app, 'Stack1', { env: { account: account1, region: 'us-east-1' } });\nconst repo = new codecommit.Repository(stack1, 'Repository', {\n // ...\n});\n\nconst stack2 = new Stack(app, 'Stack2', { env: { account: account2, region: 'us-east-1' } });\nconst project = new codebuild.Project(stack2, 'Project', {\n // ...\n});\n\nrepo.onCommit('OnCommit', {\n target: new targets.CodeBuildProject(project),\n});\n```\n\nIn this situation, the CDK will wire the 2 accounts together:\n\n* It will generate a rule in the source stack with the event bus of the target account as the target\n* It will generate a rule in the target stack, with the provided target\n* It will generate a separate stack that gives the source account permissions to publish events\n to the event bus of the target account in the given region,\n and make sure its deployed before the source stack\n\n**Note**: while events can span multiple accounts, they _cannot_ span different regions\n(that is an EventBridge, not CDK, limitation).\n\nFor more information, see the\n[AWS documentation on cross-account events](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html).\n" }, "repository": { "directory": "packages/@aws-cdk/aws-events", "type": "git", "url": "https://github.com/aws/aws-cdk.git" }, "schema": "jsii/0.10.0", "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Events", "packageId": "Amazon.CDK.AWS.Events", "signAssembly": true }, "java": { "maven": { "artifactId": "events", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.events" }, "js": { "npm": "@aws-cdk/aws-events" }, "python": { "distName": "aws-cdk.aws-events", "module": "aws_cdk.aws_events" } }, "types": { "@aws-cdk/aws-events.CfnEventBus": { "assembly": "@aws-cdk/aws-events", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Events::EventBus" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html", "stability": "external", "summary": "A CloudFormation `AWS::Events::EventBus`." }, "fqn": "@aws-cdk/aws-events.CfnEventBus", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Events::EventBus`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 137 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-events.CfnEventBusProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/events.generated.ts", "line": 81 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 155 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 166 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnEventBus", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 85 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 106 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Name" }, "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 111 }, "name": "attrName", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Policy" }, "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 116 }, "name": "attrPolicy", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 160 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name", "stability": "external", "summary": "`AWS::Events::EventBus.Name`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 122 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename", "stability": "external", "summary": "`AWS::Events::EventBus.EventSourceName`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 128 }, "name": "eventSourceName", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-events.CfnEventBusPolicy": { "assembly": "@aws-cdk/aws-events", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Events::EventBusPolicy" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html", "stability": "external", "summary": "A CloudFormation `AWS::Events::EventBusPolicy`." }, "fqn": "@aws-cdk/aws-events.CfnEventBusPolicy", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Events::EventBusPolicy`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 329 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-events.CfnEventBusPolicyProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/events.generated.ts", "line": 270 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 349 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 363 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnEventBusPolicy", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 274 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 354 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-action", "stability": "external", "summary": "`AWS::Events::EventBusPolicy.Action`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 296 }, "name": "action", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-principal", "stability": "external", "summary": "`AWS::Events::EventBusPolicy.Principal`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 302 }, "name": "principal", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statementid", "stability": "external", "summary": "`AWS::Events::EventBusPolicy.StatementId`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 308 }, "name": "statementId", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-condition", "stability": "external", "summary": "`AWS::Events::EventBusPolicy.Condition`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 314 }, "name": "condition", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnEventBusPolicy.ConditionProperty" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-eventbusname", "stability": "external", "summary": "`AWS::Events::EventBusPolicy.EventBusName`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 320 }, "name": "eventBusName", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-events.CfnEventBusPolicy.ConditionProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html", "stability": "external" }, "fqn": "@aws-cdk/aws-events.CfnEventBusPolicy.ConditionProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 373 }, "name": "ConditionProperty", "namespace": "CfnEventBusPolicy", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html#cfn-events-eventbuspolicy-condition-key", "stability": "external", "summary": "`CfnEventBusPolicy.ConditionProperty.Key`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 378 }, "name": "key", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html#cfn-events-eventbuspolicy-condition-type", "stability": "external", "summary": "`CfnEventBusPolicy.ConditionProperty.Type`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 383 }, "name": "type", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html#cfn-events-eventbuspolicy-condition-value", "stability": "external", "summary": "`CfnEventBusPolicy.ConditionProperty.Value`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 388 }, "name": "value", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-events.CfnEventBusPolicyProps": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html", "stability": "external", "summary": "Properties for defining a `AWS::Events::EventBusPolicy`." }, "fqn": "@aws-cdk/aws-events.CfnEventBusPolicyProps", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 177 }, "name": "CfnEventBusPolicyProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-action", "stability": "external", "summary": "`AWS::Events::EventBusPolicy.Action`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 183 }, "name": "action", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-principal", "stability": "external", "summary": "`AWS::Events::EventBusPolicy.Principal`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 189 }, "name": "principal", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statementid", "stability": "external", "summary": "`AWS::Events::EventBusPolicy.StatementId`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 195 }, "name": "statementId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-condition", "stability": "external", "summary": "`AWS::Events::EventBusPolicy.Condition`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 201 }, "name": "condition", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnEventBusPolicy.ConditionProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-eventbusname", "stability": "external", "summary": "`AWS::Events::EventBusPolicy.EventBusName`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 207 }, "name": "eventBusName", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-events.CfnEventBusProps": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html", "stability": "external", "summary": "Properties for defining a `AWS::Events::EventBus`." }, "fqn": "@aws-cdk/aws-events.CfnEventBusProps", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 17 }, "name": "CfnEventBusProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name", "stability": "external", "summary": "`AWS::Events::EventBus.Name`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 23 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename", "stability": "external", "summary": "`AWS::Events::EventBus.EventSourceName`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 29 }, "name": "eventSourceName", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-events.CfnRule": { "assembly": "@aws-cdk/aws-events", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Events::Rule" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html", "stability": "external", "summary": "A CloudFormation `AWS::Events::Rule`." }, "fqn": "@aws-cdk/aws-events.CfnRule", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Events::Rule`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 644 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.CfnRuleProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/events.generated.ts", "line": 562 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 665 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 682 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnRule", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 566 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 587 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 670 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern", "stability": "external", "summary": "`AWS::Events::Rule.EventPattern`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 605 }, "name": "eventPattern", "type": { "primitive": "any" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description", "stability": "external", "summary": "`AWS::Events::Rule.Description`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 593 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname", "stability": "external", "summary": "`AWS::Events::Rule.EventBusName`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 599 }, "name": "eventBusName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name", "stability": "external", "summary": "`AWS::Events::Rule.Name`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 611 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-rolearn", "stability": "external", "summary": "`AWS::Events::Rule.RoleArn`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 617 }, "name": "roleArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression", "stability": "external", "summary": "`AWS::Events::Rule.ScheduleExpression`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 623 }, "name": "scheduleExpression", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state", "stability": "external", "summary": "`AWS::Events::Rule.State`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 629 }, "name": "state", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets", "stability": "external", "summary": "`AWS::Events::Rule.Targets`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 635 }, "name": "targets", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.TargetProperty" } ] } }, "kind": "array" } } ] } } } ] }, "@aws-cdk/aws-events.CfnRule.AwsVpcConfigurationProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html", "stability": "external" }, "fqn": "@aws-cdk/aws-events.CfnRule.AwsVpcConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 692 }, "name": "AwsVpcConfigurationProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-subnets", "stability": "external", "summary": "`CfnRule.AwsVpcConfigurationProperty.Subnets`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 707 }, "name": "subnets", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-assignpublicip", "stability": "external", "summary": "`CfnRule.AwsVpcConfigurationProperty.AssignPublicIp`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 697 }, "name": "assignPublicIp", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-securitygroups", "stability": "external", "summary": "`CfnRule.AwsVpcConfigurationProperty.SecurityGroups`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 702 }, "name": "securityGroups", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ] }, "@aws-cdk/aws-events.CfnRule.BatchArrayPropertiesProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batcharrayproperties.html", "stability": "external" }, "fqn": "@aws-cdk/aws-events.CfnRule.BatchArrayPropertiesProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 764 }, "name": "BatchArrayPropertiesProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batcharrayproperties.html#cfn-events-rule-batcharrayproperties-size", "stability": "external", "summary": "`CfnRule.BatchArrayPropertiesProperty.Size`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 769 }, "name": "size", "optional": true, "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-events.CfnRule.BatchParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html", "stability": "external" }, "fqn": "@aws-cdk/aws-events.CfnRule.BatchParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 819 }, "name": "BatchParametersProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-jobdefinition", "stability": "external", "summary": "`CfnRule.BatchParametersProperty.JobDefinition`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 829 }, "name": "jobDefinition", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-jobname", "stability": "external", "summary": "`CfnRule.BatchParametersProperty.JobName`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 834 }, "name": "jobName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-arrayproperties", "stability": "external", "summary": "`CfnRule.BatchParametersProperty.ArrayProperties`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 824 }, "name": "arrayProperties", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.BatchArrayPropertiesProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-retrystrategy", "stability": "external", "summary": "`CfnRule.BatchParametersProperty.RetryStrategy`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 839 }, "name": "retryStrategy", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.BatchRetryStrategyProperty" } ] } } } ] }, "@aws-cdk/aws-events.CfnRule.BatchRetryStrategyProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchretrystrategy.html", "stability": "external" }, "fqn": "@aws-cdk/aws-events.CfnRule.BatchRetryStrategyProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 900 }, "name": "BatchRetryStrategyProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchretrystrategy.html#cfn-events-rule-batchretrystrategy-attempts", "stability": "external", "summary": "`CfnRule.BatchRetryStrategyProperty.Attempts`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 905 }, "name": "attempts", "optional": true, "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-events.CfnRule.EcsParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html", "stability": "external" }, "fqn": "@aws-cdk/aws-events.CfnRule.EcsParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 955 }, "name": "EcsParametersProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskdefinitionarn", "stability": "external", "summary": "`CfnRule.EcsParametersProperty.TaskDefinitionArn`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 985 }, "name": "taskDefinitionArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-group", "stability": "external", "summary": "`CfnRule.EcsParametersProperty.Group`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 960 }, "name": "group", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-launchtype", "stability": "external", "summary": "`CfnRule.EcsParametersProperty.LaunchType`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 965 }, "name": "launchType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-networkconfiguration", "stability": "external", "summary": "`CfnRule.EcsParametersProperty.NetworkConfiguration`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 970 }, "name": "networkConfiguration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.NetworkConfigurationProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-platformversion", "stability": "external", "summary": "`CfnRule.EcsParametersProperty.PlatformVersion`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 975 }, "name": "platformVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskcount", "stability": "external", "summary": "`CfnRule.EcsParametersProperty.TaskCount`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 980 }, "name": "taskCount", "optional": true, "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-events.CfnRule.HttpParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html", "stability": "external" }, "fqn": "@aws-cdk/aws-events.CfnRule.HttpParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 1051 }, "name": "HttpParametersProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-headerparameters", "stability": "external", "summary": "`CfnRule.HttpParametersProperty.HeaderParameters`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1056 }, "name": "headerParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-pathparametervalues", "stability": "external", "summary": "`CfnRule.HttpParametersProperty.PathParameterValues`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1061 }, "name": "pathParameterValues", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-querystringparameters", "stability": "external", "summary": "`CfnRule.HttpParametersProperty.QueryStringParameters`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1066 }, "name": "queryStringParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } } ] }, "@aws-cdk/aws-events.CfnRule.InputTransformerProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html", "stability": "external" }, "fqn": "@aws-cdk/aws-events.CfnRule.InputTransformerProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 1122 }, "name": "InputTransformerProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html#cfn-events-rule-inputtransformer-inputtemplate", "stability": "external", "summary": "`CfnRule.InputTransformerProperty.InputTemplate`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1132 }, "name": "inputTemplate", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html#cfn-events-rule-inputtransformer-inputpathsmap", "stability": "external", "summary": "`CfnRule.InputTransformerProperty.InputPathsMap`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1127 }, "name": "inputPathsMap", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } } ] }, "@aws-cdk/aws-events.CfnRule.KinesisParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html", "stability": "external" }, "fqn": "@aws-cdk/aws-events.CfnRule.KinesisParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 1186 }, "name": "KinesisParametersProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html#cfn-events-rule-kinesisparameters-partitionkeypath", "stability": "external", "summary": "`CfnRule.KinesisParametersProperty.PartitionKeyPath`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1191 }, "name": "partitionKeyPath", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-events.CfnRule.NetworkConfigurationProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-networkconfiguration.html", "stability": "external" }, "fqn": "@aws-cdk/aws-events.CfnRule.NetworkConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 1242 }, "name": "NetworkConfigurationProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-networkconfiguration.html#cfn-events-rule-networkconfiguration-awsvpcconfiguration", "stability": "external", "summary": "`CfnRule.NetworkConfigurationProperty.AwsVpcConfiguration`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1247 }, "name": "awsVpcConfiguration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.AwsVpcConfigurationProperty" } ] } } } ] }, "@aws-cdk/aws-events.CfnRule.RunCommandParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandparameters.html", "stability": "external" }, "fqn": "@aws-cdk/aws-events.CfnRule.RunCommandParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 1297 }, "name": "RunCommandParametersProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandparameters.html#cfn-events-rule-runcommandparameters-runcommandtargets", "stability": "external", "summary": "`CfnRule.RunCommandParametersProperty.RunCommandTargets`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1302 }, "name": "runCommandTargets", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.RunCommandTargetProperty" } ] } }, "kind": "array" } } ] } } } ] }, "@aws-cdk/aws-events.CfnRule.RunCommandTargetProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html", "stability": "external" }, "fqn": "@aws-cdk/aws-events.CfnRule.RunCommandTargetProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 1353 }, "name": "RunCommandTargetProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html#cfn-events-rule-runcommandtarget-key", "stability": "external", "summary": "`CfnRule.RunCommandTargetProperty.Key`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1358 }, "name": "key", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html#cfn-events-rule-runcommandtarget-values", "stability": "external", "summary": "`CfnRule.RunCommandTargetProperty.Values`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1363 }, "name": "values", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ] }, "@aws-cdk/aws-events.CfnRule.SqsParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sqsparameters.html", "stability": "external" }, "fqn": "@aws-cdk/aws-events.CfnRule.SqsParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 1418 }, "name": "SqsParametersProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sqsparameters.html#cfn-events-rule-sqsparameters-messagegroupid", "stability": "external", "summary": "`CfnRule.SqsParametersProperty.MessageGroupId`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1423 }, "name": "messageGroupId", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-events.CfnRule.TargetProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html", "stability": "external" }, "fqn": "@aws-cdk/aws-events.CfnRule.TargetProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 1474 }, "name": "TargetProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-arn", "stability": "external", "summary": "`CfnRule.TargetProperty.Arn`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1479 }, "name": "arn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id", "stability": "external", "summary": "`CfnRule.TargetProperty.Id`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1499 }, "name": "id", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-batchparameters", "stability": "external", "summary": "`CfnRule.TargetProperty.BatchParameters`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1484 }, "name": "batchParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.BatchParametersProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-ecsparameters", "stability": "external", "summary": "`CfnRule.TargetProperty.EcsParameters`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1489 }, "name": "ecsParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.EcsParametersProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-httpparameters", "stability": "external", "summary": "`CfnRule.TargetProperty.HttpParameters`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1494 }, "name": "httpParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.HttpParametersProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input", "stability": "external", "summary": "`CfnRule.TargetProperty.Input`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1504 }, "name": "input", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath", "stability": "external", "summary": "`CfnRule.TargetProperty.InputPath`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1509 }, "name": "inputPath", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputtransformer", "stability": "external", "summary": "`CfnRule.TargetProperty.InputTransformer`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1514 }, "name": "inputTransformer", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.InputTransformerProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-kinesisparameters", "stability": "external", "summary": "`CfnRule.TargetProperty.KinesisParameters`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1519 }, "name": "kinesisParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.KinesisParametersProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-rolearn", "stability": "external", "summary": "`CfnRule.TargetProperty.RoleArn`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1524 }, "name": "roleArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-runcommandparameters", "stability": "external", "summary": "`CfnRule.TargetProperty.RunCommandParameters`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1529 }, "name": "runCommandParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.RunCommandParametersProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-sqsparameters", "stability": "external", "summary": "`CfnRule.TargetProperty.SqsParameters`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1534 }, "name": "sqsParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.SqsParametersProperty" } ] } } } ] }, "@aws-cdk/aws-events.CfnRuleProps": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html", "stability": "external", "summary": "Properties for defining a `AWS::Events::Rule`." }, "fqn": "@aws-cdk/aws-events.CfnRuleProps", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 445 }, "name": "CfnRuleProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description", "stability": "external", "summary": "`AWS::Events::Rule.Description`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 451 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname", "stability": "external", "summary": "`AWS::Events::Rule.EventBusName`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 457 }, "name": "eventBusName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern", "stability": "external", "summary": "`AWS::Events::Rule.EventPattern`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 463 }, "name": "eventPattern", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name", "stability": "external", "summary": "`AWS::Events::Rule.Name`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 469 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-rolearn", "stability": "external", "summary": "`AWS::Events::Rule.RoleArn`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 475 }, "name": "roleArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression", "stability": "external", "summary": "`AWS::Events::Rule.ScheduleExpression`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 481 }, "name": "scheduleExpression", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state", "stability": "external", "summary": "`AWS::Events::Rule.State`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 487 }, "name": "state", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets", "stability": "external", "summary": "`AWS::Events::Rule.Targets`." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 493 }, "name": "targets", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.TargetProperty" } ] } }, "kind": "array" } } ] } } } ] }, "@aws-cdk/aws-events.CronOptions": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "remarks": "All fields are strings so you can use complex expressions. Absence of\na field implies '*' or '?', whichever one is appropriate.", "see": "https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html#cron-expressions", "stability": "stable", "summary": "Options to configure a cron expression." }, "fqn": "@aws-cdk/aws-events.CronOptions", "kind": "interface", "locationInModule": { "filename": "lib/schedule.ts", "line": 67 }, "name": "CronOptions", "properties": [ { "abstract": true, "docs": { "default": "- Every day of the month", "stability": "stable", "summary": "The day of the month to run this rule at." }, "immutable": true, "locationInModule": { "filename": "lib/schedule.ts", "line": 87 }, "name": "day", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Every hour", "stability": "stable", "summary": "The hour to run this rule at." }, "immutable": true, "locationInModule": { "filename": "lib/schedule.ts", "line": 80 }, "name": "hour", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Every minute", "stability": "stable", "summary": "The minute to run this rule at." }, "immutable": true, "locationInModule": { "filename": "lib/schedule.ts", "line": 73 }, "name": "minute", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Every month", "stability": "stable", "summary": "The month to run this rule at." }, "immutable": true, "locationInModule": { "filename": "lib/schedule.ts", "line": 94 }, "name": "month", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Any day of the week", "stability": "stable", "summary": "The day of the week to run this rule at." }, "immutable": true, "locationInModule": { "filename": "lib/schedule.ts", "line": 108 }, "name": "weekDay", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Every year", "stability": "stable", "summary": "The year to run this rule at." }, "immutable": true, "locationInModule": { "filename": "lib/schedule.ts", "line": 101 }, "name": "year", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-events.EventBus": { "assembly": "@aws-cdk/aws-events", "base": "@aws-cdk/core.Resource", "docs": { "custom": { "resource": "AWS::Events::EventBus" }, "stability": "stable", "summary": "Define an EventBridge EventBus." }, "fqn": "@aws-cdk/aws-events.EventBus", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/event-bus.ts", "line": 219 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.EventBusProps" } } ] }, "interfaces": [ "@aws-cdk/aws-events.IEventBus" ], "kind": "class", "locationInModule": { "filename": "lib/event-bus.ts", "line": 103 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import an existing event bus resource." }, "locationInModule": { "filename": "lib/event-bus.ts", "line": 111 }, "name": "fromEventBusArn", "parameters": [ { "docs": { "summary": "Parent construct." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "Construct ID." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "ARN of imported event bus." }, "name": "eventBusArn", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.IEventBus" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Import an existing event bus resource." }, "locationInModule": { "filename": "lib/event-bus.ts", "line": 129 }, "name": "fromEventBusAttributes", "parameters": [ { "docs": { "summary": "Parent construct." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "Construct ID." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "Imported event bus properties." }, "name": "attrs", "type": { "fqn": "@aws-cdk/aws-events.EventBusAttributes" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.IEventBus" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Permits an IAM Principal to send custom events to EventBridge so that they can be matched to rules." }, "locationInModule": { "filename": "lib/event-bus.ts", "line": 146 }, "name": "grantPutEvents", "parameters": [ { "docs": { "summary": "The principal (no-op if undefined)." }, "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } }, "static": true } ], "name": "EventBus", "properties": [ { "docs": { "stability": "stable", "summary": "The ARN of the event bus, such as: arn:aws:events:us-east-2:123456789012:event-bus/aws.partner/PartnerName/acct1/repo1." }, "immutable": true, "locationInModule": { "filename": "lib/event-bus.ts", "line": 207 }, "name": "eventBusArn", "overrides": "@aws-cdk/aws-events.IEventBus", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The physical ID of this event bus resource." }, "immutable": true, "locationInModule": { "filename": "lib/event-bus.ts", "line": 201 }, "name": "eventBusName", "overrides": "@aws-cdk/aws-events.IEventBus", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The policy for the event bus in JSON form." }, "immutable": true, "locationInModule": { "filename": "lib/event-bus.ts", "line": 212 }, "name": "eventBusPolicy", "overrides": "@aws-cdk/aws-events.IEventBus", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The name of the partner event source." }, "immutable": true, "locationInModule": { "filename": "lib/event-bus.ts", "line": 217 }, "name": "eventSourceName", "optional": true, "overrides": "@aws-cdk/aws-events.IEventBus", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-events.EventBusAttributes": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "stability": "stable", "summary": "Interface with properties necessary to import a reusable EventBus." }, "fqn": "@aws-cdk/aws-events.EventBusAttributes", "kind": "interface", "locationInModule": { "filename": "lib/event-bus.ts", "line": 67 }, "name": "EventBusAttributes", "properties": [ { "abstract": true, "docs": { "custom": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#Arn-fn::getatt" }, "stability": "stable", "summary": "The ARN of this event bus resource." }, "immutable": true, "locationInModule": { "filename": "lib/event-bus.ts", "line": 80 }, "name": "eventBusArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name" }, "stability": "stable", "summary": "The physical ID of this event bus resource." }, "immutable": true, "locationInModule": { "filename": "lib/event-bus.ts", "line": 73 }, "name": "eventBusName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#Policy-fn::getatt" }, "stability": "stable", "summary": "The JSON policy of this event bus resource." }, "immutable": true, "locationInModule": { "filename": "lib/event-bus.ts", "line": 87 }, "name": "eventBusPolicy", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename" }, "default": "- no partner event source", "stability": "stable", "summary": "The partner event source to associate with this event bus resource." }, "immutable": true, "locationInModule": { "filename": "lib/event-bus.ts", "line": 95 }, "name": "eventSourceName", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-events.EventBusProps": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "stability": "stable", "summary": "Properties to define an event bus." }, "fqn": "@aws-cdk/aws-events.EventBusProps", "kind": "interface", "locationInModule": { "filename": "lib/event-bus.ts", "line": 44 }, "name": "EventBusProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name" }, "default": "- automatically generated name", "stability": "stable", "summary": "The name of the event bus you are creating Note: If 'eventSourceName' is passed in, you cannot set this." }, "immutable": true, "locationInModule": { "filename": "lib/event-bus.ts", "line": 52 }, "name": "eventBusName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename" }, "default": "- no partner event source", "stability": "stable", "summary": "The partner event source to associate with this event bus resource Note: If 'eventBusName' is passed in, you cannot set this." }, "immutable": true, "locationInModule": { "filename": "lib/event-bus.ts", "line": 61 }, "name": "eventSourceName", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-events.EventField": { "assembly": "@aws-cdk/aws-events", "docs": { "stability": "stable", "summary": "Represents a field in the event pattern." }, "fqn": "@aws-cdk/aws-events.EventField", "interfaces": [ "@aws-cdk/core.IResolvable" ], "kind": "class", "locationInModule": { "filename": "lib/input.ts", "line": 249 }, "methods": [ { "docs": { "stability": "stable", "summary": "Extract a custom JSON path from the event." }, "locationInModule": { "filename": "lib/input.ts", "line": 295 }, "name": "fromPath", "parameters": [ { "name": "path", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Produce the Token's value at resolution time." }, "locationInModule": { "filename": "lib/input.ts", "line": 315 }, "name": "resolve", "overrides": "@aws-cdk/core.IResolvable", "parameters": [ { "name": "_ctx", "type": { "fqn": "@aws-cdk/core.IResolveContext" } } ], "returns": { "type": { "primitive": "any" } } }, { "docs": { "stability": "stable", "summary": "Convert the path to the field in the event pattern to JSON." }, "locationInModule": { "filename": "lib/input.ts", "line": 326 }, "name": "toJSON", "returns": { "type": { "primitive": "string" } } }, { "docs": { "remarks": "Returns a reversible string representation.", "stability": "stable", "summary": "Return a string representation of this resolvable object." }, "locationInModule": { "filename": "lib/input.ts", "line": 319 }, "name": "toString", "overrides": "@aws-cdk/core.IResolvable", "returns": { "type": { "primitive": "string" } } } ], "name": "EventField", "properties": [ { "docs": { "stability": "stable", "summary": "Extract the account from the event." }, "immutable": true, "locationInModule": { "filename": "lib/input.ts", "line": 274 }, "name": "account", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Extract the detail type from the event." }, "immutable": true, "locationInModule": { "filename": "lib/input.ts", "line": 260 }, "name": "detailType", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Extract the event ID from the event." }, "immutable": true, "locationInModule": { "filename": "lib/input.ts", "line": 253 }, "name": "eventId", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Extract the region from the event." }, "immutable": true, "locationInModule": { "filename": "lib/input.ts", "line": 288 }, "name": "region", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Extract the source from the event." }, "immutable": true, "locationInModule": { "filename": "lib/input.ts", "line": 267 }, "name": "source", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Extract the time from the event." }, "immutable": true, "locationInModule": { "filename": "lib/input.ts", "line": 281 }, "name": "time", "static": true, "type": { "primitive": "string" } }, { "docs": { "remarks": "If this returns an empty array the stack will not be attached.", "stability": "stable", "summary": "The creation stack of this resolvable which will be appended to errors thrown during resolution." }, "immutable": true, "locationInModule": { "filename": "lib/input.ts", "line": 303 }, "name": "creationStack", "overrides": "@aws-cdk/core.IResolvable", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "Human readable display hint about the event pattern." }, "immutable": true, "locationInModule": { "filename": "lib/input.ts", "line": 302 }, "name": "displayHint", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "the path to a field in the event pattern." }, "immutable": true, "locationInModule": { "filename": "lib/input.ts", "line": 309 }, "name": "path", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-events.EventPattern": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "remarks": "Rules use event patterns to select events and route them to targets. A\npattern either matches an event or it doesn't. Event patterns are represented\nas JSON objects with a structure that is similar to that of events, for\nexample:\n\nIt is important to remember the following about event pattern matching:\n\n- For a pattern to match an event, the event must contain all the field names\n listed in the pattern. The field names must appear in the event with the\n same nesting structure.\n\n- Other fields of the event not mentioned in the pattern are ignored;\n effectively, there is a ``\"*\": \"*\"`` wildcard for fields not mentioned.\n\n- The matching is exact (character-by-character), without case-folding or any\n other string normalization.\n\n- The values being matched follow JSON rules: Strings enclosed in quotes,\n numbers, and the unquoted keywords true, false, and null.\n\n- Number matching is at the string representation level. For example, 300,\n 300.0, and 3.0e2 are not considered equal.", "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html", "stability": "stable", "summary": "Events in Amazon CloudWatch Events are represented as JSON objects. For more information about JSON objects, see RFC 7159." }, "fqn": "@aws-cdk/aws-events.EventPattern", "kind": "interface", "locationInModule": { "filename": "lib/event-pattern.ts", "line": 30 }, "name": "EventPattern", "properties": [ { "abstract": true, "docs": { "default": "- No filtering on account", "stability": "stable", "summary": "The 12-digit number identifying an AWS account." }, "immutable": true, "locationInModule": { "filename": "lib/event-pattern.ts", "line": 76 }, "name": "account", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- No filtering on detail", "stability": "stable", "summary": "A JSON object, whose content is at the discretion of the service originating the event." }, "immutable": true, "locationInModule": { "filename": "lib/event-pattern.ts", "line": 115 }, "name": "detail", "optional": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- No filtering on detail type", "remarks": "Represents the \"detail-type\" event field.", "stability": "stable", "summary": "Identifies, in combination with the source field, the fields and values that appear in the detail field." }, "immutable": true, "locationInModule": { "filename": "lib/event-pattern.ts", "line": 54 }, "name": "detailType", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- No filtering on id", "remarks": "This can be helpful in\ntracing events as they move through rules to targets, and are processed.", "stability": "stable", "summary": "A unique value is generated for every event." }, "immutable": true, "locationInModule": { "filename": "lib/event-pattern.ts", "line": 44 }, "name": "id", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- No filtering on region", "stability": "stable", "summary": "Identifies the AWS region where the event originated." }, "immutable": true, "locationInModule": { "filename": "lib/event-pattern.ts", "line": 93 }, "name": "region", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- No filtering on resource", "remarks": "Inclusion of these ARNs is at the discretion of the\nservice.\n\nFor example, Amazon EC2 instance state-changes include Amazon EC2\ninstance ARNs, Auto Scaling events include ARNs for both instances and\nAuto Scaling groups, but API calls with AWS CloudTrail do not include\nresource ARNs.", "stability": "stable", "summary": "This JSON array contains ARNs that identify resources that are involved in the event." }, "immutable": true, "locationInModule": { "filename": "lib/event-pattern.ts", "line": 107 }, "name": "resources", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- No filtering on source", "remarks": "All events sourced from\nwithin AWS begin with \"aws.\" Customer-generated events can have any value\nhere, as long as it doesn't begin with \"aws.\" We recommend the use of\nJava package-name style reverse domain-name strings.\n\nTo find the correct value for source for an AWS service, see the table in\nAWS Service Namespaces. For example, the source value for Amazon\nCloudFront is aws.cloudfront.", "see": "http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces", "stability": "stable", "summary": "Identifies the service that sourced the event." }, "immutable": true, "locationInModule": { "filename": "lib/event-pattern.ts", "line": 69 }, "name": "source", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- No filtering on time", "remarks": "If the event spans a time interval, the service might choose\nto report the start time, so this value can be noticeably before the time\nthe event is actually received.", "stability": "stable", "summary": "The event timestamp, which can be specified by the service originating the event." }, "immutable": true, "locationInModule": { "filename": "lib/event-pattern.ts", "line": 86 }, "name": "time", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- No filtering on version", "stability": "stable", "summary": "By default, this is set to 0 (zero) in all events." }, "immutable": true, "locationInModule": { "filename": "lib/event-pattern.ts", "line": 36 }, "name": "version", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ] }, "@aws-cdk/aws-events.IEventBus": { "assembly": "@aws-cdk/aws-events", "docs": { "stability": "stable", "summary": "Interface which all EventBus based classes MUST implement." }, "fqn": "@aws-cdk/aws-events.IEventBus", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/event-bus.ts", "line": 8 }, "name": "IEventBus", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true", "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#Arn-fn::getatt" }, "stability": "stable", "summary": "The ARN of this event bus resource." }, "immutable": true, "locationInModule": { "filename": "lib/event-bus.ts", "line": 23 }, "name": "eventBusArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true", "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name" }, "stability": "stable", "summary": "The physical ID of this event bus resource." }, "immutable": true, "locationInModule": { "filename": "lib/event-bus.ts", "line": 15 }, "name": "eventBusName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true", "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#Policy-fn::getatt" }, "stability": "stable", "summary": "The JSON policy of this event bus resource." }, "immutable": true, "locationInModule": { "filename": "lib/event-bus.ts", "line": 31 }, "name": "eventBusPolicy", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename" }, "stability": "stable", "summary": "The partner event source to associate with this event bus resource." }, "immutable": true, "locationInModule": { "filename": "lib/event-bus.ts", "line": 38 }, "name": "eventSourceName", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-events.IRule": { "assembly": "@aws-cdk/aws-events", "docs": { "stability": "stable", "summary": "Represents an EventBridge Rule." }, "fqn": "@aws-cdk/aws-events.IRule", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/rule-ref.ts", "line": 6 }, "name": "IRule", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example." }, "immutable": true, "locationInModule": { "filename": "lib/rule-ref.ts", "line": 13 }, "name": "ruleArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The name event rule." }, "immutable": true, "locationInModule": { "filename": "lib/rule-ref.ts", "line": 20 }, "name": "ruleName", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-events.IRuleTarget": { "assembly": "@aws-cdk/aws-events", "docs": { "stability": "stable", "summary": "An abstract target for EventRules." }, "fqn": "@aws-cdk/aws-events.IRuleTarget", "kind": "interface", "locationInModule": { "filename": "lib/target.ts", "line": 10 }, "methods": [ { "abstract": true, "docs": { "remarks": "NOTE: Do not use the various `inputXxx` options. They can be set in a call to `addTarget`.", "stability": "stable", "summary": "Returns the rule target specification." }, "locationInModule": { "filename": "lib/target.ts", "line": 18 }, "name": "bind", "parameters": [ { "docs": { "summary": "The EventBridge Rule that would trigger this target." }, "name": "rule", "type": { "fqn": "@aws-cdk/aws-events.IRule" } }, { "docs": { "summary": "The id of the target that will be attached to the rule." }, "name": "id", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.RuleTargetConfig" } } } ], "name": "IRuleTarget" }, "@aws-cdk/aws-events.OnEventOptions": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "stability": "stable", "summary": "Standard set of options for `onXxx` event handlers on construct." }, "fqn": "@aws-cdk/aws-events.OnEventOptions", "kind": "interface", "locationInModule": { "filename": "lib/on-event-options.ts", "line": 7 }, "name": "OnEventOptions", "properties": [ { "abstract": true, "docs": { "default": "- No description", "stability": "stable", "summary": "A description of the rule's purpose." }, "immutable": true, "locationInModule": { "filename": "lib/on-event-options.ts", "line": 20 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No additional filtering based on an event pattern.", "remarks": "The method that generates the rule probably imposes some type of event\nfiltering. The filtering implied by what you pass here is added\non top of that filtering.", "see": "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html", "stability": "stable", "summary": "Additional restrictions for the event to route to the specified target." }, "immutable": true, "locationInModule": { "filename": "lib/on-event-options.ts", "line": 41 }, "name": "eventPattern", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.EventPattern" } }, { "abstract": true, "docs": { "default": "AWS CloudFormation generates a unique physical ID.", "stability": "stable", "summary": "A name for the rule." }, "immutable": true, "locationInModule": { "filename": "lib/on-event-options.ts", "line": 27 }, "name": "ruleName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No target is added to the rule. Use `addTarget()` to add a target.", "stability": "stable", "summary": "The target to register for the event." }, "immutable": true, "locationInModule": { "filename": "lib/on-event-options.ts", "line": 13 }, "name": "target", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.IRuleTarget" } } ] }, "@aws-cdk/aws-events.Rule": { "assembly": "@aws-cdk/aws-events", "base": "@aws-cdk/core.Resource", "docs": { "custom": { "resource": "AWS::Events::Rule" }, "stability": "stable", "summary": "Defines an EventBridge Rule in this stack." }, "fqn": "@aws-cdk/aws-events.Rule", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/rule.ts", "line": 117 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.RuleProps" } } ] }, "interfaces": [ "@aws-cdk/aws-events.IRule" ], "kind": "class", "locationInModule": { "filename": "lib/rule.ts", "line": 89 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import an existing EventBridge Rule provided an ARN." }, "locationInModule": { "filename": "lib/rule.ts", "line": 98 }, "name": "fromEventRuleArn", "parameters": [ { "docs": { "summary": "The parent creating construct (usually `this`)." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "The construct's name." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "Event Rule ARN (i.e. arn:aws:events:::rule/MyScheduledRule)." }, "name": "eventRuleArn", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.IRule" } }, "static": true }, { "docs": { "remarks": "If a pattern was already specified,\nthese values are merged into the existing pattern.\n\nFor example, if the rule already contains the pattern:\n\n {\n \"resources\": [ \"r1\" ],\n \"detail\": {\n \"hello\": [ 1 ]\n }\n }\n\nAnd `addEventPattern` is called with the pattern:\n\n {\n \"resources\": [ \"r2\" ],\n \"detail\": {\n \"foo\": [ \"bar\" ]\n }\n }\n\nThe resulting event pattern will be:\n\n {\n \"resources\": [ \"r1\", \"r2\" ],\n \"detail\": {\n \"hello\": [ 1 ],\n \"foo\": [ \"bar\" ]\n }\n }", "stability": "stable", "summary": "Adds an event pattern filter to this rule." }, "locationInModule": { "filename": "lib/rule.ts", "line": 340 }, "name": "addEventPattern", "parameters": [ { "name": "eventPattern", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.EventPattern" } } ] }, { "docs": { "remarks": "No-op if target is undefined.", "stability": "stable", "summary": "Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets." }, "locationInModule": { "filename": "lib/rule.ts", "line": 159 }, "name": "addTarget", "parameters": [ { "name": "target", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.IRuleTarget" } } ] }, { "docs": { "remarks": "This method can be implemented by derived constructs in order to perform\nvalidation logic. It is called on all constructs before synthesis.", "stability": "stable", "summary": "Validate the current construct." }, "locationInModule": { "filename": "lib/rule.ts", "line": 372 }, "name": "validate", "overrides": "@aws-cdk/core.Construct", "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } } ], "name": "Rule", "properties": [ { "docs": { "stability": "stable", "summary": "The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example." }, "immutable": true, "locationInModule": { "filename": "lib/rule.ts", "line": 108 }, "name": "ruleArn", "overrides": "@aws-cdk/aws-events.IRule", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The name event rule." }, "immutable": true, "locationInModule": { "filename": "lib/rule.ts", "line": 109 }, "name": "ruleName", "overrides": "@aws-cdk/aws-events.IRule", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-events.RuleProps": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for defining an EventBridge Rule." }, "fqn": "@aws-cdk/aws-events.RuleProps", "kind": "interface", "locationInModule": { "filename": "lib/rule.ts", "line": 13 }, "name": "RuleProps", "properties": [ { "abstract": true, "docs": { "default": "- No description.", "stability": "stable", "summary": "A description of the rule's purpose." }, "immutable": true, "locationInModule": { "filename": "lib/rule.ts", "line": 19 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Indicates whether the rule is enabled." }, "immutable": true, "locationInModule": { "filename": "lib/rule.ts", "line": 34 }, "name": "enabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- The default event bus.", "stability": "stable", "summary": "The event bus to associate with this rule." }, "immutable": true, "locationInModule": { "filename": "lib/rule.ts", "line": 81 }, "name": "eventBus", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.IEventBus" } }, { "abstract": true, "docs": { "default": "- None.", "remarks": "These routed events are matched events. For more information, see Events\nand Event Patterns in the Amazon EventBridge User Guide.", "see": "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html\n\nYou must specify this property (either via props or via\n`addEventPattern`), the `scheduleExpression` property, or both. The\nmethod `addEventPattern` can be used to add filter values to the event\npattern.", "stability": "stable", "summary": "Describes which events EventBridge routes to the specified target." }, "immutable": true, "locationInModule": { "filename": "lib/rule.ts", "line": 64 }, "name": "eventPattern", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.EventPattern" } }, { "abstract": true, "docs": { "default": "- AWS CloudFormation generates a unique physical ID and uses that ID\nfor the rule name. For more information, see Name Type.", "stability": "stable", "summary": "A name for the rule." }, "immutable": true, "locationInModule": { "filename": "lib/rule.ts", "line": 27 }, "name": "ruleName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- None.", "remarks": "For more information, see Schedule Expression Syntax for\nRules in the Amazon EventBridge User Guide.", "see": "https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html\n\nYou must specify this property, the `eventPattern` property, or both.", "stability": "stable", "summary": "The schedule or rate (frequency) that determines when EventBridge runs the rule." }, "immutable": true, "locationInModule": { "filename": "lib/rule.ts", "line": 47 }, "name": "schedule", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.Schedule" } }, { "abstract": true, "docs": { "default": "- No targets.", "remarks": "Input will be the full matched event. If you wish to specify custom\ntarget input, use `addTarget(target[, inputOptions])`.", "stability": "stable", "summary": "Targets to invoke when this rule matches an event." }, "immutable": true, "locationInModule": { "filename": "lib/rule.ts", "line": 74 }, "name": "targets", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-events.IRuleTarget" }, "kind": "array" } } } ] }, "@aws-cdk/aws-events.RuleTargetConfig": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for an event rule target." }, "fqn": "@aws-cdk/aws-events.RuleTargetConfig", "kind": "interface", "locationInModule": { "filename": "lib/target.ts", "line": 24 }, "name": "RuleTargetConfig", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The Amazon Resource Name (ARN) of the target." }, "immutable": true, "locationInModule": { "filename": "lib/target.ts", "line": 37 }, "name": "arn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "deprecated": "prefer auto-generated id by specifying an empty string", "remarks": "Acceptable values\ninclude alphanumeric characters, periods (.), hyphens (-), and\nunderscores (_).", "stability": "deprecated", "summary": "A unique, user-defined identifier for the target." }, "immutable": true, "locationInModule": { "filename": "lib/target.ts", "line": 32 }, "name": "id", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "no parameters set", "stability": "stable", "summary": "Parameters used when the rule invokes Amazon AWS Batch Job/Queue." }, "immutable": true, "locationInModule": { "filename": "lib/target.ts", "line": 48 }, "name": "batchParameters", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.CfnRule.BatchParametersProperty" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The Amazon ECS task definition and task count to use, if the event target is an Amazon ECS task." }, "immutable": true, "locationInModule": { "filename": "lib/target.ts", "line": 54 }, "name": "ecsParameters", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.CfnRule.EcsParametersProperty" } }, { "abstract": true, "docs": { "default": "the entire event", "stability": "stable", "summary": "What input to send to the event target." }, "immutable": true, "locationInModule": { "filename": "lib/target.ts", "line": 80 }, "name": "input", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.RuleTargetInput" } }, { "abstract": true, "docs": { "remarks": "If you don't include this parameter, eventId is used as the\npartition key.", "stability": "stable", "summary": "Settings that control shard assignment, when the target is a Kinesis stream." }, "immutable": true, "locationInModule": { "filename": "lib/target.ts", "line": 61 }, "name": "kinesisParameters", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.CfnRule.KinesisParametersProperty" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Role to use to invoke this event target." }, "immutable": true, "locationInModule": { "filename": "lib/target.ts", "line": 42 }, "name": "role", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Parameters used when the rule invokes Amazon EC2 Systems Manager Run Command." }, "immutable": true, "locationInModule": { "filename": "lib/target.ts", "line": 67 }, "name": "runCommandParameters", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.CfnRule.RunCommandParametersProperty" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Parameters used when the FIFO sqs queue is used an event target by the rule." }, "immutable": true, "locationInModule": { "filename": "lib/target.ts", "line": 73 }, "name": "sqsParameters", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.CfnRule.SqsParametersProperty" } }, { "abstract": true, "docs": { "default": "the target is not backed by any resource", "remarks": "This is the resource that will actually have some action performed on it when used as a target\n(for example, start a build for a CodeBuild project).\nWe need it to determine whether the rule belongs to a different account than the target -\nif so, we generate a more complex setup,\nincluding an additional stack containing the EventBusPolicy.", "see": "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html", "stability": "stable", "summary": "The resource that is backing this target." }, "immutable": true, "locationInModule": { "filename": "lib/target.ts", "line": 93 }, "name": "targetResource", "optional": true, "type": { "fqn": "@aws-cdk/core.IConstruct" } } ] }, "@aws-cdk/aws-events.RuleTargetInput": { "abstract": true, "assembly": "@aws-cdk/aws-events", "docs": { "stability": "stable", "summary": "The input to send to the event target." }, "fqn": "@aws-cdk/aws-events.RuleTargetInput", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/input.ts", "line": 51 } }, "kind": "class", "locationInModule": { "filename": "lib/input.ts", "line": 10 }, "methods": [ { "docs": { "stability": "stable", "summary": "Take the event target input from a path in the event JSON." }, "locationInModule": { "filename": "lib/input.ts", "line": 47 }, "name": "fromEventPath", "parameters": [ { "name": "path", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.RuleTargetInput" } }, "static": true }, { "docs": { "remarks": "This is only useful when passing to a target that does not\ntake a single argument.\n\nMay contain strings returned by EventField.from() to substitute in parts\nof the matched event.", "stability": "stable", "summary": "Pass text to the event target, splitting on newlines." }, "locationInModule": { "filename": "lib/input.ts", "line": 30 }, "name": "fromMultilineText", "parameters": [ { "name": "text", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.RuleTargetInput" } }, "static": true }, { "docs": { "remarks": "May contain strings returned by EventField.from() to substitute in parts of the\nmatched event.", "stability": "stable", "summary": "Pass a JSON object to the event target." }, "locationInModule": { "filename": "lib/input.ts", "line": 40 }, "name": "fromObject", "parameters": [ { "name": "obj", "type": { "primitive": "any" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.RuleTargetInput" } }, "static": true }, { "docs": { "remarks": "May contain strings returned by EventField.from() to substitute in parts of the\nmatched event.", "stability": "stable", "summary": "Pass text to the event target." }, "locationInModule": { "filename": "lib/input.ts", "line": 17 }, "name": "fromText", "parameters": [ { "name": "text", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.RuleTargetInput" } }, "static": true }, { "abstract": true, "docs": { "stability": "stable", "summary": "Return the input properties for this input object." }, "locationInModule": { "filename": "lib/input.ts", "line": 57 }, "name": "bind", "parameters": [ { "name": "rule", "type": { "fqn": "@aws-cdk/aws-events.IRule" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.RuleTargetInputProperties" } } } ], "name": "RuleTargetInput" }, "@aws-cdk/aws-events.RuleTargetInputProperties": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "stability": "stable", "summary": "The input properties for an event target." }, "fqn": "@aws-cdk/aws-events.RuleTargetInputProperties", "kind": "interface", "locationInModule": { "filename": "lib/input.ts", "line": 63 }, "name": "RuleTargetInputProperties", "properties": [ { "abstract": true, "docs": { "default": "- input for the event target. If the input contains a paths map\nvalues wil be extracted from event and inserted into the `inputTemplate`.", "stability": "stable", "summary": "Literal input to the target service (must be valid JSON)." }, "immutable": true, "locationInModule": { "filename": "lib/input.ts", "line": 70 }, "name": "input", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- None. The entire matched event is passed as input", "stability": "stable", "summary": "JsonPath to take input from the input event." }, "immutable": true, "locationInModule": { "filename": "lib/input.ts", "line": 77 }, "name": "inputPath", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No values extracted from event.", "stability": "stable", "summary": "Paths map to extract values from event and insert into `inputTemplate`." }, "immutable": true, "locationInModule": { "filename": "lib/input.ts", "line": 91 }, "name": "inputPathsMap", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- None.", "stability": "stable", "summary": "Input template to insert paths map into." }, "immutable": true, "locationInModule": { "filename": "lib/input.ts", "line": 84 }, "name": "inputTemplate", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-events.Schedule": { "abstract": true, "assembly": "@aws-cdk/aws-events", "docs": { "stability": "stable", "summary": "Schedule for scheduled event rules." }, "fqn": "@aws-cdk/aws-events.Schedule", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/schedule.ts", "line": 55 } }, "kind": "class", "locationInModule": { "filename": "lib/schedule.ts", "line": 6 }, "methods": [ { "docs": { "stability": "stable", "summary": "Create a schedule from a set of cron fields." }, "locationInModule": { "filename": "lib/schedule.ts", "line": 33 }, "name": "cron", "parameters": [ { "name": "options", "type": { "fqn": "@aws-cdk/aws-events.CronOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.Schedule" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Construct a schedule from a literal schedule expression." }, "locationInModule": { "filename": "lib/schedule.ts", "line": 12 }, "name": "expression", "parameters": [ { "docs": { "remarks": "Must be in a format that EventBridge will recognize", "summary": "The expression to use." }, "name": "expression", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.Schedule" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Construct a schedule from an interval and a time unit." }, "locationInModule": { "filename": "lib/schedule.ts", "line": 19 }, "name": "rate", "parameters": [ { "name": "duration", "type": { "fqn": "@aws-cdk/core.Duration" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.Schedule" } }, "static": true } ], "name": "Schedule", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Retrieve the expression for this schedule." }, "immutable": true, "locationInModule": { "filename": "lib/schedule.ts", "line": 53 }, "name": "expressionString", "type": { "primitive": "string" } } ] } }, "version": "1.64.0", "fingerprint": "DXmbkkNpml/G80mB3njsn51Vs8e8xcP4rPGzLLunLq4=" }