{ "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "dependencies": { "@aws-cdk/aws-iam": "1.204.0", "@aws-cdk/core": "1.204.0", "constructs": "^3.3.69" }, "dependencyClosure": { "@aws-cdk/aws-iam": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.IAM", "packageId": "Amazon.CDK.AWS.IAM" }, "java": { "maven": { "artifactId": "iam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.iam" }, "js": { "npm": "@aws-cdk/aws-iam" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-iam", "module": "aws_cdk.aws_iam" } } }, "@aws-cdk/cloud-assembly-schema": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CloudAssembly.Schema", "packageId": "Amazon.CDK.CloudAssembly.Schema" }, "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": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cloud-assembly-schema", "module": "aws_cdk.cloud_assembly_schema" } } }, "@aws-cdk/core": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK", "packageId": "Amazon.CDK" }, "java": { "maven": { "artifactId": "core", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.core" }, "js": { "npm": "@aws-cdk/core" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.core", "module": "aws_cdk.core" } } }, "@aws-cdk/cx-api": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CXAPI", "packageId": "Amazon.CDK.CXAPI" }, "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cx-api", "module": "aws_cdk.cx_api" } } }, "@aws-cdk/region-info": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.RegionInfo", "packageId": "Amazon.CDK.RegionInfo" }, "java": { "maven": { "artifactId": "cdk-region-info", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.regioninfo" }, "js": { "npm": "@aws-cdk/region-info" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.region-info", "module": "aws_cdk.region_info" } } }, "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "go": { "moduleName": "github.com/aws/constructs-go" }, "java": { "maven": { "artifactId": "constructs", "groupId": "software.constructs" }, "package": "software.constructs" }, "js": { "npm": "constructs" }, "python": { "distName": "constructs", "module": "constructs" } } } }, "description": "Amazon EventBridge Construct Library", "docs": { "deprecated": "AWS CDK v1 has reached End-of-Support on 2023-06-01.\nThis package is no longer being updated, and users should migrate to AWS CDK v2.\n\nFor more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html", "stability": "stable" }, "homepage": "https://github.com/aws/aws-cdk", "jsiiVersion": "1.84.0 (build 5404dcf)", "keywords": [ "aws", "cdk", "constructs", "cloudwatch", "events", "eventbridge" ], "license": "Apache-2.0", "metadata": { "jsii": { "compiledWithDeprecationWarnings": true, "pacmak": { "hasDefaultInterfaces": true }, "rosetta": { "strict": true } } }, "name": "@aws-cdk/aws-events", "readme": { "markdown": "# Amazon EventBridge Construct Library\n\n\n---\n\n![End-of-Support](https://img.shields.io/badge/End--of--Support-critical.svg?style=for-the-badge)\n\n> AWS CDK v1 has reached End-of-Support on 2023-06-01.\n> This package is no longer being updated, and users should migrate to AWS CDK v2.\n>\n> For more information on how to migrate, see the [_Migrating to AWS CDK v2_ guide][doc].\n>\n> [doc]: https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html\n\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 its 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, Amazon CloudWatch LogGroups, 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\ndeclare const repo: codecommit.Repository;\ndeclare const project: codebuild.Project;\n\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\ndeclare const onCommitRule: events.Rule;\ndeclare const topic: sns.Topic;\n\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\nOr using an Object:\n\n```ts\ndeclare const onCommitRule: events.Rule;\ndeclare const topic: sns.Topic;\n\nonCommitRule.addTarget(new targets.SnsTopic(topic, {\n message: events.RuleTargetInput.fromObject(\n {\n DataType: `custom_${events.EventField.fromPath('$.detail-type')}`\n }\n )\n}));\n```\n\n## Scheduling\n\nYou can configure a Rule to run on a schedule (cron or rate).\nRate must be specified in minutes, hours or days.\n\nThe following example runs a task every day at 4am:\n\n```ts fixture=basic\nimport { Rule, Schedule } from '@aws-cdk/aws-events';\nimport { EcsTask } from '@aws-cdk/aws-events-targets';\nimport { Cluster, TaskDefinition } from '@aws-cdk/aws-ecs';\nimport { Role } from '@aws-cdk/aws-iam';\n\ndeclare const cluster: Cluster;\ndeclare const taskDefinition: TaskDefinition;\ndeclare const role: Role;\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\n```ts\ndeclare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\ndeclare const role: iam.Role;\n\nconst platformVersion = ecs.FargatePlatformVersion.VERSION1_4;\nconst ecsTaskTarget = new targets.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* `targets.ApiGateway`: Invoke an AWS API Gateway\n* `targets.ApiDestination`: Make an call to an external destination\n\n### Cross-account and cross-region targets\n\nIt's possible to have the source of the event and a target in separate AWS accounts and regions:\n\n```ts nofixture\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 account1 = '11111111111';\nconst account2 = '22222222222';\n\nconst stack1 = new Stack(app, 'Stack1', { env: { account: account1, region: 'us-west-1' } });\nconst repo = new codecommit.Repository(stack1, 'Repository', {\n repositoryName: 'myrepository',\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\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\n## Archiving\n\nIt is possible to archive all or some events sent to an event bus. It is then possible to [replay these events](https://aws.amazon.com/blogs/aws/new-archive-and-replay-events-with-amazon-eventbridge/).\n\n```ts\nconst bus = new events.EventBus(this, 'bus', {\n eventBusName: 'MyCustomEventBus'\n});\n\nbus.archive('MyArchive', {\n archiveName: 'MyCustomEventBusArchive',\n description: 'MyCustomerEventBus Archive',\n eventPattern: {\n account: [Stack.of(this).account],\n },\n retention: Duration.days(365),\n});\n```\n\n## Granting PutEvents to an existing EventBus\n\nTo import an existing EventBus into your CDK application, use `EventBus.fromEventBusArn`, `EventBus.fromEventBusAttributes`\nor `EventBus.fromEventBusName` factory method.\n\nThen, you can use the `grantPutEventsTo` method to grant `event:PutEvents` to the eventBus.\n\n```ts\ndeclare const lambdaFunction: lambda.Function;\n\nconst eventBus = events.EventBus.fromEventBusArn(this, 'ImportedEventBus', 'arn:aws:events:us-east-1:111111111:event-bus/my-event-bus');\n\n// now you can just call methods on the eventbus\neventBus.grantPutEventsTo(lambdaFunction);\n```\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": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Events", "packageId": "Amazon.CDK.AWS.Events" }, "java": { "maven": { "artifactId": "events", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.events" }, "js": { "npm": "@aws-cdk/aws-events" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-events", "module": "aws_cdk.aws_events" } }, "types": { "@aws-cdk/aws-events.ApiDestination": { "assembly": "@aws-cdk/aws-events", "base": "@aws-cdk/core.Resource", "docs": { "custom": { "resource": "AWS::Events::ApiDestination", "exampleMetadata": "infused" }, "stability": "stable", "summary": "Define an EventBridge Api Destination.", "example": "const connection = new events.Connection(this, 'Connection', {\n authorization: events.Authorization.apiKey('x-api-key', SecretValue.secretsManager('ApiSecretName')),\n description: 'Connection with API Key x-api-key',\n});\n\nconst destination = new events.ApiDestination(this, 'Destination', {\n connection,\n endpoint: 'https://example.com',\n description: 'Calling example.com with API key x-api-key',\n});\n\nconst rule = new events.Rule(this, 'Rule', {\n schedule: events.Schedule.rate(cdk.Duration.minutes(1)),\n targets: [new targets.ApiDestination(destination)],\n});" }, "fqn": "@aws-cdk/aws-events.ApiDestination", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/api-destination.ts", "line": 88 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-events.ApiDestinationProps" } } ] }, "interfaces": [ "@aws-cdk/aws-events.IApiDestination" ], "kind": "class", "locationInModule": { "filename": "lib/api-destination.ts", "line": 70 }, "name": "ApiDestination", "properties": [ { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ARN of the Api Destination created." }, "immutable": true, "locationInModule": { "filename": "lib/api-destination.ts", "line": 86 }, "name": "apiDestinationArn", "overrides": "@aws-cdk/aws-events.IApiDestination", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The Name of the Api Destination created." }, "immutable": true, "locationInModule": { "filename": "lib/api-destination.ts", "line": 80 }, "name": "apiDestinationName", "overrides": "@aws-cdk/aws-events.IApiDestination", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The Connection to associate with Api Destination." }, "immutable": true, "locationInModule": { "filename": "lib/api-destination.ts", "line": 74 }, "name": "connection", "type": { "fqn": "@aws-cdk/aws-events.IConnection" } } ], "symbolId": "lib/api-destination:ApiDestination" }, "@aws-cdk/aws-events.ApiDestinationProps": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "stability": "stable", "summary": "The event API Destination properties.", "example": "const connection = new events.Connection(this, 'Connection', {\n authorization: events.Authorization.apiKey('x-api-key', SecretValue.secretsManager('ApiSecretName')),\n description: 'Connection with API Key x-api-key',\n});\n\nconst destination = new events.ApiDestination(this, 'Destination', {\n connection,\n endpoint: 'https://example.com',\n description: 'Calling example.com with API key x-api-key',\n});\n\nconst rule = new events.Rule(this, 'Rule', {\n schedule: events.Schedule.rate(cdk.Duration.minutes(1)),\n targets: [new targets.ApiDestination(destination)],\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-events.ApiDestinationProps", "kind": "interface", "locationInModule": { "filename": "lib/api-destination.ts", "line": 9 }, "name": "ApiDestinationProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The ARN of the connection to use for the API destination." }, "immutable": true, "locationInModule": { "filename": "lib/api-destination.ts", "line": 26 }, "name": "connection", "type": { "fqn": "@aws-cdk/aws-events.IConnection" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The URL to the HTTP invocation endpoint for the API destination.." }, "immutable": true, "locationInModule": { "filename": "lib/api-destination.ts", "line": 31 }, "name": "endpoint", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- A unique name will be generated", "stability": "stable", "summary": "The name for the API destination." }, "immutable": true, "locationInModule": { "filename": "lib/api-destination.ts", "line": 14 }, "name": "apiDestinationName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- none", "stability": "stable", "summary": "A description for the API destination." }, "immutable": true, "locationInModule": { "filename": "lib/api-destination.ts", "line": 21 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "HttpMethod.POST", "stability": "stable", "summary": "The method to use for the request to the HTTP invocation endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/api-destination.ts", "line": 38 }, "name": "httpMethod", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.HttpMethod" } }, { "abstract": true, "docs": { "default": "- Not rate limited", "stability": "stable", "summary": "The maximum number of requests per second to send to the HTTP invocation endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/api-destination.ts", "line": 45 }, "name": "rateLimitPerSecond", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/api-destination:ApiDestinationProps" }, "@aws-cdk/aws-events.Archive": { "assembly": "@aws-cdk/aws-events", "base": "@aws-cdk/core.Resource", "docs": { "custom": { "resource": "AWS::Events::Archive", "exampleMetadata": "fixture=_generated" }, "stability": "stable", "summary": "Define an EventBridge Archive.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const detail: any;\ndeclare const eventBus: events.EventBus;\nconst archive = new events.Archive(this, 'MyArchive', {\n eventPattern: {\n account: ['account'],\n detail: {\n detailKey: detail,\n },\n detailType: ['detailType'],\n id: ['id'],\n region: ['region'],\n resources: ['resources'],\n source: ['source'],\n time: ['time'],\n version: ['version'],\n },\n sourceEventBus: eventBus,\n\n // the properties below are optional\n archiveName: 'archiveName',\n description: 'description',\n retention: cdk.Duration.minutes(30),\n});" }, "fqn": "@aws-cdk/aws-events.Archive", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/archive.ts", "line": 64 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-events.ArchiveProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/archive.ts", "line": 51 }, "name": "Archive", "properties": [ { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ARN of the archive created." }, "immutable": true, "locationInModule": { "filename": "lib/archive.ts", "line": 62 }, "name": "archiveArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The archive name." }, "immutable": true, "locationInModule": { "filename": "lib/archive.ts", "line": 56 }, "name": "archiveName", "type": { "primitive": "string" } } ], "symbolId": "lib/archive:Archive" }, "@aws-cdk/aws-events.ArchiveProps": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "stability": "stable", "summary": "The event archive properties.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const detail: any;\ndeclare const eventBus: events.EventBus;\nconst archiveProps: events.ArchiveProps = {\n eventPattern: {\n account: ['account'],\n detail: {\n detailKey: detail,\n },\n detailType: ['detailType'],\n id: ['id'],\n region: ['region'],\n resources: ['resources'],\n source: ['source'],\n time: ['time'],\n version: ['version'],\n },\n sourceEventBus: eventBus,\n\n // the properties below are optional\n archiveName: 'archiveName',\n description: 'description',\n retention: cdk.Duration.minutes(30),\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-events.ArchiveProps", "interfaces": [ "@aws-cdk/aws-events.BaseArchiveProps" ], "kind": "interface", "locationInModule": { "filename": "lib/archive.ts", "line": 39 }, "name": "ArchiveProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The event source associated with the archive." }, "immutable": true, "locationInModule": { "filename": "lib/archive.ts", "line": 43 }, "name": "sourceEventBus", "type": { "fqn": "@aws-cdk/aws-events.IEventBus" } } ], "symbolId": "lib/archive:ArchiveProps" }, "@aws-cdk/aws-events.Authorization": { "abstract": true, "assembly": "@aws-cdk/aws-events", "docs": { "stability": "stable", "summary": "Authorization type for an API Destination Connection.", "example": "const connection = new events.Connection(this, 'Connection', {\n authorization: events.Authorization.apiKey('x-api-key', SecretValue.secretsManager('ApiSecretName')),\n description: 'Connection with API Key x-api-key',\n});\n\nconst destination = new events.ApiDestination(this, 'Destination', {\n connection,\n endpoint: 'https://example.com',\n description: 'Calling example.com with API key x-api-key',\n});\n\nconst rule = new events.Rule(this, 'Rule', {\n schedule: events.Schedule.rate(cdk.Duration.minutes(1)),\n targets: [new targets.ApiDestination(destination)],\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-events.Authorization", "initializer": { "docs": { "stability": "stable" } }, "kind": "class", "locationInModule": { "filename": "lib/connection.ts", "line": 55 }, "methods": [ { "docs": { "remarks": "API key authorization has two components: an API key name and an API key value.\nWhat these are depends on the target of your connection.", "stability": "stable", "summary": "Use API key authorization." }, "locationInModule": { "filename": "lib/connection.ts", "line": 62 }, "name": "apiKey", "parameters": [ { "name": "apiKeyName", "type": { "primitive": "string" } }, { "name": "apiKeyValue", "type": { "fqn": "@aws-cdk/core.SecretValue" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.Authorization" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Use username and password authorization." }, "locationInModule": { "filename": "lib/connection.ts", "line": 81 }, "name": "basic", "parameters": [ { "name": "username", "type": { "primitive": "string" } }, { "name": "password", "type": { "fqn": "@aws-cdk/core.SecretValue" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.Authorization" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Use OAuth authorization." }, "locationInModule": { "filename": "lib/connection.ts", "line": 100 }, "name": "oauth", "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-events.OAuthAuthorizationProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.Authorization" } }, "static": true } ], "name": "Authorization", "symbolId": "lib/connection:Authorization" }, "@aws-cdk/aws-events.BaseArchiveProps": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "stability": "stable", "summary": "The event archive base properties.", "example": "const bus = new events.EventBus(this, 'bus', {\n eventBusName: 'MyCustomEventBus'\n});\n\nbus.archive('MyArchive', {\n archiveName: 'MyCustomEventBusArchive',\n description: 'MyCustomerEventBus Archive',\n eventPattern: {\n account: [Stack.of(this).account],\n },\n retention: Duration.days(365),\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-events.BaseArchiveProps", "kind": "interface", "locationInModule": { "filename": "lib/archive.ts", "line": 11 }, "name": "BaseArchiveProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "An event pattern to use to filter events sent to the archive." }, "immutable": true, "locationInModule": { "filename": "lib/archive.ts", "line": 27 }, "name": "eventPattern", "type": { "fqn": "@aws-cdk/aws-events.EventPattern" } }, { "abstract": true, "docs": { "default": "- Automatically generated", "stability": "stable", "summary": "The name of the archive." }, "immutable": true, "locationInModule": { "filename": "lib/archive.ts", "line": 17 }, "name": "archiveName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- none", "stability": "stable", "summary": "A description for the archive." }, "immutable": true, "locationInModule": { "filename": "lib/archive.ts", "line": 23 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Infinite", "remarks": "Default value is 0. If set to 0, events are retained indefinitely.", "stability": "stable", "summary": "The number of days to retain events for." }, "immutable": true, "locationInModule": { "filename": "lib/archive.ts", "line": 32 }, "name": "retention", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } } ], "symbolId": "lib/archive:BaseArchiveProps" }, "@aws-cdk/aws-events.CfnApiDestination": { "assembly": "@aws-cdk/aws-events", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Events::ApiDestination", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.\n\nWhen using ApiDesinations with OAuth authentication we recommend these best practices:\n\n- Create a secret in Secrets Manager with your OAuth credentials.\n- Reference that secret in your CloudFormation template for `AWS::Events::Connection` using CloudFormation dynamic reference syntax. For more information, see [Secrets Manager secrets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) .\n\nWhen the Connection resource is created the secret will be passed to EventBridge and stored in the customer account using “Service Linked Secrets,” effectively creating two secrets. This will minimize the cost because the original secret is only accessed when a CloudFormation template is created or updated, not every time an event is sent to the ApiDestination. The secret stored in the customer account by EventBridge is the one used for each event sent to the ApiDestination and AWS is responsible for the fees.\n\n> The secret stored in the customer account by EventBridge can’t be updated directly, only when a CloudFormation template is updated.\n\nFor examples of CloudFormation templates that use secrets, see [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#aws-resource-events-connection--examples) .", "stability": "external", "summary": "A CloudFormation `AWS::Events::ApiDestination`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst cfnApiDestination = new events.CfnApiDestination(this, 'MyCfnApiDestination', {\n connectionArn: 'connectionArn',\n httpMethod: 'httpMethod',\n invocationEndpoint: 'invocationEndpoint',\n\n // the properties below are optional\n description: 'description',\n invocationRateLimitPerSecond: 123,\n name: 'name',\n});" }, "fqn": "@aws-cdk/aws-events.CfnApiDestination", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Events::ApiDestination`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 228 }, "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.CfnApiDestinationProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/events.generated.ts", "line": 148 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 249 }, "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": 265 }, "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": "CfnApiDestination", "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": 152 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "The ARN of the API destination that was created by the request." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 177 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 254 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-connectionarn" }, "remarks": "The destination endpoint must support the authorization type specified for the connection.", "stability": "external", "summary": "The ARN of the connection to use for the API destination." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 184 }, "name": "connectionArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-httpmethod" }, "stability": "external", "summary": "The method to use for the request to the HTTP invocation endpoint." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 191 }, "name": "httpMethod", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationendpoint" }, "stability": "external", "summary": "The URL to the HTTP invocation endpoint for the API destination." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 198 }, "name": "invocationEndpoint", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-description" }, "stability": "external", "summary": "A description for the API destination to create." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 205 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationratelimitpersecond" }, "stability": "external", "summary": "The maximum number of requests per second to send to the HTTP invocation endpoint." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 212 }, "name": "invocationRateLimitPerSecond", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-name" }, "stability": "external", "summary": "The name for the API destination to create." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 219 }, "name": "name", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnApiDestination" }, "@aws-cdk/aws-events.CfnApiDestinationProps": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnApiDestination`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst cfnApiDestinationProps: events.CfnApiDestinationProps = {\n connectionArn: 'connectionArn',\n httpMethod: 'httpMethod',\n invocationEndpoint: 'invocationEndpoint',\n\n // the properties below are optional\n description: 'description',\n invocationRateLimitPerSecond: 123,\n name: 'name',\n};" }, "fqn": "@aws-cdk/aws-events.CfnApiDestinationProps", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 19 }, "name": "CfnApiDestinationProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-connectionarn" }, "remarks": "The destination endpoint must support the authorization type specified for the connection.", "stability": "external", "summary": "The ARN of the connection to use for the API destination." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 26 }, "name": "connectionArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-httpmethod" }, "stability": "external", "summary": "The method to use for the request to the HTTP invocation endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 33 }, "name": "httpMethod", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationendpoint" }, "stability": "external", "summary": "The URL to the HTTP invocation endpoint for the API destination." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 40 }, "name": "invocationEndpoint", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-description" }, "stability": "external", "summary": "A description for the API destination to create." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 47 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationratelimitpersecond" }, "stability": "external", "summary": "The maximum number of requests per second to send to the HTTP invocation endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 54 }, "name": "invocationRateLimitPerSecond", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-name" }, "stability": "external", "summary": "The name for the API destination to create." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 61 }, "name": "name", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnApiDestinationProps" }, "@aws-cdk/aws-events.CfnArchive": { "assembly": "@aws-cdk/aws-events", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Events::Archive", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive.", "stability": "external", "summary": "A CloudFormation `AWS::Events::Archive`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\n\ndeclare const eventPattern: any;\nconst cfnArchive = new events.CfnArchive(this, 'MyCfnArchive', {\n sourceArn: 'sourceArn',\n\n // the properties below are optional\n archiveName: 'archiveName',\n description: 'description',\n eventPattern: eventPattern,\n retentionDays: 123,\n});" }, "fqn": "@aws-cdk/aws-events.CfnArchive", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Events::Archive`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 457 }, "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.CfnArchiveProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/events.generated.ts", "line": 384 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 475 }, "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": 490 }, "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": "CfnArchive", "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": 388 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "The ARN of the archive created." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 413 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 480 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-eventpattern" }, "stability": "external", "summary": "An event pattern to use to filter events sent to the archive." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 441 }, "name": "eventPattern", "type": { "primitive": "any" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-sourcearn" }, "stability": "external", "summary": "The ARN of the event bus that sends events to the archive." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 420 }, "name": "sourceArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-archivename" }, "stability": "external", "summary": "The name for the archive to create." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 427 }, "name": "archiveName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-description" }, "stability": "external", "summary": "A description for the archive." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 434 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-retentiondays" }, "remarks": "Default value is 0. If set to 0, events are retained indefinitely", "stability": "external", "summary": "The number of days to retain events for." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 448 }, "name": "retentionDays", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/events.generated:CfnArchive" }, "@aws-cdk/aws-events.CfnArchiveProps": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnArchive`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\n\ndeclare const eventPattern: any;\nconst cfnArchiveProps: events.CfnArchiveProps = {\n sourceArn: 'sourceArn',\n\n // the properties below are optional\n archiveName: 'archiveName',\n description: 'description',\n eventPattern: eventPattern,\n retentionDays: 123,\n};" }, "fqn": "@aws-cdk/aws-events.CfnArchiveProps", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 278 }, "name": "CfnArchiveProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-sourcearn" }, "stability": "external", "summary": "The ARN of the event bus that sends events to the archive." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 285 }, "name": "sourceArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-archivename" }, "stability": "external", "summary": "The name for the archive to create." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 292 }, "name": "archiveName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-description" }, "stability": "external", "summary": "A description for the archive." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 299 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-eventpattern" }, "stability": "external", "summary": "An event pattern to use to filter events sent to the archive." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 306 }, "name": "eventPattern", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-retentiondays" }, "remarks": "Default value is 0. If set to 0, events are retained indefinitely", "stability": "external", "summary": "The number of days to retain events for." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 313 }, "name": "retentionDays", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/events.generated:CfnArchiveProps" }, "@aws-cdk/aws-events.CfnConnection": { "assembly": "@aws-cdk/aws-events", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Events::Connection", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.", "stability": "external", "summary": "A CloudFormation `AWS::Events::Connection`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst cfnConnection = new events.CfnConnection(this, 'MyCfnConnection', {\n authorizationType: 'authorizationType',\n authParameters: {\n apiKeyAuthParameters: {\n apiKeyName: 'apiKeyName',\n apiKeyValue: 'apiKeyValue',\n },\n basicAuthParameters: {\n password: 'password',\n username: 'username',\n },\n invocationHttpParameters: {\n bodyParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n headerParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n queryStringParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n },\n oAuthParameters: {\n authorizationEndpoint: 'authorizationEndpoint',\n clientParameters: {\n clientId: 'clientId',\n clientSecret: 'clientSecret',\n },\n httpMethod: 'httpMethod',\n\n // the properties below are optional\n oAuthHttpParameters: {\n bodyParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n headerParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n queryStringParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n },\n },\n },\n\n // the properties below are optional\n description: 'description',\n name: 'name',\n});" }, "fqn": "@aws-cdk/aws-events.CfnConnection", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Events::Connection`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 676 }, "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.CfnConnectionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/events.generated.ts", "line": 602 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 695 }, "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": 709 }, "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": "CfnConnection", "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": 606 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "The ARN of the connection that was created by the request." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 631 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "SecretArn" }, "stability": "external", "summary": "The ARN for the secret created for the connection." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 637 }, "name": "attrSecretArn", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 700 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authorizationtype" }, "remarks": "> OAUTH tokens are refreshed when a 401 or 407 response is returned.", "stability": "external", "summary": "The type of authorization to use for the connection." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 646 }, "name": "authorizationType", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authparameters" }, "stability": "external", "summary": "A `CreateConnectionAuthRequestParameters` object that contains the authorization parameters to use to authorize with the endpoint." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 653 }, "name": "authParameters", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnConnection.AuthParametersProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-description" }, "stability": "external", "summary": "A description for the connection to create." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 660 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-name" }, "stability": "external", "summary": "The name for the connection to create." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 667 }, "name": "name", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnConnection" }, "@aws-cdk/aws-events.CfnConnection.ApiKeyAuthParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains the API key authorization parameters for the connection.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst apiKeyAuthParametersProperty: events.CfnConnection.ApiKeyAuthParametersProperty = {\n apiKeyName: 'apiKeyName',\n apiKeyValue: 'apiKeyValue',\n};" }, "fqn": "@aws-cdk/aws-events.CfnConnection.ApiKeyAuthParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 723 }, "name": "ApiKeyAuthParametersProperty", "namespace": "CfnConnection", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html#cfn-events-connection-apikeyauthparameters-apikeyname" }, "stability": "external", "summary": "The name of the API key to use for authorization." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 729 }, "name": "apiKeyName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html#cfn-events-connection-apikeyauthparameters-apikeyvalue" }, "stability": "external", "summary": "The value for the API key to use for authorization." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 735 }, "name": "apiKeyValue", "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnConnection.ApiKeyAuthParametersProperty" }, "@aws-cdk/aws-events.CfnConnection.AuthParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains the authorization parameters to use for the connection.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst authParametersProperty: events.CfnConnection.AuthParametersProperty = {\n apiKeyAuthParameters: {\n apiKeyName: 'apiKeyName',\n apiKeyValue: 'apiKeyValue',\n },\n basicAuthParameters: {\n password: 'password',\n username: 'username',\n },\n invocationHttpParameters: {\n bodyParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n headerParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n queryStringParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n },\n oAuthParameters: {\n authorizationEndpoint: 'authorizationEndpoint',\n clientParameters: {\n clientId: 'clientId',\n clientSecret: 'clientSecret',\n },\n httpMethod: 'httpMethod',\n\n // the properties below are optional\n oAuthHttpParameters: {\n bodyParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n headerParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n queryStringParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n },\n },\n};" }, "fqn": "@aws-cdk/aws-events.CfnConnection.AuthParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 801 }, "name": "AuthParametersProperty", "namespace": "CfnConnection", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-apikeyauthparameters" }, "stability": "external", "summary": "The API Key parameters to use for authorization." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 807 }, "name": "apiKeyAuthParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnConnection.ApiKeyAuthParametersProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-basicauthparameters" }, "stability": "external", "summary": "The authorization parameters for Basic authorization." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 813 }, "name": "basicAuthParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnConnection.BasicAuthParametersProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-invocationhttpparameters" }, "stability": "external", "summary": "Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 819 }, "name": "invocationHttpParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnConnection.ConnectionHttpParametersProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-oauthparameters" }, "stability": "external", "summary": "The OAuth parameters to use for authorization." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 825 }, "name": "oAuthParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnConnection.OAuthParametersProperty" } ] } } } ], "symbolId": "lib/events.generated:CfnConnection.AuthParametersProperty" }, "@aws-cdk/aws-events.CfnConnection.BasicAuthParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains the Basic authorization parameters for the connection.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst basicAuthParametersProperty: events.CfnConnection.BasicAuthParametersProperty = {\n password: 'password',\n username: 'username',\n};" }, "fqn": "@aws-cdk/aws-events.CfnConnection.BasicAuthParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 895 }, "name": "BasicAuthParametersProperty", "namespace": "CfnConnection", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html#cfn-events-connection-basicauthparameters-password" }, "stability": "external", "summary": "The password associated with the user name to use for Basic authorization." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 901 }, "name": "password", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html#cfn-events-connection-basicauthparameters-username" }, "stability": "external", "summary": "The user name to use for Basic authorization." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 907 }, "name": "username", "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnConnection.BasicAuthParametersProperty" }, "@aws-cdk/aws-events.CfnConnection.ClientParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains the OAuth authorization parameters to use for the connection.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst clientParametersProperty: events.CfnConnection.ClientParametersProperty = {\n clientId: 'clientId',\n clientSecret: 'clientSecret',\n};" }, "fqn": "@aws-cdk/aws-events.CfnConnection.ClientParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 973 }, "name": "ClientParametersProperty", "namespace": "CfnConnection", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html#cfn-events-connection-clientparameters-clientid" }, "stability": "external", "summary": "The client ID to use for OAuth authorization." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 979 }, "name": "clientId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html#cfn-events-connection-clientparameters-clientsecret" }, "stability": "external", "summary": "The client secret assciated with the client ID to use for OAuth authorization." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 985 }, "name": "clientSecret", "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnConnection.ClientParametersProperty" }, "@aws-cdk/aws-events.CfnConnection.ConnectionHttpParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains additional parameters for the connection.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst connectionHttpParametersProperty: events.CfnConnection.ConnectionHttpParametersProperty = {\n bodyParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n headerParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n queryStringParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n};" }, "fqn": "@aws-cdk/aws-events.CfnConnection.ConnectionHttpParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 1051 }, "name": "ConnectionHttpParametersProperty", "namespace": "CfnConnection", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-bodyparameters" }, "stability": "external", "summary": "Contains additional body string parameters for the connection." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1057 }, "name": "bodyParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnConnection.ParameterProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-headerparameters" }, "stability": "external", "summary": "Contains additional header parameters for the connection." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1063 }, "name": "headerParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnConnection.ParameterProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-querystringparameters" }, "stability": "external", "summary": "Contains additional query string parameters for the connection." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1069 }, "name": "queryStringParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnConnection.ParameterProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/events.generated:CfnConnection.ConnectionHttpParametersProperty" }, "@aws-cdk/aws-events.CfnConnection.OAuthParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains the OAuth authorization parameters to use for the connection.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst oAuthParametersProperty: events.CfnConnection.OAuthParametersProperty = {\n authorizationEndpoint: 'authorizationEndpoint',\n clientParameters: {\n clientId: 'clientId',\n clientSecret: 'clientSecret',\n },\n httpMethod: 'httpMethod',\n\n // the properties below are optional\n oAuthHttpParameters: {\n bodyParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n headerParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n queryStringParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n },\n};" }, "fqn": "@aws-cdk/aws-events.CfnConnection.OAuthParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 1136 }, "name": "OAuthParametersProperty", "namespace": "CfnConnection", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-authorizationendpoint" }, "stability": "external", "summary": "The URL to the authorization endpoint when OAuth is specified as the authorization type." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1142 }, "name": "authorizationEndpoint", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-clientparameters" }, "stability": "external", "summary": "A `CreateConnectionOAuthClientRequestParameters` object that contains the client parameters for OAuth authorization." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1148 }, "name": "clientParameters", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnConnection.ClientParametersProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-httpmethod" }, "stability": "external", "summary": "The method to use for the authorization request." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1154 }, "name": "httpMethod", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-oauthhttpparameters" }, "stability": "external", "summary": "A `ConnectionHttpParameters` object that contains details about the additional parameters to use for the connection." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1160 }, "name": "oAuthHttpParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnConnection.ConnectionHttpParametersProperty" } ] } } } ], "symbolId": "lib/events.generated:CfnConnection.OAuthParametersProperty" }, "@aws-cdk/aws-events.CfnConnection.ParameterProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html", "exampleMetadata": "fixture=_generated" }, "remarks": "You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.", "stability": "external", "summary": "Additional query string parameter for the connection.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst parameterProperty: events.CfnConnection.ParameterProperty = {\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n};" }, "fqn": "@aws-cdk/aws-events.CfnConnection.ParameterProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 1233 }, "name": "ParameterProperty", "namespace": "CfnConnection", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html#cfn-events-connection-parameter-key" }, "stability": "external", "summary": "The key for a query string parameter." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1245 }, "name": "key", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html#cfn-events-connection-parameter-value" }, "stability": "external", "summary": "The value associated with the key for the query string parameter." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1251 }, "name": "value", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html#cfn-events-connection-parameter-isvaluesecret" }, "stability": "external", "summary": "Specifies whether the value is secret." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1239 }, "name": "isValueSecret", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/events.generated:CfnConnection.ParameterProperty" }, "@aws-cdk/aws-events.CfnConnectionProps": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnConnection`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst cfnConnectionProps: events.CfnConnectionProps = {\n authorizationType: 'authorizationType',\n authParameters: {\n apiKeyAuthParameters: {\n apiKeyName: 'apiKeyName',\n apiKeyValue: 'apiKeyValue',\n },\n basicAuthParameters: {\n password: 'password',\n username: 'username',\n },\n invocationHttpParameters: {\n bodyParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n headerParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n queryStringParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n },\n oAuthParameters: {\n authorizationEndpoint: 'authorizationEndpoint',\n clientParameters: {\n clientId: 'clientId',\n clientSecret: 'clientSecret',\n },\n httpMethod: 'httpMethod',\n\n // the properties below are optional\n oAuthHttpParameters: {\n bodyParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n headerParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n queryStringParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n },\n },\n },\n\n // the properties below are optional\n description: 'description',\n name: 'name',\n};" }, "fqn": "@aws-cdk/aws-events.CfnConnectionProps", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 503 }, "name": "CfnConnectionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authorizationtype" }, "remarks": "> OAUTH tokens are refreshed when a 401 or 407 response is returned.", "stability": "external", "summary": "The type of authorization to use for the connection." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 512 }, "name": "authorizationType", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authparameters" }, "stability": "external", "summary": "A `CreateConnectionAuthRequestParameters` object that contains the authorization parameters to use to authorize with the endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 519 }, "name": "authParameters", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnConnection.AuthParametersProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-description" }, "stability": "external", "summary": "A description for the connection to create." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 526 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-name" }, "stability": "external", "summary": "The name for the connection to create." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 533 }, "name": "name", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnConnectionProps" }, "@aws-cdk/aws-events.CfnEndpoint": { "assembly": "@aws-cdk/aws-events", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Events::Endpoint", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html", "exampleMetadata": "fixture=_generated" }, "remarks": "A global endpoint used to improve your application's availability by making it regional-fault tolerant. For more information about global endpoints, see [Making applications Regional-fault tolerant with global endpoints and event replication](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html) in the *Amazon EventBridge User Guide* .", "stability": "external", "summary": "A CloudFormation `AWS::Events::Endpoint`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst cfnEndpoint = new events.CfnEndpoint(this, 'MyCfnEndpoint', {\n eventBuses: [{\n eventBusArn: 'eventBusArn',\n }],\n routingConfig: {\n failoverConfig: {\n primary: {\n healthCheck: 'healthCheck',\n },\n secondary: {\n route: 'route',\n },\n },\n },\n\n // the properties below are optional\n description: 'description',\n name: 'name',\n replicationConfig: {\n state: 'state',\n },\n roleArn: 'roleArn',\n});" }, "fqn": "@aws-cdk/aws-events.CfnEndpoint", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Events::Endpoint`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1544 }, "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.CfnEndpointProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/events.generated.ts", "line": 1438 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1568 }, "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": 1584 }, "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": "CfnEndpoint", "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": 1442 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "The ARN of the endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1467 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "EndpointId" }, "stability": "external", "summary": "The ID of the endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1473 }, "name": "attrEndpointId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "EndpointUrl" }, "stability": "external", "summary": "The URL of the endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1479 }, "name": "attrEndpointUrl", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "State" }, "stability": "external", "summary": "The current state of the endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1485 }, "name": "attrState", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "StateReason" }, "stability": "external", "summary": "The reason the endpoint is in its current state." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1491 }, "name": "attrStateReason", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1573 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-eventbuses" }, "remarks": "*Exactly* : `2`", "stability": "external", "summary": "The event buses being used by the endpoint." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1500 }, "name": "eventBuses", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnEndpoint.EndpointEventBusProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-routingconfig" }, "stability": "external", "summary": "The routing configuration of the endpoint." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1507 }, "name": "routingConfig", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnEndpoint.RoutingConfigProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-description" }, "stability": "external", "summary": "A description for the endpoint." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1514 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-name" }, "stability": "external", "summary": "The name of the endpoint." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1521 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-replicationconfig" }, "remarks": "The default state is `ENABLED` which means you must supply a `RoleArn` . If you don't have a `RoleArn` or you don't want event replication enabled, set the state to `DISABLED` .", "stability": "external", "summary": "Whether event replication was enabled or disabled for this endpoint." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1528 }, "name": "replicationConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnEndpoint.ReplicationConfigProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-rolearn" }, "stability": "external", "summary": "The ARN of the role used by event replication for the endpoint." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1535 }, "name": "roleArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnEndpoint" }, "@aws-cdk/aws-events.CfnEndpoint.EndpointEventBusProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-endpointeventbus.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "The event buses the endpoint is associated with.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst endpointEventBusProperty: events.CfnEndpoint.EndpointEventBusProperty = {\n eventBusArn: 'eventBusArn',\n};" }, "fqn": "@aws-cdk/aws-events.CfnEndpoint.EndpointEventBusProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 1598 }, "name": "EndpointEventBusProperty", "namespace": "CfnEndpoint", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-endpointeventbus.html#cfn-events-endpoint-endpointeventbus-eventbusarn" }, "stability": "external", "summary": "The ARN of the event bus the endpoint is associated with." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1604 }, "name": "eventBusArn", "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnEndpoint.EndpointEventBusProperty" }, "@aws-cdk/aws-events.CfnEndpoint.FailoverConfigProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-failoverconfig.html", "exampleMetadata": "fixture=_generated" }, "remarks": "This includes what triggers failover and what happens when it's triggered.", "stability": "external", "summary": "The failover configuration for an endpoint.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst failoverConfigProperty: events.CfnEndpoint.FailoverConfigProperty = {\n primary: {\n healthCheck: 'healthCheck',\n },\n secondary: {\n route: 'route',\n },\n};" }, "fqn": "@aws-cdk/aws-events.CfnEndpoint.FailoverConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 1666 }, "name": "FailoverConfigProperty", "namespace": "CfnEndpoint", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-failoverconfig.html#cfn-events-endpoint-failoverconfig-primary" }, "stability": "external", "summary": "The main Region of the endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1672 }, "name": "primary", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnEndpoint.PrimaryProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-failoverconfig.html#cfn-events-endpoint-failoverconfig-secondary" }, "stability": "external", "summary": "The Region that events are routed to when failover is triggered or event replication is enabled." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1678 }, "name": "secondary", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnEndpoint.SecondaryProperty" } ] } } } ], "symbolId": "lib/events.generated:CfnEndpoint.FailoverConfigProperty" }, "@aws-cdk/aws-events.CfnEndpoint.PrimaryProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-primary.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "The primary Region of the endpoint.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst primaryProperty: events.CfnEndpoint.PrimaryProperty = {\n healthCheck: 'healthCheck',\n};" }, "fqn": "@aws-cdk/aws-events.CfnEndpoint.PrimaryProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 1744 }, "name": "PrimaryProperty", "namespace": "CfnEndpoint", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-primary.html#cfn-events-endpoint-primary-healthcheck" }, "stability": "external", "summary": "The ARN of the health check used by the endpoint to determine whether failover is triggered." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1750 }, "name": "healthCheck", "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnEndpoint.PrimaryProperty" }, "@aws-cdk/aws-events.CfnEndpoint.ReplicationConfigProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-replicationconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Endpoints can replicate all events to the secondary Region.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst replicationConfigProperty: events.CfnEndpoint.ReplicationConfigProperty = {\n state: 'state',\n};" }, "fqn": "@aws-cdk/aws-events.CfnEndpoint.ReplicationConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 1812 }, "name": "ReplicationConfigProperty", "namespace": "CfnEndpoint", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-replicationconfig.html#cfn-events-endpoint-replicationconfig-state" }, "stability": "external", "summary": "The state of event replication." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1818 }, "name": "state", "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnEndpoint.ReplicationConfigProperty" }, "@aws-cdk/aws-events.CfnEndpoint.RoutingConfigProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-routingconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "The routing configuration of the endpoint.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst routingConfigProperty: events.CfnEndpoint.RoutingConfigProperty = {\n failoverConfig: {\n primary: {\n healthCheck: 'healthCheck',\n },\n secondary: {\n route: 'route',\n },\n },\n};" }, "fqn": "@aws-cdk/aws-events.CfnEndpoint.RoutingConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 1880 }, "name": "RoutingConfigProperty", "namespace": "CfnEndpoint", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-routingconfig.html#cfn-events-endpoint-routingconfig-failoverconfig" }, "remarks": "This includes what triggers failover and what happens when it's triggered.", "stability": "external", "summary": "The failover configuration for an endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1886 }, "name": "failoverConfig", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnEndpoint.FailoverConfigProperty" } ] } } } ], "symbolId": "lib/events.generated:CfnEndpoint.RoutingConfigProperty" }, "@aws-cdk/aws-events.CfnEndpoint.SecondaryProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-secondary.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "The secondary Region that processes events when failover is triggered or replication is enabled.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst secondaryProperty: events.CfnEndpoint.SecondaryProperty = {\n route: 'route',\n};" }, "fqn": "@aws-cdk/aws-events.CfnEndpoint.SecondaryProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 1948 }, "name": "SecondaryProperty", "namespace": "CfnEndpoint", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-secondary.html#cfn-events-endpoint-secondary-route" }, "stability": "external", "summary": "Defines the secondary Region." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1954 }, "name": "route", "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnEndpoint.SecondaryProperty" }, "@aws-cdk/aws-events.CfnEndpointProps": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnEndpoint`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst cfnEndpointProps: events.CfnEndpointProps = {\n eventBuses: [{\n eventBusArn: 'eventBusArn',\n }],\n routingConfig: {\n failoverConfig: {\n primary: {\n healthCheck: 'healthCheck',\n },\n secondary: {\n route: 'route',\n },\n },\n },\n\n // the properties below are optional\n description: 'description',\n name: 'name',\n replicationConfig: {\n state: 'state',\n },\n roleArn: 'roleArn',\n};" }, "fqn": "@aws-cdk/aws-events.CfnEndpointProps", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 1319 }, "name": "CfnEndpointProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-eventbuses" }, "remarks": "*Exactly* : `2`", "stability": "external", "summary": "The event buses being used by the endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1328 }, "name": "eventBuses", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnEndpoint.EndpointEventBusProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-routingconfig" }, "stability": "external", "summary": "The routing configuration of the endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1335 }, "name": "routingConfig", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnEndpoint.RoutingConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-description" }, "stability": "external", "summary": "A description for the endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1342 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-name" }, "stability": "external", "summary": "The name of the endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1349 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-replicationconfig" }, "remarks": "The default state is `ENABLED` which means you must supply a `RoleArn` . If you don't have a `RoleArn` or you don't want event replication enabled, set the state to `DISABLED` .", "stability": "external", "summary": "Whether event replication was enabled or disabled for this endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1356 }, "name": "replicationConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnEndpoint.ReplicationConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-rolearn" }, "stability": "external", "summary": "The ARN of the role used by event replication for the endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 1363 }, "name": "roleArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnEndpointProps" }, "@aws-cdk/aws-events.CfnEventBus": { "assembly": "@aws-cdk/aws-events", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Events::EventBus", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source.", "stability": "external", "summary": "A CloudFormation `AWS::Events::EventBus`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst cfnEventBus = new events.CfnEventBus(this, 'MyCfnEventBus', {\n name: 'name',\n\n // the properties below are optional\n eventSourceName: 'eventSourceName',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-events.CfnEventBus", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Events::EventBus`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2180 }, "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": 2105 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2198 }, "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": 2211 }, "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": 2109 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "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/events.generated.ts", "line": 2134 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Name" }, "stability": "external", "summary": "The name of the event bus, such as `PartnerName/acct1/repo1` ." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2140 }, "name": "attrName", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Policy" }, "stability": "external", "summary": "The policy for the event bus in JSON form." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2146 }, "name": "attrPolicy", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2203 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name" }, "remarks": "Custom event bus names can't contain the `/` character, but you can use the `/` character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.\n\nYou can't use the name `default` for a custom event bus, as this name is already used for your account's default event bus.", "stability": "external", "summary": "The name of the new event bus." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2157 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename" }, "stability": "external", "summary": "If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2164 }, "name": "eventSourceName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-tags" }, "stability": "external", "summary": "Tags to associate with the event bus." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2171 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-events.CfnEventBus.TagEntryProperty" }, "kind": "array" } } } ], "symbolId": "lib/events.generated:CfnEventBus" }, "@aws-cdk/aws-events.CfnEventBus.TagEntryProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-tagentry.html", "exampleMetadata": "fixture=_generated" }, "remarks": "In EventBridge, rules and event buses support tagging.", "stability": "external", "summary": "A key-value pair associated with an AWS resource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst tagEntryProperty: events.CfnEventBus.TagEntryProperty = {\n key: 'key',\n value: 'value',\n};" }, "fqn": "@aws-cdk/aws-events.CfnEventBus.TagEntryProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 2225 }, "name": "TagEntryProperty", "namespace": "CfnEventBus", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-tagentry.html#cfn-events-eventbus-tagentry-key" }, "remarks": "The combination of tag keys and values can help you organize and categorize your resources.", "stability": "external", "summary": "A string you can use to assign a value." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2231 }, "name": "key", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-tagentry.html#cfn-events-eventbus-tagentry-value" }, "stability": "external", "summary": "The value for the specified tag key." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2237 }, "name": "value", "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnEventBus.TagEntryProperty" }, "@aws-cdk/aws-events.CfnEventBusPolicy": { "assembly": "@aws-cdk/aws-events", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Events::EventBusPolicy", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Running `PutPermission` permits the specified AWS account or AWS organization to put events to the specified *event bus* . Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account.\n\nFor another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target.\n\nTo enable multiple AWS accounts to put events to your event bus, run `PutPermission` once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run `PutPermission` once specifying `Principal` as \"*\" and specifying the AWS organization ID in `Condition` , to grant permissions to all accounts in that organization.\n\nIf you grant permissions using an organization, then accounts in that organization must specify a `RoleArn` with proper permissions when they use `PutTarget` to add your account's event bus as a target. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide* .\n\nThe permission policy on the event bus cannot exceed 10 KB in size.", "stability": "external", "summary": "A CloudFormation `AWS::Events::EventBusPolicy`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\n\ndeclare const statement: any;\nconst cfnEventBusPolicy = new events.CfnEventBusPolicy(this, 'MyCfnEventBusPolicy', {\n statementId: 'statementId',\n\n // the properties below are optional\n action: 'action',\n condition: {\n key: 'key',\n type: 'type',\n value: 'value',\n },\n eventBusName: 'eventBusName',\n principal: 'principal',\n statement: statement,\n});" }, "fqn": "@aws-cdk/aws-events.CfnEventBusPolicy", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Events::EventBusPolicy`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2516 }, "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": 2434 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2534 }, "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": 2550 }, "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": 2438 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2539 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statement" }, "remarks": "You can include a `Policy` parameter in the request instead of using the `StatementId` , `Action` , `Principal` , or `Condition` parameters.", "stability": "external", "summary": "A JSON string that describes the permission policy statement." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2507 }, "name": "statement", "type": { "primitive": "any" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statementid" }, "remarks": "If you later want to revoke the permission for this external account, specify this `StatementId` when you run [RemovePermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html) .\n\n> Each `StatementId` must be unique.", "stability": "external", "summary": "An identifier string for the external account that you are granting permissions to." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2466 }, "name": "statementId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-action" }, "stability": "external", "summary": "The action that you are enabling the other account to perform." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2473 }, "name": "action", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-condition" }, "remarks": "For more information about AWS Organizations, see [What Is AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html) in the *AWS Organizations User Guide* .\n\nIf you specify `Condition` with an AWS organization ID, and specify \"*\" as the value for `Principal` , you grant permission to all the accounts in the named organization.\n\nThe `Condition` is a JSON string which must contain `Type` , `Key` , and `Value` fields.", "stability": "external", "summary": "This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2484 }, "name": "condition", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnEventBusPolicy.ConditionProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-eventbusname" }, "remarks": "If you omit this, the default event bus is used.", "stability": "external", "summary": "The name of the event bus associated with the rule." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2491 }, "name": "eventBusName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-principal" }, "remarks": "Specify \"*\" to permit any account to put events to your default event bus.\n\nIf you specify \"*\" without specifying `Condition` , avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an `account` field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.", "stability": "external", "summary": "The 12-digit AWS account ID that you are permitting to put events to your default event bus." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2500 }, "name": "principal", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnEventBusPolicy" }, "@aws-cdk/aws-events.CfnEventBusPolicy.ConditionProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Currently, the only supported condition is membership in a certain AWS organization. The string must contain `Type` , `Key` , and `Value` fields. The `Value` field specifies the ID of the AWS organization. Following is an example value for `Condition` :\n\n`'{\"Type\" : \"StringEquals\", \"Key\": \"aws:PrincipalOrgID\", \"Value\": \"o-1234567890\"}'`", "stability": "external", "summary": "A JSON string which you can use to limit the event bus permissions you are granting to only accounts that fulfill the condition.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst conditionProperty: events.CfnEventBusPolicy.ConditionProperty = {\n key: 'key',\n type: 'type',\n value: 'value',\n};" }, "fqn": "@aws-cdk/aws-events.CfnEventBusPolicy.ConditionProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 2566 }, "name": "ConditionProperty", "namespace": "CfnEventBusPolicy", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html#cfn-events-eventbuspolicy-condition-key" }, "remarks": "Currently the only supported key is `aws:PrincipalOrgID` .", "stability": "external", "summary": "Specifies the key for the condition." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2572 }, "name": "key", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html#cfn-events-eventbuspolicy-condition-type" }, "remarks": "Currently the only supported value is `StringEquals` .", "stability": "external", "summary": "Specifies the type of condition." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2578 }, "name": "type", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html#cfn-events-eventbuspolicy-condition-value" }, "remarks": "Currently, this must be the ID of the organization.", "stability": "external", "summary": "Specifies the value for the key." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2584 }, "name": "value", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnEventBusPolicy.ConditionProperty" }, "@aws-cdk/aws-events.CfnEventBusPolicyProps": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnEventBusPolicy`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\n\ndeclare const statement: any;\nconst cfnEventBusPolicyProps: events.CfnEventBusPolicyProps = {\n statementId: 'statementId',\n\n // the properties below are optional\n action: 'action',\n condition: {\n key: 'key',\n type: 'type',\n value: 'value',\n },\n eventBusName: 'eventBusName',\n principal: 'principal',\n statement: statement,\n};" }, "fqn": "@aws-cdk/aws-events.CfnEventBusPolicyProps", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 2302 }, "name": "CfnEventBusPolicyProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statementid" }, "remarks": "If you later want to revoke the permission for this external account, specify this `StatementId` when you run [RemovePermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html) .\n\n> Each `StatementId` must be unique.", "stability": "external", "summary": "An identifier string for the external account that you are granting permissions to." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2311 }, "name": "statementId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-action" }, "stability": "external", "summary": "The action that you are enabling the other account to perform." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2318 }, "name": "action", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-condition" }, "remarks": "For more information about AWS Organizations, see [What Is AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html) in the *AWS Organizations User Guide* .\n\nIf you specify `Condition` with an AWS organization ID, and specify \"*\" as the value for `Principal` , you grant permission to all the accounts in the named organization.\n\nThe `Condition` is a JSON string which must contain `Type` , `Key` , and `Value` fields.", "stability": "external", "summary": "This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2329 }, "name": "condition", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnEventBusPolicy.ConditionProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-eventbusname" }, "remarks": "If you omit this, the default event bus is used.", "stability": "external", "summary": "The name of the event bus associated with the rule." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2336 }, "name": "eventBusName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-principal" }, "remarks": "Specify \"*\" to permit any account to put events to your default event bus.\n\nIf you specify \"*\" without specifying `Condition` , avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an `account` field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.", "stability": "external", "summary": "The 12-digit AWS account ID that you are permitting to put events to your default event bus." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2345 }, "name": "principal", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statement" }, "remarks": "You can include a `Policy` parameter in the request instead of using the `StatementId` , `Action` , `Principal` , or `Condition` parameters.", "stability": "external", "summary": "A JSON string that describes the permission policy statement." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2352 }, "name": "statement", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/events.generated:CfnEventBusPolicyProps" }, "@aws-cdk/aws-events.CfnEventBusProps": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnEventBus`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst cfnEventBusProps: events.CfnEventBusProps = {\n name: 'name',\n\n // the properties below are optional\n eventSourceName: 'eventSourceName',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-events.CfnEventBusProps", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 2015 }, "name": "CfnEventBusProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name" }, "remarks": "Custom event bus names can't contain the `/` character, but you can use the `/` character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.\n\nYou can't use the name `default` for a custom event bus, as this name is already used for your account's default event bus.", "stability": "external", "summary": "The name of the new event bus." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2026 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename" }, "stability": "external", "summary": "If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2033 }, "name": "eventSourceName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-tags" }, "stability": "external", "summary": "Tags to associate with the event bus." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2040 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-events.CfnEventBus.TagEntryProperty" }, "kind": "array" } } } ], "symbolId": "lib/events.generated:CfnEventBusProps" }, "@aws-cdk/aws-events.CfnRule": { "assembly": "@aws-cdk/aws-events", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Events::Rule", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using [DisableRule](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html) .\n\nA single rule watches for events from a single event bus. Events generated by AWS services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see [CreateEventBus](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html) .\n\nIf you are updating an existing rule, the rule is replaced with what you specify in this `PutRule` command. If you omit arguments in `PutRule` , the old values for those arguments are not kept. Instead, they are replaced with null values.\n\nWhen you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect.\n\nA rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.\n\nMost services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.\n\nIn EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.\n\nTo prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.\n\nAn infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see [Managing Your Costs with Budgets](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html) .", "stability": "external", "summary": "A CloudFormation `AWS::Events::Rule`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\n\ndeclare const eventPattern: any;\nconst cfnRule = new events.CfnRule(this, 'MyCfnRule', /* all optional props */ {\n description: 'description',\n eventBusName: 'eventBusName',\n eventPattern: eventPattern,\n name: 'name',\n roleArn: 'roleArn',\n scheduleExpression: 'scheduleExpression',\n state: 'state',\n targets: [{\n arn: 'arn',\n id: 'id',\n\n // the properties below are optional\n batchParameters: {\n jobDefinition: 'jobDefinition',\n jobName: 'jobName',\n\n // the properties below are optional\n arrayProperties: {\n size: 123,\n },\n retryStrategy: {\n attempts: 123,\n },\n },\n deadLetterConfig: {\n arn: 'arn',\n },\n ecsParameters: {\n taskDefinitionArn: 'taskDefinitionArn',\n\n // the properties below are optional\n capacityProviderStrategy: [{\n capacityProvider: 'capacityProvider',\n\n // the properties below are optional\n base: 123,\n weight: 123,\n }],\n enableEcsManagedTags: false,\n enableExecuteCommand: false,\n group: 'group',\n launchType: 'launchType',\n networkConfiguration: {\n awsVpcConfiguration: {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n },\n },\n placementConstraints: [{\n expression: 'expression',\n type: 'type',\n }],\n placementStrategies: [{\n field: 'field',\n type: 'type',\n }],\n platformVersion: 'platformVersion',\n propagateTags: 'propagateTags',\n referenceId: 'referenceId',\n tagList: [{\n key: 'key',\n value: 'value',\n }],\n taskCount: 123,\n },\n httpParameters: {\n headerParameters: {\n headerParametersKey: 'headerParameters',\n },\n pathParameterValues: ['pathParameterValues'],\n queryStringParameters: {\n queryStringParametersKey: 'queryStringParameters',\n },\n },\n input: 'input',\n inputPath: 'inputPath',\n inputTransformer: {\n inputTemplate: 'inputTemplate',\n\n // the properties below are optional\n inputPathsMap: {\n inputPathsMapKey: 'inputPathsMap',\n },\n },\n kinesisParameters: {\n partitionKeyPath: 'partitionKeyPath',\n },\n redshiftDataParameters: {\n database: 'database',\n sql: 'sql',\n\n // the properties below are optional\n dbUser: 'dbUser',\n secretManagerArn: 'secretManagerArn',\n statementName: 'statementName',\n withEvent: false,\n },\n retryPolicy: {\n maximumEventAgeInSeconds: 123,\n maximumRetryAttempts: 123,\n },\n roleArn: 'roleArn',\n runCommandParameters: {\n runCommandTargets: [{\n key: 'key',\n values: ['values'],\n }],\n },\n sageMakerPipelineParameters: {\n pipelineParameterList: [{\n name: 'name',\n value: 'value',\n }],\n },\n sqsParameters: {\n messageGroupId: 'messageGroupId',\n },\n }],\n});" }, "fqn": "@aws-cdk/aws-events.CfnRule", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Events::Rule`." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2993 }, "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": 2850 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3013 }, "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": 3031 }, "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": 2854 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "The ARN of the rule, such as `arn:aws:events:us-east-2:123456789012:rule/example` ." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2879 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3018 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern" }, "remarks": "For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide* .", "stability": "external", "summary": "The event pattern of the rule." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2900 }, "name": "eventPattern", "type": { "primitive": "any" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description" }, "stability": "external", "summary": "The description of the rule." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2886 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname" }, "remarks": "If you omit this, the default event bus is used.", "stability": "external", "summary": "The name or ARN of the event bus associated with the rule." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2893 }, "name": "eventBusName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name" }, "stability": "external", "summary": "The name of the rule." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2907 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-rolearn" }, "remarks": "If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a `RoleArn` with proper permissions in the `Target` structure, instead of here in this parameter.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the role that is used for target invocation." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2916 }, "name": "roleArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression" }, "remarks": "For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\". For more information, see [Creating an Amazon EventBridge rule that runs on a schedule](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html) .", "stability": "external", "summary": "The scheduling expression." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2923 }, "name": "scheduleExpression", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state" }, "stability": "external", "summary": "The state of the rule." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2930 }, "name": "state", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets" }, "remarks": "Targets are the resources that are invoked when a rule is triggered.\n\nThe maximum number of entries per request is 10.\n\n> Each rule can have up to five (5) targets associated with it at one time.\n\nFor a list of services you can configure as targets for events, see [EventBridge targets](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html) in the *Amazon EventBridge User Guide* .\n\nCreating rules with built-in targets is supported only in the AWS Management Console . The built-in targets are:\n\n- `Amazon EBS CreateSnapshot API call`\n- `Amazon EC2 RebootInstances API call`\n- `Amazon EC2 StopInstances API call`\n- `Amazon EC2 TerminateInstances API call`\n\nFor some target types, `PutTargets` provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the `KinesisParameters` argument. To invoke a command on multiple EC2 instances with one rule, you can use the `RunCommandParameters` field.\n\nTo be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions:\n\n- For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.\n- For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets` .\n\nFor more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the *Amazon EventBridge User Guide* .\n\nIf another AWS account is in the same region and has granted you permission (using `PutPermission` ), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the `Arn` value when you run `PutTargets` . If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see [Amazon EventBridge Pricing](https://docs.aws.amazon.com/eventbridge/pricing/) .\n\n> `Input` , `InputPath` , and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account.\n\nIf you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide* .\n\n> If you have an IAM role on a cross-account event bus target, a `PutTargets` call without a role on the same target (same `Id` and `Arn` ) will not remove the role.\n\nFor more information about enabling cross-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html) .\n\n*Input* , *InputPath* , and *InputTransformer* are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:\n\n- If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).\n- If *Input* is specified in the form of valid JSON, then the matched event is overridden with this constant.\n- If *InputPath* is specified in the form of JSONPath (for example, `$.detail` ), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).\n- If *InputTransformer* is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.\n\nWhen you specify `InputPath` or `InputTransformer` , you must use JSON dot notation, not bracket notation.\n\nWhen you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.\n\nThis action can partially fail if too many requests are made at the same time. If that happens, `FailedEntryCount` is non-zero in the response and each entry in `FailedEntries` provides the ID of the failed target and the error code.", "stability": "external", "summary": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule." }, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2984 }, "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" } } ] } } } ], "symbolId": "lib/events.generated:CfnRule" }, "@aws-cdk/aws-events.CfnRule.AwsVpcConfigurationProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html", "exampleMetadata": "fixture=_generated" }, "remarks": "This structure is relevant only for ECS tasks that use the `awsvpc` network mode.", "stability": "external", "summary": "This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst awsVpcConfigurationProperty: events.CfnRule.AwsVpcConfigurationProperty = {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.AwsVpcConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 3045 }, "name": "AwsVpcConfigurationProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-subnets" }, "remarks": "These subnets must all be in the same VPC. You can specify as many as 16 subnets.", "stability": "external", "summary": "Specifies the subnets associated with the task." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3063 }, "name": "subnets", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-assignpublicip" }, "remarks": "You can specify `ENABLED` only when `LaunchType` in `EcsParameters` is set to `FARGATE` .", "stability": "external", "summary": "Specifies whether the task's elastic network interface receives a public IP address." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3051 }, "name": "assignPublicIp", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-securitygroups" }, "remarks": "These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.", "stability": "external", "summary": "Specifies the security groups associated with the task." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3057 }, "name": "securityGroups", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/events.generated:CfnRule.AwsVpcConfigurationProperty" }, "@aws-cdk/aws-events.CfnRule.BatchArrayPropertiesProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batcharrayproperties.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.", "stability": "external", "summary": "The array properties for the submitted job, such as the size of the array.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst batchArrayPropertiesProperty: events.CfnRule.BatchArrayPropertiesProperty = {\n size: 123,\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.BatchArrayPropertiesProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 3131 }, "name": "BatchArrayPropertiesProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batcharrayproperties.html#cfn-events-rule-batcharrayproperties-size" }, "remarks": "Valid values are integers between 2 and 10,000.", "stability": "external", "summary": "The size of the array, if this is an array batch job." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3137 }, "name": "size", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/events.generated:CfnRule.BatchArrayPropertiesProperty" }, "@aws-cdk/aws-events.CfnRule.BatchParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "The custom parameters to be used when the target is an AWS Batch job.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst batchParametersProperty: events.CfnRule.BatchParametersProperty = {\n jobDefinition: 'jobDefinition',\n jobName: 'jobName',\n\n // the properties below are optional\n arrayProperties: {\n size: 123,\n },\n retryStrategy: {\n attempts: 123,\n },\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.BatchParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 3198 }, "name": "BatchParametersProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-jobdefinition" }, "remarks": "This job definition must already exist.", "stability": "external", "summary": "The ARN or name of the job definition to use if the event target is an AWS Batch job." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3210 }, "name": "jobDefinition", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-jobname" }, "stability": "external", "summary": "The name to use for this execution of the job, if the target is an AWS Batch job." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3216 }, "name": "jobName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-arrayproperties" }, "remarks": "The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.", "stability": "external", "summary": "The array properties for the submitted job, such as the size of the array." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3204 }, "name": "arrayProperties", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.BatchArrayPropertiesProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-retrystrategy" }, "remarks": "The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.", "stability": "external", "summary": "The retry strategy to use for failed jobs, if the target is an AWS Batch job." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3222 }, "name": "retryStrategy", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.BatchRetryStrategyProperty" } ] } } } ], "symbolId": "lib/events.generated:CfnRule.BatchParametersProperty" }, "@aws-cdk/aws-events.CfnRule.BatchRetryStrategyProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchretrystrategy.html", "exampleMetadata": "fixture=_generated" }, "remarks": "If you specify a retry strategy here, it overrides the retry strategy defined in the job definition.", "stability": "external", "summary": "The retry strategy to use for failed jobs, if the target is an AWS Batch job.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst batchRetryStrategyProperty: events.CfnRule.BatchRetryStrategyProperty = {\n attempts: 123,\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.BatchRetryStrategyProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 3294 }, "name": "BatchRetryStrategyProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchretrystrategy.html#cfn-events-rule-batchretrystrategy-attempts" }, "remarks": "Valid values are 1–10.", "stability": "external", "summary": "The number of times to attempt to retry, if the job fails." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3300 }, "name": "attempts", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/events.generated:CfnRule.BatchRetryStrategyProperty" }, "@aws-cdk/aws-events.CfnRule.CapacityProviderStrategyItemProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html", "exampleMetadata": "fixture=_generated" }, "remarks": "To learn more, see [CapacityProviderStrategyItem](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) in the Amazon ECS API Reference.", "stability": "external", "summary": "The details of a capacity provider strategy.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst capacityProviderStrategyItemProperty: events.CfnRule.CapacityProviderStrategyItemProperty = {\n capacityProvider: 'capacityProvider',\n\n // the properties below are optional\n base: 123,\n weight: 123,\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.CapacityProviderStrategyItemProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 3361 }, "name": "CapacityProviderStrategyItemProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html#cfn-events-rule-capacityproviderstrategyitem-capacityprovider" }, "stability": "external", "summary": "The short name of the capacity provider." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3373 }, "name": "capacityProvider", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html#cfn-events-rule-capacityproviderstrategyitem-base" }, "remarks": "Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.", "stability": "external", "summary": "The base value designates how many tasks, at a minimum, to run on the specified capacity provider." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3367 }, "name": "base", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html#cfn-events-rule-capacityproviderstrategyitem-weight" }, "remarks": "The weight value is taken into consideration after the base value, if defined, is satisfied.", "stability": "external", "summary": "The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3379 }, "name": "weight", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/events.generated:CfnRule.CapacityProviderStrategyItemProperty" }, "@aws-cdk/aws-events.CfnRule.DeadLetterConfigProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "A `DeadLetterConfig` object that contains information about a dead-letter queue configuration.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst deadLetterConfigProperty: events.CfnRule.DeadLetterConfigProperty = {\n arn: 'arn',\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.DeadLetterConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 3447 }, "name": "DeadLetterConfigProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn" }, "stability": "external", "summary": "The ARN of the SQS queue specified as the target for the dead-letter queue." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3453 }, "name": "arn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnRule.DeadLetterConfigProperty" }, "@aws-cdk/aws-events.CfnRule.EcsParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "The custom parameters to be used when the target is an Amazon ECS task.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst ecsParametersProperty: events.CfnRule.EcsParametersProperty = {\n taskDefinitionArn: 'taskDefinitionArn',\n\n // the properties below are optional\n capacityProviderStrategy: [{\n capacityProvider: 'capacityProvider',\n\n // the properties below are optional\n base: 123,\n weight: 123,\n }],\n enableEcsManagedTags: false,\n enableExecuteCommand: false,\n group: 'group',\n launchType: 'launchType',\n networkConfiguration: {\n awsVpcConfiguration: {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n },\n },\n placementConstraints: [{\n expression: 'expression',\n type: 'type',\n }],\n placementStrategies: [{\n field: 'field',\n type: 'type',\n }],\n platformVersion: 'platformVersion',\n propagateTags: 'propagateTags',\n referenceId: 'referenceId',\n tagList: [{\n key: 'key',\n value: 'value',\n }],\n taskCount: 123,\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.EcsParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 3514 }, "name": "EcsParametersProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskdefinitionarn" }, "stability": "external", "summary": "The ARN of the task definition to use if the event target is an Amazon ECS task." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3604 }, "name": "taskDefinitionArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-capacityproviderstrategy" }, "remarks": "If a `capacityProviderStrategy` is specified, the `launchType` parameter must be omitted. If no `capacityProviderStrategy` or launchType is specified, the `defaultCapacityProviderStrategy` for the cluster is used.", "stability": "external", "summary": "The capacity provider strategy to use for the task." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3522 }, "name": "capacityProviderStrategy", "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.CapacityProviderStrategyItemProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-enableecsmanagedtags" }, "remarks": "For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the Amazon Elastic Container Service Developer Guide.", "stability": "external", "summary": "Specifies whether to enable Amazon ECS managed tags for the task." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3528 }, "name": "enableEcsManagedTags", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-enableexecutecommand" }, "remarks": "If true, this enables execute command functionality on all containers in the task.", "stability": "external", "summary": "Whether or not to enable the execute command functionality for the containers in this task." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3534 }, "name": "enableExecuteCommand", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-group" }, "remarks": "The maximum length is 255 characters.", "stability": "external", "summary": "Specifies an ECS task group for the task." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3540 }, "name": "group", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-launchtype" }, "remarks": "The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The `FARGATE` value is supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more information, see [AWS Fargate on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) in the *Amazon Elastic Container Service Developer Guide* .", "stability": "external", "summary": "Specifies the launch type on which your task is running." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3546 }, "name": "launchType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-networkconfiguration" }, "remarks": "This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if `LaunchType` is `FARGATE` because the `awsvpc` mode is required for Fargate tasks.\n\nIf you specify `NetworkConfiguration` when the target ECS task does not use the `awsvpc` network mode, the task fails.", "stability": "external", "summary": "Use this structure if the Amazon ECS task uses the `awsvpc` network mode." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3554 }, "name": "networkConfiguration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.NetworkConfigurationProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-placementconstraints" }, "remarks": "You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).", "stability": "external", "summary": "An array of placement constraint objects to use for the task." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3560 }, "name": "placementConstraints", "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.PlacementConstraintProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-placementstrategies" }, "remarks": "You can specify a maximum of five strategy rules per task.", "stability": "external", "summary": "The placement strategy objects to use for the task." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3566 }, "name": "placementStrategies", "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.PlacementStrategyProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-platformversion" }, "remarks": "Specify only the numeric portion of the platform version, such as `1.1.0` .\n\nThis structure is used only if `LaunchType` is `FARGATE` . For more information about valid platform versions, see [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide* .", "stability": "external", "summary": "Specifies the platform version for the task." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3574 }, "name": "platformVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-propagatetags" }, "remarks": "If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.", "stability": "external", "summary": "Specifies whether to propagate the tags from the task definition to the task." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3580 }, "name": "propagateTags", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-referenceid" }, "stability": "external", "summary": "The reference ID to use for the task." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3586 }, "name": "referenceId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taglist" }, "remarks": "Each tag consists of a key and an optional value, both of which you define. To learn more, see [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) in the Amazon ECS API Reference.", "stability": "external", "summary": "The metadata that you apply to the task to help you categorize and organize them." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3592 }, "name": "tagList", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/core.CfnTag" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskcount" }, "remarks": "The default is 1.", "stability": "external", "summary": "The number of tasks to create based on `TaskDefinition` ." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3598 }, "name": "taskCount", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/events.generated:CfnRule.EcsParametersProperty" }, "@aws-cdk/aws-events.CfnRule.HttpParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html", "exampleMetadata": "fixture=_generated" }, "remarks": "In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.", "stability": "external", "summary": "These are custom parameter to be used when the target is an API Gateway APIs or EventBridge ApiDestinations.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst httpParametersProperty: events.CfnRule.HttpParametersProperty = {\n headerParameters: {\n headerParametersKey: 'headerParameters',\n },\n pathParameterValues: ['pathParameterValues'],\n queryStringParameters: {\n queryStringParametersKey: 'queryStringParameters',\n },\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.HttpParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 3705 }, "name": "HttpParametersProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-headerparameters" }, "stability": "external", "summary": "The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3711 }, "name": "headerParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-pathparametervalues" }, "stability": "external", "summary": "The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards (\"*\")." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3717 }, "name": "pathParameterValues", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-querystringparameters" }, "stability": "external", "summary": "The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3723 }, "name": "queryStringParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } } ], "symbolId": "lib/events.generated:CfnRule.HttpParametersProperty" }, "@aws-cdk/aws-events.CfnRule.InputTransformerProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst inputTransformerProperty: events.CfnRule.InputTransformerProperty = {\n inputTemplate: 'inputTemplate',\n\n // the properties below are optional\n inputPathsMap: {\n inputPathsMapKey: 'inputPathsMap',\n },\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.InputTransformerProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 3790 }, "name": "InputTransformerProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html#cfn-events-rule-inputtransformer-inputtemplate" }, "remarks": "Enclose each `InputPathsMaps` value in brackets: < *value* >\n\nIf `InputTemplate` is a JSON object (surrounded by curly braces), the following restrictions apply:\n\n- The placeholder cannot be used as an object key.\n\nThe following example shows the syntax for using `InputPathsMap` and `InputTemplate` .\n\n`\"InputTransformer\":`\n\n`{`\n\n`\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},`\n\n`\"InputTemplate\": \" is in state \"`\n\n`}`\n\nTo have the `InputTemplate` include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:\n\n`\"InputTransformer\":`\n\n`{`\n\n`\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},`\n\n`\"InputTemplate\": \" is in state \\\"\\\"\"`\n\n`}`\n\nThe `InputTemplate` can also be valid JSON with varibles in quotes or out, as in the following example:\n\n`\"InputTransformer\":`\n\n`{`\n\n`\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},`\n\n`\"InputTemplate\": '{\"myInstance\": ,\"myStatus\": \" is in state \\\"\\\"\"}'`\n\n`}`", "stability": "external", "summary": "Input template where you specify placeholders that will be filled with the values of the keys from `InputPathsMap` to customize the data sent to the target." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3846 }, "name": "inputTemplate", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html#cfn-events-rule-inputtransformer-inputpathsmap" }, "remarks": "You can then insert these in the template in `InputTemplate` to produce the output you want to be sent to the target.\n\n`InputPathsMap` is an array key-value pairs, where each value is a valid JSON path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket notation.\n\nThe keys cannot start with \" AWS .\"", "stability": "external", "summary": "Map of JSON paths to be extracted from the event." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3800 }, "name": "inputPathsMap", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } } ], "symbolId": "lib/events.generated:CfnRule.InputTransformerProperty" }, "@aws-cdk/aws-events.CfnRule.KinesisParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html", "exampleMetadata": "fixture=_generated" }, "remarks": "If you do not include this parameter, the default is to use the `eventId` as the partition key.", "stability": "external", "summary": "This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis data stream, so that you can control the shard to which the event goes.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst kinesisParametersProperty: events.CfnRule.KinesisParametersProperty = {\n partitionKeyPath: 'partitionKeyPath',\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.KinesisParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 3911 }, "name": "KinesisParametersProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html#cfn-events-rule-kinesisparameters-partitionkeypath" }, "remarks": "For more information, see [Amazon Kinesis Streams Key Concepts](https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key) in the *Amazon Kinesis Streams Developer Guide* .", "stability": "external", "summary": "The JSON path to be extracted from the event and used as the partition key." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3917 }, "name": "partitionKeyPath", "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnRule.KinesisParametersProperty" }, "@aws-cdk/aws-events.CfnRule.NetworkConfigurationProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-networkconfiguration.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "This structure specifies the network configuration for an ECS task.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst networkConfigurationProperty: events.CfnRule.NetworkConfigurationProperty = {\n awsVpcConfiguration: {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n },\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.NetworkConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 3979 }, "name": "NetworkConfigurationProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-networkconfiguration.html#cfn-events-rule-networkconfiguration-awsvpcconfiguration" }, "remarks": "This structure is relevant only for ECS tasks that use the `awsvpc` network mode.", "stability": "external", "summary": "Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 3985 }, "name": "awsVpcConfiguration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.AwsVpcConfigurationProperty" } ] } } } ], "symbolId": "lib/events.generated:CfnRule.NetworkConfigurationProperty" }, "@aws-cdk/aws-events.CfnRule.PlacementConstraintProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementconstraint.html", "exampleMetadata": "fixture=_generated" }, "remarks": "To learn more, see [Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the Amazon Elastic Container Service Developer Guide.", "stability": "external", "summary": "An object representing a constraint on task placement.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst placementConstraintProperty: events.CfnRule.PlacementConstraintProperty = {\n expression: 'expression',\n type: 'type',\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.PlacementConstraintProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 4046 }, "name": "PlacementConstraintProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementconstraint.html#cfn-events-rule-placementconstraint-expression" }, "remarks": "You cannot specify an expression if the constraint type is `distinctInstance` . To learn more, see [Cluster Query Language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the Amazon Elastic Container Service Developer Guide.", "stability": "external", "summary": "A cluster query language expression to apply to the constraint." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4052 }, "name": "expression", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementconstraint.html#cfn-events-rule-placementconstraint-type" }, "remarks": "Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.", "stability": "external", "summary": "The type of constraint." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4058 }, "name": "type", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnRule.PlacementConstraintProperty" }, "@aws-cdk/aws-events.CfnRule.PlacementStrategyProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementstrategy.html", "exampleMetadata": "fixture=_generated" }, "remarks": "To learn more, see [Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the Amazon Elastic Container Service Service Developer Guide.", "stability": "external", "summary": "The task placement strategy for a task or service.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst placementStrategyProperty: events.CfnRule.PlacementStrategyProperty = {\n field: 'field',\n type: 'type',\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.PlacementStrategyProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 4122 }, "name": "PlacementStrategyProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementstrategy.html#cfn-events-rule-placementstrategy-field" }, "remarks": "For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.", "stability": "external", "summary": "The field to apply the placement strategy against." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4128 }, "name": "field", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementstrategy.html#cfn-events-rule-placementstrategy-type" }, "remarks": "The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).", "stability": "external", "summary": "The type of placement strategy." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4134 }, "name": "type", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnRule.PlacementStrategyProperty" }, "@aws-cdk/aws-events.CfnRule.RedshiftDataParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst redshiftDataParametersProperty: events.CfnRule.RedshiftDataParametersProperty = {\n database: 'database',\n sql: 'sql',\n\n // the properties below are optional\n dbUser: 'dbUser',\n secretManagerArn: 'secretManagerArn',\n statementName: 'statementName',\n withEvent: false,\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.RedshiftDataParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 4198 }, "name": "RedshiftDataParametersProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-database" }, "remarks": "Required when authenticating using temporary credentials.", "stability": "external", "summary": "The name of the database." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4204 }, "name": "database", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-sql" }, "stability": "external", "summary": "The SQL statement text to run." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4222 }, "name": "sql", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-dbuser" }, "remarks": "Required when authenticating using temporary credentials.", "stability": "external", "summary": "The database user name." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4210 }, "name": "dbUser", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-secretmanagerarn" }, "remarks": "Required when authenticating using AWS Secrets Manager.", "stability": "external", "summary": "The name or ARN of the secret that enables access to the database." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4216 }, "name": "secretManagerArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-statementname" }, "remarks": "You can name the SQL statement when you create it to identify the query.", "stability": "external", "summary": "The name of the SQL statement." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4228 }, "name": "statementName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-withevent" }, "stability": "external", "summary": "Indicates whether to send an event back to EventBridge after the SQL statement runs." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4234 }, "name": "withEvent", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/events.generated:CfnRule.RedshiftDataParametersProperty" }, "@aws-cdk/aws-events.CfnRule.RetryPolicyProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-retrypolicy.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "A `RetryPolicy` object that includes information about the retry policy settings.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst retryPolicyProperty: events.CfnRule.RetryPolicyProperty = {\n maximumEventAgeInSeconds: 123,\n maximumRetryAttempts: 123,\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.RetryPolicyProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 4312 }, "name": "RetryPolicyProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-retrypolicy.html#cfn-events-rule-retrypolicy-maximumeventageinseconds" }, "stability": "external", "summary": "The maximum amount of time, in seconds, to continue to make retry attempts." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4318 }, "name": "maximumEventAgeInSeconds", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-retrypolicy.html#cfn-events-rule-retrypolicy-maximumretryattempts" }, "remarks": "Retry attempts continue until either the maximum number of attempts is made or until the duration of the `MaximumEventAgeInSeconds` is met.", "stability": "external", "summary": "The maximum number of retry attempts to make before the request fails." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4324 }, "name": "maximumRetryAttempts", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/events.generated:CfnRule.RetryPolicyProperty" }, "@aws-cdk/aws-events.CfnRule.RunCommandParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandparameters.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances are to be sent the command.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst runCommandParametersProperty: events.CfnRule.RunCommandParametersProperty = {\n runCommandTargets: [{\n key: 'key',\n values: ['values'],\n }],\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.RunCommandParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 4388 }, "name": "RunCommandParametersProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandparameters.html#cfn-events-rule-runcommandparameters-runcommandtargets" }, "stability": "external", "summary": "Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4394 }, "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" } } ] } } } ], "symbolId": "lib/events.generated:CfnRule.RunCommandParametersProperty" }, "@aws-cdk/aws-events.CfnRule.RunCommandTargetProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Each `RunCommandTarget` block can include only one key, but this key may specify multiple values.", "stability": "external", "summary": "Information about the EC2 instances that are to be sent the command, specified as key-value pairs.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst runCommandTargetProperty: events.CfnRule.RunCommandTargetProperty = {\n key: 'key',\n values: ['values'],\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.RunCommandTargetProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 4456 }, "name": "RunCommandTargetProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html#cfn-events-rule-runcommandtarget-key" }, "stability": "external", "summary": "Can be either `tag:` *tag-key* or `InstanceIds` ." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4462 }, "name": "key", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html#cfn-events-rule-runcommandtarget-values" }, "remarks": "If `Key` is `InstanceIds` , `Values` is a list of Amazon EC2 instance IDs.", "stability": "external", "summary": "If `Key` is `tag:` *tag-key* , `Values` is a list of tag values." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4468 }, "name": "values", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/events.generated:CfnRule.RunCommandTargetProperty" }, "@aws-cdk/aws-events.CfnRule.SageMakerPipelineParameterProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameter.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst sageMakerPipelineParameterProperty: events.CfnRule.SageMakerPipelineParameterProperty = {\n name: 'name',\n value: 'value',\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.SageMakerPipelineParameterProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 4534 }, "name": "SageMakerPipelineParameterProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameter.html#cfn-events-rule-sagemakerpipelineparameter-name" }, "stability": "external", "summary": "Name of parameter to start execution of a SageMaker Model Building Pipeline." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4540 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameter.html#cfn-events-rule-sagemakerpipelineparameter-value" }, "stability": "external", "summary": "Value of parameter to start execution of a SageMaker Model Building Pipeline." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4546 }, "name": "value", "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnRule.SageMakerPipelineParameterProperty" }, "@aws-cdk/aws-events.CfnRule.SageMakerPipelineParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameters.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "These are custom parameters to use when the target is a SageMaker Model Building Pipeline that starts based on EventBridge events.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst sageMakerPipelineParametersProperty: events.CfnRule.SageMakerPipelineParametersProperty = {\n pipelineParameterList: [{\n name: 'name',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.SageMakerPipelineParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 4612 }, "name": "SageMakerPipelineParametersProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameters.html#cfn-events-rule-sagemakerpipelineparameters-pipelineparameterlist" }, "stability": "external", "summary": "List of Parameter names and values for SageMaker Model Building Pipeline execution." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4618 }, "name": "pipelineParameterList", "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.SageMakerPipelineParameterProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/events.generated:CfnRule.SageMakerPipelineParametersProperty" }, "@aws-cdk/aws-events.CfnRule.SqsParametersProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sqsparameters.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "This structure includes the custom parameter to be used when the target is an SQS FIFO queue.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst sqsParametersProperty: events.CfnRule.SqsParametersProperty = {\n messageGroupId: 'messageGroupId',\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.SqsParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 4679 }, "name": "SqsParametersProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sqsparameters.html#cfn-events-rule-sqsparameters-messagegroupid" }, "stability": "external", "summary": "The FIFO message group ID to use as the target." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4685 }, "name": "messageGroupId", "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnRule.SqsParametersProperty" }, "@aws-cdk/aws-events.CfnRule.TagProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-tag.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The tag will be propagated to ECS by EventBridge when starting an ECS task based on a matched event.\n\n> Currently, tags are only available when using ECS with EventBridge .", "stability": "external", "summary": "A key-value pair associated with an ECS Target of an EventBridge rule.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst tagProperty: events.CfnRule.TagProperty = {\n key: 'key',\n value: 'value',\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.TagProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 4749 }, "name": "TagProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-tag.html#cfn-events-rule-tag-key" }, "remarks": "The combination of tag keys and values can help you organize and categorize your resources.", "stability": "external", "summary": "A string you can use to assign a value." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4755 }, "name": "key", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-tag.html#cfn-events-rule-tag-value" }, "stability": "external", "summary": "The value for the specified tag key." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4761 }, "name": "value", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/events.generated:CfnRule.TagProperty" }, "@aws-cdk/aws-events.CfnRule.TargetProperty": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html", "exampleMetadata": "fixture=_generated" }, "remarks": "For a complete list of services and resources that can be set as a target, see [PutTargets](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html) .\n\nIf you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide* .", "stability": "external", "summary": "Targets are the resources to be invoked when a rule is triggered.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst targetProperty: events.CfnRule.TargetProperty = {\n arn: 'arn',\n id: 'id',\n\n // the properties below are optional\n batchParameters: {\n jobDefinition: 'jobDefinition',\n jobName: 'jobName',\n\n // the properties below are optional\n arrayProperties: {\n size: 123,\n },\n retryStrategy: {\n attempts: 123,\n },\n },\n deadLetterConfig: {\n arn: 'arn',\n },\n ecsParameters: {\n taskDefinitionArn: 'taskDefinitionArn',\n\n // the properties below are optional\n capacityProviderStrategy: [{\n capacityProvider: 'capacityProvider',\n\n // the properties below are optional\n base: 123,\n weight: 123,\n }],\n enableEcsManagedTags: false,\n enableExecuteCommand: false,\n group: 'group',\n launchType: 'launchType',\n networkConfiguration: {\n awsVpcConfiguration: {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n },\n },\n placementConstraints: [{\n expression: 'expression',\n type: 'type',\n }],\n placementStrategies: [{\n field: 'field',\n type: 'type',\n }],\n platformVersion: 'platformVersion',\n propagateTags: 'propagateTags',\n referenceId: 'referenceId',\n tagList: [{\n key: 'key',\n value: 'value',\n }],\n taskCount: 123,\n },\n httpParameters: {\n headerParameters: {\n headerParametersKey: 'headerParameters',\n },\n pathParameterValues: ['pathParameterValues'],\n queryStringParameters: {\n queryStringParametersKey: 'queryStringParameters',\n },\n },\n input: 'input',\n inputPath: 'inputPath',\n inputTransformer: {\n inputTemplate: 'inputTemplate',\n\n // the properties below are optional\n inputPathsMap: {\n inputPathsMapKey: 'inputPathsMap',\n },\n },\n kinesisParameters: {\n partitionKeyPath: 'partitionKeyPath',\n },\n redshiftDataParameters: {\n database: 'database',\n sql: 'sql',\n\n // the properties below are optional\n dbUser: 'dbUser',\n secretManagerArn: 'secretManagerArn',\n statementName: 'statementName',\n withEvent: false,\n },\n retryPolicy: {\n maximumEventAgeInSeconds: 123,\n maximumRetryAttempts: 123,\n },\n roleArn: 'roleArn',\n runCommandParameters: {\n runCommandTargets: [{\n key: 'key',\n values: ['values'],\n }],\n },\n sageMakerPipelineParameters: {\n pipelineParameterList: [{\n name: 'name',\n value: 'value',\n }],\n },\n sqsParameters: {\n messageGroupId: 'messageGroupId',\n },\n};" }, "fqn": "@aws-cdk/aws-events.CfnRule.TargetProperty", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 4827 }, "name": "TargetProperty", "namespace": "CfnRule", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-arn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the target." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4833 }, "name": "arn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id" }, "remarks": "Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.", "stability": "external", "summary": "The ID of the target within the specified rule." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4865 }, "name": "id", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-batchparameters" }, "remarks": "For more information, see [Jobs](https://docs.aws.amazon.com/batch/latest/userguide/jobs.html) in the *AWS Batch User Guide* .", "stability": "external", "summary": "If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4839 }, "name": "batchParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.BatchParametersProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig" }, "stability": "external", "summary": "The `DeadLetterConfig` that defines the target queue to send dead-letter queue events to." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4845 }, "name": "deadLetterConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.DeadLetterConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-ecsparameters" }, "remarks": "For more information about Amazon ECS tasks, see [Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon EC2 Container Service Developer Guide* .", "stability": "external", "summary": "Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4851 }, "name": "ecsParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.EcsParametersProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-httpparameters" }, "remarks": "If you specify an API Gateway API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.", "stability": "external", "summary": "Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4859 }, "name": "httpParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.HttpParametersProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input" }, "remarks": "In this case, nothing from the event itself is passed to the target. For more information, see [The JavaScript Object Notation (JSON) Data Interchange Format](https://docs.aws.amazon.com/http://www.rfc-editor.org/rfc/rfc7159.txt) .", "stability": "external", "summary": "Valid JSON text passed to the target." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4871 }, "name": "input", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath" }, "remarks": "You may use JSON dot notation or bracket notation. For more information about JSON paths, see [JSONPath](https://docs.aws.amazon.com/http://goessner.net/articles/JsonPath/) .", "stability": "external", "summary": "The value of the JSONPath that is used for extracting part of the matched event when passing it to the target." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4877 }, "name": "inputPath", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputtransformer" }, "remarks": "You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.", "stability": "external", "summary": "Settings to enable you to provide custom input to a target based on certain event data." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4883 }, "name": "inputTransformer", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.InputTransformerProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-kinesisparameters" }, "remarks": "If you do not include this parameter, the default is to use the `eventId` as the partition key.", "stability": "external", "summary": "The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4889 }, "name": "kinesisParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.KinesisParametersProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-redshiftdataparameters" }, "remarks": "If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.", "stability": "external", "summary": "Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4897 }, "name": "redshiftDataParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.RedshiftDataParametersProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy" }, "stability": "external", "summary": "The `RetryPolicy` object that contains the retry policy configuration to use for the dead-letter queue." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4903 }, "name": "retryPolicy", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.RetryPolicyProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-rolearn" }, "remarks": "If one rule triggers multiple targets, you can use a different IAM role for each target.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4909 }, "name": "roleArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-runcommandparameters" }, "stability": "external", "summary": "Parameters used when you are using the rule to invoke Amazon EC2 Run Command." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4915 }, "name": "runCommandParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.RunCommandParametersProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-sagemakerpipelineparameters" }, "remarks": "If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.", "stability": "external", "summary": "Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4923 }, "name": "sageMakerPipelineParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.SageMakerPipelineParametersProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-sqsparameters" }, "remarks": "If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.", "stability": "external", "summary": "Contains the message group ID to use when the target is a FIFO queue." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 4931 }, "name": "sqsParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-events.CfnRule.SqsParametersProperty" } ] } } } ], "symbolId": "lib/events.generated:CfnRule.TargetProperty" }, "@aws-cdk/aws-events.CfnRuleProps": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnRule`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\n\ndeclare const eventPattern: any;\nconst cfnRuleProps: events.CfnRuleProps = {\n description: 'description',\n eventBusName: 'eventBusName',\n eventPattern: eventPattern,\n name: 'name',\n roleArn: 'roleArn',\n scheduleExpression: 'scheduleExpression',\n state: 'state',\n targets: [{\n arn: 'arn',\n id: 'id',\n\n // the properties below are optional\n batchParameters: {\n jobDefinition: 'jobDefinition',\n jobName: 'jobName',\n\n // the properties below are optional\n arrayProperties: {\n size: 123,\n },\n retryStrategy: {\n attempts: 123,\n },\n },\n deadLetterConfig: {\n arn: 'arn',\n },\n ecsParameters: {\n taskDefinitionArn: 'taskDefinitionArn',\n\n // the properties below are optional\n capacityProviderStrategy: [{\n capacityProvider: 'capacityProvider',\n\n // the properties below are optional\n base: 123,\n weight: 123,\n }],\n enableEcsManagedTags: false,\n enableExecuteCommand: false,\n group: 'group',\n launchType: 'launchType',\n networkConfiguration: {\n awsVpcConfiguration: {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n },\n },\n placementConstraints: [{\n expression: 'expression',\n type: 'type',\n }],\n placementStrategies: [{\n field: 'field',\n type: 'type',\n }],\n platformVersion: 'platformVersion',\n propagateTags: 'propagateTags',\n referenceId: 'referenceId',\n tagList: [{\n key: 'key',\n value: 'value',\n }],\n taskCount: 123,\n },\n httpParameters: {\n headerParameters: {\n headerParametersKey: 'headerParameters',\n },\n pathParameterValues: ['pathParameterValues'],\n queryStringParameters: {\n queryStringParametersKey: 'queryStringParameters',\n },\n },\n input: 'input',\n inputPath: 'inputPath',\n inputTransformer: {\n inputTemplate: 'inputTemplate',\n\n // the properties below are optional\n inputPathsMap: {\n inputPathsMapKey: 'inputPathsMap',\n },\n },\n kinesisParameters: {\n partitionKeyPath: 'partitionKeyPath',\n },\n redshiftDataParameters: {\n database: 'database',\n sql: 'sql',\n\n // the properties below are optional\n dbUser: 'dbUser',\n secretManagerArn: 'secretManagerArn',\n statementName: 'statementName',\n withEvent: false,\n },\n retryPolicy: {\n maximumEventAgeInSeconds: 123,\n maximumRetryAttempts: 123,\n },\n roleArn: 'roleArn',\n runCommandParameters: {\n runCommandTargets: [{\n key: 'key',\n values: ['values'],\n }],\n },\n sageMakerPipelineParameters: {\n pipelineParameterList: [{\n name: 'name',\n value: 'value',\n }],\n },\n sqsParameters: {\n messageGroupId: 'messageGroupId',\n },\n }],\n};" }, "fqn": "@aws-cdk/aws-events.CfnRuleProps", "kind": "interface", "locationInModule": { "filename": "lib/events.generated.ts", "line": 2650 }, "name": "CfnRuleProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description" }, "stability": "external", "summary": "The description of the rule." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2657 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname" }, "remarks": "If you omit this, the default event bus is used.", "stability": "external", "summary": "The name or ARN of the event bus associated with the rule." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2664 }, "name": "eventBusName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern" }, "remarks": "For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide* .", "stability": "external", "summary": "The event pattern of the rule." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2671 }, "name": "eventPattern", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name" }, "stability": "external", "summary": "The name of the rule." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2678 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-rolearn" }, "remarks": "If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a `RoleArn` with proper permissions in the `Target` structure, instead of here in this parameter.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the role that is used for target invocation." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2687 }, "name": "roleArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression" }, "remarks": "For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\". For more information, see [Creating an Amazon EventBridge rule that runs on a schedule](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html) .", "stability": "external", "summary": "The scheduling expression." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2694 }, "name": "scheduleExpression", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state" }, "stability": "external", "summary": "The state of the rule." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2701 }, "name": "state", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets" }, "remarks": "Targets are the resources that are invoked when a rule is triggered.\n\nThe maximum number of entries per request is 10.\n\n> Each rule can have up to five (5) targets associated with it at one time.\n\nFor a list of services you can configure as targets for events, see [EventBridge targets](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html) in the *Amazon EventBridge User Guide* .\n\nCreating rules with built-in targets is supported only in the AWS Management Console . The built-in targets are:\n\n- `Amazon EBS CreateSnapshot API call`\n- `Amazon EC2 RebootInstances API call`\n- `Amazon EC2 StopInstances API call`\n- `Amazon EC2 TerminateInstances API call`\n\nFor some target types, `PutTargets` provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the `KinesisParameters` argument. To invoke a command on multiple EC2 instances with one rule, you can use the `RunCommandParameters` field.\n\nTo be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions:\n\n- For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.\n- For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets` .\n\nFor more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the *Amazon EventBridge User Guide* .\n\nIf another AWS account is in the same region and has granted you permission (using `PutPermission` ), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the `Arn` value when you run `PutTargets` . If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see [Amazon EventBridge Pricing](https://docs.aws.amazon.com/eventbridge/pricing/) .\n\n> `Input` , `InputPath` , and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account.\n\nIf you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide* .\n\n> If you have an IAM role on a cross-account event bus target, a `PutTargets` call without a role on the same target (same `Id` and `Arn` ) will not remove the role.\n\nFor more information about enabling cross-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html) .\n\n*Input* , *InputPath* , and *InputTransformer* are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:\n\n- If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).\n- If *Input* is specified in the form of valid JSON, then the matched event is overridden with this constant.\n- If *InputPath* is specified in the form of JSONPath (for example, `$.detail` ), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).\n- If *InputTransformer* is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.\n\nWhen you specify `InputPath` or `InputTransformer` , you must use JSON dot notation, not bracket notation.\n\nWhen you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.\n\nThis action can partially fail if too many requests are made at the same time. If that happens, `FailedEntryCount` is non-zero in the response and each entry in `FailedEntries` provides the ID of the failed target and the error code.", "stability": "external", "summary": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule." }, "immutable": true, "locationInModule": { "filename": "lib/events.generated.ts", "line": 2755 }, "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" } } ] } } } ], "symbolId": "lib/events.generated:CfnRuleProps" }, "@aws-cdk/aws-events.Connection": { "assembly": "@aws-cdk/aws-events", "base": "@aws-cdk/core.Resource", "docs": { "custom": { "resource": "AWS::Events::Connection", "exampleMetadata": "infused" }, "stability": "stable", "summary": "Define an EventBridge Connection.", "example": "const connection = new events.Connection(this, 'Connection', {\n authorization: events.Authorization.apiKey('x-api-key', SecretValue.secretsManager('ApiSecretName')),\n description: 'Connection with API Key x-api-key',\n});\n\nconst destination = new events.ApiDestination(this, 'Destination', {\n connection,\n endpoint: 'https://example.com',\n description: 'Calling example.com with API key x-api-key',\n});\n\nconst rule = new events.Rule(this, 'Rule', {\n schedule: events.Schedule.rate(cdk.Duration.minutes(1)),\n targets: [new targets.ApiDestination(destination)],\n});" }, "fqn": "@aws-cdk/aws-events.Connection", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/connection.ts", "line": 340 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-events.ConnectionProps" } } ] }, "interfaces": [ "@aws-cdk/aws-events.IConnection" ], "kind": "class", "locationInModule": { "filename": "lib/connection.ts", "line": 295 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import an existing connection resource." }, "locationInModule": { "filename": "lib/connection.ts", "line": 318 }, "name": "fromConnectionAttributes", "parameters": [ { "docs": { "summary": "Parent construct." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "Construct ID." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "Imported connection properties." }, "name": "attrs", "type": { "fqn": "@aws-cdk/aws-events.ConnectionAttributes" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.IConnection" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Import an existing connection resource." }, "locationInModule": { "filename": "lib/connection.ts", "line": 302 }, "name": "fromEventBusArn", "parameters": [ { "docs": { "summary": "Parent construct." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "Construct ID." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "ARN of imported connection." }, "name": "connectionArn", "type": { "primitive": "string" } }, { "name": "connectionSecretArn", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.IConnection" } }, "static": true } ], "name": "Connection", "properties": [ { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ARN of the connection created." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 332 }, "name": "connectionArn", "overrides": "@aws-cdk/aws-events.IConnection", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The Name for the connection." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 326 }, "name": "connectionName", "overrides": "@aws-cdk/aws-events.IConnection", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ARN for the secret created for the connection." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 338 }, "name": "connectionSecretArn", "overrides": "@aws-cdk/aws-events.IConnection", "type": { "primitive": "string" } } ], "symbolId": "lib/connection:Connection" }, "@aws-cdk/aws-events.ConnectionAttributes": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "stability": "stable", "summary": "Interface with properties necessary to import a reusable Connection.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst connectionAttributes: events.ConnectionAttributes = {\n connectionArn: 'connectionArn',\n connectionName: 'connectionName',\n connectionSecretArn: 'connectionSecretArn',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-events.ConnectionAttributes", "kind": "interface", "locationInModule": { "filename": "lib/connection.ts", "line": 273 }, "name": "ConnectionAttributes", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The ARN of the connection created." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 282 }, "name": "connectionArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The Name for the connection." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 277 }, "name": "connectionName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The ARN for the secret created for the connection." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 287 }, "name": "connectionSecretArn", "type": { "primitive": "string" } } ], "symbolId": "lib/connection:ConnectionAttributes" }, "@aws-cdk/aws-events.ConnectionProps": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "remarks": "A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.", "stability": "stable", "summary": "An API Destination Connection.", "example": "const connection = new events.Connection(this, 'Connection', {\n authorization: events.Authorization.apiKey('x-api-key', SecretValue.secretsManager('ApiSecretName')),\n description: 'Connection with API Key x-api-key',\n});\n\nconst destination = new events.ApiDestination(this, 'Destination', {\n connection,\n endpoint: 'https://example.com',\n description: 'Calling example.com with API key x-api-key',\n});\n\nconst rule = new events.Rule(this, 'Rule', {\n schedule: events.Schedule.rate(cdk.Duration.minutes(1)),\n targets: [new targets.ApiDestination(destination)],\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-events.ConnectionProps", "kind": "interface", "locationInModule": { "filename": "lib/connection.ts", "line": 10 }, "name": "ConnectionProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The authorization type for the connection." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 28 }, "name": "authorization", "type": { "fqn": "@aws-cdk/aws-events.Authorization" } }, { "abstract": true, "docs": { "default": "- No additional parameters", "stability": "stable", "summary": "Additional string parameters to add to the invocation bodies." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 35 }, "name": "bodyParameters", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-events.HttpParameter" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- A name is automatically generated", "stability": "stable", "summary": "The name of the connection." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 16 }, "name": "connectionName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- none", "stability": "stable", "summary": "The name of the connection." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 23 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No additional parameters", "stability": "stable", "summary": "Additional string parameters to add to the invocation headers." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 42 }, "name": "headerParameters", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-events.HttpParameter" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- No additional parameters", "stability": "stable", "summary": "Additional string parameters to add to the invocation query strings." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 49 }, "name": "queryStringParameters", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-events.HttpParameter" }, "kind": "map" } } } ], "symbolId": "lib/connection:ConnectionProps" }, "@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.", "example": "import * as events from '@aws-cdk/aws-events';\nimport * as targets from '@aws-cdk/aws-events-targets';\n\ndeclare const fn: lambda.Function;\nconst rule = new events.Rule(this, 'Schedule Rule', {\n schedule: events.Schedule.cron({ minute: '0', hour: '4' }),\n});\nrule.addTarget(new targets.LambdaFunction(fn));", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-events.CronOptions", "kind": "interface", "locationInModule": { "filename": "lib/schedule.ts", "line": 91 }, "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": 111 }, "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": 104 }, "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": 97 }, "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": 118 }, "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": 132 }, "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": 125 }, "name": "year", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/schedule:CronOptions" }, "@aws-cdk/aws-events.EventBus": { "assembly": "@aws-cdk/aws-events", "base": "@aws-cdk/core.Resource", "docs": { "custom": { "resource": "AWS::Events::EventBus", "exampleMetadata": "infused" }, "stability": "stable", "summary": "Define an EventBridge EventBus.", "example": "const bus = new events.EventBus(this, 'bus', {\n eventBusName: 'MyCustomEventBus'\n});\n\nbus.archive('MyArchive', {\n archiveName: 'MyCustomEventBusArchive',\n description: 'MyCustomerEventBus Archive',\n eventPattern: {\n account: [Stack.of(this).account],\n },\n retention: Duration.days(365),\n});" }, "fqn": "@aws-cdk/aws-events.EventBus", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/event-bus.ts", "line": 310 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.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": 163 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import an existing event bus resource." }, "locationInModule": { "filename": "lib/event-bus.ts", "line": 171 }, "name": "fromEventBusArn", "parameters": [ { "docs": { "summary": "Parent construct." }, "name": "scope", "type": { "fqn": "constructs.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": 207 }, "name": "fromEventBusAttributes", "parameters": [ { "docs": { "summary": "Parent construct." }, "name": "scope", "type": { "fqn": "constructs.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": "Import an existing event bus resource." }, "locationInModule": { "filename": "lib/event-bus.ts", "line": 187 }, "name": "fromEventBusName", "parameters": [ { "docs": { "summary": "Parent construct." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "Construct ID." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "Name of imported event bus." }, "name": "eventBusName", "type": { "primitive": "string" } } ], "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": 234 }, "name": "grantAllPutEvents", "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 }, { "docs": { "deprecated": "use grantAllPutEvents instead", "stability": "deprecated", "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": 218 }, "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 }, { "docs": { "remarks": "When you create an archive, incoming events might not immediately start being sent to the archive.\nAllow a short period of time for changes to take effect.", "stability": "stable", "summary": "Create an EventBridge archive to send events to." }, "locationInModule": { "filename": "lib/event-bus.ts", "line": 139 }, "name": "archive", "overrides": "@aws-cdk/aws-events.IEventBus", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-events.BaseArchiveProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.Archive" } } }, { "docs": { "stability": "stable", "summary": "Grants an IAM Principal to send custom events to the eventBus so that they can be matched to rules." }, "locationInModule": { "filename": "lib/event-bus.ts", "line": 149 }, "name": "grantPutEventsTo", "overrides": "@aws-cdk/aws-events.IEventBus", "parameters": [ { "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } } ], "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": 298 }, "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": 292 }, "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": 303 }, "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": 308 }, "name": "eventSourceName", "optional": true, "overrides": "@aws-cdk/aws-events.IEventBus", "type": { "primitive": "string" } } ], "symbolId": "lib/event-bus:EventBus" }, "@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.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst eventBusAttributes: events.EventBusAttributes = {\n eventBusArn: 'eventBusArn',\n eventBusName: 'eventBusName',\n eventBusPolicy: 'eventBusPolicy',\n\n // the properties below are optional\n eventSourceName: 'eventSourceName',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-events.EventBusAttributes", "kind": "interface", "locationInModule": { "filename": "lib/event-bus.ts", "line": 86 }, "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": 99 }, "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": 92 }, "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": 106 }, "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": 114 }, "name": "eventSourceName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/event-bus:EventBusAttributes" }, "@aws-cdk/aws-events.EventBusProps": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "stability": "stable", "summary": "Properties to define an event bus.", "example": "const bus = new events.EventBus(this, 'bus', {\n eventBusName: 'MyCustomEventBus'\n});\n\nbus.archive('MyArchive', {\n archiveName: 'MyCustomEventBusArchive',\n description: 'MyCustomerEventBus Archive',\n eventPattern: {\n account: [Stack.of(this).account],\n },\n retention: Duration.days(365),\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-events.EventBusProps", "kind": "interface", "locationInModule": { "filename": "lib/event-bus.ts", "line": 63 }, "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": 71 }, "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": 80 }, "name": "eventSourceName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/event-bus:EventBusProps" }, "@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": 242 }, "methods": [ { "docs": { "stability": "stable", "summary": "Extract a custom JSON path from the event." }, "locationInModule": { "filename": "lib/input.ts", "line": 288 }, "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": 308 }, "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": 319 }, "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": 312 }, "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": 267 }, "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": 253 }, "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": 246 }, "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": 281 }, "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": 260 }, "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": 274 }, "name": "time", "static": true, "type": { "primitive": "string" } }, { "docs": { "remarks": "This may return an array with a single informational element indicating how\nto get this property populated, if it was skipped for performance reasons.", "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": 296 }, "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": 295 }, "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": 302 }, "name": "path", "type": { "primitive": "string" } } ], "symbolId": "lib/input:EventField" }, "@aws-cdk/aws-events.EventPattern": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "remarks": "**Important**: this class can only be used with a `Rule` class. In particular,\ndo not use it with `CfnRule` class: your pattern will not be rendered\ncorrectly. In a `CfnRule` class, write the pattern as you normally would when\ndirectly writing CloudFormation.\n\nRules 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.\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.", "example": "import * as lambda from '@aws-cdk/aws-lambda';\n\nconst fn = new lambda.Function(this, 'MyFunc', {\n runtime: lambda.Runtime.NODEJS_14_X,\n handler: 'index.handler',\n code: lambda.Code.fromInline(`exports.handler = handler.toString()`),\n});\n\nconst rule = new events.Rule(this, 'rule', {\n eventPattern: {\n source: [\"aws.ec2\"],\n },\n});\n\nconst queue = new sqs.Queue(this, 'Queue');\n\nrule.addTarget(new targets.LambdaFunction(fn, {\n deadLetterQueue: queue, // Optional: add a dead letter queue\n maxEventAge: cdk.Duration.hours(2), // Optional: set the maxEventAge retry policy\n retryAttempts: 2, // Optional: set the max number of retry attempts\n}));", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-events.EventPattern", "kind": "interface", "locationInModule": { "filename": "lib/event-pattern.ts", "line": 34 }, "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": 80 }, "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": 119 }, "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": 58 }, "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": 48 }, "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": 97 }, "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": 111 }, "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": 73 }, "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": 90 }, "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": 40 }, "name": "version", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/event-pattern:EventPattern" }, "@aws-cdk/aws-events.HttpMethod": { "assembly": "@aws-cdk/aws-events", "docs": { "stability": "stable", "summary": "Supported HTTP operations." }, "fqn": "@aws-cdk/aws-events.HttpMethod", "kind": "enum", "locationInModule": { "filename": "lib/connection.ts", "line": 389 }, "members": [ { "docs": { "stability": "stable", "summary": "POST." }, "name": "POST" }, { "docs": { "stability": "stable", "summary": "GET." }, "name": "GET" }, { "docs": { "stability": "stable", "summary": "HEAD." }, "name": "HEAD" }, { "docs": { "stability": "stable", "summary": "OPTIONS." }, "name": "OPTIONS" }, { "docs": { "stability": "stable", "summary": "PUT." }, "name": "PUT" }, { "docs": { "stability": "stable", "summary": "PATCH." }, "name": "PATCH" }, { "docs": { "stability": "stable", "summary": "DELETE." }, "name": "DELETE" } ], "name": "HttpMethod", "symbolId": "lib/connection:HttpMethod" }, "@aws-cdk/aws-events.HttpParameter": { "abstract": true, "assembly": "@aws-cdk/aws-events", "docs": { "stability": "stable", "summary": "An additional HTTP parameter to send along with the OAuth request.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const secretValue: cdk.SecretValue;\nconst httpParameter = events.HttpParameter.fromSecret(secretValue);", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-events.HttpParameter", "initializer": { "docs": { "stability": "stable" } }, "kind": "class", "locationInModule": { "filename": "lib/connection.ts", "line": 190 }, "methods": [ { "docs": { "stability": "stable", "summary": "Make an OAuthParameter from a secret." }, "locationInModule": { "filename": "lib/connection.ts", "line": 210 }, "name": "fromSecret", "parameters": [ { "name": "value", "type": { "fqn": "@aws-cdk/core.SecretValue" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.HttpParameter" } }, "static": true }, { "docs": { "remarks": "The value is not treated as a secret.", "stability": "stable", "summary": "Make an OAuthParameter from a string value." }, "locationInModule": { "filename": "lib/connection.ts", "line": 196 }, "name": "fromString", "parameters": [ { "name": "value", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.HttpParameter" } }, "static": true } ], "name": "HttpParameter", "symbolId": "lib/connection:HttpParameter" }, "@aws-cdk/aws-events.IApiDestination": { "assembly": "@aws-cdk/aws-events", "docs": { "stability": "stable", "summary": "Interface for API Destinations." }, "fqn": "@aws-cdk/aws-events.IApiDestination", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/api-destination.ts", "line": 51 }, "name": "IApiDestination", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ARN of the Api Destination created." }, "immutable": true, "locationInModule": { "filename": "lib/api-destination.ts", "line": 62 }, "name": "apiDestinationArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The Name of the Api Destination created." }, "immutable": true, "locationInModule": { "filename": "lib/api-destination.ts", "line": 56 }, "name": "apiDestinationName", "type": { "primitive": "string" } } ], "symbolId": "lib/api-destination:IApiDestination" }, "@aws-cdk/aws-events.IConnection": { "assembly": "@aws-cdk/aws-events", "docs": { "stability": "stable", "summary": "Interface for EventBus Connections." }, "fqn": "@aws-cdk/aws-events.IConnection", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/connection.ts", "line": 250 }, "name": "IConnection", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ARN of the connection created." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 261 }, "name": "connectionArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The Name for the connection." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 255 }, "name": "connectionName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ARN for the secret created for the connection." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 267 }, "name": "connectionSecretArn", "type": { "primitive": "string" } } ], "symbolId": "lib/connection:IConnection" }, "@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": 10 }, "methods": [ { "abstract": true, "docs": { "remarks": "When you create an archive, incoming events might not immediately start being sent to the archive.\nAllow a short period of time for changes to take effect.", "stability": "stable", "summary": "Create an EventBridge archive to send events to." }, "locationInModule": { "filename": "lib/event-bus.ts", "line": 49 }, "name": "archive", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "Properties of the archive." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-events.BaseArchiveProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.Archive" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Grants an IAM Principal to send custom events to the eventBus so that they can be matched to rules." }, "locationInModule": { "filename": "lib/event-bus.ts", "line": 57 }, "name": "grantPutEventsTo", "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" } } } ], "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": 25 }, "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": 17 }, "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": 33 }, "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": 40 }, "name": "eventSourceName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/event-bus:IEventBus" }, "@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" } } ], "symbolId": "lib/rule-ref:IRule" }, "@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", "symbolId": "lib/target:IRuleTarget" }, "@aws-cdk/aws-events.OAuthAuthorizationProps": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `Authorization.oauth()`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const httpParameter: events.HttpParameter;\ndeclare const secretValue: cdk.SecretValue;\nconst oAuthAuthorizationProps: events.OAuthAuthorizationProps = {\n authorizationEndpoint: 'authorizationEndpoint',\n clientId: 'clientId',\n clientSecret: secretValue,\n httpMethod: events.HttpMethod.POST,\n\n // the properties below are optional\n bodyParameters: {\n bodyParametersKey: httpParameter,\n },\n headerParameters: {\n headerParametersKey: httpParameter,\n },\n queryStringParameters: {\n queryStringParametersKey: httpParameter,\n },\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-events.OAuthAuthorizationProps", "kind": "interface", "locationInModule": { "filename": "lib/connection.ts", "line": 141 }, "name": "OAuthAuthorizationProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The URL to the authorization endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 146 }, "name": "authorizationEndpoint", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The client ID to use for OAuth authorization for the connection." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 158 }, "name": "clientId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The client secret associated with the client ID to use for OAuth authorization for the connection." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 163 }, "name": "clientSecret", "type": { "fqn": "@aws-cdk/core.SecretValue" } }, { "abstract": true, "docs": { "remarks": "(Can only choose POST, GET or PUT).", "stability": "stable", "summary": "The method to use for the authorization request." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 153 }, "name": "httpMethod", "type": { "fqn": "@aws-cdk/aws-events.HttpMethod" } }, { "abstract": true, "docs": { "default": "- No additional parameters", "stability": "stable", "summary": "Additional string parameters to add to the OAuth request body." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 170 }, "name": "bodyParameters", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-events.HttpParameter" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- No additional parameters", "stability": "stable", "summary": "Additional string parameters to add to the OAuth request header." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 177 }, "name": "headerParameters", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-events.HttpParameter" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- No additional parameters", "stability": "stable", "summary": "Additional string parameters to add to the OAuth request query string." }, "immutable": true, "locationInModule": { "filename": "lib/connection.ts", "line": 184 }, "name": "queryStringParameters", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-events.HttpParameter" }, "kind": "map" } } } ], "symbolId": "lib/connection:OAuthAuthorizationProps" }, "@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.", "example": "// Lambda function containing logic that evaluates compliance with the rule.\nconst evalComplianceFn = new lambda.Function(this, 'CustomFunction', {\n code: lambda.AssetCode.fromInline('exports.handler = (event) => console.log(event);'),\n handler: 'index.handler',\n runtime: lambda.Runtime.NODEJS_14_X,\n});\n\n// A custom rule that runs on configuration changes of EC2 instances\nconst customRule = new config.CustomRule(this, 'Custom', {\n configurationChanges: true,\n lambdaFunction: evalComplianceFn,\n ruleScope: config.RuleScope.fromResource(config.ResourceType.EC2_INSTANCE),\n});\n\n// A rule to detect stack drifts\nconst driftRule = new config.CloudFormationStackDriftDetectionCheck(this, 'Drift');\n\n// Topic to which compliance notification events will be published\nconst complianceTopic = new sns.Topic(this, 'ComplianceTopic');\n\n// Send notification on compliance change events\ndriftRule.onComplianceChange('ComplianceChange', {\n target: new targets.SnsTopic(complianceTopic),\n});", "custom": { "exampleMetadata": "infused" } }, "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" } } ], "symbolId": "lib/on-event-options:OnEventOptions" }, "@aws-cdk/aws-events.Rule": { "assembly": "@aws-cdk/aws-events", "base": "@aws-cdk/core.Resource", "docs": { "custom": { "resource": "AWS::Events::Rule", "exampleMetadata": "infused" }, "stability": "stable", "summary": "Defines an EventBridge Rule in this stack.", "example": "import * as lambda from '@aws-cdk/aws-lambda';\n\nconst fn = new lambda.Function(this, 'MyFunc', {\n runtime: lambda.Runtime.NODEJS_14_X,\n handler: 'index.handler',\n code: lambda.Code.fromInline(`exports.handler = handler.toString()`),\n});\n\nconst rule = new events.Rule(this, 'rule', {\n eventPattern: {\n source: [\"aws.ec2\"],\n },\n});\n\nconst queue = new sqs.Queue(this, 'Queue');\n\nrule.addTarget(new targets.LambdaFunction(fn, {\n deadLetterQueue: queue, // Optional: add a dead letter queue\n maxEventAge: cdk.Duration.hours(2), // Optional: set the maxEventAge retry policy\n retryAttempts: 2, // Optional: set the max number of retry attempts\n}));" }, "fqn": "@aws-cdk/aws-events.Rule", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/rule.ts", "line": 121 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.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": 91 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import an existing EventBridge Rule provided an ARN." }, "locationInModule": { "filename": "lib/rule.ts", "line": 100 }, "name": "fromEventRuleArn", "parameters": [ { "docs": { "summary": "The parent creating construct (usually `this`)." }, "name": "scope", "type": { "fqn": "constructs.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": 308 }, "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": 166 }, "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": 324 }, "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": 110 }, "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": 111 }, "name": "ruleName", "overrides": "@aws-cdk/aws-events.IRule", "type": { "primitive": "string" } } ], "symbolId": "lib/rule:Rule" }, "@aws-cdk/aws-events.RuleProps": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for defining an EventBridge Rule.", "example": "const connection = new events.Connection(this, 'Connection', {\n authorization: events.Authorization.apiKey('x-api-key', SecretValue.secretsManager('ApiSecretName')),\n description: 'Connection with API Key x-api-key',\n});\n\nconst destination = new events.ApiDestination(this, 'Destination', {\n connection,\n endpoint: 'https://example.com',\n description: 'Calling example.com with API key x-api-key',\n});\n\nconst rule = new events.Rule(this, 'Rule', {\n schedule: events.Schedule.rate(cdk.Duration.minutes(1)),\n targets: [new targets.ApiDestination(destination)],\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-events.RuleProps", "kind": "interface", "locationInModule": { "filename": "lib/rule.ts", "line": 15 }, "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": 21 }, "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": 36 }, "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": 83 }, "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": 66 }, "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": 29 }, "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": 49 }, "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": 76 }, "name": "targets", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-events.IRuleTarget" }, "kind": "array" } } } ], "symbolId": "lib/rule:RuleProps" }, "@aws-cdk/aws-events.RuleTargetConfig": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for an event rule target.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const construct: cdk.Construct;\ndeclare const role: iam.Role;\ndeclare const ruleTargetInput: events.RuleTargetInput;\nconst ruleTargetConfig: events.RuleTargetConfig = {\n arn: 'arn',\n\n // the properties below are optional\n batchParameters: {\n jobDefinition: 'jobDefinition',\n jobName: 'jobName',\n\n // the properties below are optional\n arrayProperties: {\n size: 123,\n },\n retryStrategy: {\n attempts: 123,\n },\n },\n deadLetterConfig: {\n arn: 'arn',\n },\n ecsParameters: {\n taskDefinitionArn: 'taskDefinitionArn',\n\n // the properties below are optional\n capacityProviderStrategy: [{\n capacityProvider: 'capacityProvider',\n\n // the properties below are optional\n base: 123,\n weight: 123,\n }],\n enableEcsManagedTags: false,\n enableExecuteCommand: false,\n group: 'group',\n launchType: 'launchType',\n networkConfiguration: {\n awsVpcConfiguration: {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n },\n },\n placementConstraints: [{\n expression: 'expression',\n type: 'type',\n }],\n placementStrategies: [{\n field: 'field',\n type: 'type',\n }],\n platformVersion: 'platformVersion',\n propagateTags: 'propagateTags',\n referenceId: 'referenceId',\n tagList: [{\n key: 'key',\n value: 'value',\n }],\n taskCount: 123,\n },\n httpParameters: {\n headerParameters: {\n headerParametersKey: 'headerParameters',\n },\n pathParameterValues: ['pathParameterValues'],\n queryStringParameters: {\n queryStringParametersKey: 'queryStringParameters',\n },\n },\n id: 'id',\n input: ruleTargetInput,\n kinesisParameters: {\n partitionKeyPath: 'partitionKeyPath',\n },\n retryPolicy: {\n maximumEventAgeInSeconds: 123,\n maximumRetryAttempts: 123,\n },\n role: role,\n runCommandParameters: {\n runCommandTargets: [{\n key: 'key',\n values: ['values'],\n }],\n },\n sqsParameters: {\n messageGroupId: 'messageGroupId',\n },\n targetResource: construct,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "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": 38 }, "name": "arn", "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": 49 }, "name": "batchParameters", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.CfnRule.BatchParametersProperty" } }, { "abstract": true, "docs": { "default": "no dead-letter queue set", "stability": "stable", "summary": "Contains information about a dead-letter queue configuration." }, "immutable": true, "locationInModule": { "filename": "lib/target.ts", "line": 55 }, "name": "deadLetterConfig", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.CfnRule.DeadLetterConfigProperty" } }, { "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": 67 }, "name": "ecsParameters", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.CfnRule.EcsParametersProperty" } }, { "abstract": true, "docs": { "default": "- None", "stability": "stable", "summary": "Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge API destination." }, "immutable": true, "locationInModule": { "filename": "lib/target.ts", "line": 74 }, "name": "httpParameters", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.CfnRule.HttpParametersProperty" } }, { "abstract": true, "docs": { "default": "- an auto-generated id", "deprecated": "no replacement. we will always use an autogenerated id.", "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": 33 }, "name": "id", "optional": true, "type": { "primitive": "string" } }, { "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": 100 }, "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": 81 }, "name": "kinesisParameters", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.CfnRule.KinesisParametersProperty" } }, { "abstract": true, "docs": { "default": "EventBridge default retry policy", "stability": "stable", "summary": "A RetryPolicy object that includes information about the retry policy settings." }, "immutable": true, "locationInModule": { "filename": "lib/target.ts", "line": 61 }, "name": "retryPolicy", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.CfnRule.RetryPolicyProperty" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Role to use to invoke this event target." }, "immutable": true, "locationInModule": { "filename": "lib/target.ts", "line": 43 }, "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": 87 }, "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": 93 }, "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": 113 }, "name": "targetResource", "optional": true, "type": { "fqn": "@aws-cdk/core.IConstruct" } } ], "symbolId": "lib/target:RuleTargetConfig" }, "@aws-cdk/aws-events.RuleTargetInput": { "abstract": true, "assembly": "@aws-cdk/aws-events", "docs": { "stability": "stable", "summary": "The input to send to the event target.", "example": "import * as iam from '@aws-cdk/aws-iam';\nimport * as sfn from '@aws-cdk/aws-stepfunctions';\n\nconst rule = new events.Rule(this, 'Rule', {\n schedule: events.Schedule.rate(cdk.Duration.minutes(1)),\n});\n\nconst dlq = new sqs.Queue(this, 'DeadLetterQueue');\n\nconst role = new iam.Role(this, 'Role', {\n assumedBy: new iam.ServicePrincipal('events.amazonaws.com'),\n});\nconst stateMachine = new sfn.StateMachine(this, 'SM', {\n definition: new sfn.Wait(this, 'Hello', { time: sfn.WaitTime.duration(cdk.Duration.seconds(10)) })\n});\n\nrule.addTarget(new targets.SfnStateMachine(stateMachine, {\n input: events.RuleTargetInput.fromObject({ SomeParam: 'SomeValue' }),\n deadLetterQueue: dlq,\n role: role\n}));", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-events.RuleTargetInput", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/input.ts", "line": 55 } }, "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": 51 }, "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": 34 }, "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": 44 }, "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.\n\nThe Rule Target input value will be a single string: the string you pass\nhere. Do not use this method to pass a complex value like a JSON object to\na Rule Target. Use `RuleTargetInput.fromObject()` instead.", "stability": "stable", "summary": "Pass text to the event target." }, "locationInModule": { "filename": "lib/input.ts", "line": 21 }, "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": 61 }, "name": "bind", "parameters": [ { "name": "rule", "type": { "fqn": "@aws-cdk/aws-events.IRule" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.RuleTargetInputProperties" } } } ], "name": "RuleTargetInput", "symbolId": "lib/input:RuleTargetInput" }, "@aws-cdk/aws-events.RuleTargetInputProperties": { "assembly": "@aws-cdk/aws-events", "datatype": true, "docs": { "stability": "stable", "summary": "The input properties for an event target.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst ruleTargetInputProperties: events.RuleTargetInputProperties = {\n input: 'input',\n inputPath: 'inputPath',\n inputPathsMap: {\n inputPathsMapKey: 'inputPathsMap',\n },\n inputTemplate: 'inputTemplate',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-events.RuleTargetInputProperties", "kind": "interface", "locationInModule": { "filename": "lib/input.ts", "line": 67 }, "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": 74 }, "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": 81 }, "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": 95 }, "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": 88 }, "name": "inputTemplate", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/input:RuleTargetInputProperties" }, "@aws-cdk/aws-events.Schedule": { "abstract": true, "assembly": "@aws-cdk/aws-events", "docs": { "stability": "stable", "summary": "Schedule for scheduled event rules.", "example": "const connection = new events.Connection(this, 'Connection', {\n authorization: events.Authorization.apiKey('x-api-key', SecretValue.secretsManager('ApiSecretName')),\n description: 'Connection with API Key x-api-key',\n});\n\nconst destination = new events.ApiDestination(this, 'Destination', {\n connection,\n endpoint: 'https://example.com',\n description: 'Calling example.com with API key x-api-key',\n});\n\nconst rule = new events.Rule(this, 'Rule', {\n schedule: events.Schedule.rate(cdk.Duration.minutes(1)),\n targets: [new targets.ApiDestination(destination)],\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-events.Schedule", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/schedule.ts", "line": 74 } }, "kind": "class", "locationInModule": { "filename": "lib/schedule.ts", "line": 10 }, "methods": [ { "docs": { "stability": "stable", "summary": "Create a schedule from a set of cron fields." }, "locationInModule": { "filename": "lib/schedule.ts", "line": 44 }, "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": 16 }, "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": 23 }, "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": 72 }, "name": "expressionString", "type": { "primitive": "string" } } ], "symbolId": "lib/schedule:Schedule" } }, "version": "1.204.0", "fingerprint": "**********" }