Skip to content
v2.277.0

JoinOperationProperty Struct ​

A transform operation that combines data from two sources based on specified join conditions.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const joinOperationProperty: quicksight.CfnDataSet.JoinOperationProperty = {
  alias: 'alias',
  leftOperand: {
    transformOperationId: 'transformOperationId',

    // the properties below are optional
    columnIdMappings: [{
      sourceColumnId: 'sourceColumnId',
      targetColumnId: 'targetColumnId',
    }],
  },
  onClause: 'onClause',
  rightOperand: {
    transformOperationId: 'transformOperationId',

    // the properties below are optional
    columnIdMappings: [{
      sourceColumnId: 'sourceColumnId',
      targetColumnId: 'targetColumnId',
    }],
  },
  type: 'type',

  // the properties below are optional
  leftOperandProperties: {
    outputColumnNameOverrides: [{
      outputColumnName: 'outputColumnName',

      // the properties below are optional
      sourceColumnName: 'sourceColumnName',
    }],
  },
  rightOperandProperties: {
    outputColumnNameOverrides: [{
      outputColumnName: 'outputColumnName',

      // the properties below are optional
      sourceColumnName: 'sourceColumnName',
    }],
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

join_operation_property = quicksight.CfnDataSet.JoinOperationProperty(
    alias="alias",
    left_operand=quicksight.CfnDataSet.TransformOperationSourceProperty(
        transform_operation_id="transformOperationId",

        # the properties below are optional
        column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
            source_column_id="sourceColumnId",
            target_column_id="targetColumnId"
        )]
    ),
    on_clause="onClause",
    right_operand=quicksight.CfnDataSet.TransformOperationSourceProperty(
        transform_operation_id="transformOperationId",

        # the properties below are optional
        column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
            source_column_id="sourceColumnId",
            target_column_id="targetColumnId"
        )]
    ),
    type="type",

    # the properties below are optional
    left_operand_properties=quicksight.CfnDataSet.JoinOperandPropertiesProperty(
        output_column_name_overrides=[quicksight.CfnDataSet.OutputColumnNameOverrideProperty(
            output_column_name="outputColumnName",

            # the properties below are optional
            source_column_name="sourceColumnName"
        )]
    ),
    right_operand_properties=quicksight.CfnDataSet.JoinOperandPropertiesProperty(
        output_column_name_overrides=[quicksight.CfnDataSet.OutputColumnNameOverrideProperty(
            output_column_name="outputColumnName",

            # the properties below are optional
            source_column_name="sourceColumnName"
        )]
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;

JoinOperationProperty joinOperationProperty = JoinOperationProperty.builder()
        .alias("alias")
        .leftOperand(TransformOperationSourceProperty.builder()
                .transformOperationId("transformOperationId")

                // the properties below are optional
                .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                        .sourceColumnId("sourceColumnId")
                        .targetColumnId("targetColumnId")
                        .build()))
                .build())
        .onClause("onClause")
        .rightOperand(TransformOperationSourceProperty.builder()
                .transformOperationId("transformOperationId")

                // the properties below are optional
                .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                        .sourceColumnId("sourceColumnId")
                        .targetColumnId("targetColumnId")
                        .build()))
                .build())
        .type("type")

        // the properties below are optional
        .leftOperandProperties(JoinOperandPropertiesProperty.builder()
                .outputColumnNameOverrides(List.of(OutputColumnNameOverrideProperty.builder()
                        .outputColumnName("outputColumnName")

                        // the properties below are optional
                        .sourceColumnName("sourceColumnName")
                        .build()))
                .build())
        .rightOperandProperties(JoinOperandPropertiesProperty.builder()
                .outputColumnNameOverrides(List.of(OutputColumnNameOverrideProperty.builder()
                        .outputColumnName("outputColumnName")

                        // the properties below are optional
                        .sourceColumnName("sourceColumnName")
                        .build()))
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var joinOperationProperty = new JoinOperationProperty {
    Alias = "alias",
    LeftOperand = new TransformOperationSourceProperty {
        TransformOperationId = "transformOperationId",

        // the properties below are optional
        ColumnIdMappings = new [] { new DataSetColumnIdMappingProperty {
            SourceColumnId = "sourceColumnId",
            TargetColumnId = "targetColumnId"
        } }
    },
    OnClause = "onClause",
    RightOperand = new TransformOperationSourceProperty {
        TransformOperationId = "transformOperationId",

        // the properties below are optional
        ColumnIdMappings = new [] { new DataSetColumnIdMappingProperty {
            SourceColumnId = "sourceColumnId",
            TargetColumnId = "targetColumnId"
        } }
    },
    Type = "type",

    // the properties below are optional
    LeftOperandProperties = new JoinOperandPropertiesProperty {
        OutputColumnNameOverrides = new [] { new OutputColumnNameOverrideProperty {
            OutputColumnName = "outputColumnName",

            // the properties below are optional
            SourceColumnName = "sourceColumnName"
        } }
    },
    RightOperandProperties = new JoinOperandPropertiesProperty {
        OutputColumnNameOverrides = new [] { new OutputColumnNameOverrideProperty {
            OutputColumnName = "outputColumnName",

            // the properties below are optional
            SourceColumnName = "sourceColumnName"
        } }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

joinOperationProperty := &JoinOperationProperty{
	Alias: jsii.String("alias"),
	LeftOperand: &TransformOperationSourceProperty{
		TransformOperationId: jsii.String("transformOperationId"),

		// the properties below are optional
		ColumnIdMappings: []interface{}{
			&DataSetColumnIdMappingProperty{
				SourceColumnId: jsii.String("sourceColumnId"),
				TargetColumnId: jsii.String("targetColumnId"),
			},
		},
	},
	OnClause: jsii.String("onClause"),
	RightOperand: &TransformOperationSourceProperty{
		TransformOperationId: jsii.String("transformOperationId"),

		// the properties below are optional
		ColumnIdMappings: []interface{}{
			&DataSetColumnIdMappingProperty{
				SourceColumnId: jsii.String("sourceColumnId"),
				TargetColumnId: jsii.String("targetColumnId"),
			},
		},
	},
	Type: jsii.String("type"),

	// the properties below are optional
	LeftOperandProperties: &JoinOperandPropertiesProperty{
		OutputColumnNameOverrides: []interface{}{
			&OutputColumnNameOverrideProperty{
				OutputColumnName: jsii.String("outputColumnName"),

				// the properties below are optional
				SourceColumnName: jsii.String("sourceColumnName"),
			},
		},
	},
	RightOperandProperties: &JoinOperandPropertiesProperty{
		OutputColumnNameOverrides: []interface{}{
			&OutputColumnNameOverrideProperty{
				OutputColumnName: jsii.String("outputColumnName"),

				// the properties below are optional
				SourceColumnName: jsii.String("sourceColumnName"),
			},
		},
	},
}

Properties ​

aliasstringaliasstraliasStringAliasstringAlias*stringrequired#
Alias for this operation.
leftOperandIResolvable | CfnDataSet.TransformOperationSourcePropertyleft_operandtyping.Union[IResolvable, TransformOperationSourceProperty]leftOperandIResolvableLeftOperandIResolvableLeftOperandinterface{}required#
The left operand for the join operation.
leftOperandPropertiesoptionalIResolvable | CfnDataSet.JoinOperandPropertiesPropertyleft_operand_propertiesoptionaltyping.Union[IResolvable, JoinOperandPropertiesProperty]leftOperandPropertiesoptionalIResolvableLeftOperandPropertiesoptionalIResolvableLeftOperandPropertiesoptionalinterface{}#
Properties that control how the left operand's columns are handled in the join result.
onClausestringon_clausestronClauseStringOnClausestringOnClause*stringrequired#
The join condition that specifies how to match rows between the left and right operands.
rightOperandIResolvable | CfnDataSet.TransformOperationSourcePropertyright_operandtyping.Union[IResolvable, TransformOperationSourceProperty]rightOperandIResolvableRightOperandIResolvableRightOperandinterface{}required#
The right operand for the join operation.
rightOperandPropertiesoptionalIResolvable | CfnDataSet.JoinOperandPropertiesPropertyright_operand_propertiesoptionaltyping.Union[IResolvable, JoinOperandPropertiesProperty]rightOperandPropertiesoptionalIResolvableRightOperandPropertiesoptionalIResolvableRightOperandPropertiesoptionalinterface{}#
Properties that control how the right operand's columns are handled in the join result.
typestringtypestrtypeStringTypestringType*stringrequired#
The type of join to perform, such as `INNER` , `LEFT` , `RIGHT` , or `OUTER` .