Class: AWSCDK::AppFlow::CfnConnectorProfile::GoogleAnalyticsConnectorProfileCredentialsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_flow/cfn_connector_profile.rb

Overview

The connector-specific profile credentials required by Google Analytics.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client_id:, client_secret:, access_token: nil, connector_o_auth_request: nil, refresh_token: nil) ⇒ GoogleAnalyticsConnectorProfileCredentialsProperty

Returns a new instance of GoogleAnalyticsConnectorProfileCredentialsProperty.

Parameters:

  • client_id (String) —

    The identifier for the desired client.

  • client_secret (String) —

    The client secret used by the OAuth client to authenticate to the authorization server.

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

    The credentials used to access protected Google Analytics resources.

  • connector_o_auth_request (AWSCDK::IResolvable, AWSCDK::AppFlow::CfnConnectorProfile::ConnectorOAuthRequestProperty, nil) (defaults to: nil) —

    Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

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

    The credentials used to acquire new access tokens.



1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
 
# File 'app_flow/cfn_connector_profile.rb', line 1473

def initialize(client_id:, client_secret:, access_token: nil, connector_o_auth_request: nil, refresh_token: nil)
  @client_id = client_id
  Jsii::Type.check_type(@client_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientId")
  @client_secret = client_secret
  Jsii::Type.check_type(@client_secret, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientSecret")
  @access_token = access_token
  Jsii::Type.check_type(@access_token, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accessToken") unless @access_token.nil?
  @connector_o_auth_request = connector_o_auth_request.is_a?(Hash) ? ::AWSCDK::AppFlow::CfnConnectorProfile::ConnectorOAuthRequestProperty.new(**connector_o_auth_request.transform_keys(&:to_sym)) : connector_o_auth_request
  Jsii::Type.check_type(@connector_o_auth_request, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBmbG93LkNmbkNvbm5lY3RvclByb2ZpbGUuQ29ubmVjdG9yT0F1dGhSZXF1ZXN0UHJvcGVydHkifV19fQ==")), "connectorOAuthRequest") unless @connector_o_auth_request.nil?
  @refresh_token = refresh_token
  Jsii::Type.check_type(@refresh_token, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "refreshToken") unless @refresh_token.nil?
end

Instance Attribute Details

#access_token ⇒ String? (readonly)

The credentials used to access protected Google Analytics resources.

Returns:

  • (String, nil)

See Also:



1500
1501
1502
 
# File 'app_flow/cfn_connector_profile.rb', line 1500

def access_token
  @access_token
end

#client_id ⇒ String (readonly)

The identifier for the desired client.

Returns:

  • (String)

See Also:



1490
1491
1492
 
# File 'app_flow/cfn_connector_profile.rb', line 1490

def client_id
  @client_id
end

#client_secret ⇒ String (readonly)

The client secret used by the OAuth client to authenticate to the authorization server.

Returns:

  • (String)

See Also:



1495
1496
1497
 
# File 'app_flow/cfn_connector_profile.rb', line 1495

def client_secret
  @client_secret
end

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

Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

Returns:

See Also:



1505
1506
1507
 
# File 'app_flow/cfn_connector_profile.rb', line 1505

def connector_o_auth_request
  @connector_o_auth_request
end

#refresh_token ⇒ String? (readonly)

The credentials used to acquire new access tokens.

This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens.

Returns:

  • (String, nil)

See Also:



1512
1513
1514
 
# File 'app_flow/cfn_connector_profile.rb', line 1512

def refresh_token
  @refresh_token
end

Class Method Details

.jsii_properties ⇒ Object 



1514
1515
1516
1517
1518
1519
1520
1521
1522
 
# File 'app_flow/cfn_connector_profile.rb', line 1514

def self.jsii_properties
  {
    :client_id => "clientId",
    :client_secret => "clientSecret",
    :access_token => "accessToken",
    :connector_o_auth_request => "connectorOAuthRequest",
    :refresh_token => "refreshToken",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
 
# File 'app_flow/cfn_connector_profile.rb', line 1524

def to_jsii
  result = {}
  result.merge!({
    "clientId" => @client_id,
    "clientSecret" => @client_secret,
    "accessToken" => @access_token,
    "connectorOAuthRequest" => @connector_o_auth_request,
    "refreshToken" => @refresh_token,
  })
  result.compact
end