aws-native.quicksight.Topic

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

pulumi/pulumi-aws-native

Create Topic Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Topic(name: string, args?: TopicArgs, opts?: CustomResourceOptions);

@overload
def Topic(resource_name: str,
          args: Optional[TopicArgs] = None,
          opts: Optional[ResourceOptions] = None)

@overload
def Topic(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          aws_account_id: Optional[str] = None,
          data_sets: Optional[Sequence[TopicDatasetMetadataArgs]] = None,
          description: Optional[str] = None,
          name: Optional[str] = None,
          topic_id: Optional[str] = None,
          user_experience_version: Optional[TopicUserExperienceVersion] = None)

func NewTopic(ctx *Context, name string, args *TopicArgs, opts ...ResourceOption) (*Topic, error)

public Topic(string name, TopicArgs? args = null, CustomResourceOptions? opts = null)

public Topic(String name, TopicArgs args)
public Topic(String name, TopicArgs args, CustomResourceOptions options)

type: aws-native:quicksight:Topic
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args TopicArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args TopicArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args TopicArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TopicArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args TopicArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

The following reference example uses placeholder values for all input properties.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const topicResource = new aws_native.quicksight.Topic("topicResource", {
    awsAccountId: "string",
    dataSets: [{
        datasetArn: "string",
        calculatedFields: [{
            calculatedFieldName: "string",
            expression: "string",
            defaultFormatting: {
                displayFormat: aws_native.quicksight.TopicDisplayFormat.Auto,
                displayFormatOptions: {
                    blankCellFormat: "string",
                    currencySymbol: "string",
                    dateFormat: "string",
                    decimalSeparator: aws_native.quicksight.TopicNumericSeparatorSymbol.Comma,
                    fractionDigits: 0,
                    groupingSeparator: "string",
                    negativeFormat: {
                        prefix: "string",
                        suffix: "string",
                    },
                    prefix: "string",
                    suffix: "string",
                    unitScaler: aws_native.quicksight.TopicNumberScale.None,
                    useBlankCellFormat: false,
                    useGrouping: false,
                },
            },
            disableIndexing: false,
            calculatedFieldSynonyms: ["string"],
            cellValueSynonyms: [{
                cellValue: "string",
                synonyms: ["string"],
            }],
            columnDataRole: aws_native.quicksight.TopicColumnDataRole.Dimension,
            comparativeOrder: {
                specifedOrder: ["string"],
                treatUndefinedSpecifiedValues: aws_native.quicksight.TopicUndefinedSpecifiedValueType.Least,
                useOrdering: aws_native.quicksight.TopicColumnOrderingType.GreaterIsBetter,
            },
            aggregation: aws_native.quicksight.TopicDefaultAggregation.Sum,
            calculatedFieldDescription: "string",
            allowedAggregations: [aws_native.quicksight.TopicAuthorSpecifiedAggregation.Count],
            isIncludedInTopic: false,
            neverAggregateInFilter: false,
            nonAdditive: false,
            notAllowedAggregations: [aws_native.quicksight.TopicAuthorSpecifiedAggregation.Count],
            semanticType: {
                falseyCellValue: "string",
                falseyCellValueSynonyms: ["string"],
                subTypeName: "string",
                truthyCellValue: "string",
                truthyCellValueSynonyms: ["string"],
                typeName: "string",
                typeParameters: {
                    string: "string",
                },
            },
            timeGranularity: aws_native.quicksight.TopicTimeGranularity.Second,
        }],
        columns: [{
            columnName: "string",
            comparativeOrder: {
                specifedOrder: ["string"],
                treatUndefinedSpecifiedValues: aws_native.quicksight.TopicUndefinedSpecifiedValueType.Least,
                useOrdering: aws_native.quicksight.TopicColumnOrderingType.GreaterIsBetter,
            },
            columnSynonyms: ["string"],
            columnDataRole: aws_native.quicksight.TopicColumnDataRole.Dimension,
            columnDescription: "string",
            defaultFormatting: {
                displayFormat: aws_native.quicksight.TopicDisplayFormat.Auto,
                displayFormatOptions: {
                    blankCellFormat: "string",
                    currencySymbol: "string",
                    dateFormat: "string",
                    decimalSeparator: aws_native.quicksight.TopicNumericSeparatorSymbol.Comma,
                    fractionDigits: 0,
                    groupingSeparator: "string",
                    negativeFormat: {
                        prefix: "string",
                        suffix: "string",
                    },
                    prefix: "string",
                    suffix: "string",
                    unitScaler: aws_native.quicksight.TopicNumberScale.None,
                    useBlankCellFormat: false,
                    useGrouping: false,
                },
            },
            allowedAggregations: [aws_native.quicksight.TopicAuthorSpecifiedAggregation.Count],
            cellValueSynonyms: [{
                cellValue: "string",
                synonyms: ["string"],
            }],
            aggregation: aws_native.quicksight.TopicDefaultAggregation.Sum,
            columnFriendlyName: "string",
            disableIndexing: false,
            isIncludedInTopic: false,
            neverAggregateInFilter: false,
            nonAdditive: false,
            notAllowedAggregations: [aws_native.quicksight.TopicAuthorSpecifiedAggregation.Count],
            semanticType: {
                falseyCellValue: "string",
                falseyCellValueSynonyms: ["string"],
                subTypeName: "string",
                truthyCellValue: "string",
                truthyCellValueSynonyms: ["string"],
                typeName: "string",
                typeParameters: {
                    string: "string",
                },
            },
            timeGranularity: aws_native.quicksight.TopicTimeGranularity.Second,
        }],
        dataAggregation: {
            datasetRowDateGranularity: aws_native.quicksight.TopicTimeGranularity.Second,
            defaultDateColumnName: "string",
        },
        datasetDescription: "string",
        datasetName: "string",
        filters: [{
            filterName: "string",
            operandFieldName: "string",
            categoryFilter: {
                categoryFilterFunction: aws_native.quicksight.TopicCategoryFilterFunction.Exact,
                categoryFilterType: aws_native.quicksight.TopicCategoryFilterType.CustomFilter,
                constant: {
                    collectiveConstant: {
                        valueList: ["string"],
                    },
                    constantType: aws_native.quicksight.TopicConstantType.Singular,
                    singularConstant: "string",
                },
                inverse: false,
            },
            dateRangeFilter: {
                constant: {
                    constantType: aws_native.quicksight.TopicConstantType.Singular,
                    rangeConstant: {
                        maximum: "string",
                        minimum: "string",
                    },
                },
                inclusive: false,
            },
            filterClass: aws_native.quicksight.TopicFilterClass.EnforcedValueFilter,
            filterDescription: "string",
            filterSynonyms: ["string"],
            filterType: aws_native.quicksight.TopicNamedFilterType.CategoryFilter,
            numericEqualityFilter: {
                aggregation: aws_native.quicksight.TopicNamedFilterAggType.NoAggregation,
                constant: {
                    constantType: aws_native.quicksight.TopicConstantType.Singular,
                    singularConstant: "string",
                },
            },
            numericRangeFilter: {
                aggregation: aws_native.quicksight.TopicNamedFilterAggType.NoAggregation,
                constant: {
                    constantType: aws_native.quicksight.TopicConstantType.Singular,
                    rangeConstant: {
                        maximum: "string",
                        minimum: "string",
                    },
                },
                inclusive: false,
            },
            relativeDateFilter: {
                constant: {
                    constantType: aws_native.quicksight.TopicConstantType.Singular,
                    singularConstant: "string",
                },
                relativeDateFilterFunction: aws_native.quicksight.TopicRelativeDateFilterFunction.Previous,
                timeGranularity: aws_native.quicksight.TopicTimeGranularity.Second,
            },
        }],
        namedEntities: [{
            entityName: "string",
            definition: [{
                fieldName: "string",
                metric: {
                    aggregation: aws_native.quicksight.TopicNamedEntityAggType.Sum,
                    aggregationFunctionParameters: {
                        string: "string",
                    },
                },
                propertyName: "string",
                propertyRole: aws_native.quicksight.TopicPropertyRole.Primary,
                propertyUsage: aws_native.quicksight.TopicPropertyUsage.Inherit,
            }],
            entityDescription: "string",
            entitySynonyms: ["string"],
            semanticEntityType: {
                subTypeName: "string",
                typeName: "string",
                typeParameters: {
                    string: "string",
                },
            },
        }],
    }],
    description: "string",
    name: "string",
    topicId: "string",
    userExperienceVersion: aws_native.quicksight.TopicUserExperienceVersion.Legacy,
});