Interface CreateEndpointRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateEndpointRequest

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

Method Summary

Modifier and Type	Method	Description
CreateEndpointRequest.Builder	description(String description)	A description of the global endpoint.
CreateEndpointRequest.Builder	eventBuses(Collection<EndpointEventBus> eventBuses)	Define the event buses used.
CreateEndpointRequest.Builder	eventBuses(Consumer<EndpointEventBus.Builder>... eventBuses)	Define the event buses used.
CreateEndpointRequest.Builder	eventBuses(EndpointEventBus... eventBuses)	Define the event buses used.
CreateEndpointRequest.Builder	name(String name)	The name of the global endpoint.
CreateEndpointRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateEndpointRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateEndpointRequest.Builder	replicationConfig(Consumer<ReplicationConfig.Builder> replicationConfig)	Enable or disable event replication.
CreateEndpointRequest.Builder	replicationConfig(ReplicationConfig replicationConfig)	Enable or disable event replication.
CreateEndpointRequest.Builder	roleArn(String roleArn)	The ARN of the role used for replication.
default CreateEndpointRequest.Builder	routingConfig(Consumer<RoutingConfig.Builder> routingConfig)	Configure the routing policy, including the health check and secondary Region..
CreateEndpointRequest.Builder	routingConfig(RoutingConfig routingConfig)	Configure the routing policy, including the health check and secondary Region..

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

CreateEndpointRequest.Builder name(String name)

The name of the global endpoint. For example, "Name":"us-east-2-custom_bus_A-endpoint".

Parameters:

name - The name of the global endpoint. For example, "Name":"us-east-2-custom_bus_A-endpoint".

Returns:

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

description

CreateEndpointRequest.Builder description(String description)

A description of the global endpoint.

Parameters:

description - A description of the global endpoint.

Returns:

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

routingConfig

CreateEndpointRequest.Builder routingConfig(RoutingConfig routingConfig)

Configure the routing policy, including the health check and secondary Region..

Parameters:

routingConfig - Configure the routing policy, including the health check and secondary Region..

Returns:

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

routingConfig

default CreateEndpointRequest.Builder routingConfig(Consumer<RoutingConfig.Builder> routingConfig)

Configure the routing policy, including the health check and secondary Region..

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

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

Parameters:

routingConfig - a consumer that will call methods on RoutingConfig.Builder

Returns:

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

See Also:

• routingConfig(RoutingConfig)

replicationConfig

CreateEndpointRequest.Builder replicationConfig(ReplicationConfig replicationConfig)

Enable or disable event replication. The default state is ENABLED which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.

Parameters:

replicationConfig - Enable or disable event replication. The default state is ENABLED which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.

Returns:

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

replicationConfig

default CreateEndpointRequest.Builder replicationConfig(Consumer<ReplicationConfig.Builder> replicationConfig)

Enable or disable event replication. The default state is ENABLED which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.

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

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

Parameters:

replicationConfig - a consumer that will call methods on ReplicationConfig.Builder

Returns:

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

See Also:

• replicationConfig(ReplicationConfig)

eventBuses

CreateEndpointRequest.Builder eventBuses(Collection<EndpointEventBus> eventBuses)

Define the event buses used.

The names of the event buses must be identical in each Region.

Parameters:

eventBuses - Define the event buses used.

The names of the event buses must be identical in each Region.

Returns:

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

eventBuses

CreateEndpointRequest.Builder eventBuses(EndpointEventBus... eventBuses)

Define the event buses used.

The names of the event buses must be identical in each Region.

Parameters:

eventBuses - Define the event buses used.

The names of the event buses must be identical in each Region.

Returns:

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

eventBuses

CreateEndpointRequest.Builder eventBuses(Consumer<EndpointEventBus.Builder>... eventBuses)

Define the event buses used.

The names of the event buses must be identical in each Region.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to eventBuses(List<EndpointEventBus>).

Parameters:

eventBuses - a consumer that will call methods on EndpointEventBus.Builder

Returns:

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

See Also:

• eventBuses(java.util.Collection<EndpointEventBus>)

roleArn

CreateEndpointRequest.Builder roleArn(String roleArn)

The ARN of the role used for replication.

Parameters:

roleArn - The ARN of the role used for replication.

Returns:

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

overrideConfiguration

CreateEndpointRequest.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

CreateEndpointRequest.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.