Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Redshift.CreateScheduledAction

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data CreateScheduledAction = CreateScheduledAction' {
- startTime :: Maybe ISO8601
- scheduledActionDescription :: Maybe Text
- enable :: Maybe Bool
- endTime :: Maybe ISO8601
- scheduledActionName :: Text
- targetAction :: ScheduledActionType
- schedule :: Text
- iamRole :: Text
}
newCreateScheduledAction :: Text -> ScheduledActionType -> Text -> Text -> CreateScheduledAction
createScheduledAction_startTime :: Lens' CreateScheduledAction (Maybe UTCTime)
createScheduledAction_scheduledActionDescription :: Lens' CreateScheduledAction (Maybe Text)
createScheduledAction_enable :: Lens' CreateScheduledAction (Maybe Bool)
createScheduledAction_endTime :: Lens' CreateScheduledAction (Maybe UTCTime)
createScheduledAction_scheduledActionName :: Lens' CreateScheduledAction Text
createScheduledAction_targetAction :: Lens' CreateScheduledAction ScheduledActionType
createScheduledAction_schedule :: Lens' CreateScheduledAction Text
createScheduledAction_iamRole :: Lens' CreateScheduledAction Text
data ScheduledAction = ScheduledAction' {
- state :: Maybe ScheduledActionState
- targetAction :: Maybe ScheduledActionType
- startTime :: Maybe ISO8601
- schedule :: Maybe Text
- scheduledActionName :: Maybe Text
- scheduledActionDescription :: Maybe Text
- nextInvocations :: Maybe [ISO8601]
- endTime :: Maybe ISO8601
- iamRole :: Maybe Text
}
newScheduledAction :: ScheduledAction
scheduledAction_state :: Lens' ScheduledAction (Maybe ScheduledActionState)
scheduledAction_targetAction :: Lens' ScheduledAction (Maybe ScheduledActionType)
scheduledAction_startTime :: Lens' ScheduledAction (Maybe UTCTime)
scheduledAction_schedule :: Lens' ScheduledAction (Maybe Text)
scheduledAction_scheduledActionName :: Lens' ScheduledAction (Maybe Text)
scheduledAction_scheduledActionDescription :: Lens' ScheduledAction (Maybe Text)
scheduledAction_nextInvocations :: Lens' ScheduledAction (Maybe [UTCTime])
scheduledAction_endTime :: Lens' ScheduledAction (Maybe UTCTime)
scheduledAction_iamRole :: Lens' ScheduledAction (Maybe Text)

Creating a Request

data CreateScheduledAction Source #

See: newCreateScheduledAction smart constructor.

Constructors

CreateScheduledAction'

Fields

startTime :: Maybe ISO8601
The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.
scheduledActionDescription :: Maybe Text
The description of the scheduled action.
enable :: Maybe Bool
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.
endTime :: Maybe ISO8601
The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.
scheduledActionName :: Text
The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.
targetAction :: ScheduledActionType
A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.
schedule :: Text
The schedule in at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.
iamRole :: Text
The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

Instances

Instances details

