All Downloads are FREE. Search and download functionalities are using the official Maven repository.

connectors.camel-aws-kinesis-source-source.json Maven / Gradle / Ivy

{
	"connector": {
		"class": "org.apache.camel.kafkaconnector.awskinesissource.CamelAwskinesissourceSourceConnector",
		"artifactId": "camel-aws-kinesis-source-kafka-connector",
		"groupId": "org.apache.camel.kafkaconnector",
		"id": "camel-aws-kinesis-source-source",
		"type": "source",
		"version": "4.8.0",
		"description": "Receive data from AWS Kinesis.\n\nThe basic authentication method for the Kinesis service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider.\n\nIf you use the default credentials provider, the Kinesis client loads the credentials through this provider and doesn't use the basic authentication method.\n\nTwo headers will be duplicated with different names for clarity at sink level, CamelAwsKinesisPartitionKey will be duplicated into aws.kinesis.partition.key and CamelAwsKinesisSequenceNumber will be duplicated in aws.kinesis.sequence.number"
	},
	"properties": {
		"camel.kamelet.aws-kinesis-source.stream": {
			"name": "camel.kamelet.aws-kinesis-source.stream",
			"description": "The Kinesis stream that you want to access. The Kinesis stream that you specify must already exist.",
			"priority": "HIGH",
			"required": "true"
		},
		"camel.kamelet.aws-kinesis-source.accessKey": {
			"name": "camel.kamelet.aws-kinesis-source.accessKey",
			"description": "The access key obtained from AWS.",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.kamelet.aws-kinesis-source.secretKey": {
			"name": "camel.kamelet.aws-kinesis-source.secretKey",
			"description": "The secret key obtained from AWS.",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.kamelet.aws-kinesis-source.region": {
			"name": "camel.kamelet.aws-kinesis-source.region",
			"description": "The AWS region to access.",
			"priority": "HIGH",
			"required": "true"
		},
		"camel.kamelet.aws-kinesis-source.useDefaultCredentialsProvider": {
			"name": "camel.kamelet.aws-kinesis-source.useDefaultCredentialsProvider",
			"description": "If true, the Kinesis client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key).",
			"defaultValue": "false",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.kamelet.aws-kinesis-source.useProfileCredentialsProvider": {
			"name": "camel.kamelet.aws-kinesis-source.useProfileCredentialsProvider",
			"description": "Set whether the Kinesis client should expect to load credentials through a profile credentials provider.",
			"defaultValue": "false",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.kamelet.aws-kinesis-source.useSessionCredentials": {
			"name": "camel.kamelet.aws-kinesis-source.useSessionCredentials",
			"description": "Set whether the Kinesis client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in Kinesis.",
			"defaultValue": "false",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.kamelet.aws-kinesis-source.profileCredentialsName": {
			"name": "camel.kamelet.aws-kinesis-source.profileCredentialsName",
			"description": "If using a profile credentials provider this parameter will set the profile name.",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.kamelet.aws-kinesis-source.sessionToken": {
			"name": "camel.kamelet.aws-kinesis-source.sessionToken",
			"description": "Amazon AWS Session Token used when the user needs to assume a IAM role.",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.kamelet.aws-kinesis-source.uriEndpointOverride": {
			"name": "camel.kamelet.aws-kinesis-source.uriEndpointOverride",
			"description": "The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option.",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.kamelet.aws-kinesis-source.overrideEndpoint": {
			"name": "camel.kamelet.aws-kinesis-source.overrideEndpoint",
			"description": "Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option.",
			"defaultValue": "false",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.kamelet.aws-kinesis-source.delay": {
			"name": "camel.kamelet.aws-kinesis-source.delay",
			"description": "The number of milliseconds before the next poll of the selected stream.",
			"defaultValue": "500",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.kamelet.aws-kinesis-source.asyncClient": {
			"name": "camel.kamelet.aws-kinesis-source.asyncClient",
			"description": "If we want to a KinesisAsyncClient instance set it to true.",
			"defaultValue": "false",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.kamelet.aws-kinesis-source.useKclConsumers": {
			"name": "camel.kamelet.aws-kinesis-source.useKclConsumers",
			"description": "If we want to a KCL Consumer set it to true",
			"defaultValue": "false",
			"priority": "MEDIUM",
			"required": "false"
		}
	}
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy