@Generated(value="software.amazon.awssdk:codegen") public final class CreateServerRequest extends TransferRequest implements ToCopyableBuilder<CreateServerRequest.Builder,CreateServerRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateServerRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static CreateServerRequest.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
IdentityProviderDetails |
identityProviderDetails()
An array containing all of the information required to call a customer-supplied authentication API.
|
IdentityProviderType |
identityProviderType()
The mode of authentication enabled for this service.
|
String |
identityProviderTypeAsString()
The mode of authentication enabled for this service.
|
String |
loggingRole()
A value that allows the service to write your SFTP users’ activity to your Amazon CloudWatch logs for monitoring
and auditing purposes.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateServerRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
Key-value pairs that can be used to group and search for servers.
|
CreateServerRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public 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.
IdentityProviderType
value of server that is created uses
the SERVICE_MANAGED
authentication method.public 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.
If the service returns an enum value that is not available in the current SDK version,
identityProviderType
will return IdentityProviderType.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from identityProviderTypeAsString()
.
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.IdentityProviderType
public String identityProviderTypeAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
identityProviderType
will return IdentityProviderType.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from identityProviderTypeAsString()
.
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.IdentityProviderType
public String loggingRole()
A value that allows the service to write your SFTP users’ activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
public List<Tag> tags()
Key-value pairs that can be used to group and search for servers.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public CreateServerRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateServerRequest.Builder,CreateServerRequest>
toBuilder
in class TransferRequest
public static CreateServerRequest.Builder builder()
public static Class<? extends CreateServerRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.