aws-cdk-lib.aws_quicksight.CfnTemplate.FieldSortOptionsProperty

FieldSortOptionsProperty Struct

The field sort options in a chart configuration.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// 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 fieldSortOptionsProperty: quicksight.CfnTemplate.FieldSortOptionsProperty = {
  columnSort: {
    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',
      },
    },
  },
  fieldSort: {
    direction: 'direction',
    fieldId: 'fieldId',
  },
};

# 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

field_sort_options_property = quicksight.CfnTemplate.FieldSortOptionsProperty(
    column_sort=quicksight.CfnTemplate.ColumnSortProperty(
        direction="direction",
        sort_by=quicksight.CfnTemplate.ColumnIdentifierProperty(
            column_name="columnName",

            # the properties below are optional
            data_set_identifier="dataSetIdentifier",
            topic_identifier="topicIdentifier"
        ),

        # the properties below are optional
        aggregation_function=quicksight.CfnTemplate.AggregationFunctionProperty(
            attribute_aggregation_function=quicksight.CfnTemplate.AttributeAggregationFunctionProperty(
                simple_attribute_aggregation="simpleAttributeAggregation",
                value_for_multiple_values="valueForMultipleValues"
            ),
            categorical_aggregation_function="categoricalAggregationFunction",
            date_aggregation_function="dateAggregationFunction",
            numerical_aggregation_function=quicksight.CfnTemplate.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight.CfnTemplate.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            )
        )
    ),
    field_sort=quicksight.CfnTemplate.FieldSortProperty(
        direction="direction",
        field_id="fieldId"
    )
)

// 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.*;

FieldSortOptionsProperty fieldSortOptionsProperty = FieldSortOptionsProperty.builder()
        .columnSort(ColumnSortProperty.builder()
                .direction("direction")
                .sortBy(ColumnIdentifierProperty.builder()
                        .columnName("columnName")

                        // the properties below are optional
                        .dataSetIdentifier("dataSetIdentifier")
                        .topicIdentifier("topicIdentifier")
                        .build())

                // the properties below are optional
                .aggregationFunction(AggregationFunctionProperty.builder()
                        .attributeAggregationFunction(AttributeAggregationFunctionProperty.builder()
                                .simpleAttributeAggregation("simpleAttributeAggregation")
                                .valueForMultipleValues("valueForMultipleValues")
                                .build())
                        .categoricalAggregationFunction("categoricalAggregationFunction")
                        .dateAggregationFunction("dateAggregationFunction")
                        .numericalAggregationFunction(NumericalAggregationFunctionProperty.builder()
                                .percentileAggregation(PercentileAggregationProperty.builder()
                                        .percentileValue(123)
                                        .build())
                                .simpleNumericalAggregation("simpleNumericalAggregation")
                                .build())
                        .build())
                .build())
        .fieldSort(FieldSortProperty.builder()
                .direction("direction")
                .fieldId("fieldId")
                .build())
        .build();

// 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 fieldSortOptionsProperty = new FieldSortOptionsProperty {
    ColumnSort = new ColumnSortProperty {
        Direction = "direction",
        SortBy = new ColumnIdentifierProperty {
            ColumnName = "columnName",

            // the properties below are optional
            DataSetIdentifier = "dataSetIdentifier",
            TopicIdentifier = "topicIdentifier"
        },

        // the properties below are optional
        AggregationFunction = new AggregationFunctionProperty {
            AttributeAggregationFunction = new AttributeAggregationFunctionProperty {
                SimpleAttributeAggregation = "simpleAttributeAggregation",
                ValueForMultipleValues = "valueForMultipleValues"
            },
            CategoricalAggregationFunction = "categoricalAggregationFunction",
            DateAggregationFunction = "dateAggregationFunction",
            NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
                PercentileAggregation = new PercentileAggregationProperty {
                    PercentileValue = 123
                },
                SimpleNumericalAggregation = "simpleNumericalAggregation"
            }
        }
    },
    FieldSort = new FieldSortProperty {
        Direction = "direction",
        FieldId = "fieldId"
    }
};

// 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"

fieldSortOptionsProperty := &FieldSortOptionsProperty{
	ColumnSort: &ColumnSortProperty{
		Direction: jsii.String("direction"),
		SortBy: &ColumnIdentifierProperty{
			ColumnName: jsii.String("columnName"),

			// the properties below are optional
			DataSetIdentifier: jsii.String("dataSetIdentifier"),
			TopicIdentifier: jsii.String("topicIdentifier"),
		},

		// the properties below are optional
		AggregationFunction: &AggregationFunctionProperty{
			AttributeAggregationFunction: &AttributeAggregationFunctionProperty{
				SimpleAttributeAggregation: jsii.String("simpleAttributeAggregation"),
				ValueForMultipleValues: jsii.String("valueForMultipleValues"),
			},
			CategoricalAggregationFunction: jsii.String("categoricalAggregationFunction"),
			DateAggregationFunction: jsii.String("dateAggregationFunction"),
			NumericalAggregationFunction: &NumericalAggregationFunctionProperty{
				PercentileAggregation: &PercentileAggregationProperty{
					PercentileValue: jsii.Number(123),
				},
				SimpleNumericalAggregation: jsii.String("simpleNumericalAggregation"),
			},
		},
	},
	FieldSort: &FieldSortProperty{
		Direction: jsii.String("direction"),
		FieldId: jsii.String("fieldId"),
	},
}

Properties

columnSort?optionalIResolvable | CfnTemplate.ColumnSortPropertycolumn_sort?optionaltyping.Union[IResolvable, ColumnSortProperty]columnSort?optionalIResolvableColumnSort?optionalIResolvableColumnSort?optionalinterface{}#

The sort configuration for a column that is not used in a field well.

fieldSort?optionalIResolvable | CfnTemplate.FieldSortPropertyfield_sort?optionaltyping.Union[IResolvable, FieldSortProperty]fieldSort?optionalIResolvableFieldSort?optionalIResolvableFieldSort?optionalinterface{}#

The sort configuration for a field in a field well.