Class: AWSCDK::QuickSight::CfnDataSource::OAuthParametersProperty

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

Overview

An object that contains information needed to create a data source connection that uses OAuth client credentials.

This option is available for data source connections that are made with Snowflake and Starburst.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(token_provider_url:, identity_provider_resource_uri: nil, identity_provider_vpc_connection_properties: nil, o_auth_scope: nil) ⇒ OAuthParametersProperty

Returns a new instance of OAuthParametersProperty.

Parameters:

  • token_provider_url (String) —

    The token endpoint URL of the identity provider.

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

    The resource uri of the identity provider.

  • identity_provider_vpc_connection_properties (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDataSource::VPCConnectionPropertiesProperty, nil) (defaults to: nil) —

    VPC connection properties.

    .

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

    The OAuth scope.



1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
 
# File 'quick_sight/cfn_data_source.rb', line 1629

def initialize(token_provider_url:, identity_provider_resource_uri: nil, identity_provider_vpc_connection_properties: nil, o_auth_scope: nil)
  @token_provider_url = token_provider_url
  Jsii::Type.check_type(@token_provider_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tokenProviderUrl")
  @identity_provider_resource_uri = identity_provider_resource_uri
  Jsii::Type.check_type(@identity_provider_resource_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identityProviderResourceUri") unless @identity_provider_resource_uri.nil?
  @identity_provider_vpc_connection_properties = identity_provider_vpc_connection_properties.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSource::VPCConnectionPropertiesProperty.new(**identity_provider_vpc_connection_properties.transform_keys(&:to_sym)) : identity_provider_vpc_connection_properties
  Jsii::Type.check_type(@identity_provider_vpc_connection_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTb3VyY2UuVnBjQ29ubmVjdGlvblByb3BlcnRpZXNQcm9wZXJ0eSJ9XX19")), "identityProviderVpcConnectionProperties") unless @identity_provider_vpc_connection_properties.nil?
  @o_auth_scope = o_auth_scope
  Jsii::Type.check_type(@o_auth_scope, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "oAuthScope") unless @o_auth_scope.nil?
end

Instance Attribute Details

#identity_provider_resource_uri ⇒ String? (readonly)

The resource uri of the identity provider.

Returns:

  • (String, nil)

See Also:



1649
1650
1651
 
# File 'quick_sight/cfn_data_source.rb', line 1649

def identity_provider_resource_uri
  @identity_provider_resource_uri
end

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

VPC connection properties.

.

Returns:

See Also:



1654
1655
1656
 
# File 'quick_sight/cfn_data_source.rb', line 1654

def identity_provider_vpc_connection_properties
  @identity_provider_vpc_connection_properties
end

#o_auth_scope ⇒ String? (readonly)

The OAuth scope.

Returns:

  • (String, nil)

See Also:



1659
1660
1661
 
# File 'quick_sight/cfn_data_source.rb', line 1659

def o_auth_scope
  @o_auth_scope
end

#token_provider_url ⇒ String (readonly)

The token endpoint URL of the identity provider.

Returns:

  • (String)

See Also:



1644
1645
1646
 
# File 'quick_sight/cfn_data_source.rb', line 1644

def token_provider_url
  @token_provider_url
end

Class Method Details

.jsii_properties ⇒ Object 



1661
1662
1663
1664
1665
1666
1667
1668
 
# File 'quick_sight/cfn_data_source.rb', line 1661

def self.jsii_properties
  {
    :token_provider_url => "tokenProviderUrl",
    :identity_provider_resource_uri => "identityProviderResourceUri",
    :identity_provider_vpc_connection_properties => "identityProviderVpcConnectionProperties",
    :o_auth_scope => "oAuthScope",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'quick_sight/cfn_data_source.rb', line 1670

def to_jsii
  result = {}
  result.merge!({
    "tokenProviderUrl" => @token_provider_url,
    "identityProviderResourceUri" => @identity_provider_resource_uri,
    "identityProviderVpcConnectionProperties" => @identity_provider_vpc_connection_properties,
    "oAuthScope" => @o_auth_scope,
  })
  result.compact
end