Interface CreateConnectionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateConnectionRequest.Builder,CreateConnectionRequest>, EventBridgeRequest.Builder, SdkBuilder<CreateConnectionRequest.Builder,CreateConnectionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateConnectionRequest

@Mutable
@NotThreadSafe
public static interface CreateConnectionRequest.Builder
extends EventBridgeRequest.Builder, SdkPojo, CopyableBuilder<CreateConnectionRequest.Builder,CreateConnectionRequest>

Method Summary

Modifier and Type	Method	Description
CreateConnectionRequest.Builder	authorizationType(String authorizationType)	The type of authorization to use for the connection.
CreateConnectionRequest.Builder	authorizationType(ConnectionAuthorizationType authorizationType)	The type of authorization to use for the connection.
default CreateConnectionRequest.Builder	authParameters(Consumer<CreateConnectionAuthRequestParameters.Builder> authParameters)	The authorization parameters to use to authorize with the endpoint.
CreateConnectionRequest.Builder	authParameters(CreateConnectionAuthRequestParameters authParameters)	The authorization parameters to use to authorize with the endpoint.
CreateConnectionRequest.Builder	description(String description)	A description for the connection to create.
default CreateConnectionRequest.Builder	invocationConnectivityParameters(Consumer<ConnectivityResourceParameters.Builder> invocationConnectivityParameters)	For connections to private APIs, the parameters to use for invoking the API.
CreateConnectionRequest.Builder	invocationConnectivityParameters(ConnectivityResourceParameters invocationConnectivityParameters)	For connections to private APIs, the parameters to use for invoking the API.
CreateConnectionRequest.Builder	kmsKeyIdentifier(String kmsKeyIdentifier)	The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection.
CreateConnectionRequest.Builder	name(String name)	The name for the connection to create.
CreateConnectionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateConnectionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.eventbridge.model.EventBridgeRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

name

CreateConnectionRequest.Builder name(String name)

The name for the connection to create.

Parameters:

name - The name for the connection to create.

Returns:

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

description

CreateConnectionRequest.Builder description(String description)

A description for the connection to create.

Parameters:

description - A description for the connection to create.

Returns:

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

authorizationType

CreateConnectionRequest.Builder authorizationType(String authorizationType)

The type of authorization to use for the connection.

OAUTH tokens are refreshed when a 401 or 407 response is returned.

Parameters:

authorizationType - The type of authorization to use for the connection.

OAUTH tokens are refreshed when a 401 or 407 response is returned.

Returns:

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

See Also:

• ConnectionAuthorizationType
• ConnectionAuthorizationType

authorizationType

CreateConnectionRequest.Builder authorizationType(ConnectionAuthorizationType authorizationType)

The type of authorization to use for the connection.

OAUTH tokens are refreshed when a 401 or 407 response is returned.

Parameters:

authorizationType - The type of authorization to use for the connection.

OAUTH tokens are refreshed when a 401 or 407 response is returned.

Returns:

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

See Also:

• ConnectionAuthorizationType
• ConnectionAuthorizationType

authParameters

CreateConnectionRequest.Builder authParameters(CreateConnectionAuthRequestParameters authParameters)

The authorization parameters to use to authorize with the endpoint.

You must include only authorization parameters for the AuthorizationType you specify.

Parameters:

authParameters - The authorization parameters to use to authorize with the endpoint.

You must include only authorization parameters for the AuthorizationType you specify.

Returns:

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

authParameters

default CreateConnectionRequest.Builder authParameters(Consumer<CreateConnectionAuthRequestParameters.Builder> authParameters)

The authorization parameters to use to authorize with the endpoint.

You must include only authorization parameters for the AuthorizationType you specify.

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

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

Parameters:

authParameters - a consumer that will call methods on CreateConnectionAuthRequestParameters.Builder

Returns:

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

See Also:

• authParameters(CreateConnectionAuthRequestParameters)

invocationConnectivityParameters

CreateConnectionRequest.Builder invocationConnectivityParameters(ConnectivityResourceParameters invocationConnectivityParameters)

For connections to private APIs, the parameters to use for invoking the API.

For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .

Parameters:

invocationConnectivityParameters - For connections to private APIs, the parameters to use for invoking the API.

For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .

Returns:

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

invocationConnectivityParameters

default CreateConnectionRequest.Builder invocationConnectivityParameters(Consumer<ConnectivityResourceParameters.Builder> invocationConnectivityParameters)

For connections to private APIs, the parameters to use for invoking the API.

For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .

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

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

Parameters:

invocationConnectivityParameters - a consumer that will call methods on ConnectivityResourceParameters.Builder

Returns:

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

See Also:

• invocationConnectivityParameters(ConnectivityResourceParameters)

kmsKeyIdentifier

CreateConnectionRequest.Builder kmsKeyIdentifier(String kmsKeyIdentifier)

The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the connection.

For more information, see Identify and view keys in the Key Management Service Developer Guide.

Parameters:

kmsKeyIdentifier - The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the connection.

For more information, see Identify and view keys in the Key Management Service Developer Guide.

Returns:

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

overrideConfiguration

CreateConnectionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateConnectionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.