Class: AWSCDK::AppFlow::CfnConnectorProfile::SalesforceConnectorProfilePropertiesProperty

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

Overview

The connector-specific profile properties required when using Salesforce.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(instance_url: nil, is_sandbox_environment: nil, use_private_link_for_metadata_and_authorization: nil) ⇒ SalesforceConnectorProfilePropertiesProperty

Returns a new instance of SalesforceConnectorProfilePropertiesProperty.

Parameters:

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

    The location of the Salesforce resource.

  • is_sandbox_environment (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Indicates whether the connector profile applies to a sandbox or production environment.

  • use_private_link_for_metadata_and_authorization (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    If the connection mode for the connector profile is private, this parameter sets whether Amazon AppFlow uses the private network to send metadata and authorization calls to Salesforce.



2500
2501
2502
2503
2504
2505
2506
2507
 
# File 'app_flow/cfn_connector_profile.rb', line 2500

def initialize(instance_url: nil, is_sandbox_environment: nil, use_private_link_for_metadata_and_authorization: nil)
  @instance_url = instance_url
  Jsii::Type.check_type(@instance_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceUrl") unless @instance_url.nil?
  @is_sandbox_environment = is_sandbox_environment
  Jsii::Type.check_type(@is_sandbox_environment, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "isSandboxEnvironment") unless @is_sandbox_environment.nil?
  @use_private_link_for_metadata_and_authorization = use_private_link_for_metadata_and_authorization
  Jsii::Type.check_type(@use_private_link_for_metadata_and_authorization, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "usePrivateLinkForMetadataAndAuthorization") unless @use_private_link_for_metadata_and_authorization.nil?
end

Instance Attribute Details

#instance_url ⇒ String? (readonly)

The location of the Salesforce resource.

Returns:

  • (String, nil)

See Also:



2513
2514
2515
 
# File 'app_flow/cfn_connector_profile.rb', line 2513

def instance_url
  @instance_url
end

#is_sandbox_environment ⇒ Boolean, ... (readonly)

Indicates whether the connector profile applies to a sandbox or production environment.

Returns:

See Also:



2518
2519
2520
 
# File 'app_flow/cfn_connector_profile.rb', line 2518

def is_sandbox_environment
  @is_sandbox_environment
end

#use_private_link_for_metadata_and_authorization ⇒ Boolean, ... (readonly)

If the connection mode for the connector profile is private, this parameter sets whether Amazon AppFlow uses the private network to send metadata and authorization calls to Salesforce.

Amazon AppFlow sends private calls through AWS PrivateLink . These calls travel through AWS infrastructure without being exposed to the public internet.

Set either of the following values:

  • true - Amazon AppFlow sends all calls to Salesforce over the private network.

These private calls are:

  • Calls to get metadata about your Salesforce records. This metadata describes your Salesforce objects and their fields.
  • Calls to get or refresh access tokens that allow Amazon AppFlow to access your Salesforce records.
  • Calls to transfer your Salesforce records as part of a flow run.
  • false - The default value. Amazon AppFlow sends some calls to Salesforce privately and other calls over the public internet.

The public calls are:

  • Calls to get metadata about your Salesforce records.
  • Calls to get or refresh access tokens.

The private calls are:

  • Calls to transfer your Salesforce records as part of a flow run.

Returns:

See Also:



2545
2546
2547
 
# File 'app_flow/cfn_connector_profile.rb', line 2545

def use_private_link_for_metadata_and_authorization
  @use_private_link_for_metadata_and_authorization
end

Class Method Details

.jsii_properties ⇒ Object 



2547
2548
2549
2550
2551
2552
2553
 
# File 'app_flow/cfn_connector_profile.rb', line 2547

def self.jsii_properties
  {
    :instance_url => "instanceUrl",
    :is_sandbox_environment => "isSandboxEnvironment",
    :use_private_link_for_metadata_and_authorization => "usePrivateLinkForMetadataAndAuthorization",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2555
2556
2557
2558
2559
2560
2561
2562
2563
 
# File 'app_flow/cfn_connector_profile.rb', line 2555

def to_jsii
  result = {}
  result.merge!({
    "instanceUrl" => @instance_url,
    "isSandboxEnvironment" => @is_sandbox_environment,
    "usePrivateLinkForMetadataAndAuthorization" => @use_private_link_for_metadata_and_authorization,
  })
  result.compact
end