CfnTopic

class aws_cdk.aws_quicksight.CfnTopic(scope, id, *, aws_account_id=None, data_sets=None, description=None, name=None, topic_id=None, user_experience_version=None)

Bases: CfnResource

Creates a new Q topic.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html

CloudformationResource:

AWS::QuickSight::Topic

ExampleMetadata:

fixture=_generated

Example:

# 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

cfn_topic = quicksight.CfnTopic(self, "MyCfnTopic",
    aws_account_id="awsAccountId",
    data_sets=[quicksight.CfnTopic.DatasetMetadataProperty(
        dataset_arn="datasetArn",

        # the properties below are optional
        calculated_fields=[quicksight.CfnTopic.TopicCalculatedFieldProperty(
            calculated_field_name="calculatedFieldName",
            expression="expression",

            # the properties below are optional
            aggregation="aggregation",
            allowed_aggregations=["allowedAggregations"],
            calculated_field_description="calculatedFieldDescription",
            calculated_field_synonyms=["calculatedFieldSynonyms"],
            cell_value_synonyms=[quicksight.CfnTopic.CellValueSynonymProperty(
                cell_value="cellValue",
                synonyms=["synonyms"]
            )],
            column_data_role="columnDataRole",
            comparative_order=quicksight.CfnTopic.ComparativeOrderProperty(
                specifed_order=["specifedOrder"],
                treat_undefined_specified_values="treatUndefinedSpecifiedValues",
                use_ordering="useOrdering"
            ),
            default_formatting=quicksight.CfnTopic.DefaultFormattingProperty(
                display_format="displayFormat",
                display_format_options=quicksight.CfnTopic.DisplayFormatOptionsProperty(
                    blank_cell_format="blankCellFormat",
                    currency_symbol="currencySymbol",
                    date_format="dateFormat",
                    decimal_separator="decimalSeparator",
                    fraction_digits=123,
                    grouping_separator="groupingSeparator",
                    negative_format=quicksight.CfnTopic.NegativeFormatProperty(
                        prefix="prefix",
                        suffix="suffix"
                    ),
                    prefix="prefix",
                    suffix="suffix",
                    unit_scaler="unitScaler",
                    use_blank_cell_format=False,
                    use_grouping=False
                )
            ),
            is_included_in_topic=False,
            never_aggregate_in_filter=False,
            non_additive=False,
            not_allowed_aggregations=["notAllowedAggregations"],
            semantic_type=quicksight.CfnTopic.SemanticTypeProperty(
                falsey_cell_value="falseyCellValue",
                falsey_cell_value_synonyms=["falseyCellValueSynonyms"],
                sub_type_name="subTypeName",
                truthy_cell_value="truthyCellValue",
                truthy_cell_value_synonyms=["truthyCellValueSynonyms"],
                type_name="typeName",
                type_parameters={
                    "type_parameters_key": "typeParameters"
                }
            ),
            time_granularity="timeGranularity"
        )],
        columns=[quicksight.CfnTopic.TopicColumnProperty(
            column_name="columnName",

            # the properties below are optional
            aggregation="aggregation",
            allowed_aggregations=["allowedAggregations"],
            cell_value_synonyms=[quicksight.CfnTopic.CellValueSynonymProperty(
                cell_value="cellValue",
                synonyms=["synonyms"]
            )],
            column_data_role="columnDataRole",
            column_description="columnDescription",
            column_friendly_name="columnFriendlyName",
            column_synonyms=["columnSynonyms"],
            comparative_order=quicksight.CfnTopic.ComparativeOrderProperty(
                specifed_order=["specifedOrder"],
                treat_undefined_specified_values="treatUndefinedSpecifiedValues",
                use_ordering="useOrdering"
            ),
            default_formatting=quicksight.CfnTopic.DefaultFormattingProperty(
                display_format="displayFormat",
                display_format_options=quicksight.CfnTopic.DisplayFormatOptionsProperty(
                    blank_cell_format="blankCellFormat",
                    currency_symbol="currencySymbol",
                    date_format="dateFormat",
                    decimal_separator="decimalSeparator",
                    fraction_digits=123,
                    grouping_separator="groupingSeparator",
                    negative_format=quicksight.CfnTopic.NegativeFormatProperty(
                        prefix="prefix",
                        suffix="suffix"
                    ),
                    prefix="prefix",
                    suffix="suffix",
                    unit_scaler="unitScaler",
                    use_blank_cell_format=False,
                    use_grouping=False
                )
            ),
            is_included_in_topic=False,
            never_aggregate_in_filter=False,
            non_additive=False,
            not_allowed_aggregations=["notAllowedAggregations"],
            semantic_type=quicksight.CfnTopic.SemanticTypeProperty(
                falsey_cell_value="falseyCellValue",
                falsey_cell_value_synonyms=["falseyCellValueSynonyms"],
                sub_type_name="subTypeName",
                truthy_cell_value="truthyCellValue",
                truthy_cell_value_synonyms=["truthyCellValueSynonyms"],
                type_name="typeName",
                type_parameters={
                    "type_parameters_key": "typeParameters"
                }
            ),
            time_granularity="timeGranularity"
        )],
        data_aggregation=quicksight.CfnTopic.DataAggregationProperty(
            dataset_row_date_granularity="datasetRowDateGranularity",
            default_date_column_name="defaultDateColumnName"
        ),
        dataset_description="datasetDescription",
        dataset_name="datasetName",
        filters=[quicksight.CfnTopic.TopicFilterProperty(
            filter_name="filterName",
            operand_field_name="operandFieldName",

            # the properties below are optional
            category_filter=quicksight.CfnTopic.TopicCategoryFilterProperty(
                category_filter_function="categoryFilterFunction",
                category_filter_type="categoryFilterType",
                constant=quicksight.CfnTopic.TopicCategoryFilterConstantProperty(
                    collective_constant=quicksight.CfnTopic.CollectiveConstantProperty(
                        value_list=["valueList"]
                    ),
                    constant_type="constantType",
                    singular_constant="singularConstant"
                ),
                inverse=False
            ),
            date_range_filter=quicksight.CfnTopic.TopicDateRangeFilterProperty(
                constant=quicksight.CfnTopic.TopicRangeFilterConstantProperty(
                    constant_type="constantType",
                    range_constant=quicksight.CfnTopic.RangeConstantProperty(
                        maximum="maximum",
                        minimum="minimum"
                    )
                ),
                inclusive=False
            ),
            filter_class="filterClass",
            filter_description="filterDescription",
            filter_synonyms=["filterSynonyms"],
            filter_type="filterType",
            numeric_equality_filter=quicksight.CfnTopic.TopicNumericEqualityFilterProperty(
                aggregation="aggregation",
                constant=quicksight.CfnTopic.TopicSingularFilterConstantProperty(
                    constant_type="constantType",
                    singular_constant="singularConstant"
                )
            ),
            numeric_range_filter=quicksight.CfnTopic.TopicNumericRangeFilterProperty(
                aggregation="aggregation",
                constant=quicksight.CfnTopic.TopicRangeFilterConstantProperty(
                    constant_type="constantType",
                    range_constant=quicksight.CfnTopic.RangeConstantProperty(
                        maximum="maximum",
                        minimum="minimum"
                    )
                ),
                inclusive=False
            ),
            relative_date_filter=quicksight.CfnTopic.TopicRelativeDateFilterProperty(
                constant=quicksight.CfnTopic.TopicSingularFilterConstantProperty(
                    constant_type="constantType",
                    singular_constant="singularConstant"
                ),
                relative_date_filter_function="relativeDateFilterFunction",
                time_granularity="timeGranularity"
            )
        )],
        named_entities=[quicksight.CfnTopic.TopicNamedEntityProperty(
            entity_name="entityName",

            # the properties below are optional
            definition=[quicksight.CfnTopic.NamedEntityDefinitionProperty(
                field_name="fieldName",
                metric=quicksight.CfnTopic.NamedEntityDefinitionMetricProperty(
                    aggregation="aggregation",
                    aggregation_function_parameters={
                        "aggregation_function_parameters_key": "aggregationFunctionParameters"
                    }
                ),
                property_name="propertyName",
                property_role="propertyRole",
                property_usage="propertyUsage"
            )],
            entity_description="entityDescription",
            entity_synonyms=["entitySynonyms"],
            semantic_entity_type=quicksight.CfnTopic.SemanticEntityTypeProperty(
                sub_type_name="subTypeName",
                type_name="typeName",
                type_parameters={
                    "type_parameters_key": "typeParameters"
                }
            )
        )]
    )],
    description="description",
    name="name",
    topic_id="topicId",
    user_experience_version="userExperienceVersion"
)
Parameters:
  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • aws_account_id (Optional[str]) – The ID of the AWS account that you want to create a topic in.

  • data_sets (Union[IResolvable, Sequence[Union[IResolvable, DatasetMetadataProperty, Dict[str, Any]]], None]) – The data sets that the topic is associated with.

  • description (Optional[str]) – The description of the topic.

  • name (Optional[str]) – The name of the topic.

  • topic_id (Optional[str]) – The ID for the topic. This ID is unique per AWS Region for each AWS account.

  • user_experience_version (Optional[str]) – The user experience version of a topic.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:
  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:
  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::QuickSight::Topic'
