aws2-kinesis-firehose/component.json

1079 lines
38 KiB
JSON
Raw Permalink Normal View History

{
"component": {
"kind": "component",
"name": "aws2-kinesis-firehose",
"title": "AWS Kinesis Firehose",
"description": "Produce data to AWS Kinesis Firehose streams.",
"deprecated": false,
"firstVersion": "1.1.0",
"label": "cloud,messaging",
"javaType": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Component",
"supportLevel": "Stable",
"nativeSupported": true,
"metadata": {
"quarkusVersion": "3.36.0",
"camelArtifact": "org.apache.camel:camel-aws2-kinesis",
"camelVersion": "4.20.0"
},
"groupId": "org.apache.camel.quarkus",
"artifactId": "camel-quarkus-aws2-kinesis",
"version": "4.20.0 (CEQ 3.36.0)",
"scheme": "aws2-kinesis-firehose",
"extendsScheme": "",
"syntax": "aws2-kinesis-firehose:streamName",
"async": false,
"api": false,
"consumerOnly": false,
"producerOnly": true,
"lenientProperties": false,
"browsable": false,
"remote": true
},
"componentProperties": {
"cborEnabled": {
"index": 0,
"kind": "property",
"displayName": "Cbor Enabled",
"group": "common",
"label": "common",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "This option will set the CBOR_ENABLED property during the execution"
},
"configuration": {
"index": 1,
"kind": "property",
"displayName": "Configuration",
"group": "producer",
"label": "",
"required": false,
"type": "object",
"javaType": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"deprecated": false,
"autowired": false,
"secret": false,
"description": "Component configuration"
},
"overrideEndpoint": {
"index": 2,
"kind": "property",
"displayName": "Override Endpoint",
"group": "common",
"label": "common",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option"
},
"lazyStartProducer": {
"index": 3,
"kind": "property",
"displayName": "Lazy Start Producer",
"group": "producer",
"label": "producer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing."
},
"operation": {
"index": 4,
"kind": "property",
"displayName": "Operation",
"group": "producer",
"label": "producer",
"required": false,
"type": "enum",
"javaType": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Operations",
"enum": [
"sendBatchRecord",
"createDeliveryStream",
"deleteDeliveryStream",
"describeDeliveryStream",
"updateDestination"
],
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "The operation to do in case the user don't want to send only a record"
},
"region": {
"index": 5,
"kind": "property",
"displayName": "Region",
"group": "producer",
"label": "",
"required": false,
"type": "enum",
"javaType": "java.lang.String",
"enum": [
"ap-south-2",
"ap-south-1",
"eu-south-1",
"eu-south-2",
"us-gov-east-1",
"me-central-1",
"il-central-1",
"ca-central-1",
"eu-central-1",
"us-iso-west-1",
"eu-central-2",
"eu-isoe-west-1",
"us-west-1",
"us-west-2",
"af-south-1",
"eu-north-1",
"eu-west-3",
"eu-west-2",
"eu-west-1",
"ap-northeast-3",
"ap-northeast-2",
"ap-northeast-1",
"me-south-1",
"sa-east-1",
"ap-east-1",
"cn-north-1",
"ca-west-1",
"us-gov-west-1",
"ap-southeast-1",
"ap-southeast-2",
"us-iso-east-1",
"ap-southeast-3",
"ap-southeast-4",
"us-east-1",
"us-east-2",
"cn-northwest-1",
"us-isob-east-1",
"aws-global",
"aws-cn-global",
"aws-us-gov-global",
"aws-iso-global",
"aws-iso-b-global"
],
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "The region in which Kinesis Firehose client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"
},
"uriEndpointOverride": {
"index": 6,
"kind": "property",
"displayName": "Uri Endpoint Override",
"group": "common",
"label": "common",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"
},
"useDefaultCredentialsProvider": {
"index": 7,
"kind": "property",
"displayName": "Use Default Credentials Provider",
"group": "common",
"label": "common",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "Set whether the Kinesis Firehose client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."
},
"amazonKinesisFirehoseClient": {
"index": 8,
"kind": "property",
"displayName": "Amazon Kinesis Firehose Client",
"group": "advanced",
"label": "advanced",
"required": false,
"type": "object",
"javaType": "software.amazon.awssdk.services.firehose.FirehoseClient",
"deprecated": false,
"deprecationNote": "",
"autowired": true,
"secret": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "Amazon Kinesis Firehose client to use for all requests for this endpoint"
},
"autowiredEnabled": {
"index": 9,
"kind": "property",
"displayName": "Autowired Enabled",
"group": "advanced",
"label": "advanced",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc."
},
"proxyHost": {
"index": 10,
"kind": "property",
"displayName": "Proxy Host",
"group": "proxy",
"label": "proxy",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "To define a proxy host when instantiating the Kinesis Firehose client"
},
"proxyPort": {
"index": 11,
"kind": "property",
"displayName": "Proxy Port",
"group": "proxy",
"label": "proxy",
"required": false,
"type": "integer",
"javaType": "java.lang.Integer",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "To define a proxy port when instantiating the Kinesis Firehose client"
},
"proxyProtocol": {
"index": 12,
"kind": "property",
"displayName": "Proxy Protocol",
"group": "proxy",
"label": "proxy",
"required": false,
"type": "enum",
"javaType": "software.amazon.awssdk.core.Protocol",
"enum": [
"HTTP",
"HTTPS"
],
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": "HTTPS",
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "To define a proxy protocol when instantiating the Kinesis Firehose client"
},
"accessKey": {
"index": 13,
"kind": "property",
"displayName": "Access Key",
"group": "security",
"label": "security",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": true,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "Amazon AWS Access Key"
},
"profileCredentialsName": {
"index": 14,
"kind": "property",
"displayName": "Profile Credentials Name",
"group": "security",
"label": "security",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "If using a profile credentials provider this parameter will set the profile name."
},
"secretKey": {
"index": 15,
"kind": "property",
"displayName": "Secret Key",
"group": "security",
"label": "security",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": true,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "Amazon AWS Secret Key"
},
"sessionToken": {
"index": 16,
"kind": "property",
"displayName": "Session Token",
"group": "security",
"label": "security",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": true,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "Amazon AWS Session Token used when the user needs to assume a IAM role"
},
"trustAllCertificates": {
"index": 17,
"kind": "property",
"displayName": "Trust All Certificates",
"group": "security",
"label": "security",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "If we want to trust all certificates in case of overriding the endpoint"
},
"useProfileCredentialsProvider": {
"index": 18,
"kind": "property",
"displayName": "Use Profile Credentials Provider",
"group": "security",
"label": "security",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "Set whether the Kinesis Firehose client should expect to load credentials through a profile credentials provider."
},
"useSessionCredentials": {
"index": 19,
"kind": "property",
"displayName": "Use Session Credentials",
"group": "security",
"label": "security",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "Set whether the Kinesis Firehose 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 Firehose."
}
},
"headers": {
"CamelAwsKinesisFirehoseRecordId": {
"index": 0,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The record ID, as defined in http://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecord.html#API_PutRecord_ResponseSyntaxResponse Syntax",
"constantName": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Constants#RECORD_ID"
},
"CamelAwsKinesisFirehoseOperation": {
"index": 1,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The operation we want to perform",
"constantName": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Constants#KINESIS_FIREHOSE_OPERATION"
},
"CamelAwsKinesisFirehoseDeliveryStreamName": {
"index": 2,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The name of the delivery stream.",
"constantName": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Constants#KINESIS_FIREHOSE_STREAM_NAME"
},
"CamelAwsKinesisFirehoseDeliveryStreamArn": {
"index": 3,
"kind": "header",
"displayName": "",
"group": "createDeliveryStream",
"label": "createDeliveryStream",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The ARN of the delivery stream.",
"constantName": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Constants#DELIVERY_STREAM_ARN"
},
"CamelAwsKinesisFirehoseFailedRecordCount": {
"index": 4,
"kind": "header",
"displayName": "",
"group": "sendBatchRecord",
"label": "sendBatchRecord",
"required": false,
"javaType": "Integer",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The number of records that failed in a batch put operation.",
"constantName": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Constants#FAILED_RECORD_COUNT"
},
"CamelAwsKinesisFirehoseEncrypted": {
"index": 5,
"kind": "header",
"displayName": "",
"group": "sendBatchRecord",
"label": "sendBatchRecord",
"required": false,
"javaType": "Boolean",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Whether the batch operation was encrypted.",
"constantName": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Constants#ENCRYPTED"
},
"CamelAwsKinesisFirehoseDeliveryStreamStatus": {
"index": 6,
"kind": "header",
"displayName": "",
"group": "describeDeliveryStream",
"label": "describeDeliveryStream",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The status of the delivery stream.",
"constantName": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Constants#DELIVERY_STREAM_STATUS"
}
},
"properties": {
"streamName": {
"index": 0,
"kind": "path",
"displayName": "Stream Name",
"group": "producer",
"label": "",
"required": true,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "Name of the stream"
},
"cborEnabled": {
"index": 1,
"kind": "parameter",
"displayName": "Cbor Enabled",
"group": "common",
"label": "common",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "This option will set the CBOR_ENABLED property during the execution"
},
"overrideEndpoint": {
"index": 2,
"kind": "parameter",
"displayName": "Override Endpoint",
"group": "common",
"label": "common",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option"
},
"uriEndpointOverride": {
"index": 3,
"kind": "parameter",
"displayName": "Uri Endpoint Override",
"group": "common",
"label": "common",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"
},
"operation": {
"index": 4,
"kind": "parameter",
"displayName": "Operation",
"group": "producer",
"label": "producer",
"required": false,
"type": "enum",
"javaType": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Operations",
"enum": [
"sendBatchRecord",
"createDeliveryStream",
"deleteDeliveryStream",
"describeDeliveryStream",
"updateDestination"
],
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "The operation to do in case the user don't want to send only a record"
},
"region": {
"index": 5,
"kind": "parameter",
"displayName": "Region",
"group": "producer",
"label": "",
"required": false,
"type": "enum",
"javaType": "java.lang.String",
"enum": [
"ap-south-2",
"ap-south-1",
"eu-south-1",
"eu-south-2",
"us-gov-east-1",
"me-central-1",
"il-central-1",
"ca-central-1",
"eu-central-1",
"us-iso-west-1",
"eu-central-2",
"eu-isoe-west-1",
"us-west-1",
"us-west-2",
"af-south-1",
"eu-north-1",
"eu-west-3",
"eu-west-2",
"eu-west-1",
"ap-northeast-3",
"ap-northeast-2",
"ap-northeast-1",
"me-south-1",
"sa-east-1",
"ap-east-1",
"cn-north-1",
"ca-west-1",
"us-gov-west-1",
"ap-southeast-1",
"ap-southeast-2",
"us-iso-east-1",
"ap-southeast-3",
"ap-southeast-4",
"us-east-1",
"us-east-2",
"cn-northwest-1",
"us-isob-east-1",
"aws-global",
"aws-cn-global",
"aws-us-gov-global",
"aws-iso-global",
"aws-iso-b-global"
],
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "The region in which Kinesis Firehose client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"
},
"useDefaultCredentialsProvider": {
"index": 6,
"kind": "parameter",
"displayName": "Use Default Credentials Provider",
"group": "common",
"label": "common",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "Set whether the Kinesis Firehose client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."
},
"lazyStartProducer": {
"index": 7,
"kind": "parameter",
"displayName": "Lazy Start Producer",
"group": "producer (advanced)",
"label": "producer,advanced",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing."
},
"amazonKinesisFirehoseClient": {
"index": 8,
"kind": "parameter",
"displayName": "Amazon Kinesis Firehose Client",
"group": "advanced",
"label": "advanced",
"required": false,
"type": "object",
"javaType": "software.amazon.awssdk.services.firehose.FirehoseClient",
"deprecated": false,
"deprecationNote": "",
"autowired": true,
"secret": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "Amazon Kinesis Firehose client to use for all requests for this endpoint"
},
"proxyHost": {
"index": 9,
"kind": "parameter",
"displayName": "Proxy Host",
"group": "proxy",
"label": "proxy",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "To define a proxy host when instantiating the Kinesis Firehose client"
},
"proxyPort": {
"index": 10,
"kind": "parameter",
"displayName": "Proxy Port",
"group": "proxy",
"label": "proxy",
"required": false,
"type": "integer",
"javaType": "java.lang.Integer",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "To define a proxy port when instantiating the Kinesis Firehose client"
},
"proxyProtocol": {
"index": 11,
"kind": "parameter",
"displayName": "Proxy Protocol",
"group": "proxy",
"label": "proxy",
"required": false,
"type": "enum",
"javaType": "software.amazon.awssdk.core.Protocol",
"enum": [
"HTTP",
"HTTPS"
],
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": "HTTPS",
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "To define a proxy protocol when instantiating the Kinesis Firehose client"
},
"accessKey": {
"index": 12,
"kind": "parameter",
"displayName": "Access Key",
"group": "security",
"label": "security",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": true,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "Amazon AWS Access Key"
},
"profileCredentialsName": {
"index": 13,
"kind": "parameter",
"displayName": "Profile Credentials Name",
"group": "security",
"label": "security",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "If using a profile credentials provider this parameter will set the profile name."
},
"secretKey": {
"index": 14,
"kind": "parameter",
"displayName": "Secret Key",
"group": "security",
"label": "security",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": true,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "Amazon AWS Secret Key"
},
"sessionToken": {
"index": 15,
"kind": "parameter",
"displayName": "Session Token",
"group": "security",
"label": "security",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": true,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "Amazon AWS Session Token used when the user needs to assume a IAM role"
},
"trustAllCertificates": {
"index": 16,
"kind": "parameter",
"displayName": "Trust All Certificates",
"group": "security",
"label": "security",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "If we want to trust all certificates in case of overriding the endpoint"
},
"useProfileCredentialsProvider": {
"index": 17,
"kind": "parameter",
"displayName": "Use Profile Credentials Provider",
"group": "security",
"label": "security",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "Set whether the Kinesis Firehose client should expect to load credentials through a profile credentials provider."
},
"useSessionCredentials": {
"index": 18,
"kind": "parameter",
"displayName": "Use Session Credentials",
"group": "security",
"label": "security",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration",
"description": "Set whether the Kinesis Firehose 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 Firehose."
}
},
"propertiesSchema": {
"properties": {
"streamName": {
"title": "Stream Name",
"description": "Name of the stream",
"type": "string",
"$comment": "group:producer"
},
"cborEnabled": {
"title": "Cbor Enabled",
"description": "This option will set the CBOR_ENABLED property during the execution",
"type": "boolean",
"$comment": "group:common",
"default": true
},
"overrideEndpoint": {
"title": "Override Endpoint",
"description": "Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option",
"type": "boolean",
"$comment": "group:common",
"default": false
},
"uriEndpointOverride": {
"title": "Uri Endpoint Override",
"description": "Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option",
"type": "string",
"$comment": "group:common"
},
"operation": {
"title": "Operation",
"description": "The operation to do in case the user don't want to send only a record",
"type": "string",
"enum": [
"sendBatchRecord",
"createDeliveryStream",
"deleteDeliveryStream",
"describeDeliveryStream",
"updateDestination"
],
"$comment": "group:producer"
},
"region": {
"title": "Region",
"description": "The region in which Kinesis Firehose client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id()",
"type": "string",
"enum": [
"ap-south-2",
"ap-south-1",
"eu-south-1",
"eu-south-2",
"us-gov-east-1",
"me-central-1",
"il-central-1",
"ca-central-1",
"eu-central-1",
"us-iso-west-1",
"eu-central-2",
"eu-isoe-west-1",
"us-west-1",
"us-west-2",
"af-south-1",
"eu-north-1",
"eu-west-3",
"eu-west-2",
"eu-west-1",
"ap-northeast-3",
"ap-northeast-2",
"ap-northeast-1",
"me-south-1",
"sa-east-1",
"ap-east-1",
"cn-north-1",
"ca-west-1",
"us-gov-west-1",
"ap-southeast-1",
"ap-southeast-2",
"us-iso-east-1",
"ap-southeast-3",
"ap-southeast-4",
"us-east-1",
"us-east-2",
"cn-northwest-1",
"us-isob-east-1",
"aws-global",
"aws-cn-global",
"aws-us-gov-global",
"aws-iso-global",
"aws-iso-b-global"
],
"$comment": "group:producer"
},
"useDefaultCredentialsProvider": {
"title": "Use Default Credentials Provider",
"description": "Set whether the Kinesis Firehose client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.",
"type": "boolean",
"$comment": "group:common",
"default": false
},
"lazyStartProducer": {
"title": "Lazy Start Producer",
"description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.",
"type": "boolean",
"$comment": "group:producer (advanced)",
"default": false
},
"amazonKinesisFirehoseClient": {
"title": "Amazon Kinesis Firehose Client",
"description": "Amazon Kinesis Firehose client to use for all requests for this endpoint",
"type": "string",
"$comment": "group:advanced",
"format": "bean:software.amazon.awssdk.services.firehose.FirehoseClient"
},
"proxyHost": {
"title": "Proxy Host",
"description": "To define a proxy host when instantiating the Kinesis Firehose client",
"type": "string",
"$comment": "group:proxy"
},
"proxyPort": {
"title": "Proxy Port",
"description": "To define a proxy port when instantiating the Kinesis Firehose client",
"type": "integer",
"$comment": "group:proxy"
},
"proxyProtocol": {
"title": "Proxy Protocol",
"description": "To define a proxy protocol when instantiating the Kinesis Firehose client",
"type": "string",
"enum": [
"HTTP",
"HTTPS"
],
"$comment": "group:proxy",
"default": "HTTPS"
},
"accessKey": {
"title": "Access Key",
"description": "Amazon AWS Access Key",
"type": "string",
"$comment": "group:security",
"format": "password"
},
"profileCredentialsName": {
"title": "Profile Credentials Name",
"description": "If using a profile credentials provider this parameter will set the profile name.",
"type": "string",
"$comment": "group:security"
},
"secretKey": {
"title": "Secret Key",
"description": "Amazon AWS Secret Key",
"type": "string",
"$comment": "group:security",
"format": "password"
},
"sessionToken": {
"title": "Session Token",
"description": "Amazon AWS Session Token used when the user needs to assume a IAM role",
"type": "string",
"$comment": "group:security",
"format": "password"
},
"trustAllCertificates": {
"title": "Trust All Certificates",
"description": "If we want to trust all certificates in case of overriding the endpoint",
"type": "boolean",
"$comment": "group:security",
"default": false
},
"useProfileCredentialsProvider": {
"title": "Use Profile Credentials Provider",
"description": "Set whether the Kinesis Firehose client should expect to load credentials through a profile credentials provider.",
"type": "boolean",
"$comment": "group:security",
"default": false
},
"useSessionCredentials": {
"title": "Use Session Credentials",
"description": "Set whether the Kinesis Firehose 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 Firehose.",
"type": "boolean",
"$comment": "group:security",
"default": false
}
},
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"required": [
"streamName"
]
}
}