Package software.amazon.awscdk.services.quicksight

Class CfnRefreshSchedule

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.quicksight.CfnRefreshSchedule
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:23.428Z") @Stability(Stable) public class CfnRefreshSchedule extends CfnResource implements IInspectable
A CloudFormation AWS::QuickSight::RefreshSchedule.

Creates a refresh schedule for a dataset in Amazon QuickSight .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 CfnRefreshSchedule cfnRefreshSchedule = CfnRefreshSchedule.Builder.create(this, "MyCfnRefreshSchedule")
         .awsAccountId("awsAccountId")
         .dataSetId("dataSetId")
         .schedule(RefreshScheduleMapProperty.builder()
                 .refreshType("refreshType")
                 .scheduleFrequency(ScheduleFrequencyProperty.builder()
                         .interval("interval")
                         .refreshOnDay(RefreshOnDayProperty.builder()
                                 .dayOfMonth("dayOfMonth")
                                 .dayOfWeek("dayOfWeek")
                                 .build())
                         .timeOfTheDay("timeOfTheDay")
                         .timeZone("timeZone")
                         .build())
                 .scheduleId("scheduleId")
                 .startAfterDateTime("startAfterDateTime")
                 .build())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRefreshSchedule

      protected CfnRefreshSchedule(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnRefreshSchedule

      protected CfnRefreshSchedule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnRefreshSchedule

      @Stability(Stable) public CfnRefreshSchedule(@NotNull Construct scope, @NotNull String id, @Nullable CfnRefreshScheduleProps props)
      Create a new AWS::QuickSight::RefreshSchedule.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnRefreshSchedule

      @Stability(Stable) public CfnRefreshSchedule(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::QuickSight::RefreshSchedule.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) for the refresh schedule.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAwsAccountId

      @Stability(Stable) @Nullable public String getAwsAccountId()
      The AWS account ID of the account that you are creating a schedule in.

    • setAwsAccountId

      @Stability(Stable) public void setAwsAccountId(@Nullable String value)
      The AWS account ID of the account that you are creating a schedule in.

    • getDataSetId

      @Stability(Stable) @Nullable public String getDataSetId()
      The ID of the dataset that you are creating a refresh schedule for.

    • setDataSetId

      @Stability(Stable) public void setDataSetId(@Nullable String value)
      The ID of the dataset that you are creating a refresh schedule for.

    • getSchedule

      @Stability(Stable) @Nullable public Object getSchedule()
      The refresh schedule of a dataset.

    • setSchedule

      @Stability(Stable) public void setSchedule(@Nullable IResolvable value)
      The refresh schedule of a dataset.

    • setSchedule

      @Stability(Stable) public void setSchedule(@Nullable CfnRefreshSchedule.RefreshScheduleMapProperty value)
      The refresh schedule of a dataset.