attr_arn

The Amazon Resource Name (ARN) of the topic.

CloudformationAttribute:

Arn

aws_account_id

The ID of the AWS account that you want to create a topic in.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

data_sets

The data sets that the topic is associated with.

description

The description of the topic.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

The name of the topic.

node

The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

topic_id

The ID for the topic.

user_experience_version

The user experience version of a topic.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

CellValueSynonymProperty

class CfnTopic.CellValueSynonymProperty(*, cell_value=None, synonyms=None)

Bases: object

A structure that represents the cell value synonym.

Parameters:
  • cell_value (Optional[str]) – The cell value.

  • synonyms (Optional[Sequence[str]]) – Other names or aliases for the cell value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-cellvaluesynonym.html

ExampleMetadata:

fixture=_generated

Example:

# 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

cell_value_synonym_property = quicksight.CfnTopic.CellValueSynonymProperty(
    cell_value="cellValue",
    synonyms=["synonyms"]
)

Attributes

cell_value

The cell value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-cellvaluesynonym.html#cfn-quicksight-topic-cellvaluesynonym-cellvalue

synonyms

Other names or aliases for the cell value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-cellvaluesynonym.html#cfn-quicksight-topic-cellvaluesynonym-synonyms

CollectiveConstantProperty

class CfnTopic.CollectiveConstantProperty(*, value_list=None)

Bases: object

A structure that represents a collective constant.

Parameters:

value_list (Optional[Sequence[str]]) – A list of values for the collective constant.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-collectiveconstant.html

ExampleMetadata:

fixture=_generated

Example:

# 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

collective_constant_property = quicksight.CfnTopic.CollectiveConstantProperty(
    value_list=["valueList"]
)

Attributes

value_list

A list of values for the collective constant.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-collectiveconstant.html#cfn-quicksight-topic-collectiveconstant-valuelist

ComparativeOrderProperty

class CfnTopic.ComparativeOrderProperty(*, specifed_order=None, treat_undefined_specified_values=None, use_ordering=None)

Bases: object

The order in which data is displayed for the column when it’s used in a comparative context.

Parameters:
  • specifed_order (Optional[Sequence[str]]) – The list of columns to be used in the ordering.

  • treat_undefined_specified_values (Optional[str]) – The treat of undefined specified values. Valid values for this structure are LEAST and MOST .

  • use_ordering (Optional[str]) – The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER , LESSER_IS_BETTER and SPECIFIED .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-comparativeorder.html

ExampleMetadata:

fixture=_generated

Example:

# 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

comparative_order_property = quicksight.CfnTopic.ComparativeOrderProperty(
    specifed_order=["specifedOrder"],
    treat_undefined_specified_values="treatUndefinedSpecifiedValues",
    use_ordering="useOrdering"
)

Attributes

specifed_order

The list of columns to be used in the ordering.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-comparativeorder.html#cfn-quicksight-topic-comparativeorder-specifedorder

treat_undefined_specified_values

The treat of undefined specified values.

Valid values for this structure are LEAST and MOST .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-comparativeorder.html#cfn-quicksight-topic-comparativeorder-treatundefinedspecifiedvalues

use_ordering

The ordering type for a column.

Valid values for this structure are GREATER_IS_BETTER , LESSER_IS_BETTER and SPECIFIED .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-comparativeorder.html#cfn-quicksight-topic-comparativeorder-useordering

DataAggregationProperty

class CfnTopic.DataAggregationProperty(*, dataset_row_date_granularity=None, default_date_column_name=None)

Bases: object

The definition of a data aggregation.

Parameters:
  • dataset_row_date_granularity (Optional[str]) – The level of time precision that is used to aggregate DateTime values.

  • default_date_column_name (Optional[str]) – The column name for the default date.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-dataaggregation.html

ExampleMetadata:

fixture=_generated

Example:

# 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_aggregation_property = quicksight.CfnTopic.DataAggregationProperty(
    dataset_row_date_granularity="datasetRowDateGranularity",
    default_date_column_name="defaultDateColumnName"
)

Attributes

dataset_row_date_granularity

The level of time precision that is used to aggregate DateTime values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-dataaggregation.html#cfn-quicksight-topic-dataaggregation-datasetrowdategranularity

default_date_column_name

The column name for the default date.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-dataaggregation.html#cfn-quicksight-topic-dataaggregation-defaultdatecolumnname

DatasetMetadataProperty

class CfnTopic.DatasetMetadataProperty(*, dataset_arn, calculated_fields=None, columns=None, data_aggregation=None, dataset_description=None, dataset_name=None, filters=None, named_entities=None)

Bases: object

A structure that represents a dataset.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.html

ExampleMetadata:

fixture=_generated

Example:

# 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

