Package org.apache.camel.builder.component.dsl

Interface Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.aws2.ddb.Ddb2Component>
All Known Implementing Classes:
Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilderImpl
Enclosing interface:
Aws2DdbComponentBuilderFactory
public static interface Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder extends ComponentBuilder<org.apache.camel.component.aws2.ddb.Ddb2Component>
Builder for the AWS DynamoDB component.

  • Method Details

    • configuration

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder configuration(org.apache.camel.component.aws2.ddb.Ddb2Configuration configuration)
      The component configuration. The option is a: <code>org.apache.camel.component.aws2.ddb.Ddb2Configuration</code> type. Group: producer
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • consistentRead

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder consistentRead(boolean consistentRead)
      Determines whether or not strong consistency should be enforced when data is read. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      consistentRead - the value to set
      Returns:
      the dsl builder

    • enabledInitialDescribeTable

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder enabledInitialDescribeTable(boolean enabledInitialDescribeTable)
      Set whether the initial Describe table operation in the DDB Endpoint must be done, or not. The option is a: <code>boolean</code> type. Default: true Group: producer
      Parameters:
      enabledInitialDescribeTable - the value to set
      Returns:
      the dsl builder

    • keyAttributeName

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder keyAttributeName(String keyAttributeName)
      Attribute name when creating table. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      keyAttributeName - the value to set
      Returns:
      the dsl builder

    • keyAttributeType

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder keyAttributeType(String keyAttributeType)
      Attribute type when creating table. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      keyAttributeType - the value to set
      Returns:
      the dsl builder

    • keyScalarType

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder keyScalarType(String keyScalarType)
      The key scalar type, it can be S (String), N (Number) and B (Bytes). The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      keyScalarType - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder lazyStartProducer(boolean lazyStartProducer)
      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. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • operation

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder operation(org.apache.camel.component.aws2.ddb.Ddb2Operations operation)
      What operation to perform. The option is a: <code>org.apache.camel.component.aws2.ddb.Ddb2Operations</code> type. Default: PutItem Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • overrideEndpoint

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder overrideEndpoint(boolean overrideEndpoint)
      Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      overrideEndpoint - the value to set
      Returns:
      the dsl builder

    • readCapacity

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder readCapacity(Long readCapacity)
      The provisioned throughput to reserve for reading resources from your table. The option is a: <code>java.lang.Long</code> type. Group: producer
      Parameters:
      readCapacity - the value to set
      Returns:
      the dsl builder

    • region

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder region(String region)
      The region in which DDB client needs to work. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      region - the value to set
      Returns:
      the dsl builder

    • uriEndpointOverride

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder uriEndpointOverride(String uriEndpointOverride)
      Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      uriEndpointOverride - the value to set
      Returns:
      the dsl builder

    • writeCapacity

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder writeCapacity(Long writeCapacity)
      The provisioned throughput to reserved for writing resources to your table. The option is a: <code>java.lang.Long</code> type. Group: producer
      Parameters:
      writeCapacity - the value to set
      Returns:
      the dsl builder

    • amazonDDBClient

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder amazonDDBClient(software.amazon.awssdk.services.dynamodb.DynamoDbClient amazonDDBClient)
      To use the AmazonDynamoDB as the client. The option is a: <code>software.amazon.awssdk.services.dynamodb.DynamoDbClient</code> type. Group: advanced
      Parameters:
      amazonDDBClient - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      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. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • healthCheckConsumerEnabled

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder healthCheckConsumerEnabled(boolean healthCheckConsumerEnabled)
      Used for enabling or disabling all consumer based health checks from this component. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckConsumerEnabled - the value to set
      Returns:
      the dsl builder

    • healthCheckProducerEnabled

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder healthCheckProducerEnabled(boolean healthCheckProducerEnabled)
      Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckProducerEnabled - the value to set
      Returns:
      the dsl builder

    • proxyHost

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder proxyHost(String proxyHost)
      To define a proxy host when instantiating the DDB client. The option is a: <code>java.lang.String</code> type. Group: proxy
      Parameters:
      proxyHost - the value to set
      Returns:
      the dsl builder

    • proxyPort

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder proxyPort(Integer proxyPort)
      The region in which DynamoDB 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(). The option is a: <code>java.lang.Integer</code> type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • proxyProtocol

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
      To define a proxy protocol when instantiating the DDB client. The option is a: <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: proxy
      Parameters:
      proxyProtocol - the value to set
      Returns:
      the dsl builder

    • accessKey

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder accessKey(String accessKey)
      Amazon AWS Access Key. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      accessKey - the value to set
      Returns:
      the dsl builder

    • profileCredentialsName

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder profileCredentialsName(String profileCredentialsName)
      If using a profile credentials provider this parameter will set the profile name. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      profileCredentialsName - the value to set
      Returns:
      the dsl builder

    • secretKey

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder secretKey(String secretKey)
      Amazon AWS Secret Key. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      secretKey - the value to set
      Returns:
      the dsl builder

    • trustAllCertificates

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder trustAllCertificates(boolean trustAllCertificates)
      If we want to trust all certificates in case of overriding the endpoint. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      trustAllCertificates - the value to set
      Returns:
      the dsl builder

    • useDefaultCredentialsProvider

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
      Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useProfileCredentialsProvider

      default Aws2DdbComponentBuilderFactory.Aws2DdbComponentBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider)
      Set whether the DDB client should expect to load credentials through a profile credentials provider. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useProfileCredentialsProvider - the value to set
      Returns:
      the dsl builder