Skip to content
v2.277.0

DataLabelTypeProperty Struct ​

The option that determines the data label type.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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 dataLabelTypeProperty: quicksight.CfnAnalysis.DataLabelTypeProperty = {
  dataPathLabelType: {
    fieldId: 'fieldId',
    fieldValue: 'fieldValue',
    visibility: 'visibility',
  },
  fieldLabelType: {
    fieldId: 'fieldId',
    visibility: 'visibility',
  },
  maximumLabelType: {
    visibility: 'visibility',
  },
  minimumLabelType: {
    visibility: 'visibility',
  },
  rangeEndsLabelType: {
    visibility: 'visibility',
  },
};
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_label_type_property = quicksight.CfnAnalysis.DataLabelTypeProperty(
    data_path_label_type=quicksight.CfnAnalysis.DataPathLabelTypeProperty(
        field_id="fieldId",
        field_value="fieldValue",
        visibility="visibility"
    ),
    field_label_type=quicksight.CfnAnalysis.FieldLabelTypeProperty(
        field_id="fieldId",
        visibility="visibility"
    ),
    maximum_label_type=quicksight.CfnAnalysis.MaximumLabelTypeProperty(
        visibility="visibility"
    ),
    minimum_label_type=quicksight.CfnAnalysis.MinimumLabelTypeProperty(
        visibility="visibility"
    ),
    range_ends_label_type=quicksight.CfnAnalysis.RangeEndsLabelTypeProperty(
        visibility="visibility"
    )
)
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.*;

DataLabelTypeProperty dataLabelTypeProperty = DataLabelTypeProperty.builder()
        .dataPathLabelType(DataPathLabelTypeProperty.builder()
                .fieldId("fieldId")
                .fieldValue("fieldValue")
                .visibility("visibility")
                .build())
        .fieldLabelType(FieldLabelTypeProperty.builder()
                .fieldId("fieldId")
                .visibility("visibility")
                .build())
        .maximumLabelType(MaximumLabelTypeProperty.builder()
                .visibility("visibility")
                .build())
        .minimumLabelType(MinimumLabelTypeProperty.builder()
                .visibility("visibility")
                .build())
        .rangeEndsLabelType(RangeEndsLabelTypeProperty.builder()
                .visibility("visibility")
                .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 dataLabelTypeProperty = new DataLabelTypeProperty {
    DataPathLabelType = new DataPathLabelTypeProperty {
        FieldId = "fieldId",
        FieldValue = "fieldValue",
        Visibility = "visibility"
    },
    FieldLabelType = new FieldLabelTypeProperty {
        FieldId = "fieldId",
        Visibility = "visibility"
    },
    MaximumLabelType = new MaximumLabelTypeProperty {
        Visibility = "visibility"
    },
    MinimumLabelType = new MinimumLabelTypeProperty {
        Visibility = "visibility"
    },
    RangeEndsLabelType = new RangeEndsLabelTypeProperty {
        Visibility = "visibility"
    }
};
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"

dataLabelTypeProperty := &DataLabelTypeProperty{
	DataPathLabelType: &DataPathLabelTypeProperty{
		FieldId: jsii.String("fieldId"),
		FieldValue: jsii.String("fieldValue"),
		Visibility: jsii.String("visibility"),
	},
	FieldLabelType: &FieldLabelTypeProperty{
		FieldId: jsii.String("fieldId"),
		Visibility: jsii.String("visibility"),
	},
	MaximumLabelType: &MaximumLabelTypeProperty{
		Visibility: jsii.String("visibility"),
	},
	MinimumLabelType: &MinimumLabelTypeProperty{
		Visibility: jsii.String("visibility"),
	},
	RangeEndsLabelType: &RangeEndsLabelTypeProperty{
		Visibility: jsii.String("visibility"),
	},
}

Properties ​

dataPathLabelTypeoptionalIResolvable | CfnAnalysis.DataPathLabelTypePropertydata_path_label_typeoptionaltyping.Union[IResolvable, DataPathLabelTypeProperty]dataPathLabelTypeoptionalIResolvableDataPathLabelTypeoptionalIResolvableDataPathLabelTypeoptionalinterface{}#
The option that specifies individual data values for labels.
fieldLabelTypeoptionalIResolvable | CfnAnalysis.FieldLabelTypePropertyfield_label_typeoptionaltyping.Union[IResolvable, FieldLabelTypeProperty]fieldLabelTypeoptionalIResolvableFieldLabelTypeoptionalIResolvableFieldLabelTypeoptionalinterface{}#
Determines the label configuration for the entire field.
maximumLabelTypeoptionalIResolvable | CfnAnalysis.MaximumLabelTypePropertymaximum_label_typeoptionaltyping.Union[IResolvable, MaximumLabelTypeProperty]maximumLabelTypeoptionalIResolvableMaximumLabelTypeoptionalIResolvableMaximumLabelTypeoptionalinterface{}#
Determines the label configuration for the maximum value in a visual.
minimumLabelTypeoptionalIResolvable | CfnAnalysis.MinimumLabelTypePropertyminimum_label_typeoptionaltyping.Union[IResolvable, MinimumLabelTypeProperty]minimumLabelTypeoptionalIResolvableMinimumLabelTypeoptionalIResolvableMinimumLabelTypeoptionalinterface{}#
Determines the label configuration for the minimum value in a visual.
rangeEndsLabelTypeoptionalIResolvable | CfnAnalysis.RangeEndsLabelTypePropertyrange_ends_label_typeoptionaltyping.Union[IResolvable, RangeEndsLabelTypeProperty]rangeEndsLabelTypeoptionalIResolvableRangeEndsLabelTypeoptionalIResolvableRangeEndsLabelTypeoptionalinterface{}#
Determines the label configuration for range end value in a visual.