dataset_metadata_property = quicksight.CfnTopic.DatasetMetadataProperty(
    dataset_arn="datasetArn",

    # the properties below are optional
    calculated_fields=[quicksight.CfnTopic.TopicCalculatedFieldProperty(
        calculated_field_name="calculatedFieldName",
        expression="expression",

        # the properties below are optional
        aggregation="aggregation",
        allowed_aggregations=["allowedAggregations"],
        calculated_field_description="calculatedFieldDescription",
        calculated_field_synonyms=["calculatedFieldSynonyms"],
        cell_value_synonyms=[quicksight.CfnTopic.CellValueSynonymProperty(
            cell_value="cellValue",
            synonyms=["synonyms"]
        )],
        column_data_role="columnDataRole",
        comparative_order=quicksight.CfnTopic.ComparativeOrderProperty(
            specifed_order=["specifedOrder"],
            treat_undefined_specified_values="treatUndefinedSpecifiedValues",
            use_ordering="useOrdering"
        ),
        default_formatting=quicksight.CfnTopic.DefaultFormattingProperty(
            display_format="displayFormat",
            display_format_options=quicksight.CfnTopic.DisplayFormatOptionsProperty(
                blank_cell_format="blankCellFormat",
                currency_symbol="currencySymbol",
                date_format="dateFormat",
                decimal_separator="decimalSeparator",
                fraction_digits=123,
                grouping_separator="groupingSeparator",
                negative_format=quicksight.CfnTopic.NegativeFormatProperty(
                    prefix="prefix",
                    suffix="suffix"
                ),
                prefix="prefix",
                suffix="suffix",
                unit_scaler="unitScaler",
                use_blank_cell_format=False,
                use_grouping=False
            )
        ),
        is_included_in_topic=False,
        never_aggregate_in_filter=False,
        non_additive=False,
        not_allowed_aggregations=["notAllowedAggregations"],
        semantic_type=quicksight.CfnTopic.SemanticTypeProperty(
            falsey_cell_value="falseyCellValue",
            falsey_cell_value_synonyms=["falseyCellValueSynonyms"],
            sub_type_name="subTypeName",
            truthy_cell_value="truthyCellValue",
            truthy_cell_value_synonyms=["truthyCellValueSynonyms"],
            type_name="typeName",
            type_parameters={
                "type_parameters_key": "typeParameters"
            }
        ),
        time_granularity="timeGranularity"
    )],
    columns=[quicksight.CfnTopic.TopicColumnProperty(
        column_name="columnName",

        # the properties below are optional
        aggregation="aggregation",
        allowed_aggregations=["allowedAggregations"],
        cell_value_synonyms=[quicksight.CfnTopic.CellValueSynonymProperty(
            cell_value="cellValue",
            synonyms=["synonyms"]
        )],
        column_data_role="columnDataRole",
        column_description="columnDescription",
        column_friendly_name="columnFriendlyName",
        column_synonyms=["columnSynonyms"],
        comparative_order=quicksight.CfnTopic.ComparativeOrderProperty(
            specifed_order=["specifedOrder"],
            treat_undefined_specified_values="treatUndefinedSpecifiedValues",
            use_ordering="useOrdering"
        ),
        default_formatting=quicksight.CfnTopic.DefaultFormattingProperty(
            display_format="displayFormat",
            display_format_options=quicksight.CfnTopic.DisplayFormatOptionsProperty(
                blank_cell_format="blankCellFormat",
                currency_symbol="currencySymbol",
                date_format="dateFormat",
                decimal_separator="decimalSeparator",
                fraction_digits=123,
                grouping_separator="groupingSeparator",
                negative_format=quicksight.CfnTopic.NegativeFormatProperty(
                    prefix="prefix",
                    suffix="suffix"
                ),
                prefix="prefix",
                suffix="suffix",
                unit_scaler="unitScaler",
                use_blank_cell_format=False,
                use_grouping=False
            )
        ),
        is_included_in_topic=False,
        never_aggregate_in_filter=False,
        non_additive=False,
        not_allowed_aggregations=["notAllowedAggregations"],
        semantic_type=quicksight.CfnTopic.SemanticTypeProperty(
            falsey_cell_value="falseyCellValue",
            falsey_cell_value_synonyms=["falseyCellValueSynonyms"],
            sub_type_name="subTypeName",
            truthy_cell_value="truthyCellValue",
            truthy_cell_value_synonyms=["truthyCellValueSynonyms"],
            type_name="typeName",
            type_parameters={
                "type_parameters_key": "typeParameters"
            }
        ),
        time_granularity="timeGranularity"
    )],
    data_aggregation=quicksight.CfnTopic.DataAggregationProperty(
        dataset_row_date_granularity="datasetRowDateGranularity",
        default_date_column_name="defaultDateColumnName"
    ),
    dataset_description="datasetDescription",
    dataset_name="datasetName",
    filters=[quicksight.CfnTopic.TopicFilterProperty(
        filter_name="filterName",
        operand_field_name="operandFieldName",

        # the properties below are optional
        category_filter=quicksight.CfnTopic.TopicCategoryFilterProperty(
            category_filter_function="categoryFilterFunction",
            category_filter_type="categoryFilterType",
            constant=quicksight.CfnTopic.TopicCategoryFilterConstantProperty(
                collective_constant=quicksight.CfnTopic.CollectiveConstantProperty(
                    value_list=["valueList"]
                ),
                constant_type="constantType",
                singular_constant="singularConstant"
            ),
            inverse=False
        ),
        date_range_filter=quicksight.CfnTopic.TopicDateRangeFilterProperty(
            constant=quicksight.CfnTopic.TopicRangeFilterConstantProperty(
                constant_type="constantType",
                range_constant=quicksight.CfnTopic.RangeConstantProperty(
                    maximum="maximum",
                    minimum="minimum"
                )
            ),
            inclusive=False
        ),
        filter_class="filterClass",
        filter_description="filterDescription",
        filter_synonyms=["filterSynonyms"],
        filter_type="filterType",
        numeric_equality_filter=quicksight.CfnTopic.TopicNumericEqualityFilterProperty(
            aggregation="aggregation",
            constant=quicksight.CfnTopic.TopicSingularFilterConstantProperty(
                constant_type="constantType",
                singular_constant="singularConstant"
            )
        ),
        numeric_range_filter=quicksight.CfnTopic.TopicNumericRangeFilterProperty(
            aggregation="aggregation",
            constant=quicksight.CfnTopic.TopicRangeFilterConstantProperty(
                constant_type="constantType",
                range_constant=quicksight.CfnTopic.RangeConstantProperty(
                    maximum="maximum",
                    minimum="minimum"
                )
            ),
            inclusive=False
        ),
        relative_date_filter=quicksight.CfnTopic.TopicRelativeDateFilterProperty(
            constant=quicksight.CfnTopic.TopicSingularFilterConstantProperty(
                constant_type="constantType",
                singular_constant="singularConstant"
            ),
            relative_date_filter_function="relativeDateFilterFunction",
            time_granularity="timeGranularity"
        )
    )],
    named_entities=[quicksight.CfnTopic.TopicNamedEntityProperty(
        entity_name="entityName",

        # the properties below are optional
        definition=[quicksight.CfnTopic.NamedEntityDefinitionProperty(
            field_name="fieldName",
            metric=quicksight.CfnTopic.NamedEntityDefinitionMetricProperty(
                aggregation="aggregation",
                aggregation_function_parameters={
                    "aggregation_function_parameters_key": "aggregationFunctionParameters"
                }
            ),
            property_name="propertyName",
            property_role="propertyRole",
            property_usage="propertyUsage"
        )],
        entity_description="entityDescription",
        entity_synonyms=["entitySynonyms"],
        semantic_entity_type=quicksight.CfnTopic.SemanticEntityTypeProperty(
            sub_type_name="subTypeName",
            type_name="typeName",
            type_parameters={
                "type_parameters_key": "typeParameters"
            }
        )
    )]
)

Attributes

calculated_fields

The list of calculated field definitions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.html#cfn-quicksight-topic-datasetmetadata-calculatedfields

columns

The list of column definitions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.html#cfn-quicksight-topic-datasetmetadata-columns

data_aggregation

The definition of a data aggregation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.html#cfn-quicksight-topic-datasetmetadata-dataaggregation

dataset_arn

The Amazon Resource Name (ARN) of the dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.html#cfn-quicksight-topic-datasetmetadata-datasetarn

dataset_description

The description of the dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.html#cfn-quicksight-topic-datasetmetadata-datasetdescription

dataset_name

The name of the dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.html#cfn-quicksight-topic-datasetmetadata-datasetname

filters

The list of filter definitions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.html#cfn-quicksight-topic-datasetmetadata-filters

named_entities

The list of named entities definitions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.html#cfn-quicksight-topic-datasetmetadata-namedentities

DefaultFormattingProperty

class CfnTopic.DefaultFormattingProperty(*, display_format=None, display_format_options=None)

Bases: object

A structure that represents a default formatting definition.

Parameters:
  • display_format (Optional[str]) – The display format. Valid values for this structure are AUTO , PERCENT , CURRENCY , NUMBER , DATE , and STRING .

  • display_format_options (Union[IResolvable, DisplayFormatOptionsProperty, Dict[str, Any], None]) – The additional options for display formatting.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-defaultformatting.html

ExampleMetadata:

fixture=_generated

Example:

# 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

default_formatting_property = quicksight.CfnTopic.DefaultFormattingProperty(
    display_format="displayFormat",
    display_format_options=quicksight.CfnTopic.DisplayFormatOptionsProperty(
        blank_cell_format="blankCellFormat",
        currency_symbol="currencySymbol",
        date_format="dateFormat",
        decimal_separator="decimalSeparator",
        fraction_digits=123,
        grouping_separator="groupingSeparator",
        negative_format=quicksight.CfnTopic.NegativeFormatProperty(
            prefix="prefix",
            suffix="suffix"
        ),
        prefix="prefix",
        suffix="suffix",
        unit_scaler="unitScaler",
        use_blank_cell_format=False,
        use_grouping=False
    )
)

Attributes

display_format

The display format.

Valid values for this structure are AUTO , PERCENT , CURRENCY , NUMBER , DATE , and STRING .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-defaultformatting.html#cfn-quicksight-topic-defaultformatting-displayformat

display_format_options

The additional options for display formatting.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-defaultformatting.html#cfn-quicksight-topic-defaultformatting-displayformatoptions

DisplayFormatOptionsProperty

class CfnTopic.DisplayFormatOptionsProperty(*, blank_cell_format=None, currency_symbol=None, date_format=None, decimal_separator=None, fraction_digits=None, grouping_separator=None, negative_format=None, prefix=None, suffix=None, unit_scaler=None, use_blank_cell_format=None, use_grouping=None)

Bases: object

A structure that represents additional options for display formatting.

