Class: Aws::Appflow::Types::CreateConnectorProfileRequest

Inherits:

Struct

• Object
• Struct
• Aws::Appflow::Types::CreateConnectorProfileRequest

Defined in:

gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  The clientToken parameter is an idempotency token.

• #connection_mode ⇒ String

  Indicates the connection mode and specifies whether it is public or private.

• #connector_label ⇒ String

  The label of the connector.

• #connector_profile_config ⇒ Types::ConnectorProfileConfig

  Defines the connector-specific configuration and credentials.

• #connector_profile_name ⇒ String

  The name of the connector profile.

• #connector_type ⇒ String

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

• #kms_arn ⇒ String

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

Instance Attribute Details

#client_token ⇒ String

The clientToken parameter is an idempotency token. It ensures that your CreateConnectorProfile request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to CreateConnectorProfile. The token is active for 8 hours.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 1305

class CreateConnectorProfileRequest < Struct.new(
  :connector_profile_name,
  :kms_arn,
  :connector_type,
  :connector_label,
  :connection_mode,
  :connector_profile_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#connection_mode ⇒ String

Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the public internet.

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 1305

class CreateConnectorProfileRequest < Struct.new(
  :connector_profile_name,
  :kms_arn,
  :connector_type,
  :connector_label,
  :connection_mode,
  :connector_profile_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#connector_label ⇒ String

The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 1305

class CreateConnectorProfileRequest < Struct.new(
  :connector_profile_name,
  :kms_arn,
  :connector_type,
  :connector_label,
  :connection_mode,
  :connector_profile_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#connector_profile_config ⇒ Types::ConnectorProfileConfig

Defines the connector-specific configuration and credentials.

Returns:

• (Types::ConnectorProfileConfig)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 1305

class CreateConnectorProfileRequest < Struct.new(
  :connector_profile_name,
  :kms_arn,
  :connector_type,
  :connector_label,
  :connection_mode,
  :connector_profile_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#connector_profile_name ⇒ String

The name of the connector profile. The name is unique for each ConnectorProfile in your Amazon Web Services account.

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 1305

class CreateConnectorProfileRequest < Struct.new(
  :connector_profile_name,
  :kms_arn,
  :connector_type,
  :connector_label,
  :connection_mode,
  :connector_profile_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#connector_type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 1305

class CreateConnectorProfileRequest < Struct.new(
  :connector_profile_name,
  :kms_arn,
  :connector_type,
  :connector_label,
  :connection_mode,
  :connector_profile_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#kms_arn ⇒ String

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)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 1305

class CreateConnectorProfileRequest < Struct.new(
  :connector_profile_name,
  :kms_arn,
  :connector_type,
  :connector_label,
  :connection_mode,
  :connector_profile_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end