Package software.amazon.awscdk.services.databrew

Class CfnSchedule

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.databrew.CfnSchedule
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.135Z") @Stability(Stable) public class CfnSchedule extends CfnResource implements IInspectable
A CloudFormation AWS::DataBrew::Schedule.

Specifies a new schedule for one or more AWS Glue DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.databrew.*;
 CfnSchedule cfnSchedule = CfnSchedule.Builder.create(this, "MyCfnSchedule")
         .cronExpression("cronExpression")
         .name("name")
         // the properties below are optional
         .jobNames(List.of("jobNames"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSchedule

      protected CfnSchedule(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSchedule

      protected CfnSchedule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSchedule

      @Stability(Stable) public CfnSchedule(@NotNull Construct scope, @NotNull String id, @NotNull CfnScheduleProps props)
      Create a new AWS::DataBrew::Schedule.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Metadata tags that have been applied to the schedule.

    • getCronExpression

      @Stability(Stable) @NotNull public String getCronExpression()
      The dates and times when the job is to run.

      For more information, see Working with cron expressions for recipe jobs in the AWS Glue DataBrew Developer Guide .

    • setCronExpression

      @Stability(Stable) public void setCronExpression(@NotNull String value)
      The dates and times when the job is to run.

      For more information, see Working with cron expressions for recipe jobs in the AWS Glue DataBrew Developer Guide .

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the schedule.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the schedule.

    • getJobNames

      @Stability(Stable) @Nullable public List<String> getJobNames()
      A list of jobs to be run, according to the schedule.

    • setJobNames

      @Stability(Stable) public void setJobNames(@Nullable List<String> value)
      A list of jobs to be run, according to the schedule.