Parameters:
  • blank_cell_format (Optional[str]) – Determines the blank cell format.

  • currency_symbol (Optional[str]) – The currency symbol, such as USD .

  • date_format (Optional[str]) – Determines the DateTime format.

  • decimal_separator (Optional[str]) – Determines the decimal separator.

  • fraction_digits (Union[int, float, None]) – Determines the number of fraction digits. Default: - 0

  • grouping_separator (Optional[str]) – Determines the grouping separator.

  • negative_format (Union[IResolvable, NegativeFormatProperty, Dict[str, Any], None]) – The negative format.

  • prefix (Optional[str]) – The prefix value for a display format.

  • suffix (Optional[str]) – The suffix value for a display format.

  • unit_scaler (Optional[str]) – The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .

  • use_blank_cell_format (Union[bool, IResolvable, None]) – A Boolean value that indicates whether to use blank cell format. Default: - false

  • use_grouping (Union[bool, IResolvable, None]) – A Boolean value that indicates whether to use grouping. Default: - false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html

ExampleMetadata:

fixture=_generated

Example:

# 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

display_format_options_property = quicksight.CfnTopic.DisplayFormatOptionsProperty(
    blank_cell_format="blankCellFormat",
    currency_symbol="currencySymbol",
    date_format="dateFormat",
    decimal_separator="decimalSeparator",
    fraction_digits=123,
    grouping_separator="groupingSeparator",
    negative_format=quicksight.CfnTopic.NegativeFormatProperty(
        prefix="prefix",
        suffix="suffix"
    ),
    prefix="prefix",
    suffix="suffix",
    unit_scaler="unitScaler",
    use_blank_cell_format=False,
    use_grouping=False
)

Attributes

blank_cell_format

Determines the blank cell format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-blankcellformat

currency_symbol

The currency symbol, such as USD .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-currencysymbol

date_format

Determines the DateTime format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-dateformat

decimal_separator

Determines the decimal separator.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-decimalseparator

fraction_digits

Determines the number of fraction digits.

Default:
  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-fractiondigits

grouping_separator

Determines the grouping separator.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-groupingseparator

negative_format

The negative format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-negativeformat

prefix

The prefix value for a display format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-prefix

suffix

The suffix value for a display format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-suffix

unit_scaler

The unit scaler.

Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-unitscaler

use_blank_cell_format

A Boolean value that indicates whether to use blank cell format.

Default:
  • false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-useblankcellformat

use_grouping

A Boolean value that indicates whether to use grouping.

Default:
  • false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-usegrouping

NamedEntityDefinitionMetricProperty

class CfnTopic.NamedEntityDefinitionMetricProperty(*, aggregation=None, aggregation_function_parameters=None)

Bases: object

A structure that represents a metric.

Parameters:
  • aggregation (Optional[str]) – The aggregation of a named entity. Valid values for this structure are SUM , MIN , MAX , COUNT , AVERAGE , DISTINCT_COUNT , STDEV , STDEVP , VAR , VARP , PERCENTILE , MEDIAN , and CUSTOM .

  • aggregation_function_parameters (Union[IResolvable, Mapping[str, str], None]) – The additional parameters for an aggregation function.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinitionmetric.html

ExampleMetadata:

fixture=_generated

Example:

# 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

named_entity_definition_metric_property = quicksight.CfnTopic.NamedEntityDefinitionMetricProperty(
    aggregation="aggregation",
    aggregation_function_parameters={
        "aggregation_function_parameters_key": "aggregationFunctionParameters"
    }
)

Attributes

aggregation

The aggregation of a named entity.

Valid values for this structure are SUM , MIN , MAX , COUNT , AVERAGE , DISTINCT_COUNT , STDEV , STDEVP , VAR , VARP , PERCENTILE , MEDIAN , and CUSTOM .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinitionmetric.html#cfn-quicksight-topic-namedentitydefinitionmetric-aggregation

aggregation_function_parameters

The additional parameters for an aggregation function.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinitionmetric.html#cfn-quicksight-topic-namedentitydefinitionmetric-aggregationfunctionparameters

NamedEntityDefinitionProperty

class CfnTopic.NamedEntityDefinitionProperty(*, field_name=None, metric=None, property_name=None, property_role=None, property_usage=None)

Bases: object

A structure that represents a named entity.

Parameters:
  • field_name (Optional[str]) – The name of the entity.

  • metric (Union[IResolvable, NamedEntityDefinitionMetricProperty, Dict[str, Any], None]) – The definition of a metric.

  • property_name (Optional[str]) – The property name to be used for the named entity.

  • property_role (Optional[str]) – The property role. Valid values for this structure are PRIMARY and ID .

  • property_usage (Optional[str]) – The property usage. Valid values for this structure are INHERIT , DIMENSION , and MEASURE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinition.html

ExampleMetadata:

fixture=_generated

Example:

# 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

named_entity_definition_property = quicksight.CfnTopic.NamedEntityDefinitionProperty(
    field_name="fieldName",
    metric=quicksight.CfnTopic.NamedEntityDefinitionMetricProperty(
        aggregation="aggregation",
        aggregation_function_parameters={
            "aggregation_function_parameters_key": "aggregationFunctionParameters"
        }
    ),
    property_name="propertyName",
    property_role="propertyRole",
    property_usage="propertyUsage"
)

Attributes

field_name

The name of the entity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinition.html#cfn-quicksight-topic-namedentitydefinition-fieldname

metric

The definition of a metric.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinition.html#cfn-quicksight-topic-namedentitydefinition-metric

property_name

The property name to be used for the named entity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinition.html#cfn-quicksight-topic-namedentitydefinition-propertyname

property_role

The property role.

Valid values for this structure are PRIMARY and ID .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinition.html#cfn-quicksight-topic-namedentitydefinition-propertyrole

property_usage

The property usage.

Valid values for this structure are INHERIT , DIMENSION , and MEASURE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinition.html#cfn-quicksight-topic-namedentitydefinition-propertyusage

NegativeFormatProperty

class CfnTopic.NegativeFormatProperty(*, prefix=None, suffix=None)

Bases: object

A structure that represents a negative format.

Parameters:
  • prefix (Optional[str]) – The prefix for a negative format.

  • suffix (Optional[str]) – The suffix for a negative format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-negativeformat.html

ExampleMetadata:

fixture=_generated

Example:

# 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

negative_format_property = quicksight.CfnTopic.NegativeFormatProperty(
    prefix="prefix",
    suffix="suffix"
)

Attributes

prefix

The prefix for a negative format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-negativeformat.html#cfn-quicksight-topic-negativeformat-prefix

suffix

The suffix for a negative format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-negativeformat.html#cfn-quicksight-topic-negativeformat-suffix

RangeConstantProperty

class CfnTopic.RangeConstantProperty(*, maximum=None, minimum=None)

Bases: object

The value of the constant that is used to specify the endpoints of a range filter.

Parameters:
  • maximum (Optional[str]) – The maximum value for a range constant.

  • minimum (Optional[str]) – The minimum value for a range constant.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-rangeconstant.html

ExampleMetadata:

fixture=_generated

Example:

# 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

range_constant_property = quicksight.CfnTopic.RangeConstantProperty(
    maximum="maximum",
    minimum="minimum"
)

Attributes

maximum

The maximum value for a range constant.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-rangeconstant.html#cfn-quicksight-topic-rangeconstant-maximum

minimum

The minimum value for a range constant.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-rangeconstant.html#cfn-quicksight-topic-rangeconstant-minimum

SemanticEntityTypeProperty

class CfnTopic.SemanticEntityTypeProperty(*, sub_type_name=None, type_name=None, type_parameters=None)

Bases: object

A structure that represents a semantic entity type.

Parameters:
  • sub_type_name (Optional[str]) – The semantic entity sub type name.

  • type_name (Optional[str]) – The semantic entity type name.

  • type_parameters (Union[IResolvable, Mapping[str, str], None]) – The semantic entity type parameters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semanticentitytype.html

ExampleMetadata:

fixture=_generated

Example:

# 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

semantic_entity_type_property = quicksight.CfnTopic.SemanticEntityTypeProperty(
    sub_type_name="subTypeName",
    type_name="typeName",
    type_parameters={
        "type_parameters_key": "typeParameters"
    }
)

Attributes

sub_type_name

The semantic entity sub type name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semanticentitytype.html#cfn-quicksight-topic-semanticentitytype-subtypename

type_name

The semantic entity type name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semanticentitytype.html#cfn-quicksight-topic-semanticentitytype-typename

type_parameters

The semantic entity type parameters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semanticentitytype.html#cfn-quicksight-topic-semanticentitytype-typeparameters

SemanticTypeProperty

