Package software.amazon.awscdk.services.kinesisfirehose

Class HttpEndpointProps.Builder

java.lang.Object

software.amazon.awscdk.services.kinesisfirehose.HttpEndpointProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpEndpointProps>

Enclosing interface:

HttpEndpointProps

@Stability(Stable)
public static final class HttpEndpointProps.Builder
extends Object
implements software.amazon.jsii.Builder<HttpEndpointProps>

A builder for HttpEndpointProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HttpEndpointProps.Builder	attributes(List<? extends HttpAttribute> attributes)	Sets the value of HttpEndpointProps.getAttributes()
HttpEndpointProps.Builder	backupMode(HttpBackupMode backupMode)	Sets the value of HttpEndpointProps.getBackupMode()
HttpEndpointProps.Builder	bufferingHints(HttpBufferingHints bufferingHints)	Sets the value of HttpEndpointProps.getBufferingHints()
HttpEndpointProps	build()	Builds the configured instance.
HttpEndpointProps.Builder	endpointConfig(HttpEndpointConfig endpointConfig)	Sets the value of HttpEndpointProps.getEndpointConfig()
HttpEndpointProps.Builder	loggingConfig(ILoggingConfig loggingConfig)	Sets the value of CommonDestinationProps.getLoggingConfig()
HttpEndpointProps.Builder	processor(IDataProcessor processor)	Deprecated. Use `processors` instead.
HttpEndpointProps.Builder	processors(List<? extends IDataProcessor> processors)	Sets the value of CommonDestinationProps.getProcessors()
HttpEndpointProps.Builder	requestCompression(HttpCompression requestCompression)	Sets the value of HttpEndpointProps.getRequestCompression()
HttpEndpointProps.Builder	retryOptions(HttpRetryOptions retryOptions)	Sets the value of HttpEndpointProps.getRetryOptions()
HttpEndpointProps.Builder	role(IRole role)	Sets the value of CommonDestinationProps.getRole()
HttpEndpointProps.Builder	s3Backup(DestinationS3BackupProps s3Backup)	Sets the value of CommonDestinationProps.getS3Backup()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

endpointConfig

@Stability(Stable)
public HttpEndpointProps.Builder endpointConfig(HttpEndpointConfig endpointConfig)

Sets the value of HttpEndpointProps.getEndpointConfig()

Parameters:

endpointConfig - Describes the configuration of the Http endpoint to which Kinesis Firehose delivers data. This parameter is required.

Returns:

this

attributes

@Stability(Stable)
public HttpEndpointProps.Builder attributes(List<? extends HttpAttribute> attributes)

Sets the value of HttpEndpointProps.getAttributes()

Parameters:

attributes - Describes the metadata sent to the Http endpoint destination.

Returns:

this

backupMode

@Stability(Stable)
public HttpEndpointProps.Builder backupMode(HttpBackupMode backupMode)

Sets the value of HttpEndpointProps.getBackupMode()

Parameters:

backupMode - Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the Http endpoint destination.

Returns:

this

bufferingHints

@Stability(Stable)
public HttpEndpointProps.Builder bufferingHints(HttpBufferingHints bufferingHints)

Sets the value of HttpEndpointProps.getBufferingHints()

Parameters:

bufferingHints - The buffering options that can be used before data is delivered to the specified destination.

Returns:

this

requestCompression

@Stability(Stable)
public HttpEndpointProps.Builder requestCompression(HttpCompression requestCompression)

Sets the value of HttpEndpointProps.getRequestCompression()

Parameters:

requestCompression - Compress the body of a request before sending the request to the destination.

Returns:

this

retryOptions

@Stability(Stable)
public HttpEndpointProps.Builder retryOptions(HttpRetryOptions retryOptions)

Sets the value of HttpEndpointProps.getRetryOptions()

Parameters:

retryOptions - The total amount of time that Kinesis Data Firehose spends on retries.

Returns:

this

loggingConfig

@Stability(Stable)
public HttpEndpointProps.Builder loggingConfig(ILoggingConfig loggingConfig)

Sets the value of CommonDestinationProps.getLoggingConfig()

Parameters:

loggingConfig - Configuration that determines whether to log errors during data transformation or delivery failures, and specifies the CloudWatch log group for storing error logs.

Returns:

this

processor

@Stability(Deprecated)
@Deprecated
public HttpEndpointProps.Builder processor(IDataProcessor processor)

Deprecated.

Use `processors` instead.

Sets the value of CommonDestinationProps.getProcessor()

Parameters:

processor - The data transformation that should be performed on the data before writing to the destination.

Returns:

this

processors

@Stability(Stable)
public HttpEndpointProps.Builder processors(List<? extends IDataProcessor> processors)

Sets the value of CommonDestinationProps.getProcessors()

Parameters:

processors - The data transformation that should be performed on the data before writing to the destination.

Returns:

this

role

@Stability(Stable)
public HttpEndpointProps.Builder role(IRole role)

Sets the value of CommonDestinationProps.getRole()

Parameters:

role - The IAM role associated with this destination. Assumed by Amazon Data Firehose to invoke processors and write to destinations

Returns:

this

s3Backup

@Stability(Stable)
public HttpEndpointProps.Builder s3Backup(DestinationS3BackupProps s3Backup)

Sets the value of CommonDestinationProps.getS3Backup()

Parameters:

s3Backup - The configuration for backing up source records to S3.

Returns:

this

build

@Stability(Stable)
public HttpEndpointProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<HttpEndpointProps>

Returns:

a new instance of HttpEndpointProps

Throws:

NullPointerException - if any required attribute was not provided