Skip to content
v2.273.0

BodySectionRepeatConfigurationProperty Struct ​

Describes the configurations that are required to declare a section as repeating.

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 bodySectionRepeatConfigurationProperty: quicksight.CfnTemplate.BodySectionRepeatConfigurationProperty = {
  dimensionConfigurations: [{
    dynamicCategoryDimensionConfiguration: {
      column: {
        columnName: 'columnName',

        // the properties below are optional
        dataSetIdentifier: 'dataSetIdentifier',
        topicIdentifier: 'topicIdentifier',
      },

      // the properties below are optional
      limit: 123,
      sortByMetrics: [{
        direction: 'direction',
        sortBy: {
          columnName: 'columnName',

          // the properties below are optional
          dataSetIdentifier: 'dataSetIdentifier',
          topicIdentifier: 'topicIdentifier',
        },

        // the properties below are optional
        aggregationFunction: {
          attributeAggregationFunction: {
            simpleAttributeAggregation: 'simpleAttributeAggregation',
            valueForMultipleValues: 'valueForMultipleValues',
          },
          categoricalAggregationFunction: 'categoricalAggregationFunction',
          dateAggregationFunction: 'dateAggregationFunction',
          numericalAggregationFunction: {
            percentileAggregation: {
              percentileValue: 123,
            },
            simpleNumericalAggregation: 'simpleNumericalAggregation',
          },
        },
      }],
    },
    dynamicNumericDimensionConfiguration: {
      column: {
        columnName: 'columnName',

        // the properties below are optional
        dataSetIdentifier: 'dataSetIdentifier',
        topicIdentifier: 'topicIdentifier',
      },

      // the properties below are optional
      limit: 123,
      sortByMetrics: [{
        direction: 'direction',
        sortBy: {
          columnName: 'columnName',

          // the properties below are optional
          dataSetIdentifier: 'dataSetIdentifier',
          topicIdentifier: 'topicIdentifier',
        },

        // the properties below are optional
        aggregationFunction: {
          attributeAggregationFunction: {
            simpleAttributeAggregation: 'simpleAttributeAggregation',
            valueForMultipleValues: 'valueForMultipleValues',
          },
          categoricalAggregationFunction: 'categoricalAggregationFunction',
          dateAggregationFunction: 'dateAggregationFunction',
          numericalAggregationFunction: {
            percentileAggregation: {
              percentileValue: 123,
            },
            simpleNumericalAggregation: 'simpleNumericalAggregation',
          },
        },
      }],
    },
  }],
  nonRepeatingVisuals: ['nonRepeatingVisuals'],
  pageBreakConfiguration: {
    after: {
      status: 'status',
    },
  },
};

Properties ​

dimensionConfigurationsIResolvable | IResolvable | CfnTemplate.BodySectionRepeatDimensionConfigurationProperty[]dimension_configurationstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, BodySectionRepeatDimensionConfigurationProperty]]]dimensionConfigurationsIResolvableDimensionConfigurationsIResolvableDimensionConfigurationsinterface{}#
List of `BodySectionRepeatDimensionConfiguration` values that describe the dataset column and constraints for the column used to repeat the contents of a section.
nonRepeatingVisualsstring[]non_repeating_visualstyping.List[str]nonRepeatingVisualsList<String>NonRepeatingVisualsstring[]NonRepeatingVisuals*[]*string#
List of visuals to exclude from repetition in repeating sections.

The visuals will render identically, and ignore the repeating configurations in all repeating instances.

pageBreakConfigurationIResolvable | CfnTemplate.BodySectionRepeatPageBreakConfigurationPropertypage_break_configurationtyping.Union[IResolvable, BodySectionRepeatPageBreakConfigurationProperty]pageBreakConfigurationIResolvablePageBreakConfigurationIResolvablePageBreakConfigurationinterface{}#
Page break configuration to apply for each repeating instance.