Class: AWSCDK::AppFlow::CfnConnectorProfile::ZendeskConnectorProfileCredentialsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::AppFlow::CfnConnectorProfile::ZendeskConnectorProfileCredentialsProperty

Defined in:

app_flow/cfn_connector_profile.rb

Overview

The connector-specific profile credentials required when using Zendesk.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-zendeskconnectorprofilecredentials.html

Instance Attribute Summary

• #access_token ⇒ String^? readonly

  The credentials used to access protected Zendesk resources.

• #client_id ⇒ String readonly

  The identifier for the desired client.

• #client_secret ⇒ String readonly

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

• #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.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(client_id:, client_secret:, access_token: nil, connector_o_auth_request: nil) ⇒ ZendeskConnectorProfileCredentialsProperty constructor

  A new instance of ZendeskConnectorProfileCredentialsProperty.

• #to_jsii ⇒ Object

Constructor Details

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

Returns a new instance of ZendeskConnectorProfileCredentialsProperty.

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 Zendesk 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.

# File 'app_flow/cfn_connector_profile.rb', line 3038

def initialize(client_id:, client_secret:, access_token: nil, connector_o_auth_request: 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?
end

Instance Attribute Details

#access_token ⇒ String^? (readonly)

The credentials used to access protected Zendesk resources.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-zendeskconnectorprofilecredentials.html#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-accesstoken

# File 'app_flow/cfn_connector_profile.rb', line 3063

def access_token
  @access_token
end

#client_id ⇒ String (readonly)

The identifier for the desired client.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-zendeskconnectorprofilecredentials.html#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-clientid

# File 'app_flow/cfn_connector_profile.rb', line 3053

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-zendeskconnectorprofilecredentials.html#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-clientsecret

# File 'app_flow/cfn_connector_profile.rb', line 3058

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:

• (AWSCDK::IResolvable, AWSCDK::AppFlow::CfnConnectorProfile::ConnectorOAuthRequestProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-zendeskconnectorprofilecredentials.html#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-connectoroauthrequest

# File 'app_flow/cfn_connector_profile.rb', line 3068

def connector_o_auth_request
  @connector_o_auth_request
end

Class Method Details

.jsii_properties ⇒ Object

# File 'app_flow/cfn_connector_profile.rb', line 3070

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

Instance Method Details

#to_jsii ⇒ Object

# File 'app_flow/cfn_connector_profile.rb', line 3079

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