class CfnTopic.SemanticTypeProperty(*, falsey_cell_value=None, falsey_cell_value_synonyms=None, sub_type_name=None, truthy_cell_value=None, truthy_cell_value_synonyms=None, type_name=None, type_parameters=None)

Bases: object

A structure that represents a semantic type.

Parameters:
  • falsey_cell_value (Optional[str]) – The semantic type falsey cell value.

  • falsey_cell_value_synonyms (Optional[Sequence[str]]) – The other names or aliases for the false cell value.

  • sub_type_name (Optional[str]) – The semantic type sub type name.

  • truthy_cell_value (Optional[str]) – The semantic type truthy cell value.

  • truthy_cell_value_synonyms (Optional[Sequence[str]]) – The other names or aliases for the true cell value.

  • type_name (Optional[str]) – The semantic type name.

  • type_parameters (Union[IResolvable, Mapping[str, str], None]) – The semantic type parameters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semantictype.html

ExampleMetadata:

fixture=_generated

Example:

# 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

semantic_type_property = quicksight.CfnTopic.SemanticTypeProperty(
    falsey_cell_value="falseyCellValue",
    falsey_cell_value_synonyms=["falseyCellValueSynonyms"],
    sub_type_name="subTypeName",
    truthy_cell_value="truthyCellValue",
    truthy_cell_value_synonyms=["truthyCellValueSynonyms"],
    type_name="typeName",
    type_parameters={
        "type_parameters_key": "typeParameters"
    }
)

Attributes

falsey_cell_value

The semantic type falsey cell value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semantictype.html#cfn-quicksight-topic-semantictype-falseycellvalue

falsey_cell_value_synonyms

The other names or aliases for the false cell value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semantictype.html#cfn-quicksight-topic-semantictype-falseycellvaluesynonyms

sub_type_name

The semantic type sub type name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semantictype.html#cfn-quicksight-topic-semantictype-subtypename

truthy_cell_value

The semantic type truthy cell value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semantictype.html#cfn-quicksight-topic-semantictype-truthycellvalue

truthy_cell_value_synonyms

The other names or aliases for the true cell value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semantictype.html#cfn-quicksight-topic-semantictype-truthycellvaluesynonyms

type_name

The semantic type name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semantictype.html#cfn-quicksight-topic-semantictype-typename

type_parameters

The semantic type parameters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semantictype.html#cfn-quicksight-topic-semantictype-typeparameters

TopicCalculatedFieldProperty

class CfnTopic.TopicCalculatedFieldProperty(*, calculated_field_name, expression, aggregation=None, allowed_aggregations=None, calculated_field_description=None, calculated_field_synonyms=None, cell_value_synonyms=None, column_data_role=None, comparative_order=None, default_formatting=None, is_included_in_topic=None, never_aggregate_in_filter=None, non_additive=None, not_allowed_aggregations=None, semantic_type=None, time_granularity=None)

Bases: object

A structure that represents a calculated field.

Parameters:
  • calculated_field_name (str) – The calculated field name.

  • expression (str) – The calculated field expression.

  • aggregation (Optional[str]) – The default aggregation. Valid values for this structure are SUM , MAX , MIN , COUNT , DISTINCT_COUNT , and AVERAGE .

  • allowed_aggregations (Optional[Sequence[str]]) – The list of aggregation types that are allowed for the calculated field. Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .

  • calculated_field_description (Optional[str]) – The calculated field description.

  • calculated_field_synonyms (Optional[Sequence[str]]) – The other names or aliases for the calculated field.

  • cell_value_synonyms (Union[IResolvable, Sequence[Union[IResolvable, CellValueSynonymProperty, Dict[str, Any]]], None]) – The other names or aliases for the calculated field cell value.

  • column_data_role (Optional[str]) – The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE .

  • comparative_order (Union[IResolvable, ComparativeOrderProperty, Dict[str, Any], None]) – The order in which data is displayed for the calculated field when it’s used in a comparative context.

  • default_formatting (Union[IResolvable, DefaultFormattingProperty, Dict[str, Any], None]) – The default formatting definition.

  • is_included_in_topic (Union[bool, IResolvable, None]) – A boolean value that indicates if a calculated field is included in the topic. Default: - false

  • never_aggregate_in_filter (Union[bool, IResolvable, None]) – A Boolean value that indicates whether to never aggregate calculated field in filters. Default: - false

  • non_additive (Union[bool, IResolvable, None]) – The non additive for the table style target. Default: - false

  • not_allowed_aggregations (Optional[Sequence[str]]) – The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .

  • semantic_type (Union[IResolvable, SemanticTypeProperty, Dict[str, Any], None]) – The semantic type.

  • time_granularity (Optional[str]) – The level of time precision that is used to aggregate DateTime values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html

ExampleMetadata:

fixture=_generated

Example:

# 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

topic_calculated_field_property = quicksight.CfnTopic.TopicCalculatedFieldProperty(
    calculated_field_name="calculatedFieldName",
    expression="expression",

    # the properties below are optional
    aggregation="aggregation",
    allowed_aggregations=["allowedAggregations"],
    calculated_field_description="calculatedFieldDescription",
    calculated_field_synonyms=["calculatedFieldSynonyms"],
    cell_value_synonyms=[quicksight.CfnTopic.CellValueSynonymProperty(
        cell_value="cellValue",
        synonyms=["synonyms"]
    )],
    column_data_role="columnDataRole",
    comparative_order=quicksight.CfnTopic.ComparativeOrderProperty(
        specifed_order=["specifedOrder"],
        treat_undefined_specified_values="treatUndefinedSpecifiedValues",
        use_ordering="useOrdering"
    ),
    default_formatting=quicksight.CfnTopic.DefaultFormattingProperty(
        display_format="displayFormat",
        display_format_options=quicksight.CfnTopic.DisplayFormatOptionsProperty(
            blank_cell_format="blankCellFormat",
            currency_symbol="currencySymbol",
            date_format="dateFormat",
            decimal_separator="decimalSeparator",
            fraction_digits=123,
            grouping_separator="groupingSeparator",
            negative_format=quicksight.CfnTopic.NegativeFormatProperty(
                prefix="prefix",
                suffix="suffix"
            ),
            prefix="prefix",
            suffix="suffix",
            unit_scaler="unitScaler",
            use_blank_cell_format=False,
            use_grouping=False
        )
    ),
    is_included_in_topic=False,
    never_aggregate_in_filter=False,
    non_additive=False,
    not_allowed_aggregations=["notAllowedAggregations"],
    semantic_type=quicksight.CfnTopic.SemanticTypeProperty(
        falsey_cell_value="falseyCellValue",
        falsey_cell_value_synonyms=["falseyCellValueSynonyms"],
        sub_type_name="subTypeName",
        truthy_cell_value="truthyCellValue",
        truthy_cell_value_synonyms=["truthyCellValueSynonyms"],
        type_name="typeName",
        type_parameters={
            "type_parameters_key": "typeParameters"
        }
    ),
    time_granularity="timeGranularity"
)

Attributes

aggregation

The default aggregation.

Valid values for this structure are SUM , MAX , MIN , COUNT , DISTINCT_COUNT , and AVERAGE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-aggregation

allowed_aggregations

The list of aggregation types that are allowed for the calculated field.

Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-allowedaggregations

calculated_field_description

The calculated field description.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-calculatedfielddescription

calculated_field_name

The calculated field name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-calculatedfieldname

calculated_field_synonyms

The other names or aliases for the calculated field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-calculatedfieldsynonyms

cell_value_synonyms

The other names or aliases for the calculated field cell value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-cellvaluesynonyms

column_data_role

The column data role for a calculated field.

Valid values for this structure are DIMENSION and MEASURE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-columndatarole

comparative_order

The order in which data is displayed for the calculated field when it’s used in a comparative context.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-comparativeorder

default_formatting

The default formatting definition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-defaultformatting

expression

The calculated field expression.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-expression

is_included_in_topic

A boolean value that indicates if a calculated field is included in the topic.

Default:
  • false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-isincludedintopic

never_aggregate_in_filter

A Boolean value that indicates whether to never aggregate calculated field in filters.

Default:
  • false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-neveraggregateinfilter

non_additive

The non additive for the table style target.

Default:
  • false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-nonadditive

not_allowed_aggregations

The list of aggregation types that are not allowed for the calculated field.

Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-notallowedaggregations

semantic_type

The semantic type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-semantictype

time_granularity

The level of time precision that is used to aggregate DateTime values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-timegranularity

