interface ColumnConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnTemplate.ColumnConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTemplate_ColumnConfigurationProperty
Java	software.amazon.awscdk.services.quicksight.CfnTemplate.ColumnConfigurationProperty
Python	aws_cdk.aws_quicksight.CfnTemplate.ColumnConfigurationProperty
TypeScript	aws-cdk-lib » aws_quicksight » CfnTemplate » ColumnConfigurationProperty

The general configuration of a column.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnconfiguration.html

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 columnConfigurationProperty: quicksight.CfnTemplate.ColumnConfigurationProperty = {
  column: {
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  },

  // the properties below are optional
  colorsConfiguration: {
    customColors: [{
      color: 'color',

      // the properties below are optional
      fieldValue: 'fieldValue',
      specialValue: 'specialValue',
    }],
  },
  formatConfiguration: {
    dateTimeFormatConfiguration: {
      dateTimeFormat: 'dateTimeFormat',
      nullValueFormatConfiguration: {
        nullString: 'nullString',
      },
      numericFormatConfiguration: {
        currencyDisplayFormatConfiguration: {
          decimalPlacesConfiguration: {
            decimalPlaces: 123,
          },
          negativeValueConfiguration: {
            displayMode: 'displayMode',
          },
          nullValueFormatConfiguration: {
            nullString: 'nullString',
          },
          numberScale: 'numberScale',
          prefix: 'prefix',
          separatorConfiguration: {
            decimalSeparator: 'decimalSeparator',
            thousandsSeparator: {
              symbol: 'symbol',
              visibility: 'visibility',
            },
          },
          suffix: 'suffix',
          symbol: 'symbol',
        },
        numberDisplayFormatConfiguration: {
          decimalPlacesConfiguration: {
            decimalPlaces: 123,
          },
          negativeValueConfiguration: {
            displayMode: 'displayMode',
          },
          nullValueFormatConfiguration: {
            nullString: 'nullString',
          },
          numberScale: 'numberScale',
          prefix: 'prefix',
          separatorConfiguration: {
            decimalSeparator: 'decimalSeparator',
            thousandsSeparator: {
              symbol: 'symbol',
              visibility: 'visibility',
            },
          },
          suffix: 'suffix',
        },
        percentageDisplayFormatConfiguration: {
          decimalPlacesConfiguration: {
            decimalPlaces: 123,
          },
          negativeValueConfiguration: {
            displayMode: 'displayMode',
          },
          nullValueFormatConfiguration: {
            nullString: 'nullString',
          },
          prefix: 'prefix',
          separatorConfiguration: {
            decimalSeparator: 'decimalSeparator',
            thousandsSeparator: {
              symbol: 'symbol',
              visibility: 'visibility',
            },
          },
          suffix: 'suffix',
        },
      },
    },
    numberFormatConfiguration: {
      formatConfiguration: {
        currencyDisplayFormatConfiguration: {
          decimalPlacesConfiguration: {
            decimalPlaces: 123,
          },
          negativeValueConfiguration: {
            displayMode: 'displayMode',
          },
          nullValueFormatConfiguration: {
            nullString: 'nullString',
          },
          numberScale: 'numberScale',
          prefix: 'prefix',
          separatorConfiguration: {
            decimalSeparator: 'decimalSeparator',
            thousandsSeparator: {
              symbol: 'symbol',
              visibility: 'visibility',
            },
          },
          suffix: 'suffix',
          symbol: 'symbol',
        },
        numberDisplayFormatConfiguration: {
          decimalPlacesConfiguration: {
            decimalPlaces: 123,
          },
          negativeValueConfiguration: {
            displayMode: 'displayMode',
          },
          nullValueFormatConfiguration: {
            nullString: 'nullString',
          },
          numberScale: 'numberScale',
          prefix: 'prefix',
          separatorConfiguration: {
            decimalSeparator: 'decimalSeparator',
            thousandsSeparator: {
              symbol: 'symbol',
              visibility: 'visibility',
            },
          },
          suffix: 'suffix',
        },
        percentageDisplayFormatConfiguration: {
          decimalPlacesConfiguration: {
            decimalPlaces: 123,
          },
          negativeValueConfiguration: {
            displayMode: 'displayMode',
          },
          nullValueFormatConfiguration: {
            nullString: 'nullString',
          },
          prefix: 'prefix',
          separatorConfiguration: {
            decimalSeparator: 'decimalSeparator',
            thousandsSeparator: {
              symbol: 'symbol',
              visibility: 'visibility',
            },
          },
          suffix: 'suffix',
        },
      },
    },
    stringFormatConfiguration: {
      nullValueFormatConfiguration: {
        nullString: 'nullString',
      },
      numericFormatConfiguration: {
        currencyDisplayFormatConfiguration: {
          decimalPlacesConfiguration: {
            decimalPlaces: 123,
          },
          negativeValueConfiguration: {
            displayMode: 'displayMode',
          },
          nullValueFormatConfiguration: {
            nullString: 'nullString',
          },
          numberScale: 'numberScale',
          prefix: 'prefix',
          separatorConfiguration: {
            decimalSeparator: 'decimalSeparator',
            thousandsSeparator: {
              symbol: 'symbol',
              visibility: 'visibility',
            },
          },
          suffix: 'suffix',
          symbol: 'symbol',
        },
        numberDisplayFormatConfiguration: {
          decimalPlacesConfiguration: {
            decimalPlaces: 123,
          },
          negativeValueConfiguration: {
            displayMode: 'displayMode',
          },
          nullValueFormatConfiguration: {
            nullString: 'nullString',
          },
          numberScale: 'numberScale',
          prefix: 'prefix',
          separatorConfiguration: {
            decimalSeparator: 'decimalSeparator',
            thousandsSeparator: {
              symbol: 'symbol',
              visibility: 'visibility',
            },
          },
          suffix: 'suffix',
        },
        percentageDisplayFormatConfiguration: {
          decimalPlacesConfiguration: {
            decimalPlaces: 123,
          },
          negativeValueConfiguration: {
            displayMode: 'displayMode',
          },
          nullValueFormatConfiguration: {
            nullString: 'nullString',
          },
          prefix: 'prefix',
          separatorConfiguration: {
            decimalSeparator: 'decimalSeparator',
            thousandsSeparator: {
              symbol: 'symbol',
              visibility: 'visibility',
            },
          },
          suffix: 'suffix',
        },
      },
    },
  },
  role: 'role',
};

Properties

Name	Type	Description
column	IResolvable | ColumnIdentifierProperty	The column.
colorsConfiguration?	IResolvable | ColorsConfigurationProperty	The color configurations of the column.
formatConfiguration?	IResolvable | FormatConfigurationProperty	The format configuration of a column.
role?	string	The role of the column.

---

column

Type: IResolvable | ColumnIdentifierProperty

The column.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnconfiguration.html#cfn-quicksight-template-columnconfiguration-column

---

colorsConfiguration?

Type: IResolvable | ColorsConfigurationProperty (optional)

The color configurations of the column.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnconfiguration.html#cfn-quicksight-template-columnconfiguration-colorsconfiguration

---

formatConfiguration?

Type: IResolvable | FormatConfigurationProperty (optional)

The format configuration of a column.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnconfiguration.html#cfn-quicksight-template-columnconfiguration-formatconfiguration

---

role?

Type: string (optional)

The role of the column.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnconfiguration.html#cfn-quicksight-template-columnconfiguration-role