@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)", date="2022-08-17T17:31:11.786Z") @Stability(value=Stable) public interface CfnDataSetProps extends software.amazon.jsii.JsiiSerializable
Example:
// 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.*;
CfnDataSetProps cfnDataSetProps = CfnDataSetProps.builder()
.awsAccountId("awsAccountId")
.columnGroups(List.of(ColumnGroupProperty.builder()
.geoSpatialColumnGroup(GeoSpatialColumnGroupProperty.builder()
.columns(List.of("columns"))
.name("name")
// the properties below are optional
.countryCode("countryCode")
.build())
.build()))
.columnLevelPermissionRules(List.of(ColumnLevelPermissionRuleProperty.builder()
.columnNames(List.of("columnNames"))
.principals(List.of("principals"))
.build()))
.dataSetId("dataSetId")
.dataSetUsageConfiguration(DataSetUsageConfigurationProperty.builder()
.disableUseAsDirectQuerySource(false)
.disableUseAsImportedSource(false)
.build())
.fieldFolders(Map.of(
"fieldFoldersKey", FieldFolderProperty.builder()
.columns(List.of("columns"))
.description("description")
.build()))
.importMode("importMode")
.ingestionWaitPolicy(IngestionWaitPolicyProperty.builder()
.ingestionWaitTimeInHours(123)
.waitForSpiceIngestion(false)
.build())
.logicalTableMap(Map.of(
"logicalTableMapKey", LogicalTableProperty.builder()
.alias("alias")
.source(LogicalTableSourceProperty.builder()
.dataSetArn("dataSetArn")
.joinInstruction(JoinInstructionProperty.builder()
.leftOperand("leftOperand")
.onClause("onClause")
.rightOperand("rightOperand")
.type("type")
// the properties below are optional
.leftJoinKeyProperties(JoinKeyPropertiesProperty.builder()
.uniqueKey(false)
.build())
.rightJoinKeyProperties(JoinKeyPropertiesProperty.builder()
.uniqueKey(false)
.build())
.build())
.physicalTableId("physicalTableId")
.build())
// the properties below are optional
.dataTransforms(List.of(TransformOperationProperty.builder()
.castColumnTypeOperation(CastColumnTypeOperationProperty.builder()
.columnName("columnName")
.newColumnType("newColumnType")
// the properties below are optional
.format("format")
.build())
.createColumnsOperation(CreateColumnsOperationProperty.builder()
.columns(List.of(CalculatedColumnProperty.builder()
.columnId("columnId")
.columnName("columnName")
.expression("expression")
.build()))
.build())
.filterOperation(FilterOperationProperty.builder()
.conditionExpression("conditionExpression")
.build())
.projectOperation(ProjectOperationProperty.builder()
.projectedColumns(List.of("projectedColumns"))
.build())
.renameColumnOperation(RenameColumnOperationProperty.builder()
.columnName("columnName")
.newColumnName("newColumnName")
.build())
.tagColumnOperation(TagColumnOperationProperty.builder()
.columnName("columnName")
.tags(List.of(ColumnTagProperty.builder()
.columnDescription(ColumnDescriptionProperty.builder()
.text("text")
.build())
.columnGeographicRole("columnGeographicRole")
.build()))
.build())
.build()))
.build()))
.name("name")
.permissions(List.of(ResourcePermissionProperty.builder()
.actions(List.of("actions"))
.principal("principal")
.build()))
.physicalTableMap(Map.of(
"physicalTableMapKey", PhysicalTableProperty.builder()
.customSql(CustomSqlProperty.builder()
.columns(List.of(InputColumnProperty.builder()
.name("name")
.type("type")
.build()))
.dataSourceArn("dataSourceArn")
.name("name")
.sqlQuery("sqlQuery")
.build())
.relationalTable(RelationalTableProperty.builder()
.dataSourceArn("dataSourceArn")
.inputColumns(List.of(InputColumnProperty.builder()
.name("name")
.type("type")
.build()))
.name("name")
// the properties below are optional
.catalog("catalog")
.schema("schema")
.build())
.s3Source(S3SourceProperty.builder()
.dataSourceArn("dataSourceArn")
.inputColumns(List.of(InputColumnProperty.builder()
.name("name")
.type("type")
.build()))
// the properties below are optional
.uploadSettings(UploadSettingsProperty.builder()
.containsHeader(false)
.delimiter("delimiter")
.format("format")
.startFromRow(123)
.textQualifier("textQualifier")
.build())
.build())
.build()))
.rowLevelPermissionDataSet(RowLevelPermissionDataSetProperty.builder()
.arn("arn")
.permissionPolicy("permissionPolicy")
// the properties below are optional
.formatVersion("formatVersion")
.namespace("namespace")
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnDataSetProps.Builder
A builder for
CfnDataSetProps |
static class |
CfnDataSetProps.Jsii$Proxy
An implementation for
CfnDataSetProps |
| Modifier and Type | Method and Description |
|---|---|
static CfnDataSetProps.Builder |
builder() |
default String |
getAwsAccountId()
The AWS account ID.
|
default Object |
getColumnGroups()
Groupings of columns that work together in certain Amazon QuickSight features.
|
default Object |
getColumnLevelPermissionRules()
A set of one or more definitions of a `ColumnLevelPermissionRule` .
|
default String |
getDataSetId()
An ID for the dataset that you want to create.
|
default Object |
getDataSetUsageConfiguration()
`AWS::QuickSight::DataSet.DataSetUsageConfiguration`.
|
default Object |
getFieldFolders()
The folder that contains fields and nested subfolders for your dataset.
|
default String |
getImportMode()
Indicates whether you want to import the data into SPICE.
|
default Object |
getIngestionWaitPolicy()
The wait policy to use when creating or updating a Dataset.
|
default Object |
getLogicalTableMap()
Configures the combination and transformation of the data from the physical tables.
|
default String |
getName()
The display name for the dataset.
|
default Object |
getPermissions()
A list of resource permissions on the dataset.
|
default Object |
getPhysicalTableMap()
Declares the physical tables that are available in the underlying data sources.
|
default Object |
getRowLevelPermissionDataSet()
The row-level security configuration for the data that you want to create.
|
default List<CfnTag> |
getTags()
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
|
@Stability(value=Stable) @Nullable default String getAwsAccountId()
@Stability(value=Stable) @Nullable default Object getColumnGroups()
Currently, only geospatial hierarchy is supported.
@Stability(value=Stable) @Nullable default Object getColumnLevelPermissionRules()
@Stability(value=Stable) @Nullable default String getDataSetId()
This ID is unique per AWS Region for each AWS account.
@Stability(value=Stable) @Nullable default Object getDataSetUsageConfiguration()
@Stability(value=Stable) @Nullable default Object getFieldFolders()
@Stability(value=Stable) @Nullable default String getImportMode()
@Stability(value=Stable) @Nullable default Object getIngestionWaitPolicy()
The default is to wait for SPICE ingestion to finish with timeout of 36 hours.
@Stability(value=Stable) @Nullable default Object getLogicalTableMap()
@Stability(value=Stable) @Nullable default String getName()
@Stability(value=Stable) @Nullable default Object getPermissions()
@Stability(value=Stable) @Nullable default Object getPhysicalTableMap()
@Stability(value=Stable) @Nullable default Object getRowLevelPermissionDataSet()
@Stability(value=Stable) @Nullable default List<CfnTag> getTags()
@Stability(value=Stable) static CfnDataSetProps.Builder builder()
CfnDataSetProps.Builder of CfnDataSetPropsCopyright © 2022. All rights reserved.