amazonka-redshift-2.0: Amazon Redshift SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Redshift.ModifyScheduledAction

Description

Modifies a scheduled action.

Synopsis

Creating a Request

data ModifyScheduledAction Source #

See: newModifyScheduledAction smart constructor.

Constructors

ModifyScheduledAction' 

Fields

  • enable :: Maybe Bool

    A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled.

  • endTime :: Maybe ISO8601

    A modified end time of the scheduled action. For more information about this parameter, see ScheduledAction.

  • iamRole :: Maybe Text

    A different IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

  • schedule :: Maybe Text

    A modified schedule in either at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

  • scheduledActionDescription :: Maybe Text

    A modified description of the scheduled action.

  • startTime :: Maybe ISO8601

    A modified start time of the scheduled action. For more information about this parameter, see ScheduledAction.

  • targetAction :: Maybe ScheduledActionType

    A modified JSON format of the scheduled action. For more information about this parameter, see ScheduledAction.

  • scheduledActionName :: Text

    The name of the scheduled action to modify.

Instances

Instances details
ToHeaders ModifyScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.ModifyScheduledAction

ToPath ModifyScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.ModifyScheduledAction

ToQuery ModifyScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.ModifyScheduledAction

AWSRequest ModifyScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.ModifyScheduledAction

Associated Types

type AWSResponse ModifyScheduledAction #

Generic ModifyScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.ModifyScheduledAction

Associated Types

type Rep ModifyScheduledAction :: Type -> Type #

Read ModifyScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.ModifyScheduledAction

Show ModifyScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.ModifyScheduledAction

NFData ModifyScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.ModifyScheduledAction

Methods

rnf :: ModifyScheduledAction -> () #

Eq ModifyScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.ModifyScheduledAction

Hashable ModifyScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.ModifyScheduledAction

type AWSResponse ModifyScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.ModifyScheduledAction

type Rep ModifyScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.ModifyScheduledAction

type Rep ModifyScheduledAction = D1 ('MetaData "ModifyScheduledAction" "Amazonka.Redshift.ModifyScheduledAction" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "ModifyScheduledAction'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "enable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "iamRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "scheduledActionDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "targetAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScheduledActionType)) :*: S1 ('MetaSel ('Just "scheduledActionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newModifyScheduledAction Source #

Create a value of ModifyScheduledAction with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:enable:ModifyScheduledAction', modifyScheduledAction_enable - A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled.

ModifyScheduledAction, modifyScheduledAction_endTime - A modified end time of the scheduled action. For more information about this parameter, see ScheduledAction.

ModifyScheduledAction, modifyScheduledAction_iamRole - A different IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

ModifyScheduledAction, modifyScheduledAction_schedule - A modified schedule in either at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

ModifyScheduledAction, modifyScheduledAction_scheduledActionDescription - A modified description of the scheduled action.

ModifyScheduledAction, modifyScheduledAction_startTime - A modified start time of the scheduled action. For more information about this parameter, see ScheduledAction.

ModifyScheduledAction, modifyScheduledAction_targetAction - A modified JSON format of the scheduled action. For more information about this parameter, see ScheduledAction.

ModifyScheduledAction, modifyScheduledAction_scheduledActionName - The name of the scheduled action to modify.

Request Lenses

modifyScheduledAction_enable :: Lens' ModifyScheduledAction (Maybe Bool) Source #

A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled.

modifyScheduledAction_endTime :: Lens' ModifyScheduledAction (Maybe UTCTime) Source #

A modified end time of the scheduled action. For more information about this parameter, see ScheduledAction.

modifyScheduledAction_iamRole :: Lens' ModifyScheduledAction (Maybe Text) Source #

A different IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

modifyScheduledAction_schedule :: Lens' ModifyScheduledAction (Maybe Text) Source #

A modified schedule in either at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

modifyScheduledAction_startTime :: Lens' ModifyScheduledAction (Maybe UTCTime) Source #

A modified start time of the scheduled action. For more information about this parameter, see ScheduledAction.

modifyScheduledAction_targetAction :: Lens' ModifyScheduledAction (Maybe ScheduledActionType) Source #

A modified JSON format of the scheduled action. For more information about this parameter, see ScheduledAction.

Destructuring the Response

data ScheduledAction Source #

Describes a scheduled action. You can use a scheduled action to trigger some Amazon Redshift API operations on a schedule. For information about which API operations can be scheduled, see ScheduledActionType.

See: newScheduledAction smart constructor.

Constructors

ScheduledAction' 

Fields

  • endTime :: Maybe ISO8601

    The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

  • iamRole :: Maybe Text

    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.

  • nextInvocations :: Maybe [ISO8601]

    List of times when the scheduled action will run.

  • schedule :: Maybe Text

    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.

  • scheduledActionDescription :: Maybe Text

    The description of the scheduled action.

  • scheduledActionName :: Maybe Text

    The name of the scheduled action.

  • startTime :: Maybe ISO8601

    The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

  • state :: Maybe ScheduledActionState

    The state of the scheduled action. For example, DISABLED.

  • targetAction :: Maybe ScheduledActionType

    A JSON format string of the Amazon Redshift API operation with input parameters.

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

Instances

Instances details
FromXML ScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.Types.ScheduledAction

Generic ScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.Types.ScheduledAction

Associated Types

type Rep ScheduledAction :: Type -> Type #

Read ScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.Types.ScheduledAction

Show ScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.Types.ScheduledAction

NFData ScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.Types.ScheduledAction

Methods

rnf :: ScheduledAction -> () #

Eq ScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.Types.ScheduledAction

Hashable ScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.Types.ScheduledAction

type Rep ScheduledAction Source # 
Instance details

Defined in Amazonka.Redshift.Types.ScheduledAction

newScheduledAction :: ScheduledAction Source #

Create a value of ScheduledAction with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endTime:ScheduledAction', scheduledAction_endTime - The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

$sel:iamRole:ScheduledAction', scheduledAction_iamRole - 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.

$sel:nextInvocations:ScheduledAction', scheduledAction_nextInvocations - List of times when the scheduled action will run.

$sel:schedule:ScheduledAction', scheduledAction_schedule - 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.

$sel:scheduledActionDescription:ScheduledAction', scheduledAction_scheduledActionDescription - The description of the scheduled action.

$sel:scheduledActionName:ScheduledAction', scheduledAction_scheduledActionName - The name of the scheduled action.

$sel:startTime:ScheduledAction', scheduledAction_startTime - The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

$sel:state:ScheduledAction', scheduledAction_state - The state of the scheduled action. For example, DISABLED.

$sel:targetAction:ScheduledAction', scheduledAction_targetAction - A JSON format string of the Amazon Redshift API operation with input parameters.

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

Response Lenses

scheduledAction_endTime :: Lens' ScheduledAction (Maybe UTCTime) Source #

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

scheduledAction_iamRole :: Lens' ScheduledAction (Maybe Text) Source #

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.

scheduledAction_nextInvocations :: Lens' ScheduledAction (Maybe [UTCTime]) Source #

List of times when the scheduled action will run.

scheduledAction_schedule :: Lens' ScheduledAction (Maybe Text) Source #

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.

scheduledAction_startTime :: Lens' ScheduledAction (Maybe UTCTime) Source #

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

scheduledAction_state :: Lens' ScheduledAction (Maybe ScheduledActionState) Source #

The state of the scheduled action. For example, DISABLED.

scheduledAction_targetAction :: Lens' ScheduledAction (Maybe ScheduledActionType) Source #

A JSON format string of the Amazon Redshift API operation with input parameters.

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