This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::QuickSight::RefreshSchedule
<a name="aws-resource-quicksight-refreshschedule"></a>

Creates a refresh schedule for a dataset in Quick.

## Syntax
<a name="aws-resource-quicksight-refreshschedule-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-quicksight-refreshschedule-syntax.json"></a>

```
{
  "Type" : "AWS::QuickSight::RefreshSchedule",
  "Properties" : {
      "[AwsAccountId](#cfn-quicksight-refreshschedule-awsaccountid)" : String,
      "[DataSetId](#cfn-quicksight-refreshschedule-datasetid)" : String,
      "[Schedule](#cfn-quicksight-refreshschedule-schedule)" : RefreshScheduleMap
    }
}
```

### YAML
<a name="aws-resource-quicksight-refreshschedule-syntax.yaml"></a>

```
Type: AWS::QuickSight::RefreshSchedule
Properties:
  [AwsAccountId](#cfn-quicksight-refreshschedule-awsaccountid): String
  [DataSetId](#cfn-quicksight-refreshschedule-datasetid): String
  [Schedule](#cfn-quicksight-refreshschedule-schedule): 
    RefreshScheduleMap
```

## Properties
<a name="aws-resource-quicksight-refreshschedule-properties"></a>

`AwsAccountId`  <a name="cfn-quicksight-refreshschedule-awsaccountid"></a>
The AWS account ID of the account that you are creating a schedule in.  
*Required*: No  
*Type*: String  
*Pattern*: `^[0-9]{12}$`  
*Minimum*: `12`  
*Maximum*: `12`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DataSetId`  <a name="cfn-quicksight-refreshschedule-datasetid"></a>
The ID of the dataset that you are creating a refresh schedule for.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Schedule`  <a name="cfn-quicksight-refreshschedule-schedule"></a>
The refresh schedule of a dataset.  
*Required*: No  
*Type*: [RefreshScheduleMap](aws-properties-quicksight-refreshschedule-refreshschedulemap.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-quicksight-refreshschedule-return-values"></a>

### Ref
<a name="aws-resource-quicksight-refreshschedule-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-quicksight-refreshschedule-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-quicksight-refreshschedule-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) for the refresh schedule.

# AWS::QuickSight::RefreshSchedule RefreshOnDay
<a name="aws-properties-quicksight-refreshschedule-refreshonday"></a>

The day that you want yout dataset to refresh.

## Syntax
<a name="aws-properties-quicksight-refreshschedule-refreshonday-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-quicksight-refreshschedule-refreshonday-syntax.json"></a>

```
{
  "[DayOfMonth](#cfn-quicksight-refreshschedule-refreshonday-dayofmonth)" : String,
  "[DayOfWeek](#cfn-quicksight-refreshschedule-refreshonday-dayofweek)" : String
}
```

### YAML
<a name="aws-properties-quicksight-refreshschedule-refreshonday-syntax.yaml"></a>

```
  [DayOfMonth](#cfn-quicksight-refreshschedule-refreshonday-dayofmonth): String
  [DayOfWeek](#cfn-quicksight-refreshschedule-refreshonday-dayofweek): String
```

## Properties
<a name="aws-properties-quicksight-refreshschedule-refreshonday-properties"></a>

`DayOfMonth`  <a name="cfn-quicksight-refreshschedule-refreshonday-dayofmonth"></a>
The day of the month that you want your dataset to refresh. This value is required for monthly refresh intervals.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DayOfWeek`  <a name="cfn-quicksight-refreshschedule-refreshonday-dayofweek"></a>
The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.  
*Required*: No  
*Type*: String  
*Allowed values*: `SUNDAY | MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::QuickSight::RefreshSchedule RefreshScheduleMap
<a name="aws-properties-quicksight-refreshschedule-refreshschedulemap"></a>

A summary of a configured refresh schedule for a dataset.

## Syntax
<a name="aws-properties-quicksight-refreshschedule-refreshschedulemap-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-quicksight-refreshschedule-refreshschedulemap-syntax.json"></a>

```
{
  "[RefreshType](#cfn-quicksight-refreshschedule-refreshschedulemap-refreshtype)" : String,
  "[ScheduleFrequency](#cfn-quicksight-refreshschedule-refreshschedulemap-schedulefrequency)" : ScheduleFrequency,
  "[ScheduleId](#cfn-quicksight-refreshschedule-refreshschedulemap-scheduleid)" : String,
  "[StartAfterDateTime](#cfn-quicksight-refreshschedule-refreshschedulemap-startafterdatetime)" : String
}
```

### YAML
<a name="aws-properties-quicksight-refreshschedule-refreshschedulemap-syntax.yaml"></a>

```
  [RefreshType](#cfn-quicksight-refreshschedule-refreshschedulemap-refreshtype): String
  [ScheduleFrequency](#cfn-quicksight-refreshschedule-refreshschedulemap-schedulefrequency): 
    ScheduleFrequency
  [ScheduleId](#cfn-quicksight-refreshschedule-refreshschedulemap-scheduleid): String
  [StartAfterDateTime](#cfn-quicksight-refreshschedule-refreshschedulemap-startafterdatetime): String
```

## Properties
<a name="aws-properties-quicksight-refreshschedule-refreshschedulemap-properties"></a>

`RefreshType`  <a name="cfn-quicksight-refreshschedule-refreshschedulemap-refreshtype"></a>
The type of refresh that a dataset undergoes. Valid values are as follows:  
+ `FULL_REFRESH`: A complete refresh of a dataset.
+ `INCREMENTAL_REFRESH`: A partial refresh of some rows of a dataset, based on the time window specified.
For more information on full and incremental refreshes, see [Refreshing SPICE data](https://docs.aws.amazon.com/quicksight/latest/user/refreshing-imported-data.html) in the *Quick User Guide*.  
*Required*: No  
*Type*: String  
*Allowed values*: `FULL_REFRESH | INCREMENTAL_REFRESH`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ScheduleFrequency`  <a name="cfn-quicksight-refreshschedule-refreshschedulemap-schedulefrequency"></a>
The frequency for the refresh schedule.  
*Required*: No  
*Type*: [ScheduleFrequency](aws-properties-quicksight-refreshschedule-schedulefrequency.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ScheduleId`  <a name="cfn-quicksight-refreshschedule-refreshschedulemap-scheduleid"></a>
An identifier for the refresh schedule.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`StartAfterDateTime`  <a name="cfn-quicksight-refreshschedule-refreshschedulemap-startafterdatetime"></a>
Time after which the refresh schedule can be started, expressed in `YYYY-MM-DDTHH:MM:SS` format.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::QuickSight::RefreshSchedule ScheduleFrequency
<a name="aws-properties-quicksight-refreshschedule-schedulefrequency"></a>

The frequency for the refresh schedule.

## Syntax
<a name="aws-properties-quicksight-refreshschedule-schedulefrequency-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-quicksight-refreshschedule-schedulefrequency-syntax.json"></a>

```
{
  "[Interval](#cfn-quicksight-refreshschedule-schedulefrequency-interval)" : String,
  "[RefreshOnDay](#cfn-quicksight-refreshschedule-schedulefrequency-refreshonday)" : RefreshOnDay,
  "[TimeOfTheDay](#cfn-quicksight-refreshschedule-schedulefrequency-timeoftheday)" : String,
  "[TimeZone](#cfn-quicksight-refreshschedule-schedulefrequency-timezone)" : String
}
```

### YAML
<a name="aws-properties-quicksight-refreshschedule-schedulefrequency-syntax.yaml"></a>

```
  [Interval](#cfn-quicksight-refreshschedule-schedulefrequency-interval): String
  [RefreshOnDay](#cfn-quicksight-refreshschedule-schedulefrequency-refreshonday): 
    RefreshOnDay
  [TimeOfTheDay](#cfn-quicksight-refreshschedule-schedulefrequency-timeoftheday): String
  [TimeZone](#cfn-quicksight-refreshschedule-schedulefrequency-timezone): String
```

## Properties
<a name="aws-properties-quicksight-refreshschedule-schedulefrequency-properties"></a>

`Interval`  <a name="cfn-quicksight-refreshschedule-schedulefrequency-interval"></a>
The interval between scheduled refreshes. Valid values are as follows:  
+ `MINUTE15`: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.
+ `MINUTE30`: The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.
+ `HOURLY`: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.
+ `DAILY`: The dataset refreshes every day.
+ `WEEKLY`: The dataset refreshes every week.
+ `MONTHLY`: The dataset refreshes every month.
*Required*: No  
*Type*: String  
*Allowed values*: `MINUTE15 | MINUTE30 | HOURLY | DAILY | WEEKLY | MONTHLY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RefreshOnDay`  <a name="cfn-quicksight-refreshschedule-schedulefrequency-refreshonday"></a>
The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.  
*Required*: No  
*Type*: [RefreshOnDay](aws-properties-quicksight-refreshschedule-refreshonday.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeOfTheDay`  <a name="cfn-quicksight-refreshschedule-schedulefrequency-timeoftheday"></a>
The time of day that you want the dataset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeZone`  <a name="cfn-quicksight-refreshschedule-schedulefrequency-timezone"></a>
The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on `java.util.time.getAvailableIDs()`.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)