Package software.amazon.awscdk.cfnpropertymixins.services.quicksight

Interface CfnDataSourcePropsMixin.S3ParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSourcePropsMixin.S3ParametersProperty.Jsii$Proxy

Enclosing class:

CfnDataSourcePropsMixin

@Stability(Stable)
public static interface CfnDataSourcePropsMixin.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.cfnpropertymixins.services.quicksight.*;
 S3ParametersProperty s3ParametersProperty = S3ParametersProperty.builder()
         .manifestFileLocation(ManifestFileLocationProperty.builder()
                 .bucket("bucket")
                 .key("key")
                 .build())
         .roleArn("roleArn")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSourcePropsMixin.S3ParametersProperty.Builder	builder()
default 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)
@Nullable
default Object getManifestFileLocation()

Location of the Amazon S3 manifest file.

This is NULL if the manifest file was uploaded into Quick Sight.

Returns union: either IResolvable or CfnDataSourcePropsMixin.ManifestFileLocationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-s3parameters.html#cfn-quicksight-datasource-s3parameters-manifestfilelocation

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-s3parameters.html#cfn-quicksight-datasource-s3parameters-rolearn

builder

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

Returns:

a CfnDataSourcePropsMixin.S3ParametersProperty.Builder of CfnDataSourcePropsMixin.S3ParametersProperty