Class: AWSCDK::Glue::CfnConnection::OAuth2PropertiesInputProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
glue/cfn_connection.rb

Overview

A structure containing properties for OAuth2 in the CreateConnection request.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(authorization_code_properties: nil, o_auth2_client_application: nil, o_auth2_credentials: nil, o_auth2_grant_type: nil, token_url: nil, token_url_parameters_map: nil) ⇒ OAuth2PropertiesInputProperty

Returns a new instance of OAuth2PropertiesInputProperty.

Parameters:



990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
 
# File 'glue/cfn_connection.rb', line 990

def initialize(authorization_code_properties: nil, o_auth2_client_application: nil, o_auth2_credentials: nil, o_auth2_grant_type: nil, token_url: nil, token_url_parameters_map: nil)
  @authorization_code_properties = authorization_code_properties.is_a?(Hash) ? ::AWSCDK::Glue::CfnConnection::AuthorizationCodePropertiesProperty.new(**authorization_code_properties.transform_keys(&:to_sym)) : authorization_code_properties
  Jsii::Type.check_type(@authorization_code_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nbHVlLkNmbkNvbm5lY3Rpb24uQXV0aG9yaXphdGlvbkNvZGVQcm9wZXJ0aWVzUHJvcGVydHkifV19fQ==")), "authorizationCodeProperties") unless @authorization_code_properties.nil?
  @o_auth2_client_application = o_auth2_client_application.is_a?(Hash) ? ::AWSCDK::Glue::CfnConnection::OAuth2ClientApplicationProperty.new(**o_auth2_client_application.transform_keys(&:to_sym)) : o_auth2_client_application
  Jsii::Type.check_type(@o_auth2_client_application, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nbHVlLkNmbkNvbm5lY3Rpb24uT0F1dGgyQ2xpZW50QXBwbGljYXRpb25Qcm9wZXJ0eSJ9XX19")), "oAuth2ClientApplication") unless @o_auth2_client_application.nil?
  @o_auth2_credentials = o_auth2_credentials.is_a?(Hash) ? ::AWSCDK::Glue::CfnConnection::OAuth2CredentialsProperty.new(**o_auth2_credentials.transform_keys(&:to_sym)) : o_auth2_credentials
  Jsii::Type.check_type(@o_auth2_credentials, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nbHVlLkNmbkNvbm5lY3Rpb24uT0F1dGgyQ3JlZGVudGlhbHNQcm9wZXJ0eSJ9XX19")), "oAuth2Credentials") unless @o_auth2_credentials.nil?
  @o_auth2_grant_type = o_auth2_grant_type
  Jsii::Type.check_type(@o_auth2_grant_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "oAuth2GrantType") unless @o_auth2_grant_type.nil?
  @token_url = token_url
  Jsii::Type.check_type(@token_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tokenUrl") unless @token_url.nil?
  @token_url_parameters_map = token_url_parameters_map
  Jsii::Type.check_type(@token_url_parameters_map, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "tokenUrlParametersMap") unless @token_url_parameters_map.nil?
end

Instance Attribute Details

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

The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type.

Returns:

See Also:



1009
1010
1011
 
# File 'glue/cfn_connection.rb', line 1009

def authorization_code_properties
  @authorization_code_properties
end

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

The client application type in the CreateConnection request.

For example, AWS_MANAGED or USER_MANAGED .

Returns:

See Also:



1016
1017
1018
 
# File 'glue/cfn_connection.rb', line 1016

def o_auth2_client_application
  @o_auth2_client_application
end

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

The credentials used when the authentication type is OAuth2 authentication.

Returns:

See Also:



1021
1022
1023
 
# File 'glue/cfn_connection.rb', line 1021

def o_auth2_credentials
  @o_auth2_credentials
end

#o_auth2_grant_type ⇒ String? (readonly)

The OAuth2 grant type in the CreateConnection request.

For example, AUTHORIZATION_CODE , JWT_BEARER , or CLIENT_CREDENTIALS .

Returns:

  • (String, nil)

See Also:



1028
1029
1030
 
# File 'glue/cfn_connection.rb', line 1028

def o_auth2_grant_type
  @o_auth2_grant_type
end

#token_url ⇒ String? (readonly)

The URL of the provider's authentication server, to exchange an authorization code for an access token.

Returns:

  • (String, nil)

See Also:



1033
1034
1035
 
# File 'glue/cfn_connection.rb', line 1033

def token_url
  @token_url
end

#token_url_parameters_map ⇒ Object? (readonly)

A map of parameters that are added to the token GET request.

Returns:

  • (Object, nil)

See Also:



1038
1039
1040
 
# File 'glue/cfn_connection.rb', line 1038

def token_url_parameters_map
  @token_url_parameters_map
end

Class Method Details

.jsii_properties ⇒ Object 



1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
 
# File 'glue/cfn_connection.rb', line 1040

def self.jsii_properties
  {
    :authorization_code_properties => "authorizationCodeProperties",
    :o_auth2_client_application => "oAuth2ClientApplication",
    :o_auth2_credentials => "oAuth2Credentials",
    :o_auth2_grant_type => "oAuth2GrantType",
    :token_url => "tokenUrl",
    :token_url_parameters_map => "tokenUrlParametersMap",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
 
# File 'glue/cfn_connection.rb', line 1051

def to_jsii
  result = {}
  result.merge!({
    "authorizationCodeProperties" => @authorization_code_properties,
    "oAuth2ClientApplication" => @o_auth2_client_application,
    "oAuth2Credentials" => @o_auth2_credentials,
    "oAuth2GrantType" => @o_auth2_grant_type,
    "tokenUrl" => @token_url,
    "tokenUrlParametersMap" => @token_url_parameters_map,
  })
  result.compact
end