TopicCategoryFilterConstantProperty

class CfnTopic.TopicCategoryFilterConstantProperty(*, collective_constant=None, constant_type=None, singular_constant=None)

Bases: object

A constant used in a category filter.

Parameters:
  • collective_constant (Union[IResolvable, CollectiveConstantProperty, Dict[str, Any], None]) – A collective constant used in a category filter. This element is used to specify a list of values for the constant.

  • constant_type (Optional[str]) – The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE .

  • singular_constant (Optional[str]) – A singular constant used in a category filter. This element is used to specify a single value for the constant.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilterconstant.html

ExampleMetadata:

fixture=_generated

Example:

# 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

topic_category_filter_constant_property = quicksight.CfnTopic.TopicCategoryFilterConstantProperty(
    collective_constant=quicksight.CfnTopic.CollectiveConstantProperty(
        value_list=["valueList"]
    ),
    constant_type="constantType",
    singular_constant="singularConstant"
)

Attributes

collective_constant

A collective constant used in a category filter.

This element is used to specify a list of values for the constant.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilterconstant.html#cfn-quicksight-topic-topiccategoryfilterconstant-collectiveconstant

constant_type

The type of category filter constant.

This element is used to specify whether a constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilterconstant.html#cfn-quicksight-topic-topiccategoryfilterconstant-constanttype

singular_constant

A singular constant used in a category filter.

This element is used to specify a single value for the constant.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilterconstant.html#cfn-quicksight-topic-topiccategoryfilterconstant-singularconstant

TopicCategoryFilterProperty

class CfnTopic.TopicCategoryFilterProperty(*, category_filter_function=None, category_filter_type=None, constant=None, inverse=None)

Bases: object

A structure that represents a category filter.

Parameters:
  • category_filter_function (Optional[str]) – The category filter function. Valid values for this structure are EXACT and CONTAINS .

  • category_filter_type (Optional[str]) – The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.

  • constant (Union[IResolvable, TopicCategoryFilterConstantProperty, Dict[str, Any], None]) – The constant used in a category filter.

  • inverse (Union[bool, IResolvable, None]) – A Boolean value that indicates if the filter is inverse. Default: - false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilter.html

ExampleMetadata:

fixture=_generated

Example:

# 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

topic_category_filter_property = quicksight.CfnTopic.TopicCategoryFilterProperty(
    category_filter_function="categoryFilterFunction",
    category_filter_type="categoryFilterType",
    constant=quicksight.CfnTopic.TopicCategoryFilterConstantProperty(
        collective_constant=quicksight.CfnTopic.CollectiveConstantProperty(
            value_list=["valueList"]
        ),
        constant_type="constantType",
        singular_constant="singularConstant"
    ),
    inverse=False
)

Attributes

category_filter_function

The category filter function.

Valid values for this structure are EXACT and CONTAINS .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilter.html#cfn-quicksight-topic-topiccategoryfilter-categoryfilterfunction

category_filter_type

The category filter type.

This element is used to specify whether a filter is a simple category filter or an inverse category filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilter.html#cfn-quicksight-topic-topiccategoryfilter-categoryfiltertype

constant

The constant used in a category filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilter.html#cfn-quicksight-topic-topiccategoryfilter-constant

inverse

A Boolean value that indicates if the filter is inverse.

Default:
  • false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilter.html#cfn-quicksight-topic-topiccategoryfilter-inverse

TopicColumnProperty

class CfnTopic.TopicColumnProperty(*, column_name, aggregation=None, allowed_aggregations=None, cell_value_synonyms=None, column_data_role=None, column_description=None, column_friendly_name=None, column_synonyms=None, comparative_order=None, default_formatting=None, is_included_in_topic=None, never_aggregate_in_filter=None, non_additive=None, not_allowed_aggregations=None, semantic_type=None, time_granularity=None)

Bases: object

Represents a column in a dataset.

Parameters:
  • column_name (str) – The name of the column.

  • aggregation (Optional[str]) – The type of aggregation that is performed on the column data when it’s queried.

  • allowed_aggregations (Optional[Sequence[str]]) – The list of aggregation types that are allowed for the column. Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .

  • cell_value_synonyms (Union[IResolvable, Sequence[Union[IResolvable, CellValueSynonymProperty, Dict[str, Any]]], None]) – The other names or aliases for the column cell value.

  • column_data_role (Optional[str]) – The role of the column in the data. Valid values are DIMENSION and MEASURE .

  • column_description (Optional[str]) – A description of the column and its contents.

  • column_friendly_name (Optional[str]) – A user-friendly name for the column.

  • column_synonyms (Optional[Sequence[str]]) – The other names or aliases for the column.

  • comparative_order (Union[IResolvable, ComparativeOrderProperty, Dict[str, Any], None]) – The order in which data is displayed for the column when it’s used in a comparative context.

  • default_formatting (Union[IResolvable, DefaultFormattingProperty, Dict[str, Any], None]) – The default formatting used for values in the column.

  • is_included_in_topic (Union[bool, IResolvable, None]) – A Boolean value that indicates whether the column is included in the query results. Default: - false

  • never_aggregate_in_filter (Union[bool, IResolvable, None]) – A Boolean value that indicates whether to aggregate the column data when it’s used in a filter context. Default: - false

  • non_additive (Union[bool, IResolvable, None]) – The non additive value for the column. Default: - false

  • not_allowed_aggregations (Optional[Sequence[str]]) – The list of aggregation types that are not allowed for the column. Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .

  • semantic_type (Union[IResolvable, SemanticTypeProperty, Dict[str, Any], None]) – The semantic type of data contained in the column.

  • time_granularity (Optional[str]) – The level of time precision that is used to aggregate DateTime values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html

ExampleMetadata:

fixture=_generated

Example:

# 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

topic_column_property = quicksight.CfnTopic.TopicColumnProperty(
    column_name="columnName",

    # the properties below are optional
    aggregation="aggregation",
    allowed_aggregations=["allowedAggregations"],
    cell_value_synonyms=[quicksight.CfnTopic.CellValueSynonymProperty(
        cell_value="cellValue",
        synonyms=["synonyms"]
    )],
    column_data_role="columnDataRole",
    column_description="columnDescription",
    column_friendly_name="columnFriendlyName",
    column_synonyms=["columnSynonyms"],
    comparative_order=quicksight.CfnTopic.ComparativeOrderProperty(
        specifed_order=["specifedOrder"],
        treat_undefined_specified_values="treatUndefinedSpecifiedValues",
        use_ordering="useOrdering"
    ),
    default_formatting=quicksight.CfnTopic.DefaultFormattingProperty(
        display_format="displayFormat",
        display_format_options=quicksight.CfnTopic.DisplayFormatOptionsProperty(
            blank_cell_format="blankCellFormat",
            currency_symbol="currencySymbol",
            date_format="dateFormat",
            decimal_separator="decimalSeparator",
            fraction_digits=123,
            grouping_separator="groupingSeparator",
            negative_format=quicksight.CfnTopic.NegativeFormatProperty(
                prefix="prefix",
                suffix="suffix"
            ),
            prefix="prefix",
            suffix="suffix",
            unit_scaler="unitScaler",
            use_blank_cell_format=False,
            use_grouping=False
        )
    ),
    is_included_in_topic=False,
    never_aggregate_in_filter=False,
    non_additive=False,
    not_allowed_aggregations=["notAllowedAggregations"],
    semantic_type=quicksight.CfnTopic.SemanticTypeProperty(
        falsey_cell_value="falseyCellValue",
        falsey_cell_value_synonyms=["falseyCellValueSynonyms"],
        sub_type_name="subTypeName",
        truthy_cell_value="truthyCellValue",
        truthy_cell_value_synonyms=["truthyCellValueSynonyms"],
        type_name="typeName",
        type_parameters={
            "type_parameters_key": "typeParameters"
        }
    ),
    time_granularity="timeGranularity"
)

Attributes

aggregation

The type of aggregation that is performed on the column data when it’s queried.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-aggregation

allowed_aggregations

The list of aggregation types that are allowed for the column.

Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-allowedaggregations

cell_value_synonyms

The other names or aliases for the column cell value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-cellvaluesynonyms

column_data_role

The role of the column in the data.

Valid values are DIMENSION and MEASURE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columndatarole

column_description

A description of the column and its contents.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columndescription

column_friendly_name

