Class: AWSCDK::QuickSight::CfnDataSource::AthenaParametersProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_data_source.rb

Overview

Parameters for Amazon Athena.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(identity_center_configuration: nil, role_arn: nil, work_group: nil) ⇒ AthenaParametersProperty

Returns a new instance of AthenaParametersProperty.

Parameters:

  • identity_center_configuration (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDataSource::IdentityCenterConfigurationProperty, nil) (defaults to: nil) —

    An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.

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

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

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

    The workgroup that Amazon Athena uses.



770
771
772
773
774
775
776
777
 
# File 'quick_sight/cfn_data_source.rb', line 770

def initialize(identity_center_configuration: nil, role_arn: nil, work_group: nil)
  @identity_center_configuration = identity_center_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSource::IdentityCenterConfigurationProperty.new(**identity_center_configuration.transform_keys(&:to_sym)) : identity_center_configuration
  Jsii::Type.check_type(@identity_center_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTb3VyY2UuSWRlbnRpdHlDZW50ZXJDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "identityCenterConfiguration") unless @identity_center_configuration.nil?
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.nil?
  @work_group = work_group
  Jsii::Type.check_type(@work_group, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workGroup") unless @work_group.nil?
end

Instance Attribute Details

#identity_center_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.

This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.

Returns:

See Also:



785
786
787
 
# File 'quick_sight/cfn_data_source.rb', line 785

def identity_center_configuration
  @identity_center_configuration
end

#role_arn ⇒ String? (readonly)

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

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

Returns:

  • (String, nil)

See Also:



792
793
794
 
# File 'quick_sight/cfn_data_source.rb', line 792

def role_arn
  @role_arn
end

#work_group ⇒ String? (readonly)

The workgroup that Amazon Athena uses.

Returns:

  • (String, nil)

See Also:



797
798
799
 
# File 'quick_sight/cfn_data_source.rb', line 797

def work_group
  @work_group
end

Class Method Details

.jsii_properties ⇒ Object 



799
800
801
802
803
804
805
 
# File 'quick_sight/cfn_data_source.rb', line 799

def self.jsii_properties
  {
    :identity_center_configuration => "identityCenterConfiguration",
    :role_arn => "roleArn",
    :work_group => "workGroup",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



807
808
809
810
811
812
813
814
815
 
# File 'quick_sight/cfn_data_source.rb', line 807

def to_jsii
  result = {}
  result.merge!({
    "identityCenterConfiguration" => @identity_center_configuration,
    "roleArn" => @role_arn,
    "workGroup" => @work_group,
  })
  result.compact
end