Interface MSKSourceConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<MSKSourceConfiguration.Builder,MSKSourceConfiguration>, SdkBuilder<MSKSourceConfiguration.Builder,MSKSourceConfiguration>, SdkPojo
Enclosing class:
MSKSourceConfiguration

public static interface MSKSourceConfiguration.Builder extends SdkPojo, CopyableBuilder<MSKSourceConfiguration.Builder,MSKSourceConfiguration>
  • Method Details

    • mskClusterARN

      MSKSourceConfiguration.Builder mskClusterARN(String mskClusterARN)

      The ARN of the Amazon MSK cluster.

      Parameters:
      mskClusterARN - The ARN of the Amazon MSK cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • topicName

      MSKSourceConfiguration.Builder topicName(String topicName)

      The topic name within the Amazon MSK cluster.

      Parameters:
      topicName - The topic name within the Amazon MSK cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • authenticationConfiguration

      MSKSourceConfiguration.Builder authenticationConfiguration(AuthenticationConfiguration authenticationConfiguration)

      The authentication configuration of the Amazon MSK cluster.

      Parameters:
      authenticationConfiguration - The authentication configuration of the Amazon MSK cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • authenticationConfiguration

      default MSKSourceConfiguration.Builder authenticationConfiguration(Consumer<AuthenticationConfiguration.Builder> authenticationConfiguration)

      The authentication configuration of the Amazon MSK cluster.

      This is a convenience method that creates an instance of the AuthenticationConfiguration.Builder avoiding the need to create one manually via AuthenticationConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to authenticationConfiguration(AuthenticationConfiguration).

      Parameters:
      authenticationConfiguration - a consumer that will call methods on AuthenticationConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • readFromTimestamp

      MSKSourceConfiguration.Builder readFromTimestamp(Instant readFromTimestamp)

      The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.

      If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestamp parameter to Epoch (1970-01-01T00:00:00Z).

      Parameters:
      readFromTimestamp - The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.

      If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestamp parameter to Epoch (1970-01-01T00:00:00Z).

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