Package software.amazon.awscdk.services.kinesisfirehose

Class HttpEndpointConfig.Builder

java.lang.Object

software.amazon.awscdk.services.kinesisfirehose.HttpEndpointConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpEndpointConfig>

Enclosing interface:

HttpEndpointConfig

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

A builder for HttpEndpointConfig

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HttpEndpointConfig.Builder	accessKey(SecretValue accessKey)	Sets the value of HttpEndpointConfig.getAccessKey()
HttpEndpointConfig	build()	Builds the configured instance.
HttpEndpointConfig.Builder	name(String name)	Sets the value of HttpEndpointConfig.getName()
HttpEndpointConfig.Builder	secret(ISecret secret)	Sets the value of HttpEndpointConfig.getSecret()
HttpEndpointConfig.Builder	url(String url)	Sets the value of HttpEndpointConfig.getUrl()

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

url

@Stability(Stable)
public HttpEndpointConfig.Builder url(String url)

Sets the value of HttpEndpointConfig.getUrl()

Parameters:

url - The URL of the Http endpoint selected as the destination. This parameter is required.

Returns:

this

accessKey

@Stability(Stable)
public HttpEndpointConfig.Builder accessKey(SecretValue accessKey)

Sets the value of HttpEndpointConfig.getAccessKey()

Parameters:

accessKey - The access key used to authenticate with the Http endpoint. Used only when secret is not set. If both accessKey and secret are provided, secret (AWS Secrets Manager) takes precedence and this value is ignored. The access key is rendered into the CloudFormation template.

Returns:

this

name

@Stability(Stable)
public HttpEndpointConfig.Builder name(String name)

Sets the value of HttpEndpointConfig.getName()

Parameters:

name - The name of the Http endpoint selected as the destination.

Returns:

this

secret

@Stability(Stable)
public HttpEndpointConfig.Builder secret(ISecret secret)

Sets the value of HttpEndpointConfig.getSecret()

Parameters:

secret - A Secrets Manager secret used to authenticate with the Http endpoint. When set, Firehose retrieves the credential from AWS Secrets Manager, and this takes precedence over accessKey.

Returns:

this

build

@Stability(Stable)
public HttpEndpointConfig build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of HttpEndpointConfig

Throws:

NullPointerException - if any required attribute was not provided