Package software.amazon.awscdk.services.quicksight

Interface CfnDataSource.S3ParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.S3ParametersProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(Stable)
public static interface CfnDataSource.S3ParametersProperty
extends software.amazon.jsii.JsiiSerializable

The parameters for S3.

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.*;
 S3ParametersProperty s3ParametersProperty = S3ParametersProperty.builder()
         .manifestFileLocation(ManifestFileLocationProperty.builder()
                 .bucket("bucket")
                 .key("key")
                 .build())
         // the properties below are optional
         .roleArn("roleArn")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.S3ParametersProperty.Builder	builder()
Object	getManifestFileLocation()	Location of the Amazon S3 manifest file.
default String	getRoleArn()	Use the RoleArn structure to override an account-wide role for a specific S3 data source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getManifestFileLocation

@Stability(Stable)
@NotNull
Object getManifestFileLocation()

Location of the Amazon S3 manifest file.

This is NULL if the manifest file was uploaded into Amazon QuickSight.

getRoleArn

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

Use the RoleArn structure to override an account-wide role for a specific S3 data source.

For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

builder

@Stability(Stable)
static CfnDataSource.S3ParametersProperty.Builder builder()

Returns:

a CfnDataSource.S3ParametersProperty.Builder of CfnDataSource.S3ParametersProperty