Skip to content
v2.278.0

ImportSourceSpecificationProperty Struct ​

Specifies the properties of data being imported from the S3 bucket source to the table.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dynamodb as dynamodb } from 'aws-cdk-lib';
const importSourceSpecificationProperty: dynamodb.CfnTable.ImportSourceSpecificationProperty = {
  inputFormat: 'inputFormat',
  s3BucketSource: {
    s3Bucket: 's3Bucket',

    // the properties below are optional
    s3BucketOwner: 's3BucketOwner',
    s3KeyPrefix: 's3KeyPrefix',
  },

  // the properties below are optional
  inputCompressionType: 'inputCompressionType',
  inputFormatOptions: {
    csv: {
      delimiter: 'delimiter',
      headerList: ['headerList'],
    },
  },
};
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_dynamodb as dynamodb

import_source_specification_property = dynamodb.CfnTable.ImportSourceSpecificationProperty(
    input_format="inputFormat",
    s3_bucket_source=dynamodb.CfnTable.S3BucketSourceProperty(
        s3_bucket="s3Bucket",

        # the properties below are optional
        s3_bucket_owner="s3BucketOwner",
        s3_key_prefix="s3KeyPrefix"
    ),

    # the properties below are optional
    input_compression_type="inputCompressionType",
    input_format_options=dynamodb.CfnTable.InputFormatOptionsProperty(
        csv=dynamodb.CfnTable.CsvProperty(
            delimiter="delimiter",
            header_list=["headerList"]
        )
    )
)
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.dynamodb.*;

ImportSourceSpecificationProperty importSourceSpecificationProperty = ImportSourceSpecificationProperty.builder()
        .inputFormat("inputFormat")
        .s3BucketSource(S3BucketSourceProperty.builder()
                .s3Bucket("s3Bucket")

                // the properties below are optional
                .s3BucketOwner("s3BucketOwner")
                .s3KeyPrefix("s3KeyPrefix")
                .build())

        // the properties below are optional
        .inputCompressionType("inputCompressionType")
        .inputFormatOptions(InputFormatOptionsProperty.builder()
                .csv(CsvProperty.builder()
                        .delimiter("delimiter")
                        .headerList(List.of("headerList"))
                        .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.DynamoDB;

var importSourceSpecificationProperty = new ImportSourceSpecificationProperty {
    InputFormat = "inputFormat",
    S3BucketSource = new S3BucketSourceProperty {
        S3Bucket = "s3Bucket",

        // the properties below are optional
        S3BucketOwner = "s3BucketOwner",
        S3KeyPrefix = "s3KeyPrefix"
    },

    // the properties below are optional
    InputCompressionType = "inputCompressionType",
    InputFormatOptions = new InputFormatOptionsProperty {
        Csv = new CsvProperty {
            Delimiter = "delimiter",
            HeaderList = new [] { "headerList" }
        }
    }
};
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"

importSourceSpecificationProperty := &ImportSourceSpecificationProperty{
	InputFormat: jsii.String("inputFormat"),
	S3BucketSource: &S3BucketSourceProperty{
		S3Bucket: jsii.String("s3Bucket"),

		// the properties below are optional
		S3BucketOwner: jsii.String("s3BucketOwner"),
		S3KeyPrefix: jsii.String("s3KeyPrefix"),
	},

	// the properties below are optional
	InputCompressionType: jsii.String("inputCompressionType"),
	InputFormatOptions: &InputFormatOptionsProperty{
		Csv: &CsvProperty{
			Delimiter: jsii.String("delimiter"),
			HeaderList: []*string{
				jsii.String("headerList"),
			},
		},
	},
}

Properties ​

inputCompressionTypeoptionalstringinput_compression_typeoptionalstrinputCompressionTypeoptionalStringInputCompressionTypeoptionalstringInputCompressionTypeoptional*string #
Type of compression to be used on the input coming from the imported table.
inputFormatstringinput_formatstrinputFormatStringInputFormatstringInputFormat*string required #
The format of the source data.

Valid values for ImportFormat are CSV , DYNAMODB_JSON or ION .

inputFormatOptionsoptionalIResolvable | CfnTable.InputFormatOptionsPropertyinput_format_optionsoptionaltyping.Union[IResolvable, InputFormatOptionsProperty]inputFormatOptionsoptionalIResolvableInputFormatOptionsoptionalIResolvableInputFormatOptionsoptionalinterface{} #
Additional properties that specify how the input is formatted,.
s3BucketSourceIResolvable | CfnTable.S3BucketSourcePropertys3_bucket_sourcetyping.Union[IResolvable, S3BucketSourceProperty]s3BucketSourceIResolvableS3BucketSourceIResolvableS3BucketSourceinterface{} required #
The S3 bucket that provides the source for the import.