software.amazon.awscdk.services.transfer

Interface CfnServer.IdentityProviderDetailsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServer.IdentityProviderDetailsProperty.Jsii$Proxy

Enclosing class:

CfnServer

@Stability(value=Stable)
public static interface CfnServer.IdentityProviderDetailsProperty
extends software.amazon.jsii.JsiiSerializable

Required when `IdentityProviderType` is set to `AWS_DIRECTORY_SERVICE` or `API_GATEWAY` .

Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.transfer.*;
 IdentityProviderDetailsProperty identityProviderDetailsProperty = IdentityProviderDetailsProperty.builder()
         .directoryId("directoryId")
         .function("function")
         .invocationRole("invocationRole")
         .url("url")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnServer.IdentityProviderDetailsProperty.Builder A builder for CfnServer.IdentityProviderDetailsProperty
static class	CfnServer.IdentityProviderDetailsProperty.Jsii$Proxy An implementation for CfnServer.IdentityProviderDetailsProperty

Method Summary

Modifier and Type	Method and Description
static CfnServer.IdentityProviderDetailsProperty.Builder	builder()
default String	getDirectoryId() The identifier of the AWS Directory Service directory that you want to stop sharing.
default String	getFunction() The ARN for a lambda function to use for the Identity provider.
default String	getInvocationRole() Provides the type of `InvocationRole` used to authenticate the user account.
default String	getUrl() Provides the location of the service endpoint used to authenticate users.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDirectoryId

@Stability(value=Stable)
 @Nullable
default String getDirectoryId()

The identifier of the AWS Directory Service directory that you want to stop sharing.

getFunction

@Stability(value=Stable)
 @Nullable
default String getFunction()

The ARN for a lambda function to use for the Identity provider.

getInvocationRole

@Stability(value=Stable)
 @Nullable
default String getInvocationRole()

Provides the type of `InvocationRole` used to authenticate the user account.

getUrl

@Stability(value=Stable)
 @Nullable
default String getUrl()

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

builder

@Stability(value=Stable)
static CfnServer.IdentityProviderDetailsProperty.Builder builder()

Returns:

a CfnServer.IdentityProviderDetailsProperty.Builder of CfnServer.IdentityProviderDetailsProperty