Class: Aws::KafkaConnect::Types::CreateConnectorRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:connector_configuration]

Instance Attribute Summary collapse

Instance Attribute Details

#capacity ⇒ Types::Capacity

Information about the capacity allocated to the connector. Exactly one of the two properties must be specified.

Returns:



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/types.rb', line 445

class CreateConnectorRequest < Struct.new(
  :capacity,
  :connector_configuration,
  :connector_description,
  :connector_name,
  :kafka_cluster,
  :kafka_cluster_client_authentication,
  :kafka_cluster_encryption_in_transit,
  :kafka_connect_version,
  :log_delivery,
  :plugins,
  :service_execution_role_arn,
  :tags,
  :worker_configuration)
  SENSITIVE = [:connector_configuration]
  include Aws::Structure
end

#connector_configuration ⇒ Hash<String,String>

A map of keys to values that represent the configuration for the connector.

Returns:

  • (Hash<String,String>) 


445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/types.rb', line 445

class CreateConnectorRequest < Struct.new(
  :capacity,
  :connector_configuration,
  :connector_description,
  :connector_name,
  :kafka_cluster,
  :kafka_cluster_client_authentication,
  :kafka_cluster_encryption_in_transit,
  :kafka_connect_version,
  :log_delivery,
  :plugins,
  :service_execution_role_arn,
  :tags,
  :worker_configuration)
  SENSITIVE = [:connector_configuration]
  include Aws::Structure
end

#connector_description ⇒ String

A summary description of the connector.

Returns:

  • (String) 


445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/types.rb', line 445

class CreateConnectorRequest < Struct.new(
  :capacity,
  :connector_configuration,
  :connector_description,
  :connector_name,
  :kafka_cluster,
  :kafka_cluster_client_authentication,
  :kafka_cluster_encryption_in_transit,
  :kafka_connect_version,
  :log_delivery,
  :plugins,
  :service_execution_role_arn,
  :tags,
  :worker_configuration)
  SENSITIVE = [:connector_configuration]
  include Aws::Structure
end

#connector_name ⇒ String

The name of the connector.

Returns:

  • (String) 


445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/types.rb', line 445

class CreateConnectorRequest < Struct.new(
  :capacity,
  :connector_configuration,
  :connector_description,
  :connector_name,
  :kafka_cluster,
  :kafka_cluster_client_authentication,
  :kafka_cluster_encryption_in_transit,
  :kafka_connect_version,
  :log_delivery,
  :plugins,
  :service_execution_role_arn,
  :tags,
  :worker_configuration)
  SENSITIVE = [:connector_configuration]
  include Aws::Structure
end

#kafka_cluster ⇒ Types::KafkaCluster

Specifies which Apache Kafka cluster to connect to.

Returns:



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/types.rb', line 445

class CreateConnectorRequest < Struct.new(
  :capacity,
  :connector_configuration,
  :connector_description,
  :connector_name,
  :kafka_cluster,
  :kafka_cluster_client_authentication,
  :kafka_cluster_encryption_in_transit,
  :kafka_connect_version,
  :log_delivery,
  :plugins,
  :service_execution_role_arn,
  :tags,
  :worker_configuration)
  SENSITIVE = [:connector_configuration]
  include Aws::Structure
end

#kafka_cluster_client_authentication ⇒ Types::KafkaClusterClientAuthentication

Details of the client authentication used by the Apache Kafka cluster.

Returns:



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/types.rb', line 445

class CreateConnectorRequest < Struct.new(
  :capacity,
  :connector_configuration,
  :connector_description,
  :connector_name,
  :kafka_cluster,
  :kafka_cluster_client_authentication,
  :kafka_cluster_encryption_in_transit,
  :kafka_connect_version,
  :log_delivery,
  :plugins,
  :service_execution_role_arn,
  :tags,
  :worker_configuration)
  SENSITIVE = [:connector_configuration]
  include Aws::Structure
end

#kafka_cluster_encryption_in_transit ⇒ Types::KafkaClusterEncryptionInTransit

Details of encryption in transit to the Apache Kafka cluster.

Returns:



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/types.rb', line 445

