Class: AWSCDK::Bedrock::CfnDataSource::SalesforceSourceConfigurationProperty

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

Overview

The endpoint information to connect to your Salesforce data source.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(auth_type:, credentials_secret_arn:, host_url:) ⇒ SalesforceSourceConfigurationProperty

Returns a new instance of SalesforceSourceConfigurationProperty.

Parameters:

  • auth_type (String)

    The supported authentication type to authenticate and connect to your Salesforce instance.

  • credentials_secret_arn (String)

    The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your Salesforce instance URL.

  • host_url (String)

    The Salesforce host URL or instance URL.



1998
1999
2000
2001
2002
2003
2004
2005
# File 'bedrock/cfn_data_source.rb', line 1998

def initialize(auth_type:, credentials_secret_arn:, host_url:)
  @auth_type = auth_type
  Jsii::Type.check_type(@auth_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authType")
  @credentials_secret_arn = credentials_secret_arn
  Jsii::Type.check_type(@credentials_secret_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "credentialsSecretArn")
  @host_url = host_url
  Jsii::Type.check_type(@host_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hostUrl")
end

Instance Attribute Details

#auth_typeString (readonly)

The supported authentication type to authenticate and connect to your Salesforce instance.



2011
2012
2013
# File 'bedrock/cfn_data_source.rb', line 2011

def auth_type
  @auth_type
end

#credentials_secret_arnString (readonly)

The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your Salesforce instance URL.

For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Salesforce connection configuration .



2018
2019
2020
# File 'bedrock/cfn_data_source.rb', line 2018

def credentials_secret_arn
  @credentials_secret_arn
end

#host_urlString (readonly)

The Salesforce host URL or instance URL.



2023
2024
2025
# File 'bedrock/cfn_data_source.rb', line 2023

def host_url
  @host_url
end

Class Method Details

.jsii_propertiesObject



2025
2026
2027
2028
2029
2030
2031
# File 'bedrock/cfn_data_source.rb', line 2025

def self.jsii_properties
  {
    :auth_type => "authType",
    :credentials_secret_arn => "credentialsSecretArn",
    :host_url => "hostUrl",
  }
end

Instance Method Details

#to_jsiiObject



2033
2034
2035
2036
2037
2038
2039
2040
2041
# File 'bedrock/cfn_data_source.rb', line 2033

def to_jsii
  result = {}
  result.merge!({
    "authType" => @auth_type,
    "credentialsSecretArn" => @credentials_secret_arn,
    "hostUrl" => @host_url,
  })
  result.compact
end