Interface GatewayTarget.Builder

All Superinterfaces:

Buildable, CopyableBuilder<GatewayTarget.Builder,GatewayTarget>, SdkBuilder<GatewayTarget.Builder,GatewayTarget>, SdkPojo

Enclosing class:

GatewayTarget

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

Method Summary

Modifier and Type	Method	Description
default GatewayTarget.Builder	authorizationData(Consumer<AuthorizationData.Builder> authorizationData)	OAuth2 authorization data for the gateway target.
GatewayTarget.Builder	authorizationData(AuthorizationData authorizationData)	OAuth2 authorization data for the gateway target.
GatewayTarget.Builder	createdAt(Instant createdAt)	The date and time at which the target was created.
GatewayTarget.Builder	credentialProviderConfigurations(Collection<CredentialProviderConfiguration> credentialProviderConfigurations)	The provider configurations.
GatewayTarget.Builder	credentialProviderConfigurations(Consumer<CredentialProviderConfiguration.Builder>... credentialProviderConfigurations)	The provider configurations.
GatewayTarget.Builder	credentialProviderConfigurations(CredentialProviderConfiguration... credentialProviderConfigurations)	The provider configurations.
GatewayTarget.Builder	description(String description)	The description for the gateway target.
GatewayTarget.Builder	gatewayArn(String gatewayArn)	The Amazon Resource Name (ARN) of the gateway target.
GatewayTarget.Builder	lastSynchronizedAt(Instant lastSynchronizedAt)	The last synchronization time.
default GatewayTarget.Builder	metadataConfiguration(Consumer<MetadataConfiguration.Builder> metadataConfiguration)	The metadata configuration for HTTP header and query parameter propagation to and from this gateway target.
GatewayTarget.Builder	metadataConfiguration(MetadataConfiguration metadataConfiguration)	The metadata configuration for HTTP header and query parameter propagation to and from this gateway target.
GatewayTarget.Builder	name(String name)	The name of the gateway target.
default GatewayTarget.Builder	privateEndpoint(Consumer<PrivateEndpoint.Builder> privateEndpoint)	Sets the value of the PrivateEndpoint property for this object.
GatewayTarget.Builder	privateEndpoint(PrivateEndpoint privateEndpoint)	Sets the value of the PrivateEndpoint property for this object.
GatewayTarget.Builder	privateEndpointManagedResources(Collection<ManagedResourceDetails> privateEndpointManagedResources)	A list of managed resources created by the gateway for private endpoint connectivity.
GatewayTarget.Builder	privateEndpointManagedResources(Consumer<ManagedResourceDetails.Builder>... privateEndpointManagedResources)	A list of managed resources created by the gateway for private endpoint connectivity.
GatewayTarget.Builder	privateEndpointManagedResources(ManagedResourceDetails... privateEndpointManagedResources)	A list of managed resources created by the gateway for private endpoint connectivity.
GatewayTarget.Builder	status(String status)	The status of the gateway target.
GatewayTarget.Builder	status(TargetStatus status)	The status of the gateway target.
GatewayTarget.Builder	statusReasons(String... statusReasons)	The status reasons for the target status.
GatewayTarget.Builder	statusReasons(Collection<String> statusReasons)	The status reasons for the target status.
default GatewayTarget.Builder	targetConfiguration(Consumer<TargetConfiguration.Builder> targetConfiguration)	Sets the value of the TargetConfiguration property for this object.
GatewayTarget.Builder	targetConfiguration(TargetConfiguration targetConfiguration)	Sets the value of the TargetConfiguration property for this object.
GatewayTarget.Builder	targetId(String targetId)	The target ID.
GatewayTarget.Builder	updatedAt(Instant updatedAt)	The date and time at which the target was updated.

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

copy

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

gatewayArn

GatewayTarget.Builder gatewayArn(String gatewayArn)

The Amazon Resource Name (ARN) of the gateway target.

Parameters:

gatewayArn - The Amazon Resource Name (ARN) of the gateway target.

Returns:

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

targetId

GatewayTarget.Builder targetId(String targetId)

The target ID.

Parameters:

targetId - The target ID.

Returns:

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

createdAt

GatewayTarget.Builder createdAt(Instant createdAt)

The date and time at which the target was created.

Parameters:

createdAt - The date and time at which the target was created.

Returns:

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

updatedAt

GatewayTarget.Builder updatedAt(Instant updatedAt)

The date and time at which the target was updated.

Parameters:

updatedAt - The date and time at which the target was updated.

Returns:

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

status

GatewayTarget.Builder status(String status)

The status of the gateway target.

Parameters:

status - The status of the gateway target.

Returns:

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

See Also:

• TargetStatus
• TargetStatus

status

GatewayTarget.Builder status(TargetStatus status)

The status of the gateway target.

Parameters:

status - The status of the gateway target.

Returns:

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

See Also:

• TargetStatus
• TargetStatus

statusReasons

GatewayTarget.Builder statusReasons(Collection<String> statusReasons)

The status reasons for the target status.

Parameters:

statusReasons - The status reasons for the target status.

Returns:

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

statusReasons

GatewayTarget.Builder statusReasons(String... statusReasons)

The status reasons for the target status.

Parameters:

statusReasons - The status reasons for the target status.

Returns:

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

name

GatewayTarget.Builder name(String name)

The name of the gateway target.

Parameters:

name - The name of the gateway target.

Returns:

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

description

GatewayTarget.Builder description(String description)

The description for the gateway target.

Parameters:

description - The description for the gateway target.

