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

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

aws-native.redshift.ScheduledAction

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

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

    Create ScheduledAction Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ScheduledAction(name: string, args?: ScheduledActionArgs, opts?: CustomResourceOptions);
    @overload
    def ScheduledAction(resource_name: str,
                        args: Optional[ScheduledActionArgs] = None,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def ScheduledAction(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        enable: Optional[bool] = None,
                        end_time: Optional[str] = None,
                        iam_role: Optional[str] = None,
                        schedule: Optional[str] = None,
                        scheduled_action_description: Optional[str] = None,
                        scheduled_action_name: Optional[str] = None,
                        start_time: Optional[str] = None,
                        target_action: Optional[ScheduledActionTypeArgs] = None)
    func NewScheduledAction(ctx *Context, name string, args *ScheduledActionArgs, opts ...ResourceOption) (*ScheduledAction, error)
    public ScheduledAction(string name, ScheduledActionArgs? args = null, CustomResourceOptions? opts = null)
    public ScheduledAction(String name, ScheduledActionArgs args)
    public ScheduledAction(String name, ScheduledActionArgs args, CustomResourceOptions options)
    
    type: aws-native:redshift:ScheduledAction
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ScheduledActionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ScheduledActionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ScheduledActionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScheduledActionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScheduledActionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ScheduledAction Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ScheduledAction resource accepts the following input properties:

    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.
    Schedule string
    The schedule in at( ) or cron( ) format.
    ScheduledActionDescription string
    The description of the scheduled action.
    ScheduledActionName string
    The name of the scheduled action. The name must be unique within an account.
    StartTime string
    The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger.
    TargetAction Pulumi.AwsNative.Redshift.Inputs.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.
    Schedule string
    The schedule in at( ) or cron( ) format.
    ScheduledActionDescription string
    The description of the scheduled action.
    ScheduledActionName string
    The name of the scheduled action. The name must be unique within an account.
    StartTime string
    The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger.
    TargetAction ScheduledActionTypeArgs
    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.
    schedule String
    The schedule in at( ) or cron( ) format.
    scheduledActionDescription String
    The description of the scheduled action.
    scheduledActionName String
    The name of the scheduled action. The name must be unique within an account.
    startTime String
    The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger.
    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.
    schedule string
    The schedule in at( ) or cron( ) format.
    scheduledActionDescription string
    The description of the scheduled action.
    scheduledActionName string
    The name of the scheduled action. The name must be unique within an account.
    startTime string
    The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger.
    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.
    schedule str
    The schedule in at( ) or cron( ) format.
    scheduled_action_description str
    The description of the scheduled action.
    scheduled_action_name str
    The name of the scheduled action. The name must be unique within an account.
    start_time str
    The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger.
    target_action ScheduledActionTypeArgs
    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.
    schedule String
    The schedule in at( ) or cron( ) format.
    scheduledActionDescription String
    The description of the scheduled action.
    scheduledActionName String
    The name of the scheduled action. The name must be unique within an account.
    startTime String
    The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger.
    targetAction Property Map
    A JSON format string of the Amazon Redshift API operation with input parameters.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ScheduledAction resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    NextInvocations List<string>
    List of times when the scheduled action will run.
    State Pulumi.AwsNative.Redshift.ScheduledActionState
    The state of the scheduled action.
    Id string
    The provider-assigned unique ID for this managed resource.
    NextInvocations []string
    List of times when the scheduled action will run.
    State ScheduledActionStateEnum
    The state of the scheduled action.
    id String
    The provider-assigned unique ID for this managed resource.
    nextInvocations List<String>
    List of times when the scheduled action will run.
    state ScheduledActionState
    The state of the scheduled action.
    id string
    The provider-assigned unique ID for this managed resource.
    nextInvocations string[]
    List of times when the scheduled action will run.
    state ScheduledActionState
    The state of the scheduled action.
    id str
    The provider-assigned unique ID for this managed resource.
    next_invocations Sequence[str]
    List of times when the scheduled action will run.
    state ScheduledActionState
    The state of the scheduled action.
    id String
    The provider-assigned unique ID for this managed resource.
    nextInvocations List<String>
    List of times when the scheduled action will run.
    state "ACTIVE" | "DISABLED"
    The state of the scheduled action.

    Supporting Types

    ScheduledActionState, ScheduledActionStateArgs

    Active
    ACTIVE
    Disabled
    DISABLED
    ScheduledActionStateActive
    ACTIVE
    ScheduledActionStateDisabled
    DISABLED
    Active
    ACTIVE
    Disabled
    DISABLED
    Active
    ACTIVE
    Disabled
    DISABLED
    ACTIVE
    ACTIVE
    DISABLED
    DISABLED
    "ACTIVE"
    ACTIVE
    "DISABLED"
    DISABLED

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi