Class: AWSCDK::AppFlow::CfnConnectorProfileProps

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

Overview

Properties for defining a CfnConnectorProfile.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection_mode:, connector_profile_name:, connector_type:, connector_label: nil, connector_profile_config: nil, kms_arn: nil) ⇒ CfnConnectorProfileProps

Returns a new instance of CfnConnectorProfileProps.

Parameters:

  • connection_mode (String) —

    Indicates the connection mode and if it is public or private.

  • connector_profile_name (String) —

    The name of the connector profile.

  • connector_type (String) —

    The type of connector, such as Salesforce, Amplitude, and so on.

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

    The label for the connector profile being created.

  • connector_profile_config (AWSCDK::IResolvable, AWSCDK::AppFlow::CfnConnectorProfile::ConnectorProfileConfigProperty, nil) (defaults to: nil) —

    Defines the connector-specific configuration and credentials.

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

    The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'app_flow/cfn_connector_profile_props.rb', line 15

def initialize(connection_mode:, connector_profile_name:, connector_type:, connector_label: nil, connector_profile_config: nil, kms_arn: nil)
  @connection_mode = connection_mode
  Jsii::Type.check_type(@connection_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectionMode")
  @connector_profile_name = connector_profile_name
  Jsii::Type.check_type(@connector_profile_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectorProfileName")
  @connector_type = connector_type
  Jsii::Type.check_type(@connector_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectorType")
  @connector_label = connector_label
  Jsii::Type.check_type(@connector_label, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectorLabel") unless @connector_label.nil?
  @connector_profile_config = connector_profile_config.is_a?(Hash) ? ::AWSCDK::AppFlow::CfnConnectorProfile::ConnectorProfileConfigProperty.new(**connector_profile_config.transform_keys(&:to_sym)) : connector_profile_config
  Jsii::Type.check_type(@connector_profile_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBmbG93LkNmbkNvbm5lY3RvclByb2ZpbGUuQ29ubmVjdG9yUHJvZmlsZUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "connectorProfileConfig") unless @connector_profile_config.nil?
  @kms_arn = kms_arn
  Jsii::Type.check_type(@kms_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsArn") unless @kms_arn.nil?
end

Instance Attribute Details

#connection_mode ⇒ String (readonly)

Indicates the connection mode and if it is public or private.

Returns:

  • (String)

See Also:



34
35
36
 
# File 'app_flow/cfn_connector_profile_props.rb', line 34

def connection_mode
  @connection_mode
end

#connector_label ⇒ String? (readonly)

The label for the connector profile being created.

Returns:

  • (String, nil)

See Also:



51
52
53
 
# File 'app_flow/cfn_connector_profile_props.rb', line 51

def connector_label
  @connector_label
end

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

Defines the connector-specific configuration and credentials.

Returns:

See Also:



56
57
58
 
# File 'app_flow/cfn_connector_profile_props.rb', line 56

def connector_profile_config
  @connector_profile_config
end

#connector_profile_name ⇒ String (readonly)

The name of the connector profile.

The name is unique for each ConnectorProfile in the AWS account .

Returns:

  • (String)

See Also:



41
42
43
 
# File 'app_flow/cfn_connector_profile_props.rb', line 41

def connector_profile_name
  @connector_profile_name
end

#connector_type ⇒ String (readonly)

The type of connector, such as Salesforce, Amplitude, and so on.

Returns:

  • (String)

See Also:



46
47
48
 
# File 'app_flow/cfn_connector_profile_props.rb', line 46

def connector_type
  @connector_type
end

#kms_arn ⇒ String? (readonly)

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.

This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.

Returns:

  • (String, nil)

See Also:



63
64
65
 
# File 'app_flow/cfn_connector_profile_props.rb', line 63

def kms_arn
  @kms_arn
end

Class Method Details

.jsii_properties ⇒ Object 



65
66
67
68
69
70
71
72
73
74
 
# File 'app_flow/cfn_connector_profile_props.rb', line 65

def self.jsii_properties
  {
    :connection_mode => "connectionMode",
    :connector_profile_name => "connectorProfileName",
    :connector_type => "connectorType",
    :connector_label => "connectorLabel",
    :connector_profile_config => "connectorProfileConfig",
    :kms_arn => "kmsArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'app_flow/cfn_connector_profile_props.rb', line 76

def to_jsii
  result = {}
  result.merge!({
    "connectionMode" => @connection_mode,
    "connectorProfileName" => @connector_profile_name,
    "connectorType" => @connector_type,
    "connectorLabel" => @connector_label,
    "connectorProfileConfig" => @connector_profile_config,
    "kmsArn" => @kms_arn,
  })
  result.compact
end