Interface CreateWebAppRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateWebAppRequest.Builder,CreateWebAppRequest>, SdkBuilder<CreateWebAppRequest.Builder,CreateWebAppRequest>, SdkPojo, SdkRequest.Builder, TransferRequest.Builder

Enclosing class:

CreateWebAppRequest

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

Method Summary

Modifier and Type	Method	Description
CreateWebAppRequest.Builder	accessEndpoint(String accessEndpoint)	The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app.
default CreateWebAppRequest.Builder	identityProviderDetails(Consumer<WebAppIdentityProviderDetails.Builder> identityProviderDetails)	You can provide a structure that contains the details for the identity provider to use with your web app.
CreateWebAppRequest.Builder	identityProviderDetails(WebAppIdentityProviderDetails identityProviderDetails)	You can provide a structure that contains the details for the identity provider to use with your web app.
CreateWebAppRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateWebAppRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateWebAppRequest.Builder	tags(Collection<Tag> tags)	Key-value pairs that can be used to group and search for web apps.
CreateWebAppRequest.Builder	tags(Consumer<Tag.Builder>... tags)	Key-value pairs that can be used to group and search for web apps.
CreateWebAppRequest.Builder	tags(Tag... tags)	Key-value pairs that can be used to group and search for web apps.
CreateWebAppRequest.Builder	webAppEndpointPolicy(String webAppEndpointPolicy)	Setting for the type of endpoint policy for the web app.
CreateWebAppRequest.Builder	webAppEndpointPolicy(WebAppEndpointPolicy webAppEndpointPolicy)	Setting for the type of endpoint policy for the web app.
default CreateWebAppRequest.Builder	webAppUnits(Consumer<WebAppUnits.Builder> webAppUnits)	A union that contains the value for number of concurrent connections or the user sessions on your web app.
CreateWebAppRequest.Builder	webAppUnits(WebAppUnits webAppUnits)	A union that contains the value for number of concurrent connections or the user sessions on your web app.

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.utils.builder.SdkBuilder

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.services.transfer.model.TransferRequest.Builder

build

Method Details

identityProviderDetails

CreateWebAppRequest.Builder identityProviderDetails(WebAppIdentityProviderDetails identityProviderDetails)

You can provide a structure that contains the details for the identity provider to use with your web app.

For more details about this parameter, see Configure your identity provider for Transfer Family web apps.

Parameters:

identityProviderDetails - You can provide a structure that contains the details for the identity provider to use with your web app.

For more details about this parameter, see Configure your identity provider for Transfer Family web apps.

Returns:

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

identityProviderDetails

default CreateWebAppRequest.Builder identityProviderDetails(Consumer<WebAppIdentityProviderDetails.Builder> identityProviderDetails)

You can provide a structure that contains the details for the identity provider to use with your web app.

For more details about this parameter, see Configure your identity provider for Transfer Family web apps.

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

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

Parameters:

identityProviderDetails - a consumer that will call methods on WebAppIdentityProviderDetails.Builder

Returns:

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

See Also:

• identityProviderDetails(WebAppIdentityProviderDetails)

accessEndpoint

CreateWebAppRequest.Builder accessEndpoint(String accessEndpoint)

The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.

Before you enter a custom URL for this parameter, follow the steps described in Update your access endpoint with a custom URL.

Parameters:

accessEndpoint - The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.

Before you enter a custom URL for this parameter, follow the steps described in Update your access endpoint with a custom URL.

Returns:

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

webAppUnits

CreateWebAppRequest.Builder webAppUnits(WebAppUnits webAppUnits)

A union that contains the value for number of concurrent connections or the user sessions on your web app.

Parameters:

webAppUnits - A union that contains the value for number of concurrent connections or the user sessions on your web app.

Returns:

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

webAppUnits

default CreateWebAppRequest.Builder webAppUnits(Consumer<WebAppUnits.Builder> webAppUnits)

A union that contains the value for number of concurrent connections or the user sessions on your web app.

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

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

Parameters:

webAppUnits - a consumer that will call methods on WebAppUnits.Builder

Returns:

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

See Also:

• webAppUnits(WebAppUnits)

tags

CreateWebAppRequest.Builder tags(Collection<Tag> tags)

Key-value pairs that can be used to group and search for web apps.

Parameters:

tags - Key-value pairs that can be used to group and search for web apps.

Returns:

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

tags

CreateWebAppRequest.Builder tags(Tag... tags)

Key-value pairs that can be used to group and search for web apps.

Parameters:

tags - Key-value pairs that can be used to group and search for web apps.

Returns:

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

tags

CreateWebAppRequest.Builder tags(Consumer<Tag.Builder>... tags)

Key-value pairs that can be used to group and search for web apps.

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

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

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

webAppEndpointPolicy

CreateWebAppRequest.Builder webAppEndpointPolicy(String webAppEndpointPolicy)

Setting for the type of endpoint policy for the web app. The default value is STANDARD.

If you are creating the web app in an Amazon Web Services GovCloud (US) Region, you can set this parameter to FIPS.

Parameters:

webAppEndpointPolicy - Setting for the type of endpoint policy for the web app. The default value is STANDARD.

If you are creating the web app in an Amazon Web Services GovCloud (US) Region, you can set this parameter to FIPS.

Returns:

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

See Also:

• WebAppEndpointPolicy
• WebAppEndpointPolicy

webAppEndpointPolicy

CreateWebAppRequest.Builder webAppEndpointPolicy(WebAppEndpointPolicy webAppEndpointPolicy)

Setting for the type of endpoint policy for the web app. The default value is STANDARD.

If you are creating the web app in an Amazon Web Services GovCloud (US) Region, you can set this parameter to FIPS.

Parameters:

webAppEndpointPolicy - Setting for the type of endpoint policy for the web app. The default value is STANDARD.

If you are creating the web app in an Amazon Web Services GovCloud (US) Region, you can set this parameter to FIPS.

Returns:

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

See Also:

• WebAppEndpointPolicy
• WebAppEndpointPolicy

overrideConfiguration

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

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