Class: AWSCDK::QuickSight::CfnDataSource::S3ParametersProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnDataSource::S3ParametersProperty

Defined in:

quick_sight/cfn_data_source.rb

Overview

The parameters for S3.

See Also:

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

Instance Attribute Summary

• #manifest_file_location ⇒ AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDataSource::ManifestFileLocationProperty readonly

  Location of the Amazon S3 manifest file.

• #role_arn ⇒ String^? readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(manifest_file_location:, role_arn: nil) ⇒ S3ParametersProperty constructor

  A new instance of S3ParametersProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(manifest_file_location:, role_arn: nil) ⇒ S3ParametersProperty

Returns a new instance of S3ParametersProperty.

Parameters:

• manifest_file_location (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDataSource::ManifestFileLocationProperty) —

  Location of the Amazon S3 manifest file.

• role_arn (String, nil) (defaults to: nil) —

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

# File 'quick_sight/cfn_data_source.rb', line 2133

def initialize(manifest_file_location:, role_arn: nil)
  @manifest_file_location = manifest_file_location.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSource::ManifestFileLocationProperty.new(**manifest_file_location.transform_keys(&:to_sym)) : manifest_file_location
  Jsii::Type.check_type(@manifest_file_location, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTb3VyY2UuTWFuaWZlc3RGaWxlTG9jYXRpb25Qcm9wZXJ0eSJ9XX19")), "manifestFileLocation")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.nil?
end

Instance Attribute Details

#manifest_file_location ⇒ AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDataSource::ManifestFileLocationProperty (readonly)

Location of the Amazon S3 manifest file.

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

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDataSource::ManifestFileLocationProperty)

See Also:

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

# File 'quick_sight/cfn_data_source.rb', line 2146

def manifest_file_location
  @manifest_file_location
end

#role_arn ⇒ String^? (readonly)

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.

Returns:

• (String, nil)

See Also:

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

# File 'quick_sight/cfn_data_source.rb', line 2153

def role_arn
  @role_arn
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_data_source.rb', line 2155

def self.jsii_properties
  {
    :manifest_file_location => "manifestFileLocation",
    :role_arn => "roleArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_data_source.rb', line 2162

def to_jsii
  result = {}
  result.merge!({
    "manifestFileLocation" => @manifest_file_location,
    "roleArn" => @role_arn,
  })
  result.compact
end