Skip to content
v2.277.0

DataSetRefreshPropertiesProperty Struct ​

The refresh properties of a dataset.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const dataSetRefreshPropertiesProperty: quicksight.CfnDataSet.DataSetRefreshPropertiesProperty = {
  failureConfiguration: {
    emailAlert: {
      alertStatus: 'alertStatus',
    },
  },
  refreshConfiguration: {
    incrementalRefresh: {
      lookbackWindow: {
        columnName: 'columnName',
        size: 123,
        sizeUnit: 'sizeUnit',
      },
    },
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

data_set_refresh_properties_property = quicksight.CfnDataSet.DataSetRefreshPropertiesProperty(
    failure_configuration=quicksight.CfnDataSet.RefreshFailureConfigurationProperty(
        email_alert=quicksight.CfnDataSet.RefreshFailureEmailAlertProperty(
            alert_status="alertStatus"
        )
    ),
    refresh_configuration=quicksight.CfnDataSet.RefreshConfigurationProperty(
        incremental_refresh=quicksight.CfnDataSet.IncrementalRefreshProperty(
            lookback_window=quicksight.CfnDataSet.LookbackWindowProperty(
                column_name="columnName",
                size=123,
                size_unit="sizeUnit"
            )
        )
    )
)
java
// 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.*;

DataSetRefreshPropertiesProperty dataSetRefreshPropertiesProperty = DataSetRefreshPropertiesProperty.builder()
        .failureConfiguration(RefreshFailureConfigurationProperty.builder()
                .emailAlert(RefreshFailureEmailAlertProperty.builder()
                        .alertStatus("alertStatus")
                        .build())
                .build())
        .refreshConfiguration(RefreshConfigurationProperty.builder()
                .incrementalRefresh(IncrementalRefreshProperty.builder()
                        .lookbackWindow(LookbackWindowProperty.builder()
                                .columnName("columnName")
                                .size(123)
                                .sizeUnit("sizeUnit")
                                .build())
                        .build())
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var dataSetRefreshPropertiesProperty = new DataSetRefreshPropertiesProperty {
    FailureConfiguration = new RefreshFailureConfigurationProperty {
        EmailAlert = new RefreshFailureEmailAlertProperty {
            AlertStatus = "alertStatus"
        }
    },
    RefreshConfiguration = new RefreshConfigurationProperty {
        IncrementalRefresh = new IncrementalRefreshProperty {
            LookbackWindow = new LookbackWindowProperty {
                ColumnName = "columnName",
                Size = 123,
                SizeUnit = "sizeUnit"
            }
        }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

dataSetRefreshPropertiesProperty := &DataSetRefreshPropertiesProperty{
	FailureConfiguration: &RefreshFailureConfigurationProperty{
		EmailAlert: &RefreshFailureEmailAlertProperty{
			AlertStatus: jsii.String("alertStatus"),
		},
	},
	RefreshConfiguration: &RefreshConfigurationProperty{
		IncrementalRefresh: &IncrementalRefreshProperty{
			LookbackWindow: &LookbackWindowProperty{
				ColumnName: jsii.String("columnName"),
				Size: jsii.Number(123),
				SizeUnit: jsii.String("sizeUnit"),
			},
		},
	},
}

Properties ​

failureConfigurationoptionalIResolvable | CfnDataSet.RefreshFailureConfigurationPropertyfailure_configurationoptionaltyping.Union[IResolvable, RefreshFailureConfigurationProperty]failureConfigurationoptionalIResolvableFailureConfigurationoptionalIResolvableFailureConfigurationoptionalinterface{}#
The failure configuration for a dataset.
refreshConfigurationoptionalIResolvable | CfnDataSet.RefreshConfigurationPropertyrefresh_configurationoptionaltyping.Union[IResolvable, RefreshConfigurationProperty]refreshConfigurationoptionalIResolvableRefreshConfigurationoptionalIResolvableRefreshConfigurationoptionalinterface{}#
The refresh configuration for a dataset.