aws-cdk-lib.aws_quicksight.CfnDataSource.S3ParametersProperty

S3ParametersProperty Struct

The parameters for S3.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const s3ParametersProperty: quicksight.CfnDataSource.S3ParametersProperty = {
  manifestFileLocation: {
    bucket: 'bucket',
    key: 'key',
  },

  // the properties below are optional
  roleArn: 'roleArn',
};

Properties

manifestFileLocationIResolvable | CfnDataSource.ManifestFileLocationPropertymanifest_file_locationtyping.Union[IResolvable, ManifestFileLocationProperty]manifestFileLocationIResolvableManifestFileLocationIResolvableManifestFileLocationinterface{}required#

Location of the Amazon S3 manifest file.

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

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*string#

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

notes

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.