Package software.amazon.awscdk.services.qbusiness

Interface CfnPlugin.S3Property

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPlugin.S3Property.Jsii$Proxy

Enclosing class:

CfnPlugin

@Stability(Stable)
public static interface CfnPlugin.S3Property
extends software.amazon.jsii.JsiiSerializable

Information required for Amazon Q Business 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.services.qbusiness.*;
 S3Property s3Property = S3Property.builder()
         .bucket("bucket")
         .key("key")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-s3.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPlugin.S3Property.Builder	builder()
String	getBucket()	The name of the S3 bucket that contains the file.
String	getKey()	The name of the file.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

@Stability(Stable)
@NotNull
String getBucket()

The name of the S3 bucket that contains the file.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-s3.html#cfn-qbusiness-plugin-s3-bucket

getKey

@Stability(Stable)
@NotNull
String getKey()

The name of the file.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-s3.html#cfn-qbusiness-plugin-s3-key

builder

@Stability(Stable)
static CfnPlugin.S3Property.Builder builder()

Returns:

a CfnPlugin.S3Property.Builder of CfnPlugin.S3Property