CfnTopicV2PropsMixin

class aws_cdk.cfn_property_mixins.aws_quicksight.CfnTopicV2PropsMixin(props, *, strategy=None)

Bases: Mixin

Definition of the AWS::QuickSight::TopicV2 Resource Type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topicv2.html
CloudformationResource:: AWS::QuickSight::TopicV2
Mixin:: true
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.cfn_property_mixins import aws_quicksight as quicksight
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_topic_v2_props_mixin = quicksight.CfnTopicV2PropsMixin(quicksight.CfnTopicV2MixinProps(
    aws_account_id="awsAccountId",
    custom_instructions=quicksight.CfnTopicV2PropsMixin.CustomInstructionsProperty(
        custom_instructions_string="customInstructionsString"
    ),
    data_set_relations=[quicksight.CfnTopicV2PropsMixin.DataSetRelationProperty(
        left=quicksight.CfnTopicV2PropsMixin.DataSetRelationEndpointProperty(
            column_names=["columnNames"],
            data_set_arn="dataSetArn"
        ),
        right=quicksight.CfnTopicV2PropsMixin.DataSetRelationEndpointProperty(
            column_names=["columnNames"],
            data_set_arn="dataSetArn"
        )
    )],
    data_sets=[quicksight.CfnTopicV2PropsMixin.DataSetReferenceProperty(
        data_set_arn="dataSetArn",
        data_set_name="dataSetName"
    )],
    description="description",
    folder_arns=["folderArns"],
    name="name",
    permissions=[quicksight.CfnTopicV2PropsMixin.ResourcePermissionProperty(
        actions=["actions"],
        principal="principal"
    )],
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    topic_id="topicId"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::QuickSight::TopicV2.

Parameters:

props (Union[CfnTopicV2MixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['awsAccountId', 'customInstructions', 'dataSetRelations', 'dataSets', 'description', 'folderArns', 'name', 'permissions', 'tags', 'topicId']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

CustomInstructionsProperty

class CfnTopicV2PropsMixin.CustomInstructionsProperty(*, custom_instructions_string=None)

Bases: object

Parameters:: custom_instructions_string (Optional[str])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topicv2-custominstructions.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.cfn_property_mixins import aws_quicksight as quicksight

custom_instructions_property = quicksight.CfnTopicV2PropsMixin.CustomInstructionsProperty(
    custom_instructions_string="customInstructionsString"
)

Attributes

custom_instructions_string

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topicv2-custominstructions.html#cfn-quicksight-topicv2-custominstructions-custominstructionsstring

Type:: see

DataSetReferenceProperty

class CfnTopicV2PropsMixin.DataSetReferenceProperty(*, data_set_arn=None, data_set_name=None)

Bases: object

A dataset reference used by a V2 (SEMANTIC_VIEW) topic.

Parameters:

data_set_arn (Optional[str])
data_set_name (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topicv2-datasetreference.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.cfn_property_mixins import aws_quicksight as quicksight

data_set_reference_property = quicksight.CfnTopicV2PropsMixin.DataSetReferenceProperty(
    data_set_arn="dataSetArn",
    data_set_name="dataSetName"
)

Attributes

data_set_arn

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

Type:: see

data_set_name

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

Type:: see

DataSetRelationEndpointProperty

class CfnTopicV2PropsMixin.DataSetRelationEndpointProperty(*, column_names=None, data_set_arn=None)

Bases: object

Parameters:

column_names (Optional[Sequence[str]])
data_set_arn (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topicv2-datasetrelationendpoint.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.cfn_property_mixins import aws_quicksight as quicksight

data_set_relation_endpoint_property = quicksight.CfnTopicV2PropsMixin.DataSetRelationEndpointProperty(
    column_names=["columnNames"],
    data_set_arn="dataSetArn"
)

Attributes

column_names

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topicv2-datasetrelationendpoint.html#cfn-quicksight-topicv2-datasetrelationendpoint-columnnames

Type:: see

data_set_arn

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

Type:: see

DataSetRelationProperty

class CfnTopicV2PropsMixin.DataSetRelationProperty(*, left=None, right=None)

Bases: object

A relation between two datasets referenced by a V2 (SEMANTIC_VIEW) topic.

Parameters:

left (Union[IResolvable, DataSetRelationEndpointProperty, Dict[str, Any], None])
right (Union[IResolvable, DataSetRelationEndpointProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topicv2-datasetrelation.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.cfn_property_mixins import aws_quicksight as quicksight

data_set_relation_property = quicksight.CfnTopicV2PropsMixin.DataSetRelationProperty(
    left=quicksight.CfnTopicV2PropsMixin.DataSetRelationEndpointProperty(
        column_names=["columnNames"],
        data_set_arn="dataSetArn"
    ),
    right=quicksight.CfnTopicV2PropsMixin.DataSetRelationEndpointProperty(
        column_names=["columnNames"],
        data_set_arn="dataSetArn"
    )
)

Attributes

left

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topicv2-datasetrelation.html#cfn-quicksight-topicv2-datasetrelation-left

Type:: see

right

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topicv2-datasetrelation.html#cfn-quicksight-topicv2-datasetrelation-right

Type:: see

ResourcePermissionProperty

class CfnTopicV2PropsMixin.ResourcePermissionProperty(*, actions=None, principal=None)

Bases: object

Parameters:

actions (Optional[Sequence[str]])
principal (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topicv2-resourcepermission.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.cfn_property_mixins import aws_quicksight as quicksight

resource_permission_property = quicksight.CfnTopicV2PropsMixin.ResourcePermissionProperty(
    actions=["actions"],
    principal="principal"
)

Attributes

actions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topicv2-resourcepermission.html#cfn-quicksight-topicv2-resourcepermission-actions

Type:: see

principal

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topicv2-resourcepermission.html#cfn-quicksight-topicv2-resourcepermission-principal

Type:: see