Package software.amazon.awscdk.cfnpropertymixins.services.transfer

Class CfnServerPropsMixin.IdentityProviderDetailsProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.transfer.CfnServerPropsMixin.IdentityProviderDetailsProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnServerPropsMixin.IdentityProviderDetailsProperty>

Enclosing interface:

CfnServerPropsMixin.IdentityProviderDetailsProperty

@Stability(Stable)
public static final class CfnServerPropsMixin.IdentityProviderDetailsProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnServerPropsMixin.IdentityProviderDetailsProperty>

A builder for CfnServerPropsMixin.IdentityProviderDetailsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnServerPropsMixin.IdentityProviderDetailsProperty	build()	Builds the configured instance.
CfnServerPropsMixin.IdentityProviderDetailsProperty.Builder	directoryId(String directoryId)	Sets the value of CfnServerPropsMixin.IdentityProviderDetailsProperty.getDirectoryId()
CfnServerPropsMixin.IdentityProviderDetailsProperty.Builder	function(String function)	Sets the value of CfnServerPropsMixin.IdentityProviderDetailsProperty.getFunction()
CfnServerPropsMixin.IdentityProviderDetailsProperty.Builder	invocationRole(String invocationRole)	Sets the value of CfnServerPropsMixin.IdentityProviderDetailsProperty.getInvocationRole()
CfnServerPropsMixin.IdentityProviderDetailsProperty.Builder	sftpAuthenticationMethods(String sftpAuthenticationMethods)	Sets the value of CfnServerPropsMixin.IdentityProviderDetailsProperty.getSftpAuthenticationMethods()
CfnServerPropsMixin.IdentityProviderDetailsProperty.Builder	url(String url)	Sets the value of CfnServerPropsMixin.IdentityProviderDetailsProperty.getUrl()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

directoryId

@Stability(Stable)
public CfnServerPropsMixin.IdentityProviderDetailsProperty.Builder directoryId(String directoryId)

Sets the value of CfnServerPropsMixin.IdentityProviderDetailsProperty.getDirectoryId()

Parameters:

directoryId - The identifier of the AWS Directory Service directory that you want to use as your identity provider.

Returns:

this

function

@Stability(Stable)
public CfnServerPropsMixin.IdentityProviderDetailsProperty.Builder function(String function)

Sets the value of CfnServerPropsMixin.IdentityProviderDetailsProperty.getFunction()

Parameters:

function - The ARN for a Lambda function to use for the Identity provider.

Returns:

this

invocationRole

@Stability(Stable)
public CfnServerPropsMixin.IdentityProviderDetailsProperty.Builder invocationRole(String invocationRole)

Sets the value of CfnServerPropsMixin.IdentityProviderDetailsProperty.getInvocationRole()

Parameters:

invocationRole - This parameter is only applicable if your IdentityProviderType is API_GATEWAY . Provides the type of InvocationRole used to authenticate the user account.

Returns:

this

sftpAuthenticationMethods

@Stability(Stable)
public CfnServerPropsMixin.IdentityProviderDetailsProperty.Builder sftpAuthenticationMethods(String sftpAuthenticationMethods)

Sets the value of CfnServerPropsMixin.IdentityProviderDetailsProperty.getSftpAuthenticationMethods()

Parameters:

sftpAuthenticationMethods - For SFTP-enabled servers, and for custom identity providers only , you can specify whether to authenticate using a password, SSH key pair, or both.

• PASSWORD - users must provide their password to connect.
• PUBLIC_KEY - users must provide their private key to connect.
• PUBLIC_KEY_OR_PASSWORD - users can authenticate with either their password or their key. This is the default value.
• PUBLIC_KEY_AND_PASSWORD - users must provide both their private key and their password to connect. The server checks the key first, and then if the key is valid, the system prompts for a password. If the private key provided does not match the public key that is stored, authentication fails.

Returns:

this

url

@Stability(Stable)
public CfnServerPropsMixin.IdentityProviderDetailsProperty.Builder url(String url)

Sets the value of CfnServerPropsMixin.IdentityProviderDetailsProperty.getUrl()

Parameters:

url - Provides the location of the service endpoint used to authenticate users.

Returns:

this

build

@Stability(Stable)
public CfnServerPropsMixin.IdentityProviderDetailsProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnServerPropsMixin.IdentityProviderDetailsProperty>

Returns:

a new instance of CfnServerPropsMixin.IdentityProviderDetailsProperty

Throws:

NullPointerException - if any required attribute was not provided