class CreateConnectorRequest < Struct.new(
  :capacity,
  :connector_configuration,
  :connector_description,
  :connector_name,
  :kafka_cluster,
  :kafka_cluster_client_authentication,
  :kafka_cluster_encryption_in_transit,
  :kafka_connect_version,
  :log_delivery,
  :plugins,
  :service_execution_role_arn,
  :tags,
  :worker_configuration)
  SENSITIVE = [:connector_configuration]
  include Aws::Structure
end

#kafka_connect_version ⇒ String

The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.

Returns:

  • (String) 


445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/types.rb', line 445

class CreateConnectorRequest < Struct.new(
  :capacity,
  :connector_configuration,
  :connector_description,
  :connector_name,
  :kafka_cluster,
  :kafka_cluster_client_authentication,
  :kafka_cluster_encryption_in_transit,
  :kafka_connect_version,
  :log_delivery,
  :plugins,
  :service_execution_role_arn,
  :tags,
  :worker_configuration)
  SENSITIVE = [:connector_configuration]
  include Aws::Structure
end

#log_delivery ⇒ Types::LogDelivery

Details about log delivery.

Returns:



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/types.rb', line 445

class CreateConnectorRequest < Struct.new(
  :capacity,
  :connector_configuration,
  :connector_description,
  :connector_name,
  :kafka_cluster,
  :kafka_cluster_client_authentication,
  :kafka_cluster_encryption_in_transit,
  :kafka_connect_version,
  :log_delivery,
  :plugins,
  :service_execution_role_arn,
  :tags,
  :worker_configuration)
  SENSITIVE = [:connector_configuration]
  include Aws::Structure
end

#plugins ⇒ Array<Types::Plugin>

Amazon MSK Connect does not currently support specifying multiple plugins as a list. To use more than one plugin for your connector, you can create a single custom plugin using a ZIP file that bundles multiple plugins together.

Specifies which plugin to use for the connector. You must specify a single-element list containing one customPlugin object.

Returns:



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/types.rb', line 445

class CreateConnectorRequest < Struct.new(
  :capacity,
  :connector_configuration,
  :connector_description,
  :connector_name,
  :kafka_cluster,
  :kafka_cluster_client_authentication,
  :kafka_cluster_encryption_in_transit,
  :kafka_connect_version,
  :log_delivery,
  :plugins,
  :service_execution_role_arn,
  :tags,
  :worker_configuration)
  SENSITIVE = [:connector_configuration]
  include Aws::Structure
end

#service_execution_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs. The types of resources depends on the logic of the connector. For example, a connector that has Amazon S3 as a destination must have permissions that allow it to write to the S3 destination bucket.

Returns:

  • (String) 


445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/types.rb', line 445

class CreateConnectorRequest < Struct.new(
  :capacity,
  :connector_configuration,
  :connector_description,
  :connector_name,
  :kafka_cluster,
  :kafka_cluster_client_authentication,
  :kafka_cluster_encryption_in_transit,
  :kafka_connect_version,
  :log_delivery,
  :plugins,
  :service_execution_role_arn,
  :tags,
  :worker_configuration)
  SENSITIVE = [:connector_configuration]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags you want to attach to the connector.

Returns:

  • (Hash<String,String>) 


445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/types.rb', line 445

class CreateConnectorRequest < Struct.new(
  :capacity,
  :connector_configuration,
  :connector_description,
  :connector_name,
  :kafka_cluster,
  :kafka_cluster_client_authentication,
  :kafka_cluster_encryption_in_transit,
  :kafka_connect_version,
  :log_delivery,
  :plugins,
  :service_execution_role_arn,
  :tags,
  :worker_configuration)
  SENSITIVE = [:connector_configuration]
  include Aws::Structure
end

#worker_configuration ⇒ Types::WorkerConfiguration

Specifies which worker configuration to use with the connector.

Returns:



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/types.rb', line 445

class CreateConnectorRequest < Struct.new(
  :capacity,
  :connector_configuration,
  :connector_description,
  :connector_name,
  :kafka_cluster,
  :kafka_cluster_client_authentication,
  :kafka_cluster_encryption_in_transit,
  :kafka_connect_version,
  :log_delivery,
  :plugins,
  :service_execution_role_arn,
  :tags,
  :worker_configuration)
  SENSITIVE = [:connector_configuration]
  include Aws::Structure
end