software.amazon.awscdk.services.databrew

Class CfnSchedule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.databrew.CfnSchedule

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.854Z")
 @Stability(value=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();
 

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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSchedule(software.constructs.Construct scope, 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 Map<String,Object>	getCfnProperties()
String	getCronExpression() The dates and times when the job is to run.
List<String>	getJobNames() A list of jobs to be run, according to the schedule.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCronExpression(String value) The dates and times when the job is to run.
void	setJobNames(List<String> value) A list of jobs to be run, according to the schedule.
void	setName(String value) The name of the schedule.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnSchedule(@NotNull
                                            software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Metadata tags that have been applied to the schedule.

getCronExpression

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getName()

The name of the schedule.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the schedule.

getJobNames

@Stability(value=Stable)
 @Nullable
public List<String> getJobNames()

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

setJobNames

@Stability(value=Stable)
public void setJobNames(@Nullable
                                                 List<String> value)

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