A user-friendly name for the column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columnfriendlyname

column_name

The name of the column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columnname

column_synonyms

The other names or aliases for the column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columnsynonyms

comparative_order

The order in which data is displayed for the column when it’s used in a comparative context.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-comparativeorder

default_formatting

The default formatting used for values in the column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-defaultformatting

is_included_in_topic

A Boolean value that indicates whether the column is included in the query results.

Default:
  • false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-isincludedintopic

never_aggregate_in_filter

A Boolean value that indicates whether to aggregate the column data when it’s used in a filter context.

Default:
  • false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-neveraggregateinfilter

non_additive

The non additive value for the column.

Default:
  • false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-nonadditive

not_allowed_aggregations

The list of aggregation types that are not allowed for the column.

Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-notallowedaggregations

semantic_type

The semantic type of data contained in the column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-semantictype

time_granularity

The level of time precision that is used to aggregate DateTime values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-timegranularity

TopicDateRangeFilterProperty

class CfnTopic.TopicDateRangeFilterProperty(*, constant=None, inclusive=None)

Bases: object

A filter used to restrict data based on a range of dates or times.

Parameters:
  • constant (Union[IResolvable, TopicRangeFilterConstantProperty, Dict[str, Any], None]) – The constant used in a date range filter.

  • inclusive (Union[bool, IResolvable, None]) – A Boolean value that indicates whether the date range filter should include the boundary values. If set to true, the filter includes the start and end dates. If set to false, the filter excludes them. Default: - false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicdaterangefilter.html

ExampleMetadata:

fixture=_generated

Example:

# 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

topic_date_range_filter_property = quicksight.CfnTopic.TopicDateRangeFilterProperty(
    constant=quicksight.CfnTopic.TopicRangeFilterConstantProperty(
        constant_type="constantType",
        range_constant=quicksight.CfnTopic.RangeConstantProperty(
            maximum="maximum",
            minimum="minimum"
        )
    ),
    inclusive=False
)

Attributes

constant

The constant used in a date range filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicdaterangefilter.html#cfn-quicksight-topic-topicdaterangefilter-constant

inclusive

A Boolean value that indicates whether the date range filter should include the boundary values.

If set to true, the filter includes the start and end dates. If set to false, the filter excludes them.

Default:
  • false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicdaterangefilter.html#cfn-quicksight-topic-topicdaterangefilter-inclusive

TopicFilterProperty

class CfnTopic.TopicFilterProperty(*, filter_name, operand_field_name, category_filter=None, date_range_filter=None, filter_class=None, filter_description=None, filter_synonyms=None, filter_type=None, numeric_equality_filter=None, numeric_range_filter=None, relative_date_filter=None)

Bases: object

A structure that represents a filter used to select items for a topic.

Parameters:
  • filter_name (str) – The name of the filter.

  • operand_field_name (str) – The name of the field that the filter operates on.

  • category_filter (Union[IResolvable, TopicCategoryFilterProperty, Dict[str, Any], None]) – The category filter that is associated with this filter.

  • date_range_filter (Union[IResolvable, TopicDateRangeFilterProperty, Dict[str, Any], None]) – The date range filter.

  • filter_class (Optional[str]) – The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER , CONDITIONAL_VALUE_FILTER , and NAMED_VALUE_FILTER .

  • filter_description (Optional[str]) – A description of the filter used to select items for a topic.

  • filter_synonyms (Optional[Sequence[str]]) – The other names or aliases for the filter.

  • filter_type (Optional[str]) – The type of the filter. Valid values for this structure are CATEGORY_FILTER , NUMERIC_EQUALITY_FILTER , NUMERIC_RANGE_FILTER , DATE_RANGE_FILTER , and RELATIVE_DATE_FILTER .

  • numeric_equality_filter (Union[IResolvable, TopicNumericEqualityFilterProperty, Dict[str, Any], None]) – The numeric equality filter.

  • numeric_range_filter (Union[IResolvable, TopicNumericRangeFilterProperty, Dict[str, Any], None]) – The numeric range filter.

  • relative_date_filter (Union[IResolvable, TopicRelativeDateFilterProperty, Dict[str, Any], None]) – The relative date filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html

ExampleMetadata:

fixture=_generated

Example:

# 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

topic_filter_property = quicksight.CfnTopic.TopicFilterProperty(
    filter_name="filterName",
    operand_field_name="operandFieldName",

    # the properties below are optional
    category_filter=quicksight.CfnTopic.TopicCategoryFilterProperty(
        category_filter_function="categoryFilterFunction",
        category_filter_type="categoryFilterType",
        constant=quicksight.CfnTopic.TopicCategoryFilterConstantProperty(
            collective_constant=quicksight.CfnTopic.CollectiveConstantProperty(
                value_list=["valueList"]
            ),
            constant_type="constantType",
            singular_constant="singularConstant"
        ),
        inverse=False
    ),
    date_range_filter=quicksight.CfnTopic.TopicDateRangeFilterProperty(
        constant=quicksight.CfnTopic.TopicRangeFilterConstantProperty(
            constant_type="constantType",
            range_constant=quicksight.CfnTopic.RangeConstantProperty(
                maximum="maximum",
                minimum="minimum"
            )
        ),
        inclusive=False
    ),
    filter_class="filterClass",
    filter_description="filterDescription",
    filter_synonyms=["filterSynonyms"],
    filter_type="filterType",
    numeric_equality_filter=quicksight.CfnTopic.TopicNumericEqualityFilterProperty(
        aggregation="aggregation",
        constant=quicksight.CfnTopic.TopicSingularFilterConstantProperty(
            constant_type="constantType",
            singular_constant="singularConstant"
        )
    ),
    numeric_range_filter=quicksight.CfnTopic.TopicNumericRangeFilterProperty(
        aggregation="aggregation",
        constant=quicksight.CfnTopic.TopicRangeFilterConstantProperty(
            constant_type="constantType",
            range_constant=quicksight.CfnTopic.RangeConstantProperty(
                maximum="maximum",
                minimum="minimum"
            )
        ),
        inclusive=False
    ),
    relative_date_filter=quicksight.CfnTopic.TopicRelativeDateFilterProperty(
        constant=quicksight.CfnTopic.TopicSingularFilterConstantProperty(
            constant_type="constantType",
            singular_constant="singularConstant"
        ),
        relative_date_filter_function="relativeDateFilterFunction",
        time_granularity="timeGranularity"
    )
)

Attributes

category_filter

The category filter that is associated with this filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-categoryfilter

date_range_filter

The date range filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-daterangefilter

filter_class

The class of the filter.

Valid values for this structure are ENFORCED_VALUE_FILTER , CONDITIONAL_VALUE_FILTER , and NAMED_VALUE_FILTER .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filterclass

filter_description

A description of the filter used to select items for a topic.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filterdescription

filter_name

The name of the filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filtername

filter_synonyms

The other names or aliases for the filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filtersynonyms

filter_type

The type of the filter.

Valid values for this structure are CATEGORY_FILTER , NUMERIC_EQUALITY_FILTER , NUMERIC_RANGE_FILTER , DATE_RANGE_FILTER , and RELATIVE_DATE_FILTER .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filtertype

numeric_equality_filter

The numeric equality filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-numericequalityfilter

numeric_range_filter

The numeric range filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-numericrangefilter

operand_field_name

The name of the field that the filter operates on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-operandfieldname

relative_date_filter

The relative date filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-relativedatefilter

TopicNamedEntityProperty

class CfnTopic.TopicNamedEntityProperty(*, entity_name, definition=None, entity_description=None, entity_synonyms=None, semantic_entity_type=None)

Bases: object

A structure that represents a named entity.

Parameters:
  • entity_name (str) – The name of the named entity.

  • definition (Union[IResolvable, Sequence[Union[IResolvable, NamedEntityDefinitionProperty, Dict[str, Any]]], None]) – The definition of a named entity.

  • entity_description (Optional[str]) – The description of the named entity.

  • entity_synonyms (Optional[Sequence[str]]) – The other names or aliases for the named entity.

  • semantic_entity_type (Union[IResolvable, SemanticEntityTypeProperty, Dict[str, Any], None]) – The type of named entity that a topic represents.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html

ExampleMetadata:

fixture=_generated

Example:

# 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

