S3SourceProperty Struct
A physical table type for an S3 data source.
| Source | |
|---|---|
| Type last changed |
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 s3SourceProperty: quicksight.CfnDataSet.S3SourceProperty = {
dataSourceArn: 'dataSourceArn',
inputColumns: [{
name: 'name',
type: 'type',
// the properties below are optional
id: 'id',
subType: 'subType',
}],
// the properties below are optional
uploadSettings: {
containsHeader: false,
delimiter: 'delimiter',
format: 'format',
startFromRow: 123,
textQualifier: 'textQualifier',
},
};
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
s3_source_property = quicksight.CfnDataSet.S3SourceProperty(
data_source_arn="dataSourceArn",
input_columns=[quicksight.CfnDataSet.InputColumnProperty(
name="name",
type="type",
# the properties below are optional
id="id",
sub_type="subType"
)],
# the properties below are optional
upload_settings=quicksight.CfnDataSet.UploadSettingsProperty(
contains_header=False,
delimiter="delimiter",
format="format",
start_from_row=123,
text_qualifier="textQualifier"
)
)
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.*;
S3SourceProperty s3SourceProperty = S3SourceProperty.builder()
.dataSourceArn("dataSourceArn")
.inputColumns(List.of(InputColumnProperty.builder()
.name("name")
.type("type")
// the properties below are optional
.id("id")
.subType("subType")
.build()))
// the properties below are optional
.uploadSettings(UploadSettingsProperty.builder()
.containsHeader(false)
.delimiter("delimiter")
.format("format")
.startFromRow(123)
.textQualifier("textQualifier")
.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 s3SourceProperty = new S3SourceProperty {
DataSourceArn = "dataSourceArn",
InputColumns = new [] { new InputColumnProperty {
Name = "name",
Type = "type",
// the properties below are optional
Id = "id",
SubType = "subType"
} },
// the properties below are optional
UploadSettings = new UploadSettingsProperty {
ContainsHeader = false,
Delimiter = "delimiter",
Format = "format",
StartFromRow = 123,
TextQualifier = "textQualifier"
}
};
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"
s3SourceProperty := &S3SourceProperty{
DataSourceArn: jsii.String("dataSourceArn"),
InputColumns: []interface{}{
&InputColumnProperty{
Name: jsii.String("name"),
Type: jsii.String("type"),
// the properties below are optional
Id: jsii.String("id"),
SubType: jsii.String("subType"),
},
},
// the properties below are optional
UploadSettings: &UploadSettingsProperty{
ContainsHeader: jsii.Boolean(false),
Delimiter: jsii.String("delimiter"),
Format: jsii.String("format"),
StartFromRow: jsii.Number(123),
TextQualifier: jsii.String("textQualifier"),
},
}
Properties
dataSourceArnstringdata_source_arnstrdataSourceArnStringDataSourceArnstringDataSourceArn*string required #The Amazon Resource Name (ARN) for the data source.
inputColumnsIResolvable | IResolvable | CfnDataSet.InputColumnProperty[]input_columnstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, InputColumnProperty]]]inputColumnsIResolvableInputColumnsIResolvableInputColumnsinterface{} required #A physical table type for an S3 data source.
For files that aren't JSON, only
STRINGdata types are supported in input columns.
uploadSettingsoptionalIResolvable | CfnDataSet.upload_settingsoptionaltyping.Union[IResolvable, UploadSettingsProperty]uploadSettingsoptionalIResolvableUploadSettingsoptionalIResolvableUploadSettingsoptionalinterface{} #Information about the format for the S3 source file or files.