Package software.amazon.awscdk.cfnpropertymixins.services.scheduler

Class CfnScheduleMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.scheduler.CfnScheduleMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnScheduleMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnScheduleMixinProps

@Stability(Stable)
@Internal
public static final class CfnScheduleMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnScheduleMixinProps

An implementation for CfnScheduleMixinProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.scheduler.CfnScheduleMixinProps

CfnScheduleMixinProps.Builder, CfnScheduleMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnScheduleMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnScheduleMixinProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getDescription()	The description you specify for the schedule.
final String	getEndDate()	The date, in UTC, before which the schedule can invoke its target.
final Object	getFlexibleTimeWindow()	Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
final String	getGroupName()	The name of the schedule group associated with this schedule.
final Object	getKmsKeyArn()	The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
final String	getName()	The name of the schedule.
final String	getScheduleExpression()	The expression that defines when the schedule runs.
final String	getScheduleExpressionTimezone()	The timezone in which the scheduling expression is evaluated.
final String	getStartDate()	The date, in UTC, after which the schedule can begin invoking its target.
final String	getState()	Specifies whether the schedule is enabled or disabled.
final Object	getTarget()	The schedule's target details.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnScheduleMixinProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnScheduleMixinProps.Builder.

Method Details

getDescription

public final String getDescription()

Description copied from interface: CfnScheduleMixinProps

The description you specify for the schedule.

Specified by:

getDescription in interface CfnScheduleMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-description

getEndDate

public final String getEndDate()

Description copied from interface: CfnScheduleMixinProps

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.

Specified by:

getEndDate in interface CfnScheduleMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-enddate

getFlexibleTimeWindow

public final Object getFlexibleTimeWindow()

Description copied from interface: CfnScheduleMixinProps

Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

Returns union: either IResolvable or CfnSchedulePropsMixin.FlexibleTimeWindowProperty

Specified by:

getFlexibleTimeWindow in interface CfnScheduleMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-flexibletimewindow

getGroupName

public final String getGroupName()

Description copied from interface: CfnScheduleMixinProps

The name of the schedule group associated with this schedule.

Specified by:

getGroupName in interface CfnScheduleMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-groupname

getKmsKeyArn

public final Object getKmsKeyArn()

Description copied from interface: CfnScheduleMixinProps

The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

Returns union: either String or IKeyRef

Specified by:

getKmsKeyArn in interface CfnScheduleMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-kmskeyarn

getName

public final String getName()

Description copied from interface: CfnScheduleMixinProps

The name of the schedule.

Specified by:

getName in interface CfnScheduleMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-name

getScheduleExpression

public final String getScheduleExpression()

Description copied from interface: CfnScheduleMixinProps

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

Specified by:

getScheduleExpression in interface CfnScheduleMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpression

getScheduleExpressionTimezone

public final String getScheduleExpressionTimezone()

Description copied from interface: CfnScheduleMixinProps

The timezone in which the scheduling expression is evaluated.

Specified by:

getScheduleExpressionTimezone in interface CfnScheduleMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpressiontimezone

getStartDate

public final String getStartDate()

Description copied from interface: CfnScheduleMixinProps

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.

Specified by:

getStartDate in interface CfnScheduleMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-startdate

getState

public final String getState()

Description copied from interface: CfnScheduleMixinProps

Specifies whether the schedule is enabled or disabled.

Allowed Values : ENABLED | DISABLED

Specified by:

getState in interface CfnScheduleMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-state

getTarget

public final Object getTarget()

Description copied from interface: CfnScheduleMixinProps

The schedule's target details.

Returns union: either IResolvable or CfnSchedulePropsMixin.TargetProperty

Specified by:

getTarget in interface CfnScheduleMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-target

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object