topic_named_entity_property = quicksight.CfnTopic.TopicNamedEntityProperty(
    entity_name="entityName",

    # the properties below are optional
    definition=[quicksight.CfnTopic.NamedEntityDefinitionProperty(
        field_name="fieldName",
        metric=quicksight.CfnTopic.NamedEntityDefinitionMetricProperty(
            aggregation="aggregation",
            aggregation_function_parameters={
                "aggregation_function_parameters_key": "aggregationFunctionParameters"
            }
        ),
        property_name="propertyName",
        property_role="propertyRole",
        property_usage="propertyUsage"
    )],
    entity_description="entityDescription",
    entity_synonyms=["entitySynonyms"],
    semantic_entity_type=quicksight.CfnTopic.SemanticEntityTypeProperty(
        sub_type_name="subTypeName",
        type_name="typeName",
        type_parameters={
            "type_parameters_key": "typeParameters"
        }
    )
)

Attributes

definition

The definition of a named entity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-definition

entity_description

The description of the named entity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-entitydescription

entity_name

The name of the named entity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-entityname

entity_synonyms

The other names or aliases for the named entity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-entitysynonyms

semantic_entity_type

The type of named entity that a topic represents.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-semanticentitytype

TopicNumericEqualityFilterProperty

class CfnTopic.TopicNumericEqualityFilterProperty(*, aggregation=None, constant=None)

Bases: object

A filter that filters topics based on the value of a numeric field.

The filter includes only topics whose numeric field value matches the specified value.

Parameters:
  • aggregation (Optional[str]) – An aggregation function that specifies how to calculate the value of a numeric field for a topic. Valid values for this structure are NO_AGGREGATION , SUM , AVERAGE , COUNT , DISTINCT_COUNT , MAX , MEDIAN , MIN , STDEV , STDEVP , VAR , and VARP .

  • constant (Union[IResolvable, TopicSingularFilterConstantProperty, Dict[str, Any], None]) – The constant used in a numeric equality filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnumericequalityfilter.html

ExampleMetadata:

fixture=_generated

Example:

# 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

topic_numeric_equality_filter_property = quicksight.CfnTopic.TopicNumericEqualityFilterProperty(
    aggregation="aggregation",
    constant=quicksight.CfnTopic.TopicSingularFilterConstantProperty(
        constant_type="constantType",
        singular_constant="singularConstant"
    )
)

Attributes

aggregation

An aggregation function that specifies how to calculate the value of a numeric field for a topic.

Valid values for this structure are NO_AGGREGATION , SUM , AVERAGE , COUNT , DISTINCT_COUNT , MAX , MEDIAN , MIN , STDEV , STDEVP , VAR , and VARP .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnumericequalityfilter.html#cfn-quicksight-topic-topicnumericequalityfilter-aggregation

constant

The constant used in a numeric equality filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnumericequalityfilter.html#cfn-quicksight-topic-topicnumericequalityfilter-constant

TopicNumericRangeFilterProperty

class CfnTopic.TopicNumericRangeFilterProperty(*, aggregation=None, constant=None, inclusive=None)

Bases: object

A filter that filters topics based on the value of a numeric field.

The filter includes only topics whose numeric field value falls within the specified range.

Parameters:
  • aggregation (Optional[str]) – An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION , SUM , AVERAGE , COUNT , DISTINCT_COUNT , MAX , MEDIAN , MIN , STDEV , STDEVP , VAR , and VARP .

  • constant (Union[IResolvable, TopicRangeFilterConstantProperty, Dict[str, Any], None]) – The constant used in a numeric range filter.

  • inclusive (Union[bool, IResolvable, None]) – A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter. Default: - false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnumericrangefilter.html

ExampleMetadata:

fixture=_generated

Example:

# 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

topic_numeric_range_filter_property = quicksight.CfnTopic.TopicNumericRangeFilterProperty(
    aggregation="aggregation",
    constant=quicksight.CfnTopic.TopicRangeFilterConstantProperty(
        constant_type="constantType",
        range_constant=quicksight.CfnTopic.RangeConstantProperty(
            maximum="maximum",
            minimum="minimum"
        )
    ),
    inclusive=False
)

Attributes

aggregation

An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION , SUM , AVERAGE , COUNT , DISTINCT_COUNT , MAX , MEDIAN , MIN , STDEV , STDEVP , VAR , and VARP .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnumericrangefilter.html#cfn-quicksight-topic-topicnumericrangefilter-aggregation

constant

The constant used in a numeric range filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnumericrangefilter.html#cfn-quicksight-topic-topicnumericrangefilter-constant

inclusive

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter.

If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.

Default:
  • false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnumericrangefilter.html#cfn-quicksight-topic-topicnumericrangefilter-inclusive

TopicRangeFilterConstantProperty

class CfnTopic.TopicRangeFilterConstantProperty(*, constant_type=None, range_constant=None)

Bases: object

A constant value that is used in a range filter to specify the endpoints of the range.

Parameters:
  • constant_type (Optional[str]) – The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE .

  • range_constant (Union[IResolvable, RangeConstantProperty, Dict[str, Any], None]) – The value of the constant that is used to specify the endpoints of a range filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicrangefilterconstant.html

ExampleMetadata:

fixture=_generated

Example:

# 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

topic_range_filter_constant_property = quicksight.CfnTopic.TopicRangeFilterConstantProperty(
    constant_type="constantType",
    range_constant=quicksight.CfnTopic.RangeConstantProperty(
        maximum="maximum",
        minimum="minimum"
    )
)

Attributes

constant_type

The data type of the constant value that is used in a range filter.

Valid values for this structure are RANGE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicrangefilterconstant.html#cfn-quicksight-topic-topicrangefilterconstant-constanttype

range_constant

The value of the constant that is used to specify the endpoints of a range filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicrangefilterconstant.html#cfn-quicksight-topic-topicrangefilterconstant-rangeconstant

TopicRelativeDateFilterProperty

class CfnTopic.TopicRelativeDateFilterProperty(*, constant=None, relative_date_filter_function=None, time_granularity=None)

Bases: object

A structure that represents a relative date filter.

Parameters:
  • constant (Union[IResolvable, TopicSingularFilterConstantProperty, Dict[str, Any], None]) – The constant used in a relative date filter.

  • relative_date_filter_function (Optional[str]) – The function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are BEFORE , AFTER , and BETWEEN .

  • time_granularity (Optional[str]) – The level of time precision that is used to aggregate DateTime values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicrelativedatefilter.html

ExampleMetadata:

fixture=_generated

Example:

# 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

topic_relative_date_filter_property = quicksight.CfnTopic.TopicRelativeDateFilterProperty(
    constant=quicksight.CfnTopic.TopicSingularFilterConstantProperty(
        constant_type="constantType",
        singular_constant="singularConstant"
    ),
    relative_date_filter_function="relativeDateFilterFunction",
    time_granularity="timeGranularity"
)

Attributes

constant

The constant used in a relative date filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicrelativedatefilter.html#cfn-quicksight-topic-topicrelativedatefilter-constant

relative_date_filter_function

The function to be used in a relative date filter to determine the range of dates to include in the results.

Valid values for this structure are BEFORE , AFTER , and BETWEEN .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicrelativedatefilter.html#cfn-quicksight-topic-topicrelativedatefilter-relativedatefilterfunction

time_granularity

The level of time precision that is used to aggregate DateTime values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicrelativedatefilter.html#cfn-quicksight-topic-topicrelativedatefilter-timegranularity

TopicSingularFilterConstantProperty

class CfnTopic.TopicSingularFilterConstantProperty(*, constant_type=None, singular_constant=None)

Bases: object

A structure that represents a singular filter constant, used in filters to specify a single value to match against.

Parameters:
  • constant_type (Optional[str]) – The type of the singular filter constant. Valid values for this structure are SINGULAR .

  • singular_constant (Optional[str]) – The value of the singular filter constant.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicsingularfilterconstant.html

ExampleMetadata:

fixture=_generated

Example:

# 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

topic_singular_filter_constant_property = quicksight.CfnTopic.TopicSingularFilterConstantProperty(
    constant_type="constantType",
    singular_constant="singularConstant"
)

Attributes

constant_type

The type of the singular filter constant.

Valid values for this structure are SINGULAR .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicsingularfilterconstant.html#cfn-quicksight-topic-topicsingularfilterconstant-constanttype

singular_constant

The value of the singular filter constant.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicsingularfilterconstant.html#cfn-quicksight-topic-topicsingularfilterconstant-singularconstant