Package com.pulumi.aws.quicksight

Class RefreshSchedule

  • public class RefreshSchedule
extends com.pulumi.resources.CustomResource
    Resource for managing a QuickSight Refresh Schedule. ## Example Usage ### Basic Usage <!--Start PulumiCodeChooser --> 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.quicksight.RefreshSchedule;
 import com.pulumi.aws.quicksight.RefreshScheduleArgs;
 import com.pulumi.aws.quicksight.inputs.RefreshScheduleScheduleArgs;
 import com.pulumi.aws.quicksight.inputs.RefreshScheduleScheduleScheduleFrequencyArgs;
 import java.util.List;
 import java.util.ArrayList;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new RefreshSchedule("example", RefreshScheduleArgs.builder()        
             .dataSetId("dataset-id")
             .scheduleId("schedule-id")
             .schedule(RefreshScheduleScheduleArgs.builder()
                 .refreshType("FULL_REFRESH")
                 .scheduleFrequency(RefreshScheduleScheduleScheduleFrequencyArgs.builder()
                     .interval("HOURLY")
                     .build())
                 .build())
             .build());
 
     }
 }
    <!--End PulumiCodeChooser --> ### With Weekly Refresh <!--Start PulumiCodeChooser --> 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.quicksight.RefreshSchedule;
 import com.pulumi.aws.quicksight.RefreshScheduleArgs;
 import com.pulumi.aws.quicksight.inputs.RefreshScheduleScheduleArgs;
 import com.pulumi.aws.quicksight.inputs.RefreshScheduleScheduleScheduleFrequencyArgs;
 import com.pulumi.aws.quicksight.inputs.RefreshScheduleScheduleScheduleFrequencyRefreshOnDayArgs;
 import java.util.List;
 import java.util.ArrayList;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new RefreshSchedule("example", RefreshScheduleArgs.builder()        
             .dataSetId("dataset-id")
             .scheduleId("schedule-id")
             .schedule(RefreshScheduleScheduleArgs.builder()
                 .refreshType("INCREMENTAL_REFRESH")
                 .scheduleFrequency(RefreshScheduleScheduleScheduleFrequencyArgs.builder()
                     .interval("WEEKLY")
                     .timeOfTheDay("01:00")
                     .timezone("Europe/London")
                     .refreshOnDay(RefreshScheduleScheduleScheduleFrequencyRefreshOnDayArgs.builder()
                         .dayOfWeek("MONDAY")
                         .build())
                     .build())
                 .build())
             .build());
 
     }
 }
    <!--End PulumiCodeChooser --> ### With Monthly Refresh <!--Start PulumiCodeChooser --> 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.quicksight.RefreshSchedule;
 import com.pulumi.aws.quicksight.RefreshScheduleArgs;
 import com.pulumi.aws.quicksight.inputs.RefreshScheduleScheduleArgs;
 import com.pulumi.aws.quicksight.inputs.RefreshScheduleScheduleScheduleFrequencyArgs;
 import com.pulumi.aws.quicksight.inputs.RefreshScheduleScheduleScheduleFrequencyRefreshOnDayArgs;
 import java.util.List;
 import java.util.ArrayList;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new RefreshSchedule("example", RefreshScheduleArgs.builder()        
             .dataSetId("dataset-id")
             .scheduleId("schedule-id")
             .schedule(RefreshScheduleScheduleArgs.builder()
                 .refreshType("INCREMENTAL_REFRESH")
                 .scheduleFrequency(RefreshScheduleScheduleScheduleFrequencyArgs.builder()
                     .interval("MONTHLY")
                     .timeOfTheDay("01:00")
                     .timezone("Europe/London")
                     .refreshOnDay(RefreshScheduleScheduleScheduleFrequencyRefreshOnDayArgs.builder()
                         .dayOfMonth("1")
                         .build())
                     .build())
                 .build())
             .build());
 
     }
 }
    <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import a QuickSight Refresh Schedule using the AWS account ID, data set ID and schedule ID separated by commas (`,`). For example: ```sh $ pulumi import aws:quicksight/refreshSchedule:RefreshSchedule example 123456789012,dataset-id,schedule-id ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> awsAccountId()  
      com.pulumi.core.Output<java.lang.String> dataSetId()  
      static RefreshSchedule get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, RefreshScheduleState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<RefreshScheduleSchedule>> schedule()  
      com.pulumi.core.Output<java.lang.String> scheduleId()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • RefreshSchedule

        public RefreshSchedule​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • RefreshSchedule

        public RefreshSchedule​(java.lang.String name,
                       RefreshScheduleArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • RefreshSchedule

        public RefreshSchedule​(java.lang.String name,
                       RefreshScheduleArgs args,
                       @Nullable
                       com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        Amazon Resource Name (ARN) of the refresh schedule.

      • awsAccountId

        public com.pulumi.core.Output<java.lang.String> awsAccountId()
        Returns:
        AWS account ID.

      • dataSetId

        public com.pulumi.core.Output<java.lang.String> dataSetId()
        Returns:
        The ID of the dataset.

      • schedule

        public com.pulumi.core.Output<java.util.Optional<RefreshScheduleSchedule>> schedule()
        Returns:
        The [refresh schedule](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RefreshSchedule.html). See schedule The following arguments are optional:

      • scheduleId

        public com.pulumi.core.Output<java.lang.String> scheduleId()
        Returns:
        The ID of the refresh schedule.

      • get

        public static RefreshSchedule get​(java.lang.String name,
                                  com.pulumi.core.Output<java.lang.String> id,
                                  @Nullable
                                  RefreshScheduleState state,
                                  @Nullable
                                  com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.