Eq CreateScheduledAction Source #
Instance details Defined in Amazonka.Redshift.CreateScheduledAction Methods (==) :: CreateScheduledAction -> CreateScheduledAction -> Bool # (/=) :: CreateScheduledAction -> CreateScheduledAction -> Bool #
Read CreateScheduledAction Source #
Instance details Defined in Amazonka.Redshift.CreateScheduledAction Methods readsPrec :: Int -> ReadS CreateScheduledAction # readList :: ReadS [CreateScheduledAction] # readPrec :: ReadPrec CreateScheduledAction # readListPrec :: ReadPrec [CreateScheduledAction] #
Show CreateScheduledAction Source #
Instance details Defined in Amazonka.Redshift.CreateScheduledAction Methods showsPrec :: Int -> CreateScheduledAction -> ShowS # show :: CreateScheduledAction -> String # showList :: [CreateScheduledAction] -> ShowS #
Generic CreateScheduledAction Source #
Instance details Defined in Amazonka.Redshift.CreateScheduledAction Associated Types type Rep CreateScheduledAction :: Type -> Type # Methods from :: CreateScheduledAction -> Rep CreateScheduledAction x # to :: Rep CreateScheduledAction x -> CreateScheduledAction #
NFData CreateScheduledAction Source #
Instance details Defined in Amazonka.Redshift.CreateScheduledAction Methods rnf :: CreateScheduledAction -> () #
Hashable CreateScheduledAction Source #
Instance details Defined in Amazonka.Redshift.CreateScheduledAction Methods hashWithSalt :: Int -> CreateScheduledAction -> Int # hash :: CreateScheduledAction -> Int #
AWSRequest CreateScheduledAction Source #
Instance details Defined in Amazonka.Redshift.CreateScheduledAction Associated Types type AWSResponse CreateScheduledAction # Methods request :: CreateScheduledAction -> Request CreateScheduledAction # response :: MonadResource m => Logger -> Service -> Proxy CreateScheduledAction -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateScheduledAction))) #
ToHeaders CreateScheduledAction Source #
Instance details Defined in Amazonka.Redshift.CreateScheduledAction Methods toHeaders :: CreateScheduledAction -> [Header] #
ToPath CreateScheduledAction Source #
Instance details Defined in Amazonka.Redshift.CreateScheduledAction Methods toPath :: CreateScheduledAction -> ByteString #
ToQuery CreateScheduledAction Source #
Instance details Defined in Amazonka.Redshift.CreateScheduledAction Methods toQuery :: CreateScheduledAction -> QueryString #
type Rep CreateScheduledAction Source #
Instance details Defined in Amazonka.Redshift.CreateScheduledAction type Rep CreateScheduledAction = D1 ('MetaData "CreateScheduledAction" "Amazonka.Redshift.CreateScheduledAction" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "CreateScheduledAction'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "scheduledActionDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "enable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :: ((S1 ('MetaSel ('Just "scheduledActionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "targetAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScheduledActionType)) :: (S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "iamRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateScheduledAction Source #
Instance details Defined in Amazonka.Redshift.CreateScheduledAction type AWSResponse CreateScheduledAction = ScheduledAction

newCreateScheduledAction Source #

Arguments

:: Text	`$sel:scheduledActionName:CreateScheduledAction'`
-> ScheduledActionType	`$sel:targetAction:CreateScheduledAction'`
-> Text	`$sel:schedule:CreateScheduledAction'`
-> Text	`$sel:iamRole:CreateScheduledAction'`
-> CreateScheduledAction

Create a value of CreateScheduledAction 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:startTime:CreateScheduledAction', createScheduledAction_startTime - The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

$sel:scheduledActionDescription:CreateScheduledAction', createScheduledAction_scheduledActionDescription - The description of the scheduled action.

$sel:enable:CreateScheduledAction', createScheduledAction_enable - 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.

$sel:endTime:CreateScheduledAction', createScheduledAction_endTime - The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

$sel:scheduledActionName:CreateScheduledAction', createScheduledAction_scheduledActionName - The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.

$sel:targetAction:CreateScheduledAction', createScheduledAction_targetAction - A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.

$sel:schedule:CreateScheduledAction', createScheduledAction_schedule - The schedule in at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

$sel:iamRole:CreateScheduledAction', createScheduledAction_iamRole - The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

Request Lenses

createScheduledAction_startTime :: Lens' CreateScheduledAction (Maybe UTCTime) Source #

The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

createScheduledAction_scheduledActionDescription :: Lens' CreateScheduledAction (Maybe Text) Source #

The description of the scheduled action.

createScheduledAction_enable :: Lens' CreateScheduledAction (Maybe Bool) Source #

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.

createScheduledAction_endTime :: Lens' CreateScheduledAction (Maybe UTCTime) Source #

The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

createScheduledAction_scheduledActionName :: Lens' CreateScheduledAction Text Source #

The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.

createScheduledAction_targetAction :: Lens' CreateScheduledAction ScheduledActionType Source #

A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.

createScheduledAction_schedule :: Lens' CreateScheduledAction Text Source #

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

createScheduledAction_iamRole :: Lens' CreateScheduledAction Text Source #

The IAM role to assume to run the target 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

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}}".
startTime :: Maybe ISO8601
The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
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.
scheduledActionName :: Maybe Text
The name of the scheduled action.
scheduledActionDescription :: Maybe Text
The description of the scheduled action.
nextInvocations :: Maybe [ISO8601]
List of times when the scheduled action will run.
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.

Instances

Instances details

Eq ScheduledAction Source #
Instance details Defined in Amazonka.Redshift.Types.ScheduledAction Methods (==) :: ScheduledAction -> ScheduledAction -> Bool # (/=) :: ScheduledAction -> ScheduledAction -> Bool #
Read ScheduledAction Source #
Instance details Defined in Amazonka.Redshift.Types.ScheduledAction Methods readsPrec :: Int -> ReadS ScheduledAction # readList :: ReadS [ScheduledAction] # readPrec :: ReadPrec ScheduledAction # readListPrec :: ReadPrec [ScheduledAction] #
Show ScheduledAction Source #
Instance details Defined in Amazonka.Redshift.Types.ScheduledAction Methods showsPrec :: Int -> ScheduledAction -> ShowS # show :: ScheduledAction -> String # showList :: [ScheduledAction] -> ShowS #
Generic ScheduledAction Source #
Instance details Defined in Amazonka.Redshift.Types.ScheduledAction Associated Types type Rep ScheduledAction :: Type -> Type # Methods from :: ScheduledAction -> Rep ScheduledAction x # to :: Rep ScheduledAction x -> ScheduledAction #
NFData ScheduledAction Source #
Instance details Defined in Amazonka.Redshift.Types.ScheduledAction Methods rnf :: ScheduledAction -> () #
Hashable ScheduledAction Source #
Instance details Defined in Amazonka.Redshift.Types.ScheduledAction Methods hashWithSalt :: Int -> ScheduledAction -> Int # hash :: ScheduledAction -> Int #
FromXML ScheduledAction Source #
Instance details Defined in Amazonka.Redshift.Types.ScheduledAction Methods parseXML :: [Node] -> Either String ScheduledAction #
type Rep ScheduledAction Source #
Instance details Defined in Amazonka.Redshift.Types.ScheduledAction type Rep ScheduledAction = D1 ('MetaData "ScheduledAction" "Amazonka.Redshift.Types.ScheduledAction" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "ScheduledAction'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScheduledActionState)) :: S1 ('MetaSel ('Just "targetAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScheduledActionType))) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "scheduledActionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "scheduledActionDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextInvocations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ISO8601])) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "iamRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

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: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}}".

$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: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:scheduledActionName:ScheduledAction', scheduledAction_scheduledActionName - The name of the scheduled action.

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

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

$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.

Response Lenses

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}}".

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_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_scheduledActionName :: Lens' ScheduledAction (Maybe Text) Source #

The name of the scheduled action.

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

The description of the scheduled action.

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

List of times when the scheduled action will run.

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.