Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.KPIConditionalFormattingOptionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.KPIConditionalFormattingOptionProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.KPIConditionalFormattingOptionProperty
extends software.amazon.jsii.JsiiSerializable

The conditional formatting options of a KPI visual.

Example:

 // 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.*;
 KPIConditionalFormattingOptionProperty kPIConditionalFormattingOptionProperty = KPIConditionalFormattingOptionProperty.builder()
         .actualValue(KPIActualValueConditionalFormattingProperty.builder()
                 .icon(ConditionalFormattingIconProperty.builder()
                         .customCondition(ConditionalFormattingCustomIconConditionProperty.builder()
                                 .expression("expression")
                                 .iconOptions(ConditionalFormattingCustomIconOptionsProperty.builder()
                                         .icon("icon")
                                         .unicodeIcon("unicodeIcon")
                                         .build())
                                 // the properties below are optional
                                 .color("color")
                                 .displayConfiguration(ConditionalFormattingIconDisplayConfigurationProperty.builder()
                                         .iconDisplayOption("iconDisplayOption")
                                         .build())
                                 .build())
                         .iconSet(ConditionalFormattingIconSetProperty.builder()
                                 .expression("expression")
                                 // the properties below are optional
                                 .iconSetType("iconSetType")
                                 .build())
                         .build())
                 .textColor(ConditionalFormattingColorProperty.builder()
                         .gradient(ConditionalFormattingGradientColorProperty.builder()
                                 .color(GradientColorProperty.builder()
                                         .stops(List.of(GradientStopProperty.builder()
                                                 .gradientOffset(123)
                                                 // the properties below are optional
                                                 .color("color")
                                                 .dataValue(123)
                                                 .build()))
                                         .build())
                                 .expression("expression")
                                 .build())
                         .solid(ConditionalFormattingSolidColorProperty.builder()
                                 .expression("expression")
                                 // the properties below are optional
                                 .color("color")
                                 .build())
                         .build())
                 .build())
         .comparisonValue(KPIComparisonValueConditionalFormattingProperty.builder()
                 .icon(ConditionalFormattingIconProperty.builder()
                         .customCondition(ConditionalFormattingCustomIconConditionProperty.builder()
                                 .expression("expression")
                                 .iconOptions(ConditionalFormattingCustomIconOptionsProperty.builder()
                                         .icon("icon")
                                         .unicodeIcon("unicodeIcon")
                                         .build())
                                 // the properties below are optional
                                 .color("color")
                                 .displayConfiguration(ConditionalFormattingIconDisplayConfigurationProperty.builder()
                                         .iconDisplayOption("iconDisplayOption")
                                         .build())
                                 .build())
                         .iconSet(ConditionalFormattingIconSetProperty.builder()
                                 .expression("expression")
                                 // the properties below are optional
                                 .iconSetType("iconSetType")
                                 .build())
                         .build())
                 .textColor(ConditionalFormattingColorProperty.builder()
                         .gradient(ConditionalFormattingGradientColorProperty.builder()
                                 .color(GradientColorProperty.builder()
                                         .stops(List.of(GradientStopProperty.builder()
                                                 .gradientOffset(123)
                                                 // the properties below are optional
                                                 .color("color")
                                                 .dataValue(123)
                                                 .build()))
                                         .build())
                                 .expression("expression")
                                 .build())
                         .solid(ConditionalFormattingSolidColorProperty.builder()
                                 .expression("expression")
                                 // the properties below are optional
                                 .color("color")
                                 .build())
                         .build())
                 .build())
         .primaryValue(KPIPrimaryValueConditionalFormattingProperty.builder()
                 .icon(ConditionalFormattingIconProperty.builder()
                         .customCondition(ConditionalFormattingCustomIconConditionProperty.builder()
                                 .expression("expression")
                                 .iconOptions(ConditionalFormattingCustomIconOptionsProperty.builder()
                                         .icon("icon")
                                         .unicodeIcon("unicodeIcon")
                                         .build())
                                 // the properties below are optional
                                 .color("color")
                                 .displayConfiguration(ConditionalFormattingIconDisplayConfigurationProperty.builder()
                                         .iconDisplayOption("iconDisplayOption")
                                         .build())
                                 .build())
                         .iconSet(ConditionalFormattingIconSetProperty.builder()
                                 .expression("expression")
                                 // the properties below are optional
                                 .iconSetType("iconSetType")
                                 .build())
                         .build())
                 .textColor(ConditionalFormattingColorProperty.builder()
                         .gradient(ConditionalFormattingGradientColorProperty.builder()
                                 .color(GradientColorProperty.builder()
                                         .stops(List.of(GradientStopProperty.builder()
                                                 .gradientOffset(123)
                                                 // the properties below are optional
                                                 .color("color")
                                                 .dataValue(123)
                                                 .build()))
                                         .build())
                                 .expression("expression")
                                 .build())
                         .solid(ConditionalFormattingSolidColorProperty.builder()
                                 .expression("expression")
                                 // the properties below are optional
                                 .color("color")
                                 .build())
                         .build())
                 .build())
         .progressBar(KPIProgressBarConditionalFormattingProperty.builder()
                 .foregroundColor(ConditionalFormattingColorProperty.builder()
                         .gradient(ConditionalFormattingGradientColorProperty.builder()
                                 .color(GradientColorProperty.builder()
                                         .stops(List.of(GradientStopProperty.builder()
                                                 .gradientOffset(123)
                                                 // the properties below are optional
                                                 .color("color")
                                                 .dataValue(123)
                                                 .build()))
                                         .build())
                                 .expression("expression")
                                 .build())
                         .solid(ConditionalFormattingSolidColorProperty.builder()
                                 .expression("expression")
                                 // the properties below are optional
                                 .color("color")
                                 .build())
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconditionalformattingoption.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTemplate.KPIConditionalFormattingOptionProperty.Builder	A builder for CfnTemplate.KPIConditionalFormattingOptionProperty
static final class	CfnTemplate.KPIConditionalFormattingOptionProperty.Jsii$Proxy	An implementation for CfnTemplate.KPIConditionalFormattingOptionProperty

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.KPIConditionalFormattingOptionProperty.Builder	builder()
default Object	getActualValue()	The conditional formatting for the actual value of a KPI visual.
default Object	getComparisonValue()	The conditional formatting for the comparison value of a KPI visual.
default Object	getPrimaryValue()	The conditional formatting for the primary value of a KPI visual.
default Object	getProgressBar()	The conditional formatting for the progress bar of a KPI visual.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActualValue

@Stability(Stable)
@Nullable
default Object getActualValue()

The conditional formatting for the actual value of a KPI visual.

Returns union: either IResolvable or CfnTemplate.KPIActualValueConditionalFormattingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconditionalformattingoption.html#cfn-quicksight-template-kpiconditionalformattingoption-actualvalue

getComparisonValue

@Stability(Stable)
@Nullable
default Object getComparisonValue()

The conditional formatting for the comparison value of a KPI visual.

Returns union: either IResolvable or CfnTemplate.KPIComparisonValueConditionalFormattingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconditionalformattingoption.html#cfn-quicksight-template-kpiconditionalformattingoption-comparisonvalue

getPrimaryValue

@Stability(Stable)
@Nullable
default Object getPrimaryValue()

The conditional formatting for the primary value of a KPI visual.

Returns union: either IResolvable or CfnTemplate.KPIPrimaryValueConditionalFormattingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconditionalformattingoption.html#cfn-quicksight-template-kpiconditionalformattingoption-primaryvalue

getProgressBar

@Stability(Stable)
@Nullable
default Object getProgressBar()

The conditional formatting for the progress bar of a KPI visual.

Returns union: either IResolvable or CfnTemplate.KPIProgressBarConditionalFormattingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconditionalformattingoption.html#cfn-quicksight-template-kpiconditionalformattingoption-progressbar

builder

@Stability(Stable)
static CfnTemplate.KPIConditionalFormattingOptionProperty.Builder builder()

Returns:

a CfnTemplate.KPIConditionalFormattingOptionProperty.Builder of CfnTemplate.KPIConditionalFormattingOptionProperty