1. Packages
  2. AWS Native
  3. API Docs
  4. redshift
  5. getScheduledAction

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

aws-native.redshift.getScheduledAction

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

    The AWS::Redshift::ScheduledAction resource creates an Amazon Redshift Scheduled Action.

    Using getScheduledAction

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getScheduledAction(args: GetScheduledActionArgs, opts?: InvokeOptions): Promise<GetScheduledActionResult>
    function getScheduledActionOutput(args: GetScheduledActionOutputArgs, opts?: InvokeOptions): Output<GetScheduledActionResult>
    def get_scheduled_action(scheduled_action_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetScheduledActionResult
    def get_scheduled_action_output(scheduled_action_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetScheduledActionResult]
    func LookupScheduledAction(ctx *Context, args *LookupScheduledActionArgs, opts ...InvokeOption) (*LookupScheduledActionResult, error)
    func LookupScheduledActionOutput(ctx *Context, args *LookupScheduledActionOutputArgs, opts ...InvokeOption) LookupScheduledActionResultOutput

    > Note: This function is named LookupScheduledAction in the Go SDK.

    public static class GetScheduledAction 
    {
        public static Task<GetScheduledActionResult> InvokeAsync(GetScheduledActionArgs args, InvokeOptions? opts = null)
        public static Output<GetScheduledActionResult> Invoke(GetScheduledActionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetScheduledActionResult> getScheduledAction(GetScheduledActionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:redshift:getScheduledAction
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ScheduledActionName string
    The name of the scheduled action. The name must be unique within an account.
    ScheduledActionName string
    The name of the scheduled action. The name must be unique within an account.
    scheduledActionName String
    The name of the scheduled action. The name must be unique within an account.
    scheduledActionName string
    The name of the scheduled action. The name must be unique within an account.
    scheduled_action_name str
    The name of the scheduled action. The name must be unique within an account.
    scheduledActionName String
    The name of the scheduled action. The name must be unique within an account.

    getScheduledAction Result

    The following output properties are available:

    Enable bool
    If true, the schedule is enabled. If false, the scheduled action does not trigger.
    EndTime string
    The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger.
    IamRole string
    The IAM role to assume to run the target action.
    NextInvocations List<string>
    List of times when the scheduled action will run.
    Schedule string
    The schedule in at( ) or cron( ) format.
    ScheduledActionDescription string
    The description of the scheduled action.
    StartTime string
    The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger.
    State Pulumi.AwsNative.Redshift.ScheduledActionState
    The state of the scheduled action.
    TargetAction Pulumi.AwsNative.Redshift.Outputs.ScheduledActionType
    A JSON format string of the Amazon Redshift API operation with input parameters.
    Enable bool
    If true, the schedule is enabled. If false, the scheduled action does not trigger.
    EndTime string
    The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger.
    IamRole string
    The IAM role to assume to run the target action.
    NextInvocations []string
    List of times when the scheduled action will run.
    Schedule string
    The schedule in at( ) or cron( ) format.
    ScheduledActionDescription string
    The description of the scheduled action.
    StartTime string
    The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger.
    State ScheduledActionStateEnum
    The state of the scheduled action.
    TargetAction ScheduledActionType
    A JSON format string of the Amazon Redshift API operation with input parameters.
    enable Boolean
    If true, the schedule is enabled. If false, the scheduled action does not trigger.
    endTime String
    The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger.
    iamRole String
    The IAM role to assume to run the target action.
    nextInvocations List<String>
    List of times when the scheduled action will run.
    schedule String
    The schedule in at( ) or cron( ) format.
    scheduledActionDescription String
    The description of the scheduled action.
    startTime String
    The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger.
    state ScheduledActionState
    The state of the scheduled action.
    targetAction ScheduledActionType
    A JSON format string of the Amazon Redshift API operation with input parameters.
    enable boolean
    If true, the schedule is enabled. If false, the scheduled action does not trigger.
    endTime string
    The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger.
    iamRole string
    The IAM role to assume to run the target action.
    nextInvocations string[]
    List of times when the scheduled action will run.
    schedule string
    The schedule in at( ) or cron( ) format.
    scheduledActionDescription string
    The description of the scheduled action.
    startTime string
    The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger.
    state ScheduledActionState
    The state of the scheduled action.
    targetAction ScheduledActionType
    A JSON format string of the Amazon Redshift API operation with input parameters.
    enable bool
    If true, the schedule is enabled. If false, the scheduled action does not trigger.
    end_time str
    The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger.
    iam_role str
    The IAM role to assume to run the target action.
    next_invocations Sequence[str]
    List of times when the scheduled action will run.
    schedule str
    The schedule in at( ) or cron( ) format.
    scheduled_action_description str
    The description of the scheduled action.
    start_time str
    The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger.
    state ScheduledActionState
    The state of the scheduled action.
    target_action ScheduledActionType
    A JSON format string of the Amazon Redshift API operation with input parameters.
    enable Boolean
    If true, the schedule is enabled. If false, the scheduled action does not trigger.
    endTime String
    The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger.
    iamRole String
    The IAM role to assume to run the target action.
    nextInvocations List<String>
    List of times when the scheduled action will run.
    schedule String
    The schedule in at( ) or cron( ) format.
    scheduledActionDescription String
    The description of the scheduled action.
    startTime String
    The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger.
    state "ACTIVE" | "DISABLED"
    The state of the scheduled action.
    targetAction Property Map
    A JSON format string of the Amazon Redshift API operation with input parameters.

    Supporting Types

    ScheduledActionState

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi