com.amazonaws.services.kafkaconnect.model

Class CreateConnectorRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kafkaconnect.model.CreateConnectorRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateConnectorRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateConnectorRequest()

Method Summary

Modifier and Type	Method and Description
CreateConnectorRequest	addConnectorConfigurationEntry(String key, String value) Add a single ConnectorConfiguration entry
CreateConnectorRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateConnectorRequest	clearConnectorConfigurationEntries() Removes all the entries added into ConnectorConfiguration.
CreateConnectorRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateConnectorRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Capacity	getCapacity() Information about the capacity allocated to the connector.
Map<String,String>	getConnectorConfiguration() A map of keys to values that represent the configuration for the connector.
String	getConnectorDescription() A summary description of the connector.
String	getConnectorName() The name of the connector.
KafkaCluster	getKafkaCluster() Specifies which Apache Kafka cluster to connect to.
KafkaClusterClientAuthentication	getKafkaClusterClientAuthentication() Details of the client authentication used by the Apache Kafka cluster.
KafkaClusterEncryptionInTransit	getKafkaClusterEncryptionInTransit() Details of encryption in transit to the Apache Kafka cluster.
String	getKafkaConnectVersion() The version of Kafka Connect.
LogDelivery	getLogDelivery() Details about log delivery.
List<Plugin>	getPlugins()
String	getServiceExecutionRoleArn() The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs.
Map<String,String>	getTags() The tags you want to attach to the connector.
WorkerConfiguration	getWorkerConfiguration() Specifies which worker configuration to use with the connector.
int	hashCode()
void	setCapacity(Capacity capacity) Information about the capacity allocated to the connector.
void	setConnectorConfiguration(Map<String,String> connectorConfiguration) A map of keys to values that represent the configuration for the connector.
void	setConnectorDescription(String connectorDescription) A summary description of the connector.
void	setConnectorName(String connectorName) The name of the connector.
void	setKafkaCluster(KafkaCluster kafkaCluster) Specifies which Apache Kafka cluster to connect to.
void	setKafkaClusterClientAuthentication(KafkaClusterClientAuthentication kafkaClusterClientAuthentication) Details of the client authentication used by the Apache Kafka cluster.
void	setKafkaClusterEncryptionInTransit(KafkaClusterEncryptionInTransit kafkaClusterEncryptionInTransit) Details of encryption in transit to the Apache Kafka cluster.
void	setKafkaConnectVersion(String kafkaConnectVersion) The version of Kafka Connect.
void	setLogDelivery(LogDelivery logDelivery) Details about log delivery.
void	setPlugins(Collection<Plugin> plugins)
void	setServiceExecutionRoleArn(String serviceExecutionRoleArn) The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs.
void	setTags(Map<String,String> tags) The tags you want to attach to the connector.
void	setWorkerConfiguration(WorkerConfiguration workerConfiguration) Specifies which worker configuration to use with the connector.
String	toString() Returns a string representation of this object.
CreateConnectorRequest	withCapacity(Capacity capacity) Information about the capacity allocated to the connector.
CreateConnectorRequest	withConnectorConfiguration(Map<String,String> connectorConfiguration) A map of keys to values that represent the configuration for the connector.
CreateConnectorRequest	withConnectorDescription(String connectorDescription) A summary description of the connector.
CreateConnectorRequest	withConnectorName(String connectorName) The name of the connector.
CreateConnectorRequest	withKafkaCluster(KafkaCluster kafkaCluster) Specifies which Apache Kafka cluster to connect to.
CreateConnectorRequest	withKafkaClusterClientAuthentication(KafkaClusterClientAuthentication kafkaClusterClientAuthentication) Details of the client authentication used by the Apache Kafka cluster.
CreateConnectorRequest	withKafkaClusterEncryptionInTransit(KafkaClusterEncryptionInTransit kafkaClusterEncryptionInTransit) Details of encryption in transit to the Apache Kafka cluster.
CreateConnectorRequest	withKafkaConnectVersion(String kafkaConnectVersion) The version of Kafka Connect.
CreateConnectorRequest	withLogDelivery(LogDelivery logDelivery) Details about log delivery.
CreateConnectorRequest	withPlugins(Collection<Plugin> plugins)
CreateConnectorRequest	withPlugins(Plugin... plugins)
CreateConnectorRequest	withServiceExecutionRoleArn(String serviceExecutionRoleArn) The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs.
CreateConnectorRequest	withTags(Map<String,String> tags) The tags you want to attach to the connector.
CreateConnectorRequest	withWorkerConfiguration(WorkerConfiguration workerConfiguration) Specifies which worker configuration to use with the connector.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateConnectorRequest

