Class: Aws::KafkaConnect::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb

Overview

An API client for KafkaConnect. To construct a client, you need to configure a :region and :credentials.

client = Aws::KafkaConnect::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/. It should have a maximum length of 50.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::KafkaConnect::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::KafkaConnect::EndpointParameters

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



385
386
387
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 385

def initialize(*args)
  super
end

Instance Method Details

#create_connector(params = {}) ⇒ Types::CreateConnectorResponse

Creates a connector using the specified properties.

Examples:

Request syntax with placeholder values


resp = client.create_connector({
  capacity: { # required
    auto_scaling: {
      max_worker_count: 1, # required
      mcu_count: 1, # required
      min_worker_count: 1, # required
      scale_in_policy: {
        cpu_utilization_percentage: 1, # required
      },
      scale_out_policy: {
        cpu_utilization_percentage: 1, # required
      },
    },
    provisioned_capacity: {
      mcu_count: 1, # required
      worker_count: 1, # required
    },
  },
  connector_configuration: { # required
    "__string" => "__string",
  },
  connector_description: "__stringMax1024",
  connector_name: "__stringMin1Max128", # required
  kafka_cluster: { # required
    apache_kafka_cluster: { # required
      bootstrap_servers: "__string", # required
      vpc: { # required
        security_groups: ["__string"],
        subnets: ["__string"], # required
      },
    },
  },
  kafka_cluster_client_authentication: { # required
    authentication_type: "NONE", # required, accepts NONE, IAM
  },
  kafka_cluster_encryption_in_transit: { # required
    encryption_type: "PLAINTEXT", # required, accepts PLAINTEXT, TLS
  },
  kafka_connect_version: "__string", # required
  log_delivery: {
    worker_log_delivery: { # required
      cloud_watch_logs: {
        enabled: false, # required
        log_group: "__string",
      },
      firehose: {
        delivery_stream: "__string",
        enabled: false, # required
      },
      s3: {
        bucket: "__string",
        enabled: false, # required
        prefix: "__string",
      },
    },
  },
  plugins: [ # required
    {
      custom_plugin: { # required
        custom_plugin_arn: "__string", # required
        revision: 1, # required
      },
    },
  ],
  service_execution_role_arn: "__string", # required
  worker_configuration: {
    revision: 1, # required
    worker_configuration_arn: "__string", # required
  },
})

Response structure


