Package software.amazon.awscdk.services.quicksight

Interface CfnDataSet.S3SourceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSet.S3SourceProperty.Jsii$Proxy

Enclosing class:

CfnDataSet

@Stability(Stable)
public static interface CfnDataSet.S3SourceProperty
extends software.amazon.jsii.JsiiSerializable

A physical table type for an S3 data 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.*;
 S3SourceProperty s3SourceProperty = S3SourceProperty.builder()
         .dataSourceArn("dataSourceArn")
         // the properties below are optional
         .inputColumns(List.of(InputColumnProperty.builder()
                 .name("name")
                 .type("type")
                 // the properties below are optional
                 .subType("subType")
                 .build()))
         .uploadSettings(UploadSettingsProperty.builder()
                 .containsHeader(false)
                 .delimiter("delimiter")
                 .format("format")
                 .startFromRow(123)
                 .textQualifier("textQualifier")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-s3source.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSet.S3SourceProperty.Builder	A builder for CfnDataSet.S3SourceProperty
static final class	CfnDataSet.S3SourceProperty.Jsii$Proxy	An implementation for CfnDataSet.S3SourceProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSet.S3SourceProperty.Builder	builder()
String	getDataSourceArn()	The Amazon Resource Name (ARN) for the data source.
default Object	getInputColumns()	A physical table type for an S3 data source.
default Object	getUploadSettings()	Information about the format for the S3 source file or files.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataSourceArn

@Stability(Stable)
@NotNull
String getDataSourceArn()

The Amazon Resource Name (ARN) for the data source.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-s3source.html#cfn-quicksight-dataset-s3source-datasourcearn

getInputColumns

@Stability(Stable)
@Nullable
default Object getInputColumns()

A physical table type for an S3 data source.

For files that aren't JSON, only STRING data types are supported in input columns.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSet.InputColumnProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-s3source.html#cfn-quicksight-dataset-s3source-inputcolumns

getUploadSettings

@Stability(Stable)
@Nullable
default Object getUploadSettings()

Information about the format for the S3 source file or files.

Returns union: either IResolvable or CfnDataSet.UploadSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-s3source.html#cfn-quicksight-dataset-s3source-uploadsettings

builder

@Stability(Stable)
static CfnDataSet.S3SourceProperty.Builder builder()

Returns:

a CfnDataSet.S3SourceProperty.Builder of CfnDataSet.S3SourceProperty