software.amazon.awscdk.services.databrew

Class CfnSchedule

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.729Z")
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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnSchedule.Builder A fluent builder for CfnSchedule.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSchedule(Construct scope, java.lang.String id, CfnScheduleProps props) Create a new `AWS::DataBrew::Schedule`.
protected	CfnSchedule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSchedule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getCronExpression() The dates and times when the job is to run.
java.util.List<java.lang.String>	getJobNames() A list of jobs to be run, according to the schedule.
java.lang.String	getName() The name of the schedule.
TagManager	getTags() Metadata tags that have been applied to the schedule.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setCronExpression(java.lang.String value) The dates and times when the job is to run.
void	setJobNames(java.util.List<java.lang.String> value) A list of jobs to be run, according to the schedule.
void	setName(java.lang.String value) The name of the schedule.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSchedule

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

CfnSchedule

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

CfnSchedule

public CfnSchedule(Construct scope,
                   java.lang.String id,
                   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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

Metadata tags that have been applied to the schedule.

getCronExpression

public java.lang.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

public void setCronExpression(java.lang.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

public java.lang.String getName()

The name of the schedule.

setName

public void setName(java.lang.String value)

The name of the schedule.

getJobNames

public java.util.List<java.lang.String> getJobNames()

A list of jobs to be run, according to the schedule.

setJobNames

public void setJobNames(java.util.List<java.lang.String> value)

A list of jobs to be run, according to the schedule.