@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:27:52.412Z") public class CfnDataSet extends CfnResource implements IInspectable
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
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.*; CfnDataSet cfnDataSet = CfnDataSet.Builder.create(this, "MyCfnDataSet") .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") .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() .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 | Class and Description |
---|---|
static class |
CfnDataSet.Builder
A fluent builder for
CfnDataSet . |
static interface |
CfnDataSet.CalculatedColumnProperty
A calculated column for a dataset.
|
static interface |
CfnDataSet.CastColumnTypeOperationProperty
A transform operation that casts a column to a different type.
|
static interface |
CfnDataSet.ColumnDescriptionProperty
Metadata that contains a description for a column.
|
static interface |
CfnDataSet.ColumnGroupProperty
Groupings of columns that work together in certain Amazon QuickSight features.
|
static interface |
CfnDataSet.ColumnLevelPermissionRuleProperty
A rule defined to grant access on one or more restricted columns.
|
static interface |
CfnDataSet.ColumnTagProperty
A tag for a column in a `[TagColumnOperation](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TagColumnOperation.html)` structure.
|
static interface |
CfnDataSet.CreateColumnsOperationProperty
A transform operation that creates calculated columns.
|
static interface |
CfnDataSet.CustomSqlProperty
A physical table type built from the results of the custom SQL query.
|
static interface |
CfnDataSet.FieldFolderProperty
A FieldFolder element is a folder that contains fields and nested subfolders.
|
static interface |
CfnDataSet.FilterOperationProperty
A transform operation that filters rows based on a condition.
|
static interface |
CfnDataSet.GeoSpatialColumnGroupProperty
Geospatial column group that denotes a hierarchy.
|
static interface |
CfnDataSet.IngestionWaitPolicyProperty
The wait policy to use when creating or updating a Dataset.
|
static interface |
CfnDataSet.InputColumnProperty
Metadata for a column that is used as the input of a transform operation.
|
static interface |
CfnDataSet.JoinInstructionProperty
The instructions associated with a join.
|
static interface |
CfnDataSet.JoinKeyPropertiesProperty
Properties associated with the columns participating in a join.
|
static interface |
CfnDataSet.LogicalTableProperty
A *logical table* is a unit that joins and that data transformations operate on.
|
static interface |
CfnDataSet.LogicalTableSourceProperty
Information about the source of a logical table.
|
static interface |
CfnDataSet.OutputColumnProperty
Output column.
|
static interface |
CfnDataSet.PhysicalTableProperty
A view of a data source that contains information about the shape of the data in the underlying source.
|
static interface |
CfnDataSet.ProjectOperationProperty
A transform operation that projects columns.
|
static interface |
CfnDataSet.RelationalTableProperty
A physical table type for relational data sources.
|
static interface |
CfnDataSet.RenameColumnOperationProperty
A transform operation that renames a column.
|
static interface |
CfnDataSet.ResourcePermissionProperty
Permission for the resource.
|
static interface |
CfnDataSet.RowLevelPermissionDataSetProperty
Information about a dataset that contains permissions for row-level security (RLS).
|
static interface |
CfnDataSet.S3SourceProperty
A physical table type for an S3 data source.
|
static interface |
CfnDataSet.TagColumnOperationProperty
A transform operation that tags a column with additional information.
|
static interface |
CfnDataSet.TransformOperationProperty
A data transformation on a logical table.
|
static interface |
CfnDataSet.UploadSettingsProperty
Information about the format for a source file or files.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnDataSet(Construct scope,
java.lang.String id)
Create a new `AWS::QuickSight::DataSet`.
|
|
CfnDataSet(Construct scope,
java.lang.String id,
CfnDataSetProps props)
Create a new `AWS::QuickSight::DataSet`.
|
protected |
CfnDataSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnDataSet(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
The Amazon Resource Name (ARN) of the dataset.
|
IResolvable |
getAttrConsumedSpiceCapacityInBytes() |
java.lang.String |
getAttrCreatedTime()
The time this dataset version was created.
|
java.lang.String |
getAttrLastUpdatedTime()
The time this dataset version was last updated.
|
IResolvable |
getAttrOutputColumns() |
java.lang.String |
getAwsAccountId()
The AWS account ID.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getColumnGroups()
Groupings of columns that work together in certain Amazon QuickSight features.
|
java.lang.Object |
getColumnLevelPermissionRules()
A set of one or more definitions of a `ColumnLevelPermissionRule` .
|
java.lang.String |
getDataSetId()
An ID for the dataset that you want to create.
|
java.lang.Object |
getFieldFolders()
The folder that contains fields and nested subfolders for your dataset.
|
java.lang.String |
getImportMode()
Indicates whether you want to import the data into SPICE.
|
java.lang.Object |
getIngestionWaitPolicy()
The wait policy to use when creating or updating a Dataset.
|
java.lang.Object |
getLogicalTableMap()
Configures the combination and transformation of the data from the physical tables.
|
java.lang.String |
getName()
The display name for the dataset.
|
java.lang.Object |
getPermissions()
A list of resource permissions on the dataset.
|
java.lang.Object |
getPhysicalTableMap()
Declares the physical tables that are available in the underlying data sources.
|
java.lang.Object |
getRowLevelPermissionDataSet()
The row-level security configuration for the data that you want to create.
|
TagManager |
getTags()
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAwsAccountId(java.lang.String value)
The AWS account ID.
|
void |
setColumnGroups(IResolvable value)
Groupings of columns that work together in certain Amazon QuickSight features.
|
void |
setColumnGroups(java.util.List<java.lang.Object> value)
Groupings of columns that work together in certain Amazon QuickSight features.
|
void |
setColumnLevelPermissionRules(IResolvable value)
A set of one or more definitions of a `ColumnLevelPermissionRule` .
|
void |
setColumnLevelPermissionRules(java.util.List<java.lang.Object> value)
A set of one or more definitions of a `ColumnLevelPermissionRule` .
|
void |
setDataSetId(java.lang.String value)
An ID for the dataset that you want to create.
|
void |
setFieldFolders(IResolvable value)
The folder that contains fields and nested subfolders for your dataset.
|
void |
setFieldFolders(java.util.Map<java.lang.String,java.lang.Object> value)
The folder that contains fields and nested subfolders for your dataset.
|
void |
setImportMode(java.lang.String value)
Indicates whether you want to import the data into SPICE.
|
void |
setIngestionWaitPolicy(CfnDataSet.IngestionWaitPolicyProperty value)
The wait policy to use when creating or updating a Dataset.
|
void |
setIngestionWaitPolicy(IResolvable value)
The wait policy to use when creating or updating a Dataset.
|
void |
setLogicalTableMap(IResolvable value)
Configures the combination and transformation of the data from the physical tables.
|
void |
setLogicalTableMap(java.util.Map<java.lang.String,java.lang.Object> value)
Configures the combination and transformation of the data from the physical tables.
|
void |
setName(java.lang.String value)
The display name for the dataset.
|
void |
setPermissions(IResolvable value)
A list of resource permissions on the dataset.
|
void |
setPermissions(java.util.List<java.lang.Object> value)
A list of resource permissions on the dataset.
|
void |
setPhysicalTableMap(IResolvable value)
Declares the physical tables that are available in the underlying data sources.
|
void |
setPhysicalTableMap(java.util.Map<java.lang.String,java.lang.Object> value)
Declares the physical tables that are available in the underlying data sources.
|
void |
setRowLevelPermissionDataSet(CfnDataSet.RowLevelPermissionDataSetProperty value)
The row-level security configuration for the data that you want to create.
|
void |
setRowLevelPermissionDataSet(IResolvable value)
The row-level security configuration for the data that you want to create.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnDataSet(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDataSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDataSet(Construct scope, java.lang.String id, CfnDataSetProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties.public CfnDataSet(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public IResolvable getAttrConsumedSpiceCapacityInBytes()
public java.lang.String getAttrCreatedTime()
public java.lang.String getAttrLastUpdatedTime()
public IResolvable getAttrOutputColumns()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getAwsAccountId()
public void setAwsAccountId(java.lang.String value)
public java.lang.Object getColumnGroups()
Currently, only geospatial hierarchy is supported.
public void setColumnGroups(IResolvable value)
Currently, only geospatial hierarchy is supported.
public void setColumnGroups(java.util.List<java.lang.Object> value)
Currently, only geospatial hierarchy is supported.
public java.lang.Object getColumnLevelPermissionRules()
public void setColumnLevelPermissionRules(IResolvable value)
public void setColumnLevelPermissionRules(java.util.List<java.lang.Object> value)
public java.lang.String getDataSetId()
This ID is unique per AWS Region for each AWS account.
public void setDataSetId(java.lang.String value)
This ID is unique per AWS Region for each AWS account.
public java.lang.Object getFieldFolders()
public void setFieldFolders(IResolvable value)
public void setFieldFolders(java.util.Map<java.lang.String,java.lang.Object> value)
public java.lang.String getImportMode()
public void setImportMode(java.lang.String value)
public java.lang.Object getIngestionWaitPolicy()
The default is to wait for SPICE ingestion to finish with timeout of 36 hours.
public void setIngestionWaitPolicy(IResolvable value)
The default is to wait for SPICE ingestion to finish with timeout of 36 hours.
public void setIngestionWaitPolicy(CfnDataSet.IngestionWaitPolicyProperty value)
The default is to wait for SPICE ingestion to finish with timeout of 36 hours.
public java.lang.Object getLogicalTableMap()
public void setLogicalTableMap(IResolvable value)
public void setLogicalTableMap(java.util.Map<java.lang.String,java.lang.Object> value)
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.Object getPermissions()
public void setPermissions(IResolvable value)
public void setPermissions(java.util.List<java.lang.Object> value)
public java.lang.Object getPhysicalTableMap()
public void setPhysicalTableMap(IResolvable value)
public void setPhysicalTableMap(java.util.Map<java.lang.String,java.lang.Object> value)
public java.lang.Object getRowLevelPermissionDataSet()
public void setRowLevelPermissionDataSet(IResolvable value)
public void setRowLevelPermissionDataSet(CfnDataSet.RowLevelPermissionDataSetProperty value)