Package software.amazon.awscdk.cfnpropertymixins.services.kendra

Interface CfnDataSourcePropsMixin.S3PathProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSourcePropsMixin.S3PathProperty.Jsii$Proxy

Enclosing class:

CfnDataSourcePropsMixin

@Stability(Stable)
public static interface CfnDataSourcePropsMixin.S3PathProperty
extends software.amazon.jsii.JsiiSerializable

Information required to find a specific file in an Amazon S3 bucket.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.kendra.*;
 S3PathProperty s3PathProperty = S3PathProperty.builder()
         .bucket("bucket")
         .key("key")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3path.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSourcePropsMixin.S3PathProperty.Builder	builder()
default Object	getBucket()	The name of the S3 bucket that contains the file.
default String	getKey()	The name of the file.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

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

The name of the S3 bucket that contains the file.

Returns union: either String or IBucketRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3path.html#cfn-kendra-datasource-s3path-bucket

getKey

@Stability(Stable)
@Nullable
default String getKey()

The name of the file.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3path.html#cfn-kendra-datasource-s3path-key

builder

@Stability(Stable)
static CfnDataSourcePropsMixin.S3PathProperty.Builder builder()

Returns:

a CfnDataSourcePropsMixin.S3PathProperty.Builder of CfnDataSourcePropsMixin.S3PathProperty