resp.connector_arn #=> String
resp.connector_name #=> String
resp.connector_state #=> String, one of "RUNNING", "CREATING", "UPDATING", "DELETING", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :capacity (required, Types::Capacity) —

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

  • :connector_configuration (required, Hash<String,String>) —

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

  • :connector_description (String) —

    A summary description of the connector.

  • :connector_name (required, String) —

    The name of the connector.

  • :kafka_cluster (required, Types::KafkaCluster) —

    Specifies which Apache Kafka cluster to connect to.

  • :kafka_cluster_client_authentication (required, Types::KafkaClusterClientAuthentication) —

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

  • :kafka_cluster_encryption_in_transit (required, Types::KafkaClusterEncryptionInTransit) —

    Details of encryption in transit to the Apache Kafka cluster.

  • :kafka_connect_version (required, String) —

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

  • :log_delivery (Types::LogDelivery) —

    Details about log delivery.

  • :plugins (required, Array<Types::Plugin>) —

    Specifies which plugins to use for the connector.

  • :service_execution_role_arn (required, 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.

  • :worker_configuration (Types::WorkerConfiguration) —

    Specifies which worker configuration to use with the connector.

Returns:

See Also:



525
526
527
528
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 525

def create_connector(params = {}, options = {})
  req = build_request(:create_connector, params)
  req.send_request(options)
end

#create_custom_plugin(params = {}) ⇒ Types::CreateCustomPluginResponse

Creates a custom plugin using the specified properties.

Examples:

Request syntax with placeholder values


resp = client.create_custom_plugin({
  content_type: "JAR", # required, accepts JAR, ZIP
  description: "__stringMax1024",
  location: { # required
    s3_location: { # required
      bucket_arn: "__string", # required
      file_key: "__string", # required
      object_version: "__string",
    },
  },
  name: "__stringMin1Max128", # required
})

Response structure


resp.custom_plugin_arn #=> String
resp.custom_plugin_state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING"
resp.name #=> String
resp.revision #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :content_type (required, String) —

    The type of the plugin file.

  • :description (String) —

    A summary description of the custom plugin.

  • :location (required, Types::CustomPluginLocation) —

    Information about the location of a custom plugin.

  • :name (required, String) —

    The name of the custom plugin.

Returns:

See Also:



577
578
579
580
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 577

def create_custom_plugin(params = {}, options = {})
  req = build_request(:create_custom_plugin, params)
  req.send_request(options)
end

#create_worker_configuration(params = {}) ⇒ Types::CreateWorkerConfigurationResponse

Creates a worker configuration using the specified properties.

Examples:

Request syntax with placeholder values


resp = client.create_worker_configuration({
  description: "__stringMax1024",
  name: "__stringMin1Max128", # required
  properties_file_content: "__sensitiveString", # required
})

Response structure


resp.creation_time #=> Time
resp.latest_revision.creation_time #=> Time
resp.latest_revision.description #=> String
resp.latest_revision.revision #=> Integer
resp.name #=> String
resp.worker_configuration_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    A summary description of the worker configuration.

  • :name (required, String) —

    The name of the worker configuration.

  • :properties_file_content (required, String) —

    Base64 encoded contents of connect-distributed.properties file.

Returns:

See Also:



621
622
623
624
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 621

def create_worker_configuration(params = {}, options = {})
  req = build_request(:create_worker_configuration, params)
  req.send_request(options)
end

#delete_connector(params = {}) ⇒ Types::DeleteConnectorResponse

Deletes the specified connector.

Examples:

Request syntax with placeholder values


resp = client.delete_connector({
  connector_arn: "__string", # required
  current_version: "__string",
})

Response structure


resp.connector_arn #=> String
resp.connector_state #=> String, one of "RUNNING", "CREATING", "UPDATING", "DELETING", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :connector_arn (required, String) —

    The Amazon Resource Name (ARN) of the connector that you want to delete.

  • :current_version (String) —

    The current version of the connector that you want to delete.

Returns:

See Also:



656
657
658
659
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 656

def delete_connector(params = {}, options = {})
  req = build_request(:delete_connector, params)
  req.send_request(options)
end

#delete_custom_plugin(params = {}) ⇒ Types::DeleteCustomPluginResponse

Deletes a custom plugin.

Examples:

Request syntax with placeholder values


resp = client.delete_custom_plugin({
  custom_plugin_arn: "__string", # required
})

Response structure


resp.custom_plugin_arn #=> String
resp.custom_plugin_state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :custom_plugin_arn (required, String) —

    The Amazon Resource Name (ARN) of the custom plugin that you want to delete.

Returns:

See Also:



687
688
689
690
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 687

def delete_custom_plugin(params = {}, options = {})
  req = build_request(:delete_custom_plugin, params)
  req.send_request(options)
end

#describe_connector(params = {}) ⇒ Types::DescribeConnectorResponse

Returns summary information about the connector.

Examples:

Request syntax with placeholder values


resp = client.describe_connector({
  connector_arn: "__string", # required
})

Response structure


resp.capacity.auto_scaling.max_worker_count #=> Integer
resp.capacity.auto_scaling.mcu_count #=> Integer
resp.capacity.auto_scaling.min_worker_count #=> Integer
resp.capacity.auto_scaling.scale_in_policy.cpu_utilization_percentage #=> Integer
resp.capacity.auto_scaling.scale_out_policy.cpu_utilization_percentage #=> Integer
resp.capacity.provisioned_capacity.mcu_count #=> Integer
resp.capacity.provisioned_capacity.worker_count #=> Integer
resp.connector_arn #=> String
resp.connector_configuration #=> Hash
resp.connector_configuration["__string"] #=> String
resp.connector_description #=> String
resp.connector_name #=> String
resp.connector_state #=> String, one of "RUNNING", "CREATING", "UPDATING", "DELETING", "FAILED"
resp.creation_time #=> Time
resp.current_version #=> String
resp.kafka_cluster.apache_kafka_cluster.bootstrap_servers #=> String
resp.kafka_cluster.apache_kafka_cluster.vpc.security_groups #=> Array
resp.kafka_cluster.apache_kafka_cluster.vpc.security_groups[0] #=> String
resp.kafka_cluster.apache_kafka_cluster.vpc.subnets #=> Array
resp.kafka_cluster.apache_kafka_cluster.vpc.subnets[0] #=> String
resp.kafka_cluster_client_authentication.authentication_type #=> String, one of "NONE", "IAM"
resp.kafka_cluster_encryption_in_transit.encryption_type #=> String, one of "PLAINTEXT", "TLS"
resp.kafka_connect_version #=> String
resp.log_delivery.worker_log_delivery.cloud_watch_logs.enabled #=> Boolean
resp.log_delivery.worker_log_delivery.cloud_watch_logs.log_group #=> String
resp.log_delivery.worker_log_delivery.firehose.delivery_stream #=> String
resp.log_delivery.worker_log_delivery.firehose.enabled #=> Boolean
resp.log_delivery.worker_log_delivery.s3.bucket #=> String
resp.log_delivery.worker_log_delivery.s3.enabled #=> Boolean
resp.log_delivery.worker_log_delivery.s3.prefix #=> String
resp.plugins #=> Array
resp.plugins[0].custom_plugin.custom_plugin_arn #=> String
resp.plugins[0].custom_plugin.revision #=> Integer
resp.service_execution_role_arn #=> String
resp.state_description.code #=> String
resp.state_description.message #=> String
resp.worker_configuration.revision #=> Integer
resp.worker_configuration.worker_configuration_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :connector_arn (required, String) —

    The Amazon Resource Name (ARN) of the connector that you want to describe.

Returns:

See Also:



769
770
771
772
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 769

def describe_connector(params = {}, options = {})
  req = build_request(:describe_connector, params)
  req.send_request(options)
end

#describe_custom_plugin(params = {}) ⇒ Types::DescribeCustomPluginResponse

A summary description of the custom plugin.

Examples:

Request syntax with placeholder values


resp = client.describe_custom_plugin({
  custom_plugin_arn: "__string", # required
})

Response structure


resp.creation_time #=> Time
resp.custom_plugin_arn #=> String
resp.custom_plugin_state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING"
resp.description #=> String
resp.latest_revision.content_type #=> String, one of "JAR", "ZIP"
resp.latest_revision.creation_time #=> Time
resp.latest_revision.description #=> String
resp.latest_revision.file_description.file_md_5 #=> String
resp.latest_revision.file_description.file_size #=> Integer
resp.latest_revision.location.s3_location.bucket_arn #=> String
resp.latest_revision.location.s3_location.file_key #=> String
resp.latest_revision.location.s3_location.object_version #=> String
resp.latest_revision.revision #=> Integer
resp.name #=> String
resp.state_description.code #=> String
resp.state_description.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :custom_plugin_arn (required, String) —

    Returns information about a custom plugin.

Returns:

See Also:



818
819
820
821
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 818

def describe_custom_plugin(params = {}, options = {})
  req = build_request(:describe_custom_plugin, params)
  req.send_request(options)
end

#describe_worker_configuration(params = {}) ⇒ Types::DescribeWorkerConfigurationResponse

Returns information about a worker configuration.

Examples:

Request syntax with placeholder values


resp = client.describe_worker_configuration({
  worker_configuration_arn: "__string", # required
})

Response structure


resp.creation_time #=> Time
resp.description #=> String
resp.latest_revision.creation_time #=> Time
resp.latest_revision.description #=> String
resp.latest_revision.properties_file_content #=> String
resp.latest_revision.revision #=> Integer
resp.name #=> String
resp.worker_configuration_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :worker_configuration_arn (required, String) —

    The Amazon Resource Name (ARN) of the worker configuration that you want to get information about.

Returns:

See Also:



858
859
860
861
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 858

def describe_worker_configuration(params = {}, options = {})
  req = build_request(:describe_worker_configuration, params)
  req.send_request(options)
end

#list_connectors(params = {}) ⇒ Types::ListConnectorsResponse

Returns a list of all the connectors in this account and Region. The list is limited to connectors whose name starts with the specified prefix. The response also includes a description of each of the listed connectors.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_connectors({
  connector_name_prefix: "__string",
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.connectors #=> Array
resp.connectors[0].capacity.auto_scaling.max_worker_count #=> Integer
resp.connectors[0].capacity.auto_scaling.mcu_count #=> Integer
resp.connectors[0].capacity.auto_scaling.min_worker_count #=> Integer
resp.connectors[0].capacity.auto_scaling.scale_in_policy.cpu_utilization_percentage #=> Integer
resp.connectors[0].capacity.auto_scaling.scale_out_policy.cpu_utilization_percentage #=> Integer
resp.connectors[0].capacity.provisioned_capacity.mcu_count #=> Integer
resp.connectors[0].capacity.provisioned_capacity.worker_count #=> Integer
resp.connectors[0].connector_arn #=> String
resp.connectors[0].connector_description #=> String
resp.connectors[0].connector_name #=> String
resp.connectors[0].connector_state #=> String, one of "RUNNING", "CREATING", "UPDATING", "DELETING", "FAILED"
resp.connectors[0].creation_time #=> Time
resp.connectors[0].current_version #=> String
resp.connectors[0].kafka_cluster.apache_kafka_cluster.bootstrap_servers #=> String
resp.connectors[0].kafka_cluster.apache_kafka_cluster.vpc.security_groups #=> Array
resp.connectors[0].kafka_cluster.apache_kafka_cluster.vpc.security_groups[0] #=> String
resp.connectors[0].kafka_cluster.apache_kafka_cluster.vpc.subnets #=> Array
resp.connectors[0].kafka_cluster.apache_kafka_cluster.vpc.subnets[0] #=> String
resp.connectors[0].kafka_cluster_client_authentication.authentication_type #=> String, one of "NONE", "IAM"
resp.connectors[0].kafka_cluster_encryption_in_transit.encryption_type #=> String, one of "PLAINTEXT", "TLS"
resp.connectors[0].kafka_connect_version #=> String
resp.connectors[0].log_delivery.worker_log_delivery.cloud_watch_logs.enabled #=> Boolean
resp.connectors[0].log_delivery.worker_log_delivery.cloud_watch_logs.log_group #=> String
resp.connectors[0].log_delivery.worker_log_delivery.firehose.delivery_stream #=> String
resp.connectors[0].log_delivery.worker_log_delivery.firehose.enabled #=> Boolean
resp.connectors[0].log_delivery.worker_log_delivery.s3.bucket #=> String
resp.connectors[0].log_delivery.worker_log_delivery.s3.enabled #=> Boolean
resp.connectors[0].log_delivery.worker_log_delivery.s3.prefix #=> String
resp.connectors[0].plugins #=> Array
resp.connectors[0].plugins[0].custom_plugin.custom_plugin_arn #=> String
resp.connectors[0].plugins[0].custom_plugin.revision #=> Integer
resp.connectors[0].service_execution_role_arn #=> String
resp.connectors[0].worker_configuration.revision #=> Integer
resp.connectors[0].worker_configuration.worker_configuration_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :connector_name_prefix (String) —

    The name prefix that you want to use to search for and list connectors.

  • :max_results (Integer) —

    The maximum number of connectors to list in one response.

  • :next_token (String) —

    If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

Returns:

See Also:



938
939
940
941
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 938

def list_connectors(params = {}, options = {})
  req = build_request(:list_connectors, params)
  req.send_request(options)
end

#list_custom_plugins(params = {}) ⇒ Types::ListCustomPluginsResponse

Returns a list of all of the custom plugins in this account and Region.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_custom_plugins({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.custom_plugins #=> Array
resp.custom_plugins[0].creation_time #=> Time
resp.custom_plugins[0].custom_plugin_arn #=> String
resp.custom_plugins[0].custom_plugin_state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING"
resp.custom_plugins[0].description #=> String
resp.custom_plugins[0].latest_revision.content_type #=> String, one of "JAR", "ZIP"
resp.custom_plugins[0].latest_revision.creation_time #=> Time
resp.custom_plugins[0].latest_revision.description #=> String
resp.custom_plugins[0].latest_revision.file_description.file_md_5 #=> String
resp.custom_plugins[0].latest_revision.file_description.file_size #=> Integer
resp.custom_plugins[0].latest_revision.location.s3_location.bucket_arn #=> String
resp.custom_plugins[0].latest_revision.location.s3_location.file_key #=> String
resp.custom_plugins[0].latest_revision.location.s3_location.object_version #=> String
resp.custom_plugins[0].latest_revision.revision #=> Integer
resp.custom_plugins[0].name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of custom plugins to list in one response.

  • :next_token (String) —

    If the response of a ListCustomPlugins operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

Returns:

See Also:



991
992
993
994
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 991

def list_custom_plugins(params = {}, options = {})
  req = build_request(:list_custom_plugins, params)
  req.send_request(options)
end

#list_worker_configurations(params = {}) ⇒ Types::ListWorkerConfigurationsResponse

Returns a list of all of the worker configurations in this account and Region.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_worker_configurations({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.next_token #=> String
resp.worker_configurations #=> Array
resp.worker_configurations[0].creation_time #=> Time
resp.worker_configurations[0].description #=> String
resp.worker_configurations[0].latest_revision.creation_time #=> Time
resp.worker_configurations[0].latest_revision.description #=> String
resp.worker_configurations[0].latest_revision.revision #=> Integer
resp.worker_configurations[0].name #=> String
resp.worker_configurations[0].worker_configuration_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of worker configurations to list in one response.

  • :next_token (String) —

    If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

Returns:

See Also:



1038
1039
1040
1041
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 1038

def list_worker_configurations(params = {}, options = {})
  req = build_request(:list_worker_configurations, params)
  req.send_request(options)
end

#update_connector(params = {}) ⇒ Types::UpdateConnectorResponse

Updates the specified connector.

Examples:

Request syntax with placeholder values


resp = client.update_connector({
  capacity: { # required
    auto_scaling: {
      max_worker_count: 1, # required
      mcu_count: 1, # required
      min_worker_count: 1, # required
      scale_in_policy: { # required
        cpu_utilization_percentage: 1, # required
      },
      scale_out_policy: { # required
        cpu_utilization_percentage: 1, # required
      },
    },
    provisioned_capacity: {
      mcu_count: 1, # required
      worker_count: 1, # required
    },
  },
  connector_arn: "__string", # required
  current_version: "__string", # required
})

Response structure


resp.connector_arn #=> String
resp.connector_state #=> String, one of "RUNNING", "CREATING", "UPDATING", "DELETING", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :capacity (required, Types::CapacityUpdate) —

    The target capacity.

  • :connector_arn (required, String) —

    The Amazon Resource Name (ARN) of the connector that you want to update.

  • :current_version (required, String) —

    The current version of the connector that you want to update.

Returns:

See Also:



1093
1094
1095
1096
 
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 1093

def update_connector(params = {}, options = {})
  req = build_request(:update_connector, params)
  req.send_request(options)
end