software.amazon.awssdk.services.transfer.model

Interface CreateServerRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateServerRequest

public static interface CreateServerRequest.Builder
extends TransferRequest.Builder, SdkPojo, CopyableBuilder<CreateServerRequest.Builder,CreateServerRequest>

Method Summary

Modifier and Type	Method and Description
default CreateServerRequest.Builder	identityProviderDetails(Consumer<IdentityProviderDetails.Builder> identityProviderDetails) An array containing all of the information required to call a customer-supplied authentication API.
CreateServerRequest.Builder	identityProviderDetails(IdentityProviderDetails identityProviderDetails) An array containing all of the information required to call a customer-supplied authentication API.
CreateServerRequest.Builder	identityProviderType(IdentityProviderType identityProviderType) The mode of authentication enabled for this service.
CreateServerRequest.Builder	identityProviderType(String identityProviderType) The mode of authentication enabled for this service.
CreateServerRequest.Builder	loggingRole(String loggingRole) A value that allows the service to write your SFTP users’ activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
CreateServerRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateServerRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateServerRequest.Builder	tags(Collection<Tag> tags) Key-value pairs that can be used to group and search for servers.
CreateServerRequest.Builder	tags(Consumer<Tag.Builder>... tags) Key-value pairs that can be used to group and search for servers.
CreateServerRequest.Builder	tags(Tag... tags) Key-value pairs that can be used to group and search for servers.

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

build

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

overrideConfiguration

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

sdkFields

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

copy

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

applyMutation, build

Method Detail

identityProviderDetails

CreateServerRequest.Builder identityProviderDetails(IdentityProviderDetails identityProviderDetails)

An array containing all of the information required to call a customer-supplied authentication API. This parameter is not required when the IdentityProviderType value of server that is created uses the SERVICE_MANAGED authentication method.

Parameters:

identityProviderDetails - An array containing all of the information required to call a customer-supplied authentication API. This parameter is not required when the IdentityProviderType value of server that is created uses the SERVICE_MANAGED authentication method.

Returns:

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

identityProviderDetails

default CreateServerRequest.Builder identityProviderDetails(Consumer<IdentityProviderDetails.Builder> identityProviderDetails)

An array containing all of the information required to call a customer-supplied authentication API. This parameter is not required when the IdentityProviderType value of server that is created uses the SERVICE_MANAGED authentication method.

This is a convenience that creates an instance of the IdentityProviderDetails.Builder avoiding the need to create one manually via IdentityProviderDetails.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to identityProviderDetails(IdentityProviderDetails).

Parameters:

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

Returns:

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

See Also:

identityProviderDetails(IdentityProviderDetails)

identityProviderType

CreateServerRequest.Builder identityProviderType(String identityProviderType)

The mode of authentication enabled for this service. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the service. An IdentityProviderType value of API_GATEWAY indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice.

Parameters:

identityProviderType - The mode of authentication enabled for this service. The default value is SERVICE_MANAGED , which allows you to store and access SFTP user credentials within the service. An IdentityProviderType value of API_GATEWAY indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice.

Returns:

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

See Also:

IdentityProviderType, IdentityProviderType

identityProviderType

CreateServerRequest.Builder identityProviderType(IdentityProviderType identityProviderType)

The mode of authentication enabled for this service. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the service. An IdentityProviderType value of API_GATEWAY indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice.

Parameters:

identityProviderType - The mode of authentication enabled for this service. The default value is SERVICE_MANAGED , which allows you to store and access SFTP user credentials within the service. An IdentityProviderType value of API_GATEWAY indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice.

Returns:

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

See Also:

IdentityProviderType, IdentityProviderType

loggingRole

CreateServerRequest.Builder loggingRole(String loggingRole)

A value that allows the service to write your SFTP users’ activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

Parameters:

loggingRole - A value that allows the service to write your SFTP users’ activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

Returns:

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

tags

CreateServerRequest.Builder tags(Collection<Tag> tags)

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

Parameters:

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

Returns:

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

tags

CreateServerRequest.Builder tags(Tag... tags)

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

Parameters:

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

Returns:

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

tags

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

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

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

Returns:

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

See Also:

#tags(List)

overrideConfiguration

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

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