public CreateConnectorRequest()

Method Detail

setCapacity

public void setCapacity(Capacity capacity)

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

Parameters:

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

getCapacity

public Capacity getCapacity()

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

Returns:

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

withCapacity

public CreateConnectorRequest withCapacity(Capacity capacity)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getConnectorConfiguration

public Map<String,String> getConnectorConfiguration()

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

Returns:

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

setConnectorConfiguration

public void setConnectorConfiguration(Map<String,String> connectorConfiguration)

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

Parameters:

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

withConnectorConfiguration

public CreateConnectorRequest withConnectorConfiguration(Map<String,String> connectorConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

addConnectorConfigurationEntry

public CreateConnectorRequest addConnectorConfigurationEntry(String key,
                                                             String value)

Add a single ConnectorConfiguration entry

See Also:

withConnectorConfiguration(java.util.Map<java.lang.String, java.lang.String>)

clearConnectorConfigurationEntries

public CreateConnectorRequest clearConnectorConfigurationEntries()

Removes all the entries added into ConnectorConfiguration.

Returns:

Returns a reference to this object so that method calls can be chained together.

setConnectorDescription

public void setConnectorDescription(String connectorDescription)

A summary description of the connector.

Parameters:

connectorDescription - A summary description of the connector.

getConnectorDescription

public String getConnectorDescription()

A summary description of the connector.

Returns:

A summary description of the connector.

withConnectorDescription

public CreateConnectorRequest withConnectorDescription(String connectorDescription)

A summary description of the connector.

Parameters:

connectorDescription - A summary description of the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

setConnectorName

public void setConnectorName(String connectorName)

The name of the connector.

Parameters:

connectorName - The name of the connector.

getConnectorName

public String getConnectorName()

The name of the connector.

Returns:

The name of the connector.

withConnectorName

public CreateConnectorRequest withConnectorName(String connectorName)

The name of the connector.

Parameters:

connectorName - The name of the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

setKafkaCluster

public void setKafkaCluster(KafkaCluster kafkaCluster)

Specifies which Apache Kafka cluster to connect to.

Parameters:

kafkaCluster - Specifies which Apache Kafka cluster to connect to.

getKafkaCluster

public KafkaCluster getKafkaCluster()

Specifies which Apache Kafka cluster to connect to.

Returns:

Specifies which Apache Kafka cluster to connect to.

withKafkaCluster

public CreateConnectorRequest withKafkaCluster(KafkaCluster kafkaCluster)

Specifies which Apache Kafka cluster to connect to.

Parameters:

kafkaCluster - Specifies which Apache Kafka cluster to connect to.

Returns:

Returns a reference to this object so that method calls can be chained together.

setKafkaClusterClientAuthentication

public void setKafkaClusterClientAuthentication(KafkaClusterClientAuthentication kafkaClusterClientAuthentication)

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

Parameters:

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

getKafkaClusterClientAuthentication

public KafkaClusterClientAuthentication getKafkaClusterClientAuthentication()

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

Returns:

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

withKafkaClusterClientAuthentication

public CreateConnectorRequest withKafkaClusterClientAuthentication(KafkaClusterClientAuthentication kafkaClusterClientAuthentication)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setKafkaClusterEncryptionInTransit

public void setKafkaClusterEncryptionInTransit(KafkaClusterEncryptionInTransit kafkaClusterEncryptionInTransit)

Details of encryption in transit to the Apache Kafka cluster.

Parameters:

kafkaClusterEncryptionInTransit - Details of encryption in transit to the Apache Kafka cluster.

getKafkaClusterEncryptionInTransit

public KafkaClusterEncryptionInTransit getKafkaClusterEncryptionInTransit()

Details of encryption in transit to the Apache Kafka cluster.

Returns:

Details of encryption in transit to the Apache Kafka cluster.

withKafkaClusterEncryptionInTransit

public CreateConnectorRequest withKafkaClusterEncryptionInTransit(KafkaClusterEncryptionInTransit kafkaClusterEncryptionInTransit)

Details of encryption in transit to the Apache Kafka cluster.

Parameters:

kafkaClusterEncryptionInTransit - Details of encryption in transit to the Apache Kafka cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

setKafkaConnectVersion

public void setKafkaConnectVersion(String kafkaConnectVersion)

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

Parameters:

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

getKafkaConnectVersion

public String getKafkaConnectVersion()

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

Returns:

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

withKafkaConnectVersion

public CreateConnectorRequest withKafkaConnectVersion(String kafkaConnectVersion)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setLogDelivery

public void setLogDelivery(LogDelivery logDelivery)

Details about log delivery.

Parameters:

logDelivery - Details about log delivery.

getLogDelivery

public LogDelivery getLogDelivery()

Details about log delivery.

Returns:

Details about log delivery.

withLogDelivery

public CreateConnectorRequest withLogDelivery(LogDelivery logDelivery)

Details about log delivery.

Parameters:

logDelivery - Details about log delivery.

Returns:

Returns a reference to this object so that method calls can be chained together.

getPlugins

public List<Plugin> getPlugins()

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:

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.

setPlugins

public void setPlugins(Collection<Plugin> plugins)

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.

Parameters:

plugins -

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.

withPlugins

public CreateConnectorRequest withPlugins(Plugin... plugins)

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.

NOTE: This method appends the values to the existing list (if any). Use setPlugins(java.util.Collection) or withPlugins(java.util.Collection) if you want to override the existing values.

Parameters:

plugins -

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:

Returns a reference to this object so that method calls can be chained together.

withPlugins

public CreateConnectorRequest withPlugins(Collection<Plugin> plugins)

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.

Parameters:

plugins -

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:

Returns a reference to this object so that method calls can be chained together.

setServiceExecutionRoleArn

public void setServiceExecutionRoleArn(String serviceExecutionRoleArn)

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.

Parameters:

serviceExecutionRoleArn - 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.

getServiceExecutionRoleArn

public String getServiceExecutionRoleArn()

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:

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.

withServiceExecutionRoleArn

public CreateConnectorRequest withServiceExecutionRoleArn(String serviceExecutionRoleArn)

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.

Parameters:

serviceExecutionRoleArn - 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:

Returns a reference to this object so that method calls can be chained together.

getTags

public Map<String,String> getTags()

The tags you want to attach to the connector.

Returns:

The tags you want to attach to the connector.

setTags

public void setTags(Map<String,String> tags)

The tags you want to attach to the connector.

Parameters:

tags - The tags you want to attach to the connector.

withTags

public CreateConnectorRequest withTags(Map<String,String> tags)

The tags you want to attach to the connector.

Parameters:

tags - The tags you want to attach to the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public CreateConnectorRequest addTagsEntry(String key,
                                           String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateConnectorRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

setWorkerConfiguration

public void setWorkerConfiguration(WorkerConfiguration workerConfiguration)

Specifies which worker configuration to use with the connector.

Parameters:

workerConfiguration - Specifies which worker configuration to use with the connector.

getWorkerConfiguration

public WorkerConfiguration getWorkerConfiguration()

Specifies which worker configuration to use with the connector.

Returns:

Specifies which worker configuration to use with the connector.

withWorkerConfiguration

public CreateConnectorRequest withWorkerConfiguration(WorkerConfiguration workerConfiguration)

Specifies which worker configuration to use with the connector.

Parameters:

workerConfiguration - Specifies which worker configuration to use with the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateConnectorRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()