Package software.amazon.awscdk.services.redshift

Class CfnScheduledAction

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.redshift.CfnScheduledAction
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:30:42.805Z") @Stability(Stable) public class CfnScheduledAction extends CfnResource implements IInspectable
A CloudFormation AWS::Redshift::ScheduledAction.

Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the ResizeCluster API operation.

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.redshift.*;
 CfnScheduledAction cfnScheduledAction = CfnScheduledAction.Builder.create(this, "MyCfnScheduledAction")
         .scheduledActionName("scheduledActionName")
         // the properties below are optional
         .enable(false)
         .endTime("endTime")
         .iamRole("iamRole")
         .schedule("schedule")
         .scheduledActionDescription("scheduledActionDescription")
         .startTime("startTime")
         .targetAction(ScheduledActionTypeProperty.builder()
                 .pauseCluster(PauseClusterMessageProperty.builder()
                         .clusterIdentifier("clusterIdentifier")
                         .build())
                 .resizeCluster(ResizeClusterMessageProperty.builder()
                         .clusterIdentifier("clusterIdentifier")
                         // the properties below are optional
                         .classic(false)
                         .clusterType("clusterType")
                         .nodeType("nodeType")
                         .numberOfNodes(123)
                         .build())
                 .resumeCluster(ResumeClusterMessageProperty.builder()
                         .clusterIdentifier("clusterIdentifier")
                         .build())
                 .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

    • CfnScheduledAction

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

    • CfnScheduledAction

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

    • CfnScheduledAction

      @Stability(Stable) public CfnScheduledAction(@NotNull Construct scope, @NotNull String id, @NotNull CfnScheduledActionProps props)
      Create a new AWS::Redshift::ScheduledAction.

      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.

    • getAttrNextInvocations

      @Stability(Stable) @NotNull public List<String> getAttrNextInvocations()
      List of times when the scheduled action will run.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The state of the scheduled action.

      For example, DISABLED .

    • getCfnProperties

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

    • getScheduledActionName

      @Stability(Stable) @NotNull public String getScheduledActionName()
      The name of the scheduled action.

    • setScheduledActionName

      @Stability(Stable) public void setScheduledActionName(@NotNull String value)
      The name of the scheduled action.

    • getEnable

      @Stability(Stable) @Nullable public Object getEnable()
      If true, the schedule is enabled.

      If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction .

    • setEnable

      @Stability(Stable) public void setEnable(@Nullable Boolean value)
      If true, the schedule is enabled.

      If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction .

    • setEnable

      @Stability(Stable) public void setEnable(@Nullable IResolvable value)
      If true, the schedule is enabled.

      If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction .

    • getEndTime

      @Stability(Stable) @Nullable public String getEndTime()
      The end time in UTC when the schedule is no longer active.

      After this time, the scheduled action does not trigger.

    • setEndTime

      @Stability(Stable) public void setEndTime(@Nullable String value)
      The end time in UTC when the schedule is no longer active.

      After this time, the scheduled action does not trigger.

    • getIamRole

      @Stability(Stable) @Nullable public String getIamRole()
      The IAM role to assume to run the scheduled action.

      This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide .

    • setIamRole

      @Stability(Stable) public void setIamRole(@Nullable String value)
      The IAM role to assume to run the scheduled action.

      This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide .

    • getSchedule

      @Stability(Stable) @Nullable public String getSchedule()
      The schedule for a one-time (at format) or recurring (cron format) scheduled action.

      Schedule invocations must be separated by at least one hour.

      Format of at expressions is " at(yyyy-mm-ddThh:mm:ss) ". For example, " at(2016-03-04T17:27:00) ".

      Format of cron expressions is " cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, " cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide .

    • setSchedule

      @Stability(Stable) public void setSchedule(@Nullable String value)
      The schedule for a one-time (at format) or recurring (cron format) scheduled action.

      Schedule invocations must be separated by at least one hour.

      Format of at expressions is " at(yyyy-mm-ddThh:mm:ss) ". For example, " at(2016-03-04T17:27:00) ".

      Format of cron expressions is " cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, " cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide .

    • getScheduledActionDescription

      @Stability(Stable) @Nullable public String getScheduledActionDescription()
      The description of the scheduled action.

    • setScheduledActionDescription

      @Stability(Stable) public void setScheduledActionDescription(@Nullable String value)
      The description of the scheduled action.

    • getStartTime

      @Stability(Stable) @Nullable public String getStartTime()
      The start time in UTC when the schedule is active.

      Before this time, the scheduled action does not trigger.

    • setStartTime

      @Stability(Stable) public void setStartTime(@Nullable String value)
      The start time in UTC when the schedule is active.

      Before this time, the scheduled action does not trigger.

    • getTargetAction

      @Stability(Stable) @Nullable public Object getTargetAction()
      A JSON format string of the Amazon Redshift API operation with input parameters.

      " {\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".

    • setTargetAction

      @Stability(Stable) public void setTargetAction(@Nullable IResolvable value)
      A JSON format string of the Amazon Redshift API operation with input parameters.

      " {\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".

    • setTargetAction

      @Stability(Stable) public void setTargetAction(@Nullable CfnScheduledAction.ScheduledActionTypeProperty value)
      A JSON format string of the Amazon Redshift API operation with input parameters.

      " {\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".