agent-claw: automated task changes
This commit is contained in:
13
cdk/node_modules/aws-cdk-lib/aws-scheduler/.jsiirc.json
generated
vendored
Normal file
13
cdk/node_modules/aws-cdk-lib/aws-scheduler/.jsiirc.json
generated
vendored
Normal file
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"targets": {
|
||||
"java": {
|
||||
"package": "software.amazon.awscdk.services.scheduler"
|
||||
},
|
||||
"dotnet": {
|
||||
"namespace": "Amazon.CDK.AWS.Scheduler"
|
||||
},
|
||||
"python": {
|
||||
"module": "aws_cdk.aws_scheduler"
|
||||
}
|
||||
}
|
||||
}
|
||||
314
cdk/node_modules/aws-cdk-lib/aws-scheduler/README.md
generated
vendored
Normal file
314
cdk/node_modules/aws-cdk-lib/aws-scheduler/README.md
generated
vendored
Normal file
@@ -0,0 +1,314 @@
|
||||
# Amazon EventBridge Scheduler Construct Library
|
||||
|
||||
[Amazon EventBridge Scheduler](https://aws.amazon.com/blogs/compute/introducing-amazon-eventbridge-scheduler/) is a feature from Amazon EventBridge
|
||||
that allows you to create, run, and manage scheduled tasks at scale. With EventBridge Scheduler, you can schedule millions of one-time or recurring tasks across various AWS services without provisioning or managing underlying infrastructure.
|
||||
|
||||
1. **Schedule**: A schedule is the main resource you create, configure, and manage using Amazon EventBridge Scheduler. Every schedule has a schedule expression that determines when, and with what frequency, the schedule runs. EventBridge Scheduler supports three types of schedules: rate, cron, and one-time schedules. When you create a schedule, you configure a target for the schedule to invoke.
|
||||
2. **Target**: A target is an API operation that EventBridge Scheduler calls on your behalf every time your schedule runs. EventBridge Scheduler
|
||||
supports two types of targets: templated targets and universal targets. Templated targets invoke common API operations across a core groups of
|
||||
services. For example, EventBridge Scheduler supports templated targets for invoking AWS Lambda Function or starting execution of Step Functions state
|
||||
machine. For API operations that are not supported by templated targets you can use customizable universal targets. Universal targets support calling
|
||||
more than 6,000 API operations across over 270 AWS services.
|
||||
3. **Schedule Group**: A schedule group is an Amazon EventBridge Scheduler resource that you use to organize your schedules. Your AWS account comes
|
||||
with a default scheduler group. A new schedule will always be added to a scheduling group. If you do not provide a scheduling group to add to, it
|
||||
will be added to the default scheduling group. You can create up to 500 schedule groups in your AWS account. Groups can be used to organize the
|
||||
schedules logically, access the schedule metrics and manage permissions at group granularity (see details below). Schedule groups support tagging.
|
||||
With EventBridge Scheduler, you apply tags to schedule groups, not to individual schedules to organize your resources.
|
||||
|
||||
## Defining a schedule
|
||||
|
||||
```ts
|
||||
declare const fn: lambda.Function;
|
||||
|
||||
const target = new targets.LambdaInvoke(fn, {
|
||||
input: ScheduleTargetInput.fromObject({
|
||||
"payload": "useful",
|
||||
}),
|
||||
});
|
||||
|
||||
const schedule = new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.rate(Duration.minutes(10)),
|
||||
target,
|
||||
description: 'This is a test schedule that invokes a lambda function every 10 minutes.',
|
||||
});
|
||||
```
|
||||
|
||||
### Schedule Expressions
|
||||
|
||||
You can choose from three schedule types when configuring your schedule: rate-based, cron-based, and one-time schedules.
|
||||
|
||||
Both rate-based and cron-based schedules are recurring schedules. You can configure each recurring schedule type using a schedule expression.
|
||||
|
||||
For
|
||||
cron-based schedules you can specify a time zone in which EventBridge Scheduler evaluates the expression.
|
||||
|
||||
```ts
|
||||
declare const target: targets.LambdaInvoke;
|
||||
|
||||
const rateBasedSchedule = new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.rate(Duration.minutes(10)),
|
||||
target,
|
||||
description: 'This is a test rate-based schedule',
|
||||
});
|
||||
|
||||
const cronBasedSchedule = new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.cron({
|
||||
minute: '0',
|
||||
hour: '23',
|
||||
day: '20',
|
||||
month: '11',
|
||||
timeZone: TimeZone.AMERICA_NEW_YORK,
|
||||
}),
|
||||
target,
|
||||
description: 'This is a test cron-based schedule that will run at 11:00 PM, on day 20 of the month, only in November in New York timezone',
|
||||
});
|
||||
```
|
||||
|
||||
A one-time schedule is a schedule that invokes a target only once. You configure a one-time schedule by specifying the time of day, date,
|
||||
and time zone in which EventBridge Scheduler evaluates the schedule.
|
||||
|
||||
```ts
|
||||
declare const target: targets.LambdaInvoke;
|
||||
|
||||
const oneTimeSchedule = new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.at(
|
||||
new Date(2022, 10, 20, 19, 20, 23),
|
||||
TimeZone.AMERICA_NEW_YORK,
|
||||
),
|
||||
target,
|
||||
description: 'This is a one-time schedule in New York timezone',
|
||||
});
|
||||
```
|
||||
|
||||
### Grouping Schedules
|
||||
|
||||
Your AWS account comes with a default scheduler group. You can access the default group in CDK with:
|
||||
|
||||
```ts
|
||||
const defaultScheduleGroup = ScheduleGroup.fromDefaultScheduleGroup(this, "DefaultGroup");
|
||||
```
|
||||
|
||||
You can add a schedule to a custom scheduling group managed by you. If a custom group is not specified, the schedule is added to the default group.
|
||||
|
||||
```ts
|
||||
declare const target: targets.LambdaInvoke;
|
||||
|
||||
const scheduleGroup = new ScheduleGroup(this, "ScheduleGroup", {
|
||||
scheduleGroupName: "MyScheduleGroup",
|
||||
});
|
||||
|
||||
new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.rate(Duration.minutes(10)),
|
||||
target,
|
||||
scheduleGroup,
|
||||
});
|
||||
```
|
||||
|
||||
### Disabling Schedules
|
||||
|
||||
By default, a schedule will be enabled. You can disable a schedule by setting the `enabled` property to false:
|
||||
|
||||
```ts
|
||||
declare const target: targets.LambdaInvoke;
|
||||
|
||||
new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.rate(Duration.minutes(10)),
|
||||
target: target,
|
||||
enabled: false,
|
||||
});
|
||||
```
|
||||
|
||||
### Configuring a start and end time of the Schedule
|
||||
|
||||
If you choose a recurring schedule, you can set the start and end time of the Schedule by specifying the `start` and `end`.
|
||||
|
||||
```ts
|
||||
declare const target: targets.LambdaInvoke;
|
||||
|
||||
new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.rate(cdk.Duration.hours(12)),
|
||||
target: target,
|
||||
start: new Date('2023-01-01T00:00:00.000Z'),
|
||||
end: new Date('2023-02-01T00:00:00.000Z'),
|
||||
});
|
||||
```
|
||||
|
||||
## Scheduler Targets
|
||||
|
||||
The `aws-cdk-lib/aws-scheduler-targets` module includes classes that implement the `IScheduleTarget` interface for
|
||||
various AWS services. EventBridge Scheduler supports two types of targets:
|
||||
|
||||
1. **Templated targets** which invoke common API
|
||||
operations across a core groups of services, and
|
||||
2. **Universal targets** that you can customize to call more
|
||||
than 6,000 operations across over 270 services.
|
||||
|
||||
A list of supported targets can be found at `aws-cdk-lib/aws-scheduler-targets`.
|
||||
|
||||
### Input
|
||||
|
||||
Targets can be invoked with a custom input. The `ScheduleTargetInput` class supports free-form text input and JSON-formatted object input:
|
||||
|
||||
```ts
|
||||
const input = ScheduleTargetInput.fromObject({
|
||||
'QueueName': 'MyQueue'
|
||||
});
|
||||
```
|
||||
|
||||
You can include context attributes in your target payload. EventBridge Scheduler will replace each keyword with
|
||||
its respective value and deliver it to the target. See
|
||||
[full list of supported context attributes](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule-context-attributes.html):
|
||||
|
||||
1. `ContextAttribute.scheduleArn()` – The ARN of the schedule.
|
||||
2. `ContextAttribute.scheduledTime()` – The time you specified for the schedule to invoke its target, e.g., 2022-03-22T18:59:43Z.
|
||||
3. `ContextAttribute.executionId()` – The unique ID that EventBridge Scheduler assigns for each attempted invocation of a target, e.g., d32c5kddcf5bb8c3.
|
||||
4. `ContextAttribute.attemptNumber()` – A counter that identifies the attempt number for the current invocation, e.g., 1.
|
||||
|
||||
```ts
|
||||
const text = `Attempt number: ${ContextAttribute.attemptNumber}`;
|
||||
const input = ScheduleTargetInput.fromText(text);
|
||||
```
|
||||
|
||||
### Specifying an execution role
|
||||
|
||||
An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf.
|
||||
|
||||
The classes for templated schedule targets automatically create an IAM role with all the minimum necessary
|
||||
permissions to interact with the templated target. If you wish you may specify your own IAM role, then the templated targets
|
||||
will grant minimal required permissions. For example, the `LambdaInvoke` target will grant the
|
||||
IAM execution role `lambda:InvokeFunction` permission to invoke the Lambda function.
|
||||
|
||||
```ts
|
||||
declare const fn: lambda.Function;
|
||||
|
||||
const role = new iam.Role(this, 'Role', {
|
||||
assumedBy: new iam.ServicePrincipal('scheduler.amazonaws.com'),
|
||||
});
|
||||
|
||||
const target = new targets.LambdaInvoke(fn, {
|
||||
input: ScheduleTargetInput.fromObject({
|
||||
"payload": "useful"
|
||||
}),
|
||||
role,
|
||||
});
|
||||
```
|
||||
|
||||
### Specifying an encryption key
|
||||
|
||||
EventBridge Scheduler integrates with AWS Key Management Service (AWS KMS) to encrypt and decrypt your data using an AWS KMS key.
|
||||
EventBridge Scheduler supports two types of KMS keys: AWS owned keys, and customer managed keys.
|
||||
|
||||
By default, all events in Scheduler are encrypted with a key that AWS owns and manages.
|
||||
If you wish you can also provide a customer managed key to encrypt and decrypt the payload that your schedule delivers to its target using the `key` property.
|
||||
Target classes will automatically add AWS `kms:Decrypt` permission to your schedule's execution role permissions policy.
|
||||
|
||||
```ts
|
||||
declare const key: kms.Key;
|
||||
declare const fn: lambda.Function;
|
||||
|
||||
const target = new targets.LambdaInvoke(fn, {
|
||||
input: ScheduleTargetInput.fromObject({
|
||||
payload: 'useful',
|
||||
}),
|
||||
});
|
||||
|
||||
const schedule = new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.rate(Duration.minutes(10)),
|
||||
target,
|
||||
key,
|
||||
});
|
||||
```
|
||||
|
||||
> See [Data protection in Amazon EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/data-protection.html) for more details.
|
||||
|
||||
## Configuring flexible time windows
|
||||
|
||||
You can configure flexible time windows by specifying the `timeWindow` property.
|
||||
Flexible time windows are disabled by default.
|
||||
|
||||
```ts
|
||||
declare const target: targets.LambdaInvoke;
|
||||
|
||||
const schedule = new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.rate(Duration.hours(12)),
|
||||
target,
|
||||
timeWindow: TimeWindow.flexible(Duration.hours(10)),
|
||||
});
|
||||
```
|
||||
|
||||
> See [Configuring flexible time windows](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule-flexible-time-windows.html) for more details.
|
||||
|
||||
## Error-handling
|
||||
|
||||
You can configure how your schedule handles failures, when EventBridge Scheduler is unable to deliver an event
|
||||
successfully to a target, by using two primary mechanisms: a retry policy, and a dead-letter queue (DLQ).
|
||||
|
||||
A retry policy determines the number of times EventBridge Scheduler must retry a failed event, and how long
|
||||
to keep an unprocessed event.
|
||||
|
||||
A DLQ is a standard Amazon SQS queue EventBridge Scheduler uses to deliver failed events to, after the retry
|
||||
policy has been exhausted. You can use a DLQ to troubleshoot issues with your schedule or its downstream target.
|
||||
If you've configured a retry policy for your schedule, EventBridge Scheduler delivers the dead-letter event after
|
||||
exhausting the maximum number of retries you set in the retry policy.
|
||||
|
||||
```ts
|
||||
declare const fn: lambda.Function;
|
||||
|
||||
const dlq = new sqs.Queue(this, "DLQ", {
|
||||
queueName: 'MyDLQ',
|
||||
});
|
||||
|
||||
const target = new targets.LambdaInvoke(fn, {
|
||||
deadLetterQueue: dlq,
|
||||
maxEventAge: Duration.minutes(1),
|
||||
retryAttempts: 3
|
||||
});
|
||||
```
|
||||
|
||||
## Monitoring
|
||||
|
||||
You can monitor Amazon EventBridge Scheduler using CloudWatch, which collects raw data
|
||||
and processes it into readable, near real-time metrics. EventBridge Scheduler emits
|
||||
a set of metrics for all schedules, and an additional set of metrics for schedules that
|
||||
have an associated dead-letter queue (DLQ). If you configure a DLQ for your schedule,
|
||||
EventBridge Scheduler publishes additional metrics when your schedule exhausts its retry policy.
|
||||
|
||||
### Metrics for all schedules
|
||||
|
||||
The `Schedule` class provides static methods for accessing all schedules metrics with default configuration, such as `metricAllErrors` for viewing errors when executing targets.
|
||||
|
||||
```ts
|
||||
new cloudwatch.Alarm(this, 'SchedulesErrorAlarm', {
|
||||
metric: Schedule.metricAllErrors(),
|
||||
threshold: 0,
|
||||
evaluationPeriods: 1,
|
||||
});
|
||||
```
|
||||
|
||||
### Metrics for a Schedule Group
|
||||
|
||||
To view metrics for a specific group you can use methods on class `ScheduleGroup`:
|
||||
|
||||
```ts
|
||||
const scheduleGroup = new ScheduleGroup(this, "ScheduleGroup", {
|
||||
scheduleGroupName: "MyScheduleGroup",
|
||||
});
|
||||
|
||||
new cloudwatch.Alarm(this, 'MyGroupErrorAlarm', {
|
||||
metric: scheduleGroup.metricTargetErrors(),
|
||||
evaluationPeriods: 1,
|
||||
threshold: 0
|
||||
});
|
||||
|
||||
// Or use default group
|
||||
const defaultScheduleGroup = ScheduleGroup.fromDefaultScheduleGroup(this, "DefaultScheduleGroup");
|
||||
new cloudwatch.Alarm(this, 'DefaultScheduleGroupErrorAlarm', {
|
||||
metric: defaultScheduleGroup.metricTargetErrors(),
|
||||
evaluationPeriods: 1,
|
||||
threshold: 0
|
||||
});
|
||||
```
|
||||
|
||||
See full list of metrics and their description at
|
||||
[Monitoring Using CloudWatch Metrics](https://docs.aws.amazon.com/scheduler/latest/UserGuide/monitoring-cloudwatch.html)
|
||||
in the *AWS EventBridge Scheduler User Guide*.
|
||||
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/index.d.ts
generated
vendored
Normal file
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/index.d.ts
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
export * from './lib';
|
||||
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/index.js
generated
vendored
Normal file
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/index.js
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
"use strict";var __createBinding=exports&&exports.__createBinding||(Object.create?(function(o,m,k,k2){k2===void 0&&(k2=k);var desc=Object.getOwnPropertyDescriptor(m,k);(!desc||("get"in desc?!m.__esModule:desc.writable||desc.configurable))&&(desc={enumerable:!0,get:function(){return m[k]}}),Object.defineProperty(o,k2,desc)}):(function(o,m,k,k2){k2===void 0&&(k2=k),o[k2]=m[k]})),__exportStar=exports&&exports.__exportStar||function(m,exports2){for(var p in m)p!=="default"&&!Object.prototype.hasOwnProperty.call(exports2,p)&&__createBinding(exports2,m,p)};Object.defineProperty(exports,"__esModule",{value:!0});var _noFold;exports.CfnSchedule=void 0,Object.defineProperty(exports,_noFold="CfnSchedule",{enumerable:!0,configurable:!0,get:()=>{var value=require("./lib").CfnSchedule;return Object.defineProperty(exports,_noFold="CfnSchedule",{enumerable:!0,configurable:!0,value}),value}}),exports.CfnScheduleGroup=void 0,Object.defineProperty(exports,_noFold="CfnScheduleGroup",{enumerable:!0,configurable:!0,get:()=>{var value=require("./lib").CfnScheduleGroup;return Object.defineProperty(exports,_noFold="CfnScheduleGroup",{enumerable:!0,configurable:!0,value}),value}}),exports.ScheduleExpression=void 0,Object.defineProperty(exports,_noFold="ScheduleExpression",{enumerable:!0,configurable:!0,get:()=>{var value=require("./lib").ScheduleExpression;return Object.defineProperty(exports,_noFold="ScheduleExpression",{enumerable:!0,configurable:!0,value}),value}}),exports.ScheduleTargetInput=void 0,Object.defineProperty(exports,_noFold="ScheduleTargetInput",{enumerable:!0,configurable:!0,get:()=>{var value=require("./lib").ScheduleTargetInput;return Object.defineProperty(exports,_noFold="ScheduleTargetInput",{enumerable:!0,configurable:!0,value}),value}}),exports.ContextAttribute=void 0,Object.defineProperty(exports,_noFold="ContextAttribute",{enumerable:!0,configurable:!0,get:()=>{var value=require("./lib").ContextAttribute;return Object.defineProperty(exports,_noFold="ContextAttribute",{enumerable:!0,configurable:!0,value}),value}}),exports.TimeWindow=void 0,Object.defineProperty(exports,_noFold="TimeWindow",{enumerable:!0,configurable:!0,get:()=>{var value=require("./lib").TimeWindow;return Object.defineProperty(exports,_noFold="TimeWindow",{enumerable:!0,configurable:!0,value}),value}}),exports.Schedule=void 0,Object.defineProperty(exports,_noFold="Schedule",{enumerable:!0,configurable:!0,get:()=>{var value=require("./lib").Schedule;return Object.defineProperty(exports,_noFold="Schedule",{enumerable:!0,configurable:!0,value}),value}}),exports.ScheduleGroup=void 0,Object.defineProperty(exports,_noFold="ScheduleGroup",{enumerable:!0,configurable:!0,get:()=>{var value=require("./lib").ScheduleGroup;return Object.defineProperty(exports,_noFold="ScheduleGroup",{enumerable:!0,configurable:!0,value}),value}}),exports.ScheduleGroupGrants=void 0,Object.defineProperty(exports,_noFold="ScheduleGroupGrants",{enumerable:!0,configurable:!0,get:()=>{var value=require("./lib").ScheduleGroupGrants;return Object.defineProperty(exports,_noFold="ScheduleGroupGrants",{enumerable:!0,configurable:!0,value}),value}});
|
||||
7
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/index.d.ts
generated
vendored
Normal file
7
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/index.d.ts
generated
vendored
Normal file
@@ -0,0 +1,7 @@
|
||||
export * from './scheduler.generated';
|
||||
export * from './schedule-expression';
|
||||
export * from './input';
|
||||
export * from './schedule';
|
||||
export * from './target';
|
||||
export * from './schedule-group';
|
||||
export * from './schedule-group-grants';
|
||||
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/index.js
generated
vendored
Normal file
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/index.js
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
"use strict";var __createBinding=exports&&exports.__createBinding||(Object.create?(function(o,m,k,k2){k2===void 0&&(k2=k);var desc=Object.getOwnPropertyDescriptor(m,k);(!desc||("get"in desc?!m.__esModule:desc.writable||desc.configurable))&&(desc={enumerable:!0,get:function(){return m[k]}}),Object.defineProperty(o,k2,desc)}):(function(o,m,k,k2){k2===void 0&&(k2=k),o[k2]=m[k]})),__exportStar=exports&&exports.__exportStar||function(m,exports2){for(var p in m)p!=="default"&&!Object.prototype.hasOwnProperty.call(exports2,p)&&__createBinding(exports2,m,p)};Object.defineProperty(exports,"__esModule",{value:!0});var _noFold;exports.CfnSchedule=void 0,Object.defineProperty(exports,_noFold="CfnSchedule",{enumerable:!0,configurable:!0,get:()=>{var value=require("./scheduler.generated").CfnSchedule;return Object.defineProperty(exports,_noFold="CfnSchedule",{enumerable:!0,configurable:!0,value}),value}}),exports.CfnScheduleGroup=void 0,Object.defineProperty(exports,_noFold="CfnScheduleGroup",{enumerable:!0,configurable:!0,get:()=>{var value=require("./scheduler.generated").CfnScheduleGroup;return Object.defineProperty(exports,_noFold="CfnScheduleGroup",{enumerable:!0,configurable:!0,value}),value}}),exports.ScheduleExpression=void 0,Object.defineProperty(exports,_noFold="ScheduleExpression",{enumerable:!0,configurable:!0,get:()=>{var value=require("./schedule-expression").ScheduleExpression;return Object.defineProperty(exports,_noFold="ScheduleExpression",{enumerable:!0,configurable:!0,value}),value}}),exports.ScheduleTargetInput=void 0,Object.defineProperty(exports,_noFold="ScheduleTargetInput",{enumerable:!0,configurable:!0,get:()=>{var value=require("./input").ScheduleTargetInput;return Object.defineProperty(exports,_noFold="ScheduleTargetInput",{enumerable:!0,configurable:!0,value}),value}}),exports.ContextAttribute=void 0,Object.defineProperty(exports,_noFold="ContextAttribute",{enumerable:!0,configurable:!0,get:()=>{var value=require("./input").ContextAttribute;return Object.defineProperty(exports,_noFold="ContextAttribute",{enumerable:!0,configurable:!0,value}),value}}),exports.TimeWindow=void 0,Object.defineProperty(exports,_noFold="TimeWindow",{enumerable:!0,configurable:!0,get:()=>{var value=require("./schedule").TimeWindow;return Object.defineProperty(exports,_noFold="TimeWindow",{enumerable:!0,configurable:!0,value}),value}}),exports.Schedule=void 0,Object.defineProperty(exports,_noFold="Schedule",{enumerable:!0,configurable:!0,get:()=>{var value=require("./schedule").Schedule;return Object.defineProperty(exports,_noFold="Schedule",{enumerable:!0,configurable:!0,value}),value}}),exports.ScheduleGroup=void 0,Object.defineProperty(exports,_noFold="ScheduleGroup",{enumerable:!0,configurable:!0,get:()=>{var value=require("./schedule-group").ScheduleGroup;return Object.defineProperty(exports,_noFold="ScheduleGroup",{enumerable:!0,configurable:!0,value}),value}}),exports.ScheduleGroupGrants=void 0,Object.defineProperty(exports,_noFold="ScheduleGroupGrants",{enumerable:!0,configurable:!0,get:()=>{var value=require("./schedule-group-grants").ScheduleGroupGrants;return Object.defineProperty(exports,_noFold="ScheduleGroupGrants",{enumerable:!0,configurable:!0,value}),value}});
|
||||
64
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/input.d.ts
generated
vendored
Normal file
64
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/input.d.ts
generated
vendored
Normal file
@@ -0,0 +1,64 @@
|
||||
import type { ISchedule } from './schedule';
|
||||
/**
|
||||
* The text or well-formed JSON input passed to the target of the schedule.
|
||||
* Tokens and ContextAttribute may be used in the input.
|
||||
*/
|
||||
export declare abstract class ScheduleTargetInput {
|
||||
/**
|
||||
* Pass simple text to the target. For passing complex values like JSON object to a target use method
|
||||
* `ScheduleTargetInput.fromObject()` instead.
|
||||
*
|
||||
* @param text Text to use as the input for the target
|
||||
*/
|
||||
static fromText(text: string): ScheduleTargetInput;
|
||||
/**
|
||||
* Pass a JSON object to the target. The object will be transformed into a well-formed JSON string in the final template.
|
||||
*
|
||||
* @param obj object to use to convert to JSON to use as input for the target
|
||||
*/
|
||||
static fromObject(obj: any): ScheduleTargetInput;
|
||||
protected constructor();
|
||||
/**
|
||||
* Return the input properties for this input object
|
||||
*/
|
||||
abstract bind(schedule: ISchedule): string;
|
||||
}
|
||||
/**
|
||||
* A set of convenient static methods representing the Scheduler Context Attributes.
|
||||
* These Context Attributes keywords can be used inside a ScheduleTargetInput.
|
||||
*
|
||||
* @see https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule-context-attributes.html
|
||||
*/
|
||||
export declare class ContextAttribute {
|
||||
readonly name: string;
|
||||
/**
|
||||
* The ARN of the schedule.
|
||||
*/
|
||||
static get scheduleArn(): string;
|
||||
/**
|
||||
* The time you specified for the schedule to invoke its target, for example,
|
||||
* 2022-03-22T18:59:43Z.
|
||||
*/
|
||||
static get scheduledTime(): string;
|
||||
/**
|
||||
* The unique ID that EventBridge Scheduler assigns for each attempted invocation of
|
||||
* a target, for example, d32c5kddcf5bb8c3.
|
||||
*/
|
||||
static get executionId(): string;
|
||||
/**
|
||||
* A counter that identifies the attempt number for the current invocation, for
|
||||
* example, 1.
|
||||
*/
|
||||
static get attemptNumber(): string;
|
||||
/**
|
||||
* Escape hatch for other Context Attributes that may be added in the future
|
||||
*
|
||||
* @param name - name will replace xxx in <aws.scheduler.xxx>
|
||||
*/
|
||||
static fromName(name: string): string;
|
||||
private constructor();
|
||||
/**
|
||||
* Convert the path to the field in the event pattern to JSON
|
||||
*/
|
||||
toString(): string;
|
||||
}
|
||||
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/input.js
generated
vendored
Normal file
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/input.js
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ContextAttribute=exports.ScheduleTargetInput=void 0;const JSII_RTTI_SYMBOL_1=Symbol.for("jsii.rtti");var core_1=()=>{var tmp=require("../../core");return core_1=()=>tmp,tmp};class ScheduleTargetInput{static[JSII_RTTI_SYMBOL_1]={fqn:"aws-cdk-lib.aws_scheduler.ScheduleTargetInput",version:"2.252.0"};static fromText(text){return new FieldAwareEventInput(text,!1)}static fromObject(obj){return new FieldAwareEventInput(obj,!0)}constructor(){}}exports.ScheduleTargetInput=ScheduleTargetInput;class FieldAwareEventInput extends ScheduleTargetInput{input;toJsonString;constructor(input,toJsonString){super(),this.input=input,this.toJsonString=toJsonString}bind(schedule){class Replacer extends core_1().DefaultTokenResolver{constructor(){super(new(core_1()).StringConcat)}resolveToken(t,_context){return core_1().Token.asString(t)}}const stack=core_1().Stack.of(schedule),inputString=core_1().Tokenization.resolve(this.input,{scope:schedule,resolver:new Replacer});return this.toJsonString?stack.toJsonString(inputString):inputString}}class ContextAttribute{name;static[JSII_RTTI_SYMBOL_1]={fqn:"aws-cdk-lib.aws_scheduler.ContextAttribute",version:"2.252.0"};static get scheduleArn(){return this.fromName("schedule-arn")}static get scheduledTime(){return this.fromName("scheduled-time")}static get executionId(){return this.fromName("execution-id")}static get attemptNumber(){return this.fromName("attempt-number")}static fromName(name){return new ContextAttribute(name).toString()}constructor(name){this.name=name}toString(){return`<aws.scheduler.${this.name}>`}}exports.ContextAttribute=ContextAttribute;
|
||||
61
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/schedule-expression.d.ts
generated
vendored
Normal file
61
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/schedule-expression.d.ts
generated
vendored
Normal file
@@ -0,0 +1,61 @@
|
||||
import * as events from '../../aws-events';
|
||||
import type { Duration } from '../../core';
|
||||
import { TimeZone } from '../../core';
|
||||
/**
|
||||
* ScheduleExpression for EventBridge Schedule
|
||||
*
|
||||
* You can choose from three schedule types when configuring your schedule: rate-based, cron-based, and one-time schedules.
|
||||
* Both rate-based and cron-based schedules are recurring schedules.
|
||||
*
|
||||
* @see https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html
|
||||
*/
|
||||
export declare abstract class ScheduleExpression {
|
||||
/**
|
||||
* Construct a one-time schedule from a date.
|
||||
*
|
||||
* @param date The date and time to use. The millisecond part will be ignored.
|
||||
* @param timeZone The time zone to use for interpreting the date. Default: - UTC
|
||||
*/
|
||||
static at(date: Date, timeZone?: TimeZone): ScheduleExpression;
|
||||
/**
|
||||
* Construct a schedule from a literal schedule expression
|
||||
* @param expression The expression to use. Must be in a format that EventBridge will recognize
|
||||
* @param timeZone The time zone to use for interpreting the expression. Default: - UTC
|
||||
*/
|
||||
static expression(expression: string, timeZone?: TimeZone): ScheduleExpression;
|
||||
/**
|
||||
* Construct a recurring schedule from an interval and a time unit
|
||||
*
|
||||
* Rates may be defined with any unit of time, but when converted into minutes, the duration must be a positive whole number of minutes.
|
||||
*/
|
||||
static rate(duration: Duration): ScheduleExpression;
|
||||
/**
|
||||
* Create a recurring schedule from a set of cron fields and time zone.
|
||||
*/
|
||||
static cron(options: CronOptionsWithTimezone): ScheduleExpression;
|
||||
/**
|
||||
* Retrieve the expression for this schedule
|
||||
*/
|
||||
abstract readonly expressionString: string;
|
||||
/**
|
||||
* Retrieve the expression for this schedule
|
||||
*/
|
||||
abstract readonly timeZone?: TimeZone;
|
||||
protected constructor();
|
||||
}
|
||||
/**
|
||||
* Options to configure a cron expression
|
||||
*
|
||||
* All fields are strings so you can use complex expressions. Absence of
|
||||
* a field implies '*' or '?', whichever one is appropriate.
|
||||
*
|
||||
* @see https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html#cron-expressions
|
||||
*/
|
||||
export interface CronOptionsWithTimezone extends events.CronOptions {
|
||||
/**
|
||||
* The timezone to run the schedule in
|
||||
*
|
||||
* @default - TimeZone.ETC_UTC
|
||||
*/
|
||||
readonly timeZone?: TimeZone;
|
||||
}
|
||||
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/schedule-expression.js
generated
vendored
Normal file
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/schedule-expression.js
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ScheduleExpression=void 0;var jsiiDeprecationWarnings=()=>{var tmp=require("../../.warnings.jsii.js");return jsiiDeprecationWarnings=()=>tmp,tmp};const JSII_RTTI_SYMBOL_1=Symbol.for("jsii.rtti");var events=()=>{var tmp=require("../../aws-events");return events=()=>tmp,tmp},core_1=()=>{var tmp=require("../../core");return core_1=()=>tmp,tmp},literal_string_1=()=>{var tmp=require("../../core/lib/private/literal-string");return literal_string_1=()=>tmp,tmp};class ScheduleExpression{static[JSII_RTTI_SYMBOL_1]={fqn:"aws-cdk-lib.aws_scheduler.ScheduleExpression",version:"2.252.0"};static at(date,timeZone){try{jsiiDeprecationWarnings().aws_cdk_lib_TimeZone(timeZone)}catch(error){throw process.env.JSII_DEBUG!=="1"&&error.name==="DeprecationError"&&Error.captureStackTrace(error,this.at),error}try{const literal=date.toISOString().split(".")[0];return new LiteralScheduleExpression(`at(${literal})`,timeZone??core_1().TimeZone.ETC_UTC)}catch(e){throw e instanceof RangeError?new(core_1()).UnscopedValidationError((0,literal_string_1().lit)`InvalidDate`,"Invalid date"):e}}static expression(expression,timeZone){try{jsiiDeprecationWarnings().aws_cdk_lib_TimeZone(timeZone)}catch(error){throw process.env.JSII_DEBUG!=="1"&&error.name==="DeprecationError"&&Error.captureStackTrace(error,this.expression),error}return new LiteralScheduleExpression(expression,timeZone??core_1().TimeZone.ETC_UTC)}static rate(duration){try{jsiiDeprecationWarnings().aws_cdk_lib_Duration(duration)}catch(error){throw process.env.JSII_DEBUG!=="1"&&error.name==="DeprecationError"&&Error.captureStackTrace(error,this.rate),error}const schedule=events().Schedule.rate(duration);return new LiteralScheduleExpression(schedule.expressionString)}static cron(options){try{jsiiDeprecationWarnings().aws_cdk_lib_aws_scheduler_CronOptionsWithTimezone(options)}catch(error){throw process.env.JSII_DEBUG!=="1"&&error.name==="DeprecationError"&&Error.captureStackTrace(error,this.cron),error}const{timeZone,...cronOptions}=options,schedule=events().Schedule.cron(cronOptions);return new LiteralScheduleExpression(schedule.expressionString,timeZone)}constructor(){}}exports.ScheduleExpression=ScheduleExpression;const DEFAULT_TIMEZONE=core_1().TimeZone.ETC_UTC;class LiteralScheduleExpression extends ScheduleExpression{expressionString;timeZone;constructor(expressionString,timeZone=DEFAULT_TIMEZONE){super(),this.expressionString=expressionString,this.timeZone=timeZone}}
|
||||
26
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/schedule-group-grants.d.ts
generated
vendored
Normal file
26
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/schedule-group-grants.d.ts
generated
vendored
Normal file
@@ -0,0 +1,26 @@
|
||||
import type * as scheduler from './scheduler.generated';
|
||||
import * as iam from '../../aws-iam';
|
||||
/**
|
||||
* Collection of grant methods for a IScheduleGroupRef
|
||||
*/
|
||||
export declare class ScheduleGroupGrants {
|
||||
/**
|
||||
* Creates grants for ScheduleGroupGrants
|
||||
*/
|
||||
static fromScheduleGroup(resource: scheduler.IScheduleGroupRef): ScheduleGroupGrants;
|
||||
protected readonly resource: scheduler.IScheduleGroupRef;
|
||||
private constructor();
|
||||
/**
|
||||
* Grant list and get schedule permissions for schedules in this group to the given principal
|
||||
*/
|
||||
readSchedules(grantee: iam.IGrantable): iam.Grant;
|
||||
/**
|
||||
* Grant create and update schedule permissions for schedules in this group to the given principal
|
||||
*/
|
||||
writeSchedules(grantee: iam.IGrantable): iam.Grant;
|
||||
/**
|
||||
* Grant delete schedule permission for schedules in this group to the given principal
|
||||
*/
|
||||
deleteSchedules(grantee: iam.IGrantable): iam.Grant;
|
||||
private arnForScheduleInGroup;
|
||||
}
|
||||
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/schedule-group-grants.js
generated
vendored
Normal file
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/schedule-group-grants.js
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ScheduleGroupGrants=void 0;var jsiiDeprecationWarnings=()=>{var tmp=require("../../.warnings.jsii.js");return jsiiDeprecationWarnings=()=>tmp,tmp};const JSII_RTTI_SYMBOL_1=Symbol.for("jsii.rtti");var iam=()=>{var tmp=require("../../aws-iam");return iam=()=>tmp,tmp},core_1=()=>{var tmp=require("../../core");return core_1=()=>tmp,tmp};class ScheduleGroupGrants{static[JSII_RTTI_SYMBOL_1]={fqn:"aws-cdk-lib.aws_scheduler.ScheduleGroupGrants",version:"2.252.0"};static fromScheduleGroup(resource){try{jsiiDeprecationWarnings().aws_cdk_lib_interfaces_aws_scheduler_IScheduleGroupRef(resource)}catch(error){throw process.env.JSII_DEBUG!=="1"&&error.name==="DeprecationError"&&Error.captureStackTrace(error,this.fromScheduleGroup),error}return new ScheduleGroupGrants({resource})}resource;constructor(props){this.resource=props.resource}readSchedules(grantee){try{jsiiDeprecationWarnings().aws_cdk_lib_aws_iam_IGrantable(grantee)}catch(error){throw process.env.JSII_DEBUG!=="1"&&error.name==="DeprecationError"&&Error.captureStackTrace(error,this.readSchedules),error}const actions=["scheduler:GetSchedule","scheduler:ListSchedules"];return iam().Grant.addToPrincipal({actions,grantee,resourceArns:[this.arnForScheduleInGroup("*")]})}writeSchedules(grantee){try{jsiiDeprecationWarnings().aws_cdk_lib_aws_iam_IGrantable(grantee)}catch(error){throw process.env.JSII_DEBUG!=="1"&&error.name==="DeprecationError"&&Error.captureStackTrace(error,this.writeSchedules),error}const actions=["scheduler:CreateSchedule","scheduler:UpdateSchedule"];return iam().Grant.addToPrincipal({actions,grantee,resourceArns:[this.arnForScheduleInGroup("*")]})}deleteSchedules(grantee){try{jsiiDeprecationWarnings().aws_cdk_lib_aws_iam_IGrantable(grantee)}catch(error){throw process.env.JSII_DEBUG!=="1"&&error.name==="DeprecationError"&&Error.captureStackTrace(error,this.deleteSchedules),error}const actions=["scheduler:DeleteSchedule"];return iam().Grant.addToPrincipal({actions,grantee,resourceArns:[this.arnForScheduleInGroup("*")]})}arnForScheduleInGroup(scheduleName){return core_1().Arn.format({region:this.resource.env.region,account:this.resource.env.account,partition:core_1().Aws.PARTITION,service:"scheduler",resource:"schedule",resourceName:this.resource.scheduleGroupRef.scheduleGroupName+"/"+scheduleName})}}exports.ScheduleGroupGrants=ScheduleGroupGrants;
|
||||
255
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/schedule-group.d.ts
generated
vendored
Normal file
255
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/schedule-group.d.ts
generated
vendored
Normal file
@@ -0,0 +1,255 @@
|
||||
import type { Construct } from 'constructs';
|
||||
import { ScheduleGroupGrants } from './schedule-group-grants';
|
||||
import type { IScheduleGroupRef, ScheduleGroupReference } from './scheduler.generated';
|
||||
import * as cloudwatch from '../../aws-cloudwatch';
|
||||
import * as iam from '../../aws-iam';
|
||||
import type { IResource, RemovalPolicy } from '../../core';
|
||||
import { Resource } from '../../core';
|
||||
/**
|
||||
* Properties for a Schedule Group.
|
||||
*/
|
||||
export interface ScheduleGroupProps {
|
||||
/**
|
||||
* The name of the schedule group.
|
||||
*
|
||||
* Up to 64 letters (uppercase and lowercase), numbers, hyphens, underscores and dots are allowed.
|
||||
*
|
||||
* @default - A unique name will be generated
|
||||
*/
|
||||
readonly scheduleGroupName?: string;
|
||||
/**
|
||||
* The removal policy for the group. If the group is removed also all schedules are removed.
|
||||
*
|
||||
* @default RemovalPolicy.RETAIN
|
||||
*/
|
||||
readonly removalPolicy?: RemovalPolicy;
|
||||
}
|
||||
/**
|
||||
* Interface representing a created or an imported `ScheduleGroup`.
|
||||
*/
|
||||
export interface IScheduleGroup extends IResource, IScheduleGroupRef {
|
||||
/**
|
||||
* The name of the schedule group
|
||||
*
|
||||
* @attribute
|
||||
*/
|
||||
readonly scheduleGroupName: string;
|
||||
/**
|
||||
* The arn of the schedule group
|
||||
*
|
||||
* @attribute
|
||||
*/
|
||||
readonly scheduleGroupArn: string;
|
||||
/**
|
||||
* Return the given named metric for this group schedules
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
metric(metricName: string, props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for the number of invocations that were throttled because it exceeds your service quotas.
|
||||
*
|
||||
* @see https://docs.aws.amazon.com/scheduler/latest/UserGuide/scheduler-quotas.html
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
metricThrottled(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for all invocation attempts.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
metricAttempts(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Emitted when the target returns an exception after EventBridge Scheduler calls the target API.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
metricTargetErrors(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for invocation failures due to API throttling by the target.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
metricTargetThrottled(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
metricDropped(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for invocations delivered to the DLQ
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
metricSentToDLQ(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for failed invocations that also failed to deliver to DLQ.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
metricFailedToBeSentToDLQ(errorCode?: string, props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for delivery of failed invocations to DLQ when the payload of the event sent to the DLQ exceeds the maximum size allowed by Amazon SQS.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
metricSentToDLQTruncated(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Grant the indicated permissions on this group to the given principal
|
||||
*/
|
||||
grant(grantee: iam.IGrantable, ...actions: string[]): iam.Grant;
|
||||
/**
|
||||
* Grant list and get schedule permissions for schedules in this group to the given principal
|
||||
*/
|
||||
grantReadSchedules(identity: iam.IGrantable): iam.Grant;
|
||||
/**
|
||||
* Grant create and update schedule permissions for schedules in this group to the given principal
|
||||
*/
|
||||
grantWriteSchedules(identity: iam.IGrantable): iam.Grant;
|
||||
/**
|
||||
* Grant delete schedule permission for schedules in this group to the given principal
|
||||
*/
|
||||
grantDeleteSchedules(identity: iam.IGrantable): iam.Grant;
|
||||
}
|
||||
declare abstract class ScheduleGroupBase extends Resource implements IScheduleGroup {
|
||||
/**
|
||||
* The name of the schedule group
|
||||
*
|
||||
* @attribute
|
||||
*/
|
||||
abstract readonly scheduleGroupName: string;
|
||||
/**
|
||||
* The arn of the schedule group
|
||||
*
|
||||
* @attribute
|
||||
*/
|
||||
abstract readonly scheduleGroupArn: string;
|
||||
/**
|
||||
* Collection of grant methods for a ScheduleGroup
|
||||
*/
|
||||
readonly grants: ScheduleGroupGrants;
|
||||
get scheduleGroupRef(): ScheduleGroupReference;
|
||||
/**
|
||||
* Return the given named metric for this schedule group
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
metric(metricName: string, props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for the number of invocations that were throttled because it exceeds your service quotas.
|
||||
*
|
||||
* @see https://docs.aws.amazon.com/scheduler/latest/UserGuide/scheduler-quotas.html
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
metricThrottled(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for all invocation attempts.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
metricAttempts(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Emitted when the target returns an exception after EventBridge Scheduler calls the target API.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
metricTargetErrors(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for invocation failures due to API throttling by the target.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
metricTargetThrottled(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
metricDropped(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for invocations delivered to the DLQ
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
metricSentToDLQ(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for failed invocations that also failed to deliver to DLQ.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
metricFailedToBeSentToDLQ(errorCode?: string, props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for delivery of failed invocations to DLQ when the payload of the event sent to the DLQ exceeds the maximum size allowed by Amazon SQS.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
metricSentToDLQTruncated(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Grant the indicated permissions on this schedule group to the given principal
|
||||
* [disable-awslint:no-grants]
|
||||
*/
|
||||
grant(grantee: iam.IGrantable, ...actions: string[]): iam.Grant;
|
||||
/**
|
||||
* Grant list and get schedule permissions for schedules in this group to the given principal
|
||||
*
|
||||
* The use of this method is discouraged. Please use `grants.readSchedules()` instead.
|
||||
*
|
||||
* [disable-awslint:no-grants]
|
||||
*/
|
||||
grantReadSchedules(identity: iam.IGrantable): iam.Grant;
|
||||
/**
|
||||
* Grant create and update schedule permissions for schedules in this group to the given principal
|
||||
*
|
||||
* The use of this method is discouraged. Please use `grants.writeSchedules()` instead.
|
||||
*
|
||||
* [disable-awslint:no-grants]
|
||||
*/
|
||||
grantWriteSchedules(identity: iam.IGrantable): iam.Grant;
|
||||
/**
|
||||
* Grant delete schedule permission for schedules in this group to the given principal
|
||||
*
|
||||
* The use of this method is discouraged. Please use `grants.deleteSchedules()` instead.
|
||||
*
|
||||
* [disable-awslint:no-grants]
|
||||
*/
|
||||
grantDeleteSchedules(identity: iam.IGrantable): iam.Grant;
|
||||
}
|
||||
/**
|
||||
* A Schedule Group.
|
||||
* @resource AWS::Scheduler::ScheduleGroup
|
||||
*/
|
||||
export declare class ScheduleGroup extends ScheduleGroupBase {
|
||||
/** Uniquely identifies this class. */
|
||||
static readonly PROPERTY_INJECTION_ID: string;
|
||||
/**
|
||||
* Import an external schedule group by ARN.
|
||||
*
|
||||
* @param scope construct scope
|
||||
* @param id construct id
|
||||
* @param scheduleGroupArn the ARN of the schedule group to import (e.g. `arn:aws:scheduler:region:account-id:schedule-group/group-name`)
|
||||
*/
|
||||
static fromScheduleGroupArn(scope: Construct, id: string, scheduleGroupArn: string): IScheduleGroup;
|
||||
/**
|
||||
* Import a default schedule group.
|
||||
*
|
||||
* @param scope construct scope
|
||||
* @param id construct id
|
||||
*/
|
||||
static fromDefaultScheduleGroup(scope: Construct, id: string): IScheduleGroup;
|
||||
/**
|
||||
* Import an existing schedule group with a given name.
|
||||
*
|
||||
* @param scope construct scope
|
||||
* @param id construct id
|
||||
* @param scheduleGroupName the name of the existing schedule group to import
|
||||
*/
|
||||
static fromScheduleGroupName(scope: Construct, id: string, scheduleGroupName: string): IScheduleGroup;
|
||||
readonly scheduleGroupName: string;
|
||||
get scheduleGroupArn(): string;
|
||||
private readonly _resource;
|
||||
constructor(scope: Construct, id: string, props?: ScheduleGroupProps);
|
||||
}
|
||||
export {};
|
||||
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/schedule-group.js
generated
vendored
Normal file
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/schedule-group.js
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
216
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/schedule.d.ts
generated
vendored
Normal file
216
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/schedule.d.ts
generated
vendored
Normal file
@@ -0,0 +1,216 @@
|
||||
import type { Construct } from 'constructs';
|
||||
import type { ScheduleExpression } from './schedule-expression';
|
||||
import type { IScheduleGroup } from './schedule-group';
|
||||
import type { IScheduleRef, ScheduleReference } from './scheduler.generated';
|
||||
import type { IScheduleTarget } from './target';
|
||||
import * as cloudwatch from '../../aws-cloudwatch';
|
||||
import type * as kms from '../../aws-kms';
|
||||
import type { Duration, IResource } from '../../core';
|
||||
import { Resource } from '../../core';
|
||||
/**
|
||||
* Interface representing a created or an imported `Schedule`.
|
||||
*/
|
||||
export interface ISchedule extends IResource, IScheduleRef {
|
||||
/**
|
||||
* The arn of the schedule.
|
||||
* @attribute
|
||||
*/
|
||||
readonly scheduleArn: string;
|
||||
/**
|
||||
* The name of the schedule.
|
||||
* @attribute
|
||||
*/
|
||||
readonly scheduleName: string;
|
||||
/**
|
||||
* The schedule group associated with this schedule.
|
||||
*/
|
||||
readonly scheduleGroup?: IScheduleGroup;
|
||||
}
|
||||
/**
|
||||
* A time window during which EventBridge Scheduler invokes the schedule.
|
||||
*/
|
||||
export declare class TimeWindow {
|
||||
/**
|
||||
* TimeWindow is disabled.
|
||||
*/
|
||||
static off(): TimeWindow;
|
||||
/**
|
||||
* TimeWindow is enabled.
|
||||
*/
|
||||
static flexible(maxWindow: Duration): TimeWindow;
|
||||
/**
|
||||
* Determines whether the schedule is invoked within a flexible time window.
|
||||
*/
|
||||
readonly mode: 'OFF' | 'FLEXIBLE';
|
||||
/**
|
||||
* The maximum time window during which the schedule can be invoked.
|
||||
*
|
||||
* Must be between 1 to 1440 minutes.
|
||||
*
|
||||
* @default - no value
|
||||
*/
|
||||
readonly maxWindow?: Duration;
|
||||
private constructor();
|
||||
}
|
||||
/**
|
||||
* Construction properties for `Schedule`.
|
||||
*/
|
||||
export interface ScheduleProps {
|
||||
/**
|
||||
* The expression that defines when the schedule runs. Can be either a `at`, `rate`
|
||||
* or `cron` expression.
|
||||
*/
|
||||
readonly schedule: ScheduleExpression;
|
||||
/**
|
||||
* The schedule's target details.
|
||||
*/
|
||||
readonly target: IScheduleTarget;
|
||||
/**
|
||||
* The name of the schedule.
|
||||
*
|
||||
* Up to 64 letters (uppercase and lowercase), numbers, hyphens, underscores and dots are allowed.
|
||||
*
|
||||
* @default - A unique name will be generated
|
||||
*/
|
||||
readonly scheduleName?: string;
|
||||
/**
|
||||
* The description you specify for the schedule.
|
||||
*
|
||||
* @default - no value
|
||||
*/
|
||||
readonly description?: string;
|
||||
/**
|
||||
* The schedule's group.
|
||||
*
|
||||
* @default - By default a schedule will be associated with the `default` group.
|
||||
*/
|
||||
readonly scheduleGroup?: IScheduleGroup;
|
||||
/**
|
||||
* Indicates whether the schedule is enabled.
|
||||
*
|
||||
* @default true
|
||||
*/
|
||||
readonly enabled?: boolean;
|
||||
/**
|
||||
* The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
|
||||
*
|
||||
* @default - All events in Scheduler are encrypted with a key that AWS owns and manages.
|
||||
*/
|
||||
readonly key?: kms.IKey;
|
||||
/**
|
||||
* A time window during which EventBridge Scheduler invokes the schedule.
|
||||
*
|
||||
* @see https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule-flexible-time-windows.html
|
||||
*
|
||||
* @default TimeWindow.off()
|
||||
*/
|
||||
readonly timeWindow?: TimeWindow;
|
||||
/**
|
||||
* The date, in UTC, after which the schedule can begin invoking its target.
|
||||
* EventBridge Scheduler ignores start for one-time schedules.
|
||||
*
|
||||
* @default - no value
|
||||
*/
|
||||
readonly start?: Date;
|
||||
/**
|
||||
* The date, in UTC, before which the schedule can invoke its target.
|
||||
* EventBridge Scheduler ignores end for one-time schedules.
|
||||
*
|
||||
* @default - no value
|
||||
*/
|
||||
readonly end?: Date;
|
||||
}
|
||||
/**
|
||||
* An EventBridge Schedule
|
||||
*/
|
||||
export declare class Schedule extends Resource implements ISchedule {
|
||||
/** Uniquely identifies this class. */
|
||||
static readonly PROPERTY_INJECTION_ID: string;
|
||||
/**
|
||||
* Return the given named metric for all schedules.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
static metricAll(metricName: string, props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for the number of invocations that were throttled across all schedules.
|
||||
*
|
||||
* @see https://docs.aws.amazon.com/scheduler/latest/UserGuide/scheduler-quotas.html
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
static metricAllThrottled(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for all invocation attempts across all schedules.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
static metricAllAttempts(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Emitted when the target returns an exception after EventBridge Scheduler calls the target API across all schedules.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
static metricAllErrors(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for invocation failures due to API throttling by the target across all schedules.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
static metricAllTargetThrottled(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.
|
||||
* Metric is calculated for all schedules.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
static metricAllDropped(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for invocations delivered to the DLQ across all schedules.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
static metricAllSentToDLQ(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for failed invocations that also failed to deliver to DLQ across all schedules.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
static metricAllFailedToBeSentToDLQ(errorCode?: string, props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Metric for delivery of failed invocations to DLQ when the payload of the event sent to the DLQ exceeds the maximum size allowed by Amazon SQS.
|
||||
* Metric is calculated for all schedules.
|
||||
*
|
||||
* @default - sum over 5 minutes
|
||||
*/
|
||||
static metricAllSentToDLQTruncated(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
|
||||
/**
|
||||
* Import an existing schedule using the ARN.
|
||||
*/
|
||||
static fromScheduleArn(scope: Construct, id: string, scheduleArn: string): ISchedule;
|
||||
/**
|
||||
* The schedule group associated with this schedule.
|
||||
*/
|
||||
readonly scheduleGroup?: IScheduleGroup;
|
||||
/**
|
||||
* The arn of the schedule.
|
||||
*/
|
||||
get scheduleArn(): string;
|
||||
/**
|
||||
* The name of the schedule.
|
||||
*/
|
||||
get scheduleName(): string;
|
||||
/**
|
||||
* The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
|
||||
*/
|
||||
readonly key?: kms.IKey;
|
||||
private readonly _resource;
|
||||
/**
|
||||
* A `RetryPolicy` object that includes information about the retry policy settings.
|
||||
*/
|
||||
private readonly retryPolicy?;
|
||||
constructor(scope: Construct, id: string, props: ScheduleProps);
|
||||
private renderRetryPolicy;
|
||||
private validateTimeFrame;
|
||||
get scheduleRef(): ScheduleReference;
|
||||
}
|
||||
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/schedule.js
generated
vendored
Normal file
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/schedule.js
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
900
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/scheduler.generated.d.ts
generated
vendored
Normal file
900
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/scheduler.generated.d.ts
generated
vendored
Normal file
@@ -0,0 +1,900 @@
|
||||
import * as cdk from "../../core/lib";
|
||||
import * as constructs from "constructs";
|
||||
import * as cfn_parse from "../../core/lib/helpers-internal";
|
||||
import { aws_kms as kmsRefs } from "../../interfaces";
|
||||
import { IScheduleGroupRef, IScheduleRef, ScheduleGroupReference, ScheduleReference } from "../../interfaces/generated/aws-scheduler-interfaces.generated";
|
||||
/**
|
||||
* A *schedule* is the main resource you create, configure, and manage using Amazon EventBridge Scheduler.
|
||||
*
|
||||
* Every schedule has a *schedule expression* that determines when, and with what frequency, the schedule runs. EventBridge Scheduler supports three types of schedules: rate, cron, and one-time schedules. For more information about different schedule types, see [Schedule types](https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html) in the *EventBridge Scheduler User Guide* .
|
||||
*
|
||||
* When you create a schedule, you configure a target for the schedule to invoke. A target is an API operation that EventBridge Scheduler calls on your behalf every time your schedule runs. EventBridge Scheduler supports two types of targets: *templated* targets invoke common API operations across a core groups of services, and customizeable *universal* targets that you can use to call more than 6,000 operations across over 270 services. For more information about configuring targets, see [Managing targets](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-targets.html) in the *EventBridge Scheduler User Guide* .
|
||||
*
|
||||
* For more information about managing schedules, changing the schedule state, setting up flexible time windows, and configuring a dead-letter queue for a schedule, see [Managing a schedule](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule.html) in the *EventBridge Scheduler User Guide* .
|
||||
*
|
||||
* @cloudformationResource AWS::Scheduler::Schedule
|
||||
* @stability external
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html
|
||||
*/
|
||||
export declare class CfnSchedule extends cdk.CfnResource implements cdk.IInspectable, IScheduleRef {
|
||||
/**
|
||||
* The CloudFormation resource type name for this resource class.
|
||||
*/
|
||||
static readonly CFN_RESOURCE_TYPE_NAME: string;
|
||||
/**
|
||||
* Build a CfnSchedule from CloudFormation properties
|
||||
*
|
||||
* A factory method that creates a new instance of this class from an object
|
||||
* containing the CloudFormation properties of this resource.
|
||||
* Used in the @aws-cdk/cloudformation-include module.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnSchedule;
|
||||
/**
|
||||
* Checks whether the given object is a CfnSchedule
|
||||
*/
|
||||
static isCfnSchedule(x: any): x is CfnSchedule;
|
||||
static arnForSchedule(resource: IScheduleRef): string;
|
||||
/**
|
||||
* The description you specify for the schedule.
|
||||
*/
|
||||
private _description?;
|
||||
/**
|
||||
* The date, in UTC, before which the schedule can invoke its target.
|
||||
*/
|
||||
private _endDate?;
|
||||
/**
|
||||
* Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
|
||||
*/
|
||||
private _flexibleTimeWindow;
|
||||
/**
|
||||
* The name of the schedule group associated with this schedule.
|
||||
*/
|
||||
private _groupName?;
|
||||
/**
|
||||
* The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
|
||||
*/
|
||||
private _kmsKeyArn?;
|
||||
/**
|
||||
* The name of the schedule.
|
||||
*/
|
||||
private _name?;
|
||||
/**
|
||||
* The expression that defines when the schedule runs. The following formats are supported.
|
||||
*/
|
||||
private _scheduleExpression;
|
||||
/**
|
||||
* The timezone in which the scheduling expression is evaluated.
|
||||
*/
|
||||
private _scheduleExpressionTimezone?;
|
||||
/**
|
||||
* The date, in UTC, after which the schedule can begin invoking its target.
|
||||
*/
|
||||
private _startDate?;
|
||||
/**
|
||||
* Specifies whether the schedule is enabled or disabled.
|
||||
*/
|
||||
private _state?;
|
||||
/**
|
||||
* The schedule's target details.
|
||||
*/
|
||||
private _target;
|
||||
protected readonly cfnPropertyNames: Record<string, string>;
|
||||
/**
|
||||
* Create a new `AWS::Scheduler::Schedule`.
|
||||
*
|
||||
* @param scope Scope in which this resource is defined
|
||||
* @param id Construct identifier for this resource (unique in its scope)
|
||||
* @param props Resource properties
|
||||
*/
|
||||
constructor(scope: constructs.Construct, id: string, props: CfnScheduleProps);
|
||||
get scheduleRef(): ScheduleReference;
|
||||
/**
|
||||
* The description you specify for the schedule.
|
||||
*/
|
||||
get description(): string | undefined;
|
||||
/**
|
||||
* The description you specify for the schedule.
|
||||
*/
|
||||
set description(value: string | undefined);
|
||||
/**
|
||||
* The date, in UTC, before which the schedule can invoke its target.
|
||||
*/
|
||||
get endDate(): string | undefined;
|
||||
/**
|
||||
* The date, in UTC, before which the schedule can invoke its target.
|
||||
*/
|
||||
set endDate(value: string | undefined);
|
||||
/**
|
||||
* Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
|
||||
*/
|
||||
get flexibleTimeWindow(): CfnSchedule.FlexibleTimeWindowProperty | cdk.IResolvable;
|
||||
/**
|
||||
* Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
|
||||
*/
|
||||
set flexibleTimeWindow(value: CfnSchedule.FlexibleTimeWindowProperty | cdk.IResolvable);
|
||||
/**
|
||||
* The name of the schedule group associated with this schedule.
|
||||
*/
|
||||
get groupName(): string | undefined;
|
||||
/**
|
||||
* The name of the schedule group associated with this schedule.
|
||||
*/
|
||||
set groupName(value: string | undefined);
|
||||
/**
|
||||
* The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
|
||||
*/
|
||||
get kmsKeyArn(): string | undefined;
|
||||
/**
|
||||
* The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
|
||||
*/
|
||||
set kmsKeyArn(value: string | undefined);
|
||||
/**
|
||||
* The name of the schedule.
|
||||
*/
|
||||
get name(): string | undefined;
|
||||
/**
|
||||
* The name of the schedule.
|
||||
*/
|
||||
set name(value: string | undefined);
|
||||
/**
|
||||
* The expression that defines when the schedule runs. The following formats are supported.
|
||||
*/
|
||||
get scheduleExpression(): string;
|
||||
/**
|
||||
* The expression that defines when the schedule runs. The following formats are supported.
|
||||
*/
|
||||
set scheduleExpression(value: string);
|
||||
/**
|
||||
* The timezone in which the scheduling expression is evaluated.
|
||||
*/
|
||||
get scheduleExpressionTimezone(): string | undefined;
|
||||
/**
|
||||
* The timezone in which the scheduling expression is evaluated.
|
||||
*/
|
||||
set scheduleExpressionTimezone(value: string | undefined);
|
||||
/**
|
||||
* The date, in UTC, after which the schedule can begin invoking its target.
|
||||
*/
|
||||
get startDate(): string | undefined;
|
||||
/**
|
||||
* The date, in UTC, after which the schedule can begin invoking its target.
|
||||
*/
|
||||
set startDate(value: string | undefined);
|
||||
/**
|
||||
* Specifies whether the schedule is enabled or disabled.
|
||||
*/
|
||||
get state(): string | undefined;
|
||||
/**
|
||||
* Specifies whether the schedule is enabled or disabled.
|
||||
*/
|
||||
set state(value: string | undefined);
|
||||
/**
|
||||
* The schedule's target details.
|
||||
*/
|
||||
get target(): cdk.IResolvable | CfnSchedule.TargetProperty;
|
||||
/**
|
||||
* The schedule's target details.
|
||||
*/
|
||||
set target(value: cdk.IResolvable | CfnSchedule.TargetProperty);
|
||||
/**
|
||||
* The Amazon Resource Name (ARN) for the Amazon EventBridge Scheduler schedule.
|
||||
*
|
||||
* @cloudformationAttribute Arn
|
||||
*/
|
||||
get attrArn(): string;
|
||||
protected get cfnProperties(): Record<string, any>;
|
||||
/**
|
||||
* Examines the CloudFormation resource and discloses attributes
|
||||
*
|
||||
* @param inspector tree inspector to collect and process attributes
|
||||
*/
|
||||
inspect(inspector: cdk.TreeInspector): void;
|
||||
protected renderProperties(props: Record<string, any>): Record<string, any>;
|
||||
}
|
||||
export declare namespace CfnSchedule {
|
||||
/**
|
||||
* The schedule's target.
|
||||
*
|
||||
* EventBridge Scheduler supports templated target that invoke common API operations, as well as universal targets that you can customize to invoke over 6,000 API operations across more than 270 services. You can only specify one templated or universal target for a schedule.
|
||||
*
|
||||
* @struct
|
||||
* @stability external
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html
|
||||
*/
|
||||
interface TargetProperty {
|
||||
/**
|
||||
* The Amazon Resource Name (ARN) of the target.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-arn
|
||||
*/
|
||||
readonly arn: string;
|
||||
/**
|
||||
* An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.
|
||||
*
|
||||
* If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-deadletterconfig
|
||||
*/
|
||||
readonly deadLetterConfig?: CfnSchedule.DeadLetterConfigProperty | cdk.IResolvable;
|
||||
/**
|
||||
* The templated target type for the Amazon ECS [`RunTask`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) API operation.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-ecsparameters
|
||||
*/
|
||||
readonly ecsParameters?: CfnSchedule.EcsParametersProperty | cdk.IResolvable;
|
||||
/**
|
||||
* The templated target type for the EventBridge [`PutEvents`](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) API operation.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-eventbridgeparameters
|
||||
*/
|
||||
readonly eventBridgeParameters?: CfnSchedule.EventBridgeParametersProperty | cdk.IResolvable;
|
||||
/**
|
||||
* The text, or well-formed JSON, passed to the target.
|
||||
*
|
||||
* If you are configuring a templated Lambda , AWS Step Functions , or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, Amazon EventBridge Scheduler delivers a default notification to the target.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-input
|
||||
*/
|
||||
readonly input?: string;
|
||||
/**
|
||||
* The templated target type for the Amazon Kinesis [`PutRecord`](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html) API operation.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-kinesisparameters
|
||||
*/
|
||||
readonly kinesisParameters?: cdk.IResolvable | CfnSchedule.KinesisParametersProperty;
|
||||
/**
|
||||
* A `RetryPolicy` object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-retrypolicy
|
||||
*/
|
||||
readonly retryPolicy?: cdk.IResolvable | CfnSchedule.RetryPolicyProperty;
|
||||
/**
|
||||
* The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn
|
||||
*/
|
||||
readonly roleArn: string;
|
||||
/**
|
||||
* The templated target type for the Amazon SageMaker [`StartPipelineExecution`](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html) API operation.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-sagemakerpipelineparameters
|
||||
*/
|
||||
readonly sageMakerPipelineParameters?: cdk.IResolvable | CfnSchedule.SageMakerPipelineParametersProperty;
|
||||
/**
|
||||
* The templated target type for the Amazon SQS [`SendMessage`](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see [Using the Amazon SQS message deduplication ID](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) in the *Amazon SQS Developer Guide* .
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-sqsparameters
|
||||
*/
|
||||
readonly sqsParameters?: cdk.IResolvable | CfnSchedule.SqsParametersProperty;
|
||||
}
|
||||
/**
|
||||
* The templated target type for the Amazon SQS [`SendMessage`](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see [Using the Amazon SQS message deduplication ID](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) in the *Amazon SQS Developer Guide* .
|
||||
*
|
||||
* @struct
|
||||
* @stability external
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sqsparameters.html
|
||||
*/
|
||||
interface SqsParametersProperty {
|
||||
/**
|
||||
* The FIFO message group ID to use as the target.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sqsparameters.html#cfn-scheduler-schedule-sqsparameters-messagegroupid
|
||||
*/
|
||||
readonly messageGroupId?: string;
|
||||
}
|
||||
/**
|
||||
* An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.
|
||||
*
|
||||
* If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.
|
||||
*
|
||||
* @struct
|
||||
* @stability external
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-deadletterconfig.html
|
||||
*/
|
||||
interface DeadLetterConfigProperty {
|
||||
/**
|
||||
* The Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-deadletterconfig.html#cfn-scheduler-schedule-deadletterconfig-arn
|
||||
*/
|
||||
readonly arn?: string;
|
||||
}
|
||||
/**
|
||||
* The templated target type for the Amazon ECS [`RunTask`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) API operation.
|
||||
*
|
||||
* @struct
|
||||
* @stability external
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html
|
||||
*/
|
||||
interface EcsParametersProperty {
|
||||
/**
|
||||
* The capacity provider strategy to use for the task.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-capacityproviderstrategy
|
||||
*/
|
||||
readonly capacityProviderStrategy?: Array<CfnSchedule.CapacityProviderStrategyItemProperty | cdk.IResolvable> | cdk.IResolvable;
|
||||
/**
|
||||
* Specifies whether to enable Amazon ECS managed tags for the task.
|
||||
*
|
||||
* For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon ECS Developer Guide* .
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-enableecsmanagedtags
|
||||
*/
|
||||
readonly enableEcsManagedTags?: boolean | cdk.IResolvable;
|
||||
/**
|
||||
* Whether or not to enable the execute command functionality for the containers in this task.
|
||||
*
|
||||
* If true, this enables execute command functionality on all containers in the task.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-enableexecutecommand
|
||||
*/
|
||||
readonly enableExecuteCommand?: boolean | cdk.IResolvable;
|
||||
/**
|
||||
* Specifies an Amazon ECS task group for the task.
|
||||
*
|
||||
* The maximum length is 255 characters.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-group
|
||||
*/
|
||||
readonly group?: string;
|
||||
/**
|
||||
* Specifies the launch type on which your task is running.
|
||||
*
|
||||
* The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The `FARGATE` value is supported only in the Regions where 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 ECS Developer Guide* .
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-launchtype
|
||||
*/
|
||||
readonly launchType?: string;
|
||||
/**
|
||||
* This structure specifies the network configuration for an ECS task.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-networkconfiguration
|
||||
*/
|
||||
readonly networkConfiguration?: cdk.IResolvable | CfnSchedule.NetworkConfigurationProperty;
|
||||
/**
|
||||
* An array of placement constraint objects to use for the task.
|
||||
*
|
||||
* You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-placementconstraints
|
||||
*/
|
||||
readonly placementConstraints?: Array<cdk.IResolvable | CfnSchedule.PlacementConstraintProperty> | cdk.IResolvable;
|
||||
/**
|
||||
* The task placement strategy for a task or service.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-placementstrategy
|
||||
*/
|
||||
readonly placementStrategy?: Array<cdk.IResolvable | CfnSchedule.PlacementStrategyProperty> | cdk.IResolvable;
|
||||
/**
|
||||
* Specifies the platform version for the task.
|
||||
*
|
||||
* Specify only the numeric portion of the platform version, such as `1.1.0` .
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-platformversion
|
||||
*/
|
||||
readonly platformVersion?: string;
|
||||
/**
|
||||
* Specifies whether to propagate the tags from the task definition to the task.
|
||||
*
|
||||
* If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the Amazon ECS [`TagResource`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-propagatetags
|
||||
*/
|
||||
readonly propagateTags?: string;
|
||||
/**
|
||||
* The reference ID to use for the task.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-referenceid
|
||||
*/
|
||||
readonly referenceId?: string;
|
||||
/**
|
||||
* The metadata that you apply to the task to help you categorize and organize them.
|
||||
*
|
||||
* Each tag consists of a key and an optional value, both of which you define. For more information, see [`RunTask`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) in the *Amazon ECS API Reference* .
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-tags
|
||||
*/
|
||||
readonly tags?: any;
|
||||
/**
|
||||
* The number of tasks to create based on `TaskDefinition` .
|
||||
*
|
||||
* The default is `1` .
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-taskcount
|
||||
*/
|
||||
readonly taskCount?: number;
|
||||
/**
|
||||
* The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-taskdefinitionarn
|
||||
*/
|
||||
readonly taskDefinitionArn: string;
|
||||
}
|
||||
/**
|
||||
* An object representing a constraint on task placement.
|
||||
*
|
||||
* @struct
|
||||
* @stability external
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-placementconstraint.html
|
||||
*/
|
||||
interface PlacementConstraintProperty {
|
||||
/**
|
||||
* A cluster query language expression to apply to the constraint.
|
||||
*
|
||||
* You cannot specify an expression if the constraint type is `distinctInstance` . For more information, see [Cluster query language](https://docs.aws.amazon.com/latest/developerguide/cluster-query-language.html) in the *Amazon ECS Developer Guide* .
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-placementconstraint.html#cfn-scheduler-schedule-placementconstraint-expression
|
||||
*/
|
||||
readonly expression?: string;
|
||||
/**
|
||||
* The type of constraint.
|
||||
*
|
||||
* Use `distinctInstance` to ensure that each task in a particular group is running on a different container instance. Use `memberOf` to restrict the selection to a group of valid candidates.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-placementconstraint.html#cfn-scheduler-schedule-placementconstraint-type
|
||||
*/
|
||||
readonly type?: string;
|
||||
}
|
||||
/**
|
||||
* The task placement strategy for a task or service.
|
||||
*
|
||||
* @struct
|
||||
* @stability external
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-placementstrategy.html
|
||||
*/
|
||||
interface PlacementStrategyProperty {
|
||||
/**
|
||||
* The field to apply the placement strategy against.
|
||||
*
|
||||
* For the spread placement strategy, valid values are `instanceId` (or `instanceId` , 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.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-placementstrategy.html#cfn-scheduler-schedule-placementstrategy-field
|
||||
*/
|
||||
readonly field?: string;
|
||||
/**
|
||||
* The type of placement strategy.
|
||||
*
|
||||
* The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-placementstrategy.html#cfn-scheduler-schedule-placementstrategy-type
|
||||
*/
|
||||
readonly type?: string;
|
||||
}
|
||||
/**
|
||||
* The details of a capacity provider strategy.
|
||||
*
|
||||
* @struct
|
||||
* @stability external
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-capacityproviderstrategyitem.html
|
||||
*/
|
||||
interface CapacityProviderStrategyItemProperty {
|
||||
/**
|
||||
* The base value designates how many tasks, at a minimum, to run on the specified capacity provider.
|
||||
*
|
||||
* Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of `0` is used.
|
||||
*
|
||||
* @default - 0
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-capacityproviderstrategyitem.html#cfn-scheduler-schedule-capacityproviderstrategyitem-base
|
||||
*/
|
||||
readonly base?: number;
|
||||
/**
|
||||
* The short name of the capacity provider.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-capacityproviderstrategyitem.html#cfn-scheduler-schedule-capacityproviderstrategyitem-capacityprovider
|
||||
*/
|
||||
readonly capacityProvider: string;
|
||||
/**
|
||||
* The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
|
||||
*
|
||||
* The weight value is taken into consideration after the base value, if defined, is satisfied.
|
||||
*
|
||||
* @default - 0
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-capacityproviderstrategyitem.html#cfn-scheduler-schedule-capacityproviderstrategyitem-weight
|
||||
*/
|
||||
readonly weight?: number;
|
||||
}
|
||||
/**
|
||||
* Specifies the network configuration for an ECS task.
|
||||
*
|
||||
* @struct
|
||||
* @stability external
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-networkconfiguration.html
|
||||
*/
|
||||
interface NetworkConfigurationProperty {
|
||||
/**
|
||||
* Specifies the Amazon VPC subnets and security groups for the task, and whether a public IP address is to be used.
|
||||
*
|
||||
* This structure is relevant only for ECS tasks that use the awsvpc network mode.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-networkconfiguration.html#cfn-scheduler-schedule-networkconfiguration-awsvpcconfiguration
|
||||
*/
|
||||
readonly awsvpcConfiguration?: CfnSchedule.AwsVpcConfigurationProperty | cdk.IResolvable;
|
||||
}
|
||||
/**
|
||||
* This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used.
|
||||
*
|
||||
* This structure is relevant only for ECS tasks that use the awsvpc network mode.
|
||||
*
|
||||
* @struct
|
||||
* @stability external
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-awsvpcconfiguration.html
|
||||
*/
|
||||
interface AwsVpcConfigurationProperty {
|
||||
/**
|
||||
* Specifies whether the task's elastic network interface receives a public IP address.
|
||||
*
|
||||
* You can specify `ENABLED` only when `LaunchType` in `EcsParameters` is set to `FARGATE` .
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-awsvpcconfiguration.html#cfn-scheduler-schedule-awsvpcconfiguration-assignpublicip
|
||||
*/
|
||||
readonly assignPublicIp?: string;
|
||||
/**
|
||||
* Specifies the security groups associated with the task.
|
||||
*
|
||||
* These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-awsvpcconfiguration.html#cfn-scheduler-schedule-awsvpcconfiguration-securitygroups
|
||||
*/
|
||||
readonly securityGroups?: Array<string>;
|
||||
/**
|
||||
* Specifies the subnets associated with the task.
|
||||
*
|
||||
* These subnets must all be in the same VPC. You can specify as many as 16 subnets.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-awsvpcconfiguration.html#cfn-scheduler-schedule-awsvpcconfiguration-subnets
|
||||
*/
|
||||
readonly subnets: Array<string>;
|
||||
}
|
||||
/**
|
||||
* The templated target type for the EventBridge [`PutEvents`](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) API operation.
|
||||
*
|
||||
* @struct
|
||||
* @stability external
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-eventbridgeparameters.html
|
||||
*/
|
||||
interface EventBridgeParametersProperty {
|
||||
/**
|
||||
* A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-eventbridgeparameters.html#cfn-scheduler-schedule-eventbridgeparameters-detailtype
|
||||
*/
|
||||
readonly detailType: string;
|
||||
/**
|
||||
* The source of the event.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-eventbridgeparameters.html#cfn-scheduler-schedule-eventbridgeparameters-source
|
||||
*/
|
||||
readonly source: string;
|
||||
}
|
||||
/**
|
||||
* The templated target type for the Amazon Kinesis [`PutRecord`](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html) API operation.
|
||||
*
|
||||
* @struct
|
||||
* @stability external
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-kinesisparameters.html
|
||||
*/
|
||||
interface KinesisParametersProperty {
|
||||
/**
|
||||
* Specifies the shard to which EventBridge Scheduler sends the event.
|
||||
*
|
||||
* For more information, see [Amazon Kinesis Data Streams terminology and concepts](https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html) in the *Amazon Kinesis Streams Developer Guide* .
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-kinesisparameters.html#cfn-scheduler-schedule-kinesisparameters-partitionkey
|
||||
*/
|
||||
readonly partitionKey: string;
|
||||
}
|
||||
/**
|
||||
* The templated target type for the Amazon SageMaker [`StartPipelineExecution`](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html) API operation.
|
||||
*
|
||||
* @struct
|
||||
* @stability external
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sagemakerpipelineparameters.html
|
||||
*/
|
||||
interface SageMakerPipelineParametersProperty {
|
||||
/**
|
||||
* List of parameter names and values to use when executing the SageMaker Model Building Pipeline.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sagemakerpipelineparameters.html#cfn-scheduler-schedule-sagemakerpipelineparameters-pipelineparameterlist
|
||||
*/
|
||||
readonly pipelineParameterList?: Array<cdk.IResolvable | CfnSchedule.SageMakerPipelineParameterProperty> | cdk.IResolvable;
|
||||
}
|
||||
/**
|
||||
* The name and value pair of a parameter to use to start execution of a SageMaker Model Building Pipeline.
|
||||
*
|
||||
* @struct
|
||||
* @stability external
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sagemakerpipelineparameter.html
|
||||
*/
|
||||
interface SageMakerPipelineParameterProperty {
|
||||
/**
|
||||
* Name of parameter to start execution of a SageMaker Model Building Pipeline.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sagemakerpipelineparameter.html#cfn-scheduler-schedule-sagemakerpipelineparameter-name
|
||||
*/
|
||||
readonly name: string;
|
||||
/**
|
||||
* Value of parameter to start execution of a SageMaker Model Building Pipeline.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sagemakerpipelineparameter.html#cfn-scheduler-schedule-sagemakerpipelineparameter-value
|
||||
*/
|
||||
readonly value: string;
|
||||
}
|
||||
/**
|
||||
* A `RetryPolicy` object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
|
||||
*
|
||||
* @struct
|
||||
* @stability external
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-retrypolicy.html
|
||||
*/
|
||||
interface RetryPolicyProperty {
|
||||
/**
|
||||
* The maximum amount of time, in seconds, to continue to make retry attempts.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-retrypolicy.html#cfn-scheduler-schedule-retrypolicy-maximumeventageinseconds
|
||||
*/
|
||||
readonly maximumEventAgeInSeconds?: number;
|
||||
/**
|
||||
* The maximum number of retry attempts to make before the request fails.
|
||||
*
|
||||
* Retry attempts with exponential backoff continue until either the maximum number of attempts is made or until the duration of the `MaximumEventAgeInSeconds` is reached.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-retrypolicy.html#cfn-scheduler-schedule-retrypolicy-maximumretryattempts
|
||||
*/
|
||||
readonly maximumRetryAttempts?: number;
|
||||
}
|
||||
/**
|
||||
* Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
|
||||
*
|
||||
* @struct
|
||||
* @stability external
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-flexibletimewindow.html
|
||||
*/
|
||||
interface FlexibleTimeWindowProperty {
|
||||
/**
|
||||
* The maximum time window during which a schedule can be invoked.
|
||||
*
|
||||
* *Minimum* : `1`
|
||||
*
|
||||
* *Maximum* : `1440`
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-flexibletimewindow.html#cfn-scheduler-schedule-flexibletimewindow-maximumwindowinminutes
|
||||
*/
|
||||
readonly maximumWindowInMinutes?: number;
|
||||
/**
|
||||
* Determines whether the schedule is invoked within a flexible time window.
|
||||
*
|
||||
* You must use quotation marks when you specify this value in your JSON or YAML template.
|
||||
*
|
||||
* *Allowed Values* : `"OFF"` | `"FLEXIBLE"`
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-flexibletimewindow.html#cfn-scheduler-schedule-flexibletimewindow-mode
|
||||
*/
|
||||
readonly mode: string;
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Properties for defining a `CfnSchedule`
|
||||
*
|
||||
* @struct
|
||||
* @stability external
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html
|
||||
*/
|
||||
export interface CfnScheduleProps {
|
||||
/**
|
||||
* The description you specify for the schedule.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-description
|
||||
*/
|
||||
readonly description?: string;
|
||||
/**
|
||||
* The date, in UTC, before which the schedule can invoke its target.
|
||||
*
|
||||
* Depending on the schedule's recurrence expression, invocations might stop on, or before, the `EndDate` you specify.
|
||||
* EventBridge Scheduler ignores `EndDate` for one-time schedules.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-enddate
|
||||
*/
|
||||
readonly endDate?: string;
|
||||
/**
|
||||
* Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-flexibletimewindow
|
||||
*/
|
||||
readonly flexibleTimeWindow: CfnSchedule.FlexibleTimeWindowProperty | cdk.IResolvable;
|
||||
/**
|
||||
* The name of the schedule group associated with this schedule.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-groupname
|
||||
*/
|
||||
readonly groupName?: string;
|
||||
/**
|
||||
* The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-kmskeyarn
|
||||
*/
|
||||
readonly kmsKeyArn?: kmsRefs.IKeyRef | string;
|
||||
/**
|
||||
* The name of the schedule.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-name
|
||||
*/
|
||||
readonly name?: string;
|
||||
/**
|
||||
* The expression that defines when the schedule runs. The following formats are supported.
|
||||
*
|
||||
* - `at` expression - `at(yyyy-mm-ddThh:mm:ss)`
|
||||
* - `rate` expression - `rate(value unit)`
|
||||
* - `cron` expression - `cron(fields)`
|
||||
*
|
||||
* You can use `at` expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use `rate` and `cron` expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.
|
||||
*
|
||||
* A `cron` expression consists of six fields separated by white spaces: `(minutes hours day_of_month month day_of_week year)` .
|
||||
*
|
||||
* A `rate` expression consists of a *value* as a positive integer, and a *unit* with the following options: `minute` | `minutes` | `hour` | `hours` | `day` | `days`
|
||||
*
|
||||
* For more information and examples, see [Schedule types on EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html) in the *EventBridge Scheduler User Guide* .
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpression
|
||||
*/
|
||||
readonly scheduleExpression: string;
|
||||
/**
|
||||
* The timezone in which the scheduling expression is evaluated.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpressiontimezone
|
||||
*/
|
||||
readonly scheduleExpressionTimezone?: string;
|
||||
/**
|
||||
* The date, in UTC, after which the schedule can begin invoking its target.
|
||||
*
|
||||
* Depending on the schedule's recurrence expression, invocations might occur on, or after, the `StartDate` you specify.
|
||||
* EventBridge Scheduler ignores `StartDate` for one-time schedules.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-startdate
|
||||
*/
|
||||
readonly startDate?: string;
|
||||
/**
|
||||
* Specifies whether the schedule is enabled or disabled.
|
||||
*
|
||||
* *Allowed Values* : `ENABLED` | `DISABLED`
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-state
|
||||
*/
|
||||
readonly state?: string;
|
||||
/**
|
||||
* The schedule's target details.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-target
|
||||
*/
|
||||
readonly target: cdk.IResolvable | CfnSchedule.TargetProperty;
|
||||
}
|
||||
/**
|
||||
* A *schedule group* is an Amazon EventBridge Scheduler resource you use to organize your schedules.
|
||||
*
|
||||
* Your AWS account comes with a `default` scheduler group. You associate a new schedule with the `default` group or with schedule groups that you create and manage. You can create up to [500 schedule groups](https://docs.aws.amazon.com/scheduler/latest/UserGuide/scheduler-quotas.html) in your AWS account. With EventBridge Scheduler, you apply [tags](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) to schedule groups, not to individual schedules to organize your resources.
|
||||
*
|
||||
* For more information about managing schedule groups, see [Managing a schedule group](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule-group.html) in the *EventBridge Scheduler User Guide* .
|
||||
*
|
||||
* @cloudformationResource AWS::Scheduler::ScheduleGroup
|
||||
* @stability external
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedulegroup.html
|
||||
*/
|
||||
export declare class CfnScheduleGroup extends cdk.CfnResource implements cdk.IInspectable, IScheduleGroupRef, cdk.ITaggable {
|
||||
/**
|
||||
* The CloudFormation resource type name for this resource class.
|
||||
*/
|
||||
static readonly CFN_RESOURCE_TYPE_NAME: string;
|
||||
/**
|
||||
* Build a CfnScheduleGroup from CloudFormation properties
|
||||
*
|
||||
* A factory method that creates a new instance of this class from an object
|
||||
* containing the CloudFormation properties of this resource.
|
||||
* Used in the @aws-cdk/cloudformation-include module.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnScheduleGroup;
|
||||
/**
|
||||
* Checks whether the given object is a CfnScheduleGroup
|
||||
*/
|
||||
static isCfnScheduleGroup(x: any): x is CfnScheduleGroup;
|
||||
static arnForScheduleGroup(resource: IScheduleGroupRef): string;
|
||||
/**
|
||||
* The name of the schedule group.
|
||||
*/
|
||||
private _name?;
|
||||
/**
|
||||
* Tag Manager which manages the tags for this resource
|
||||
*/
|
||||
readonly tags: cdk.TagManager;
|
||||
/**
|
||||
* An array of key-value pairs to apply to this resource.
|
||||
*/
|
||||
private _tagsRaw?;
|
||||
protected readonly cfnPropertyNames: Record<string, string>;
|
||||
/**
|
||||
* Create a new `AWS::Scheduler::ScheduleGroup`.
|
||||
*
|
||||
* @param scope Scope in which this resource is defined
|
||||
* @param id Construct identifier for this resource (unique in its scope)
|
||||
* @param props Resource properties
|
||||
*/
|
||||
constructor(scope: constructs.Construct, id: string, props?: CfnScheduleGroupProps);
|
||||
get scheduleGroupRef(): ScheduleGroupReference;
|
||||
/**
|
||||
* The name of the schedule group.
|
||||
*/
|
||||
get name(): string | undefined;
|
||||
/**
|
||||
* The name of the schedule group.
|
||||
*/
|
||||
set name(value: string | undefined);
|
||||
/**
|
||||
* An array of key-value pairs to apply to this resource.
|
||||
*/
|
||||
get tagsRaw(): Array<cdk.CfnTag> | undefined;
|
||||
/**
|
||||
* An array of key-value pairs to apply to this resource.
|
||||
*/
|
||||
set tagsRaw(value: Array<cdk.CfnTag> | undefined);
|
||||
/**
|
||||
* The Amazon Resource Name (ARN) of the schedule group.
|
||||
*
|
||||
* @cloudformationAttribute Arn
|
||||
*/
|
||||
get attrArn(): string;
|
||||
/**
|
||||
* The date and time at which the schedule group was created.
|
||||
*
|
||||
* @cloudformationAttribute CreationDate
|
||||
*/
|
||||
get attrCreationDate(): string;
|
||||
/**
|
||||
* The time at which the schedule group was last modified.
|
||||
*
|
||||
* @cloudformationAttribute LastModificationDate
|
||||
*/
|
||||
get attrLastModificationDate(): string;
|
||||
/**
|
||||
* Specifies the state of the schedule group.
|
||||
*
|
||||
* *Allowed Values* : `ACTIVE` | `DELETING`
|
||||
*
|
||||
* @cloudformationAttribute State
|
||||
*/
|
||||
get attrState(): string;
|
||||
protected get cfnProperties(): Record<string, any>;
|
||||
/**
|
||||
* Examines the CloudFormation resource and discloses attributes
|
||||
*
|
||||
* @param inspector tree inspector to collect and process attributes
|
||||
*/
|
||||
inspect(inspector: cdk.TreeInspector): void;
|
||||
protected renderProperties(props: Record<string, any>): Record<string, any>;
|
||||
}
|
||||
/**
|
||||
* Properties for defining a `CfnScheduleGroup`
|
||||
*
|
||||
* @struct
|
||||
* @stability external
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedulegroup.html
|
||||
*/
|
||||
export interface CfnScheduleGroupProps {
|
||||
/**
|
||||
* The name of the schedule group.
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedulegroup.html#cfn-scheduler-schedulegroup-name
|
||||
*/
|
||||
readonly name?: string;
|
||||
/**
|
||||
* An array of key-value pairs to apply to this resource.
|
||||
*
|
||||
* For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
|
||||
*
|
||||
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedulegroup.html#cfn-scheduler-schedulegroup-tags
|
||||
*/
|
||||
readonly tags?: Array<cdk.CfnTag>;
|
||||
}
|
||||
export type { IScheduleRef, ScheduleReference };
|
||||
export type { IScheduleGroupRef, ScheduleGroupReference };
|
||||
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/scheduler.generated.js
generated
vendored
Normal file
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/scheduler.generated.js
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
69
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/target.d.ts
generated
vendored
Normal file
69
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/target.d.ts
generated
vendored
Normal file
@@ -0,0 +1,69 @@
|
||||
import type { ScheduleTargetInput } from './input';
|
||||
import type { ISchedule } from './schedule';
|
||||
import type { CfnSchedule } from './scheduler.generated';
|
||||
import type * as iam from '../../aws-iam';
|
||||
/**
|
||||
* Interface representing a Event Bridge Schedule Target.
|
||||
*/
|
||||
export interface IScheduleTarget {
|
||||
/**
|
||||
* Returns the schedule target specification.
|
||||
*
|
||||
* @param _schedule a schedule the target should be added to.
|
||||
*/
|
||||
bind(_schedule: ISchedule): ScheduleTargetConfig;
|
||||
}
|
||||
/**
|
||||
* Config of a Schedule Target used during initialization of Schedule
|
||||
*/
|
||||
export interface ScheduleTargetConfig {
|
||||
/**
|
||||
* The Amazon Resource Name (ARN) of the target.
|
||||
*/
|
||||
readonly arn: string;
|
||||
/**
|
||||
* Role to use to invoke this event target
|
||||
*/
|
||||
readonly role: iam.IRole;
|
||||
/**
|
||||
* What input to pass to the target
|
||||
* @default - No input
|
||||
*/
|
||||
readonly input?: ScheduleTargetInput;
|
||||
/**
|
||||
* A `RetryPolicy` object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
|
||||
* @default - Maximum retry attempts of 185 and maximum age of 86400 seconds (1 day)
|
||||
*/
|
||||
readonly retryPolicy?: CfnSchedule.RetryPolicyProperty;
|
||||
/**
|
||||
* An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.
|
||||
* If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.
|
||||
* @default - No dead-letter queue
|
||||
*/
|
||||
readonly deadLetterConfig?: CfnSchedule.DeadLetterConfigProperty;
|
||||
/**
|
||||
* The templated target type for the Amazon ECS RunTask API Operation.
|
||||
* @default - No parameters
|
||||
*/
|
||||
readonly ecsParameters?: CfnSchedule.EcsParametersProperty;
|
||||
/**
|
||||
* The templated target type for the EventBridge PutEvents API operation.
|
||||
* @default - No parameters
|
||||
*/
|
||||
readonly eventBridgeParameters?: CfnSchedule.EventBridgeParametersProperty;
|
||||
/**
|
||||
* The templated target type for the Amazon Kinesis PutRecord API operation.
|
||||
* @default - No parameters
|
||||
*/
|
||||
readonly kinesisParameters?: CfnSchedule.KinesisParametersProperty;
|
||||
/**
|
||||
* The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
|
||||
* @default - No parameters
|
||||
*/
|
||||
readonly sageMakerPipelineParameters?: CfnSchedule.SageMakerPipelineParametersProperty;
|
||||
/**
|
||||
* The templated target type for the Amazon SQS SendMessage API Operation
|
||||
* @default - No parameters
|
||||
*/
|
||||
readonly sqsParameters?: CfnSchedule.SqsParametersProperty;
|
||||
}
|
||||
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/target.js
generated
vendored
Normal file
1
cdk/node_modules/aws-cdk-lib/aws-scheduler/lib/target.js
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
"use strict";Object.defineProperty(exports,"__esModule",{value:!0});
|
||||
Reference in New Issue
Block a user