Returns:

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

targetConfiguration

GatewayTarget.Builder targetConfiguration(TargetConfiguration targetConfiguration)

Sets the value of the TargetConfiguration property for this object.

Parameters:

targetConfiguration - The new value for the TargetConfiguration property for this object.

Returns:

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

targetConfiguration

default GatewayTarget.Builder targetConfiguration(Consumer<TargetConfiguration.Builder> targetConfiguration)

Sets the value of the TargetConfiguration property for this object. This is a convenience method that creates an instance of the TargetConfiguration.Builder avoiding the need to create one manually via TargetConfiguration.builder().

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

Parameters:

targetConfiguration - a consumer that will call methods on TargetConfiguration.Builder

Returns:

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

See Also:

• targetConfiguration(TargetConfiguration)

credentialProviderConfigurations

GatewayTarget.Builder credentialProviderConfigurations(Collection<CredentialProviderConfiguration> credentialProviderConfigurations)

The provider configurations.

Parameters:

credentialProviderConfigurations - The provider configurations.

Returns:

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

credentialProviderConfigurations

GatewayTarget.Builder credentialProviderConfigurations(CredentialProviderConfiguration... credentialProviderConfigurations)

The provider configurations.

Parameters:

credentialProviderConfigurations - The provider configurations.

Returns:

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

credentialProviderConfigurations

GatewayTarget.Builder credentialProviderConfigurations(Consumer<CredentialProviderConfiguration.Builder>... credentialProviderConfigurations)

The provider configurations.

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

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

Parameters:

credentialProviderConfigurations - a consumer that will call methods on CredentialProviderConfiguration.Builder

Returns:

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

See Also:

• credentialProviderConfigurations(java.util.Collection<CredentialProviderConfiguration>)

lastSynchronizedAt

GatewayTarget.Builder lastSynchronizedAt(Instant lastSynchronizedAt)

The last synchronization time.

Parameters:

lastSynchronizedAt - The last synchronization time.

Returns:

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

metadataConfiguration

GatewayTarget.Builder metadataConfiguration(MetadataConfiguration metadataConfiguration)

The metadata configuration for HTTP header and query parameter propagation to and from this gateway target.

Parameters:

metadataConfiguration - The metadata configuration for HTTP header and query parameter propagation to and from this gateway target.

Returns:

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

metadataConfiguration

default GatewayTarget.Builder metadataConfiguration(Consumer<MetadataConfiguration.Builder> metadataConfiguration)

The metadata configuration for HTTP header and query parameter propagation to and from this gateway target.

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

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

Parameters:

metadataConfiguration - a consumer that will call methods on MetadataConfiguration.Builder

Returns:

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

See Also:

• metadataConfiguration(MetadataConfiguration)

privateEndpoint

GatewayTarget.Builder privateEndpoint(PrivateEndpoint privateEndpoint)

Sets the value of the PrivateEndpoint property for this object.

Parameters:

privateEndpoint - The new value for the PrivateEndpoint property for this object.

Returns:

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

privateEndpoint

default GatewayTarget.Builder privateEndpoint(Consumer<PrivateEndpoint.Builder> privateEndpoint)

Sets the value of the PrivateEndpoint property for this object. This is a convenience method that creates an instance of the PrivateEndpoint.Builder avoiding the need to create one manually via PrivateEndpoint.builder().

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

Parameters:

privateEndpoint - a consumer that will call methods on PrivateEndpoint.Builder

Returns:

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

See Also:

• privateEndpoint(PrivateEndpoint)

privateEndpointManagedResources

GatewayTarget.Builder privateEndpointManagedResources(Collection<ManagedResourceDetails> privateEndpointManagedResources)

A list of managed resources created by the gateway for private endpoint connectivity. These resources are created in your account when you use a managed VPC Lattice resource configuration.

Parameters:

privateEndpointManagedResources - A list of managed resources created by the gateway for private endpoint connectivity. These resources are created in your account when you use a managed VPC Lattice resource configuration.

Returns:

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

privateEndpointManagedResources

GatewayTarget.Builder privateEndpointManagedResources(ManagedResourceDetails... privateEndpointManagedResources)

A list of managed resources created by the gateway for private endpoint connectivity. These resources are created in your account when you use a managed VPC Lattice resource configuration.

Parameters:

privateEndpointManagedResources - A list of managed resources created by the gateway for private endpoint connectivity. These resources are created in your account when you use a managed VPC Lattice resource configuration.

Returns:

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

privateEndpointManagedResources

GatewayTarget.Builder privateEndpointManagedResources(Consumer<ManagedResourceDetails.Builder>... privateEndpointManagedResources)

A list of managed resources created by the gateway for private endpoint connectivity. These resources are created in your account when you use a managed VPC Lattice resource configuration.

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

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

Parameters:

privateEndpointManagedResources - a consumer that will call methods on ManagedResourceDetails.Builder

Returns:

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

See Also:

• privateEndpointManagedResources(java.util.Collection<ManagedResourceDetails>)

authorizationData

GatewayTarget.Builder authorizationData(AuthorizationData authorizationData)

OAuth2 authorization data for the gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.

Parameters:

authorizationData - OAuth2 authorization data for the gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.

Returns:

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

authorizationData

default GatewayTarget.Builder authorizationData(Consumer<AuthorizationData.Builder> authorizationData)

OAuth2 authorization data for the gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.

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

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

Parameters:

authorizationData - a consumer that will call methods on AuthorizationData.Builder

Returns:

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

See Also:

• authorizationData(AuthorizationData)