class CfnSchedulePropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Scheduler.Mixins.CfnSchedulePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsscheduler/mixins#CfnSchedulePropsMixin
Java	software.amazon.awscdk.mixins.preview.services.scheduler.mixins.CfnSchedulePropsMixin
Python	aws_cdk.mixins_preview.aws_scheduler.mixins.CfnSchedulePropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_scheduler » mixins » CfnSchedulePropsMixin

Implements IMixin

Extends Mixin

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 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 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 in the EventBridge Scheduler User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as scheduler_mixins } from '@aws-cdk/mixins-preview/aws-scheduler';

declare const tags: any;
const cfnSchedulePropsMixin = new scheduler_mixins.CfnSchedulePropsMixin({
  description: 'description',
  endDate: 'endDate',
  flexibleTimeWindow: {
    maximumWindowInMinutes: 123,
    mode: 'mode',
  },
  groupName: 'groupName',
  kmsKeyArn: 'kmsKeyArn',
  name: 'name',
  scheduleExpression: 'scheduleExpression',
  scheduleExpressionTimezone: 'scheduleExpressionTimezone',
  startDate: 'startDate',
  state: 'state',
  target: {
    arn: 'arn',
    deadLetterConfig: {
      arn: 'arn',
    },
    ecsParameters: {
      capacityProviderStrategy: [{
        base: 123,
        capacityProvider: 'capacityProvider',
        weight: 123,
      }],
      enableEcsManagedTags: false,
      enableExecuteCommand: false,
      group: 'group',
      launchType: 'launchType',
      networkConfiguration: {
        awsvpcConfiguration: {
          assignPublicIp: 'assignPublicIp',
          securityGroups: ['securityGroups'],
          subnets: ['subnets'],
        },
      },
      placementConstraints: [{
        expression: 'expression',
        type: 'type',
      }],
      placementStrategy: [{
        field: 'field',
        type: 'type',
      }],
      platformVersion: 'platformVersion',
      propagateTags: 'propagateTags',
      referenceId: 'referenceId',
      tags: tags,
      taskCount: 123,
      taskDefinitionArn: 'taskDefinitionArn',
    },
    eventBridgeParameters: {
      detailType: 'detailType',
      source: 'source',
    },
    input: 'input',
    kinesisParameters: {
      partitionKey: 'partitionKey',
    },
    retryPolicy: {
      maximumEventAgeInSeconds: 123,
      maximumRetryAttempts: 123,
    },
    roleArn: 'roleArn',
    sageMakerPipelineParameters: {
      pipelineParameterList: [{
        name: 'name',
        value: 'value',
      }],
    },
    sqsParameters: {
      messageGroupId: 'messageGroupId',
    },
  },
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnSchedulePropsMixin(props: CfnScheduleMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnScheduleMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Scheduler::Schedule.

Properties

Name	Type	Description
props	CfnScheduleMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnScheduleMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.