@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateServerRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateServerRequest() |
Modifier and Type | Method and Description |
---|---|
CreateServerRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
EndpointDetails |
getEndpointDetails()
The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server.
|
String |
getEndpointType()
The type of VPC endpoint that you want your SFTP server to connect to.
|
String |
getHostKey()
The RSA private key as generated by the
ssh-keygen -N "" -f my-new-server-key command. |
IdentityProviderDetails |
getIdentityProviderDetails()
This parameter is required when the
IdentityProviderType is set to API_GATEWAY . |
String |
getIdentityProviderType()
Specifies the mode of authentication for the SFTP server.
|
String |
getLoggingRole()
A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring
and auditing purposes.
|
List<Tag> |
getTags()
Key-value pairs that can be used to group and search for servers.
|
int |
hashCode() |
void |
setEndpointDetails(EndpointDetails endpointDetails)
The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server.
|
void |
setEndpointType(String endpointType)
The type of VPC endpoint that you want your SFTP server to connect to.
|
void |
setHostKey(String hostKey)
The RSA private key as generated by the
ssh-keygen -N "" -f my-new-server-key command. |
void |
setIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)
This parameter is required when the
IdentityProviderType is set to API_GATEWAY . |
void |
setIdentityProviderType(String identityProviderType)
Specifies the mode of authentication for the SFTP server.
|
void |
setLoggingRole(String loggingRole)
A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring
and auditing purposes.
|
void |
setTags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for servers.
|
String |
toString()
Returns a string representation of this object.
|
CreateServerRequest |
withEndpointDetails(EndpointDetails endpointDetails)
The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server.
|
CreateServerRequest |
withEndpointType(EndpointType endpointType)
The type of VPC endpoint that you want your SFTP server to connect to.
|
CreateServerRequest |
withEndpointType(String endpointType)
The type of VPC endpoint that you want your SFTP server to connect to.
|
CreateServerRequest |
withHostKey(String hostKey)
The RSA private key as generated by the
ssh-keygen -N "" -f my-new-server-key command. |
CreateServerRequest |
withIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)
This parameter is required when the
IdentityProviderType is set to API_GATEWAY . |
CreateServerRequest |
withIdentityProviderType(IdentityProviderType identityProviderType)
Specifies the mode of authentication for the SFTP server.
|
CreateServerRequest |
withIdentityProviderType(String identityProviderType)
Specifies the mode of authentication for the SFTP server.
|
CreateServerRequest |
withLoggingRole(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 |
withTags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for servers.
|
CreateServerRequest |
withTags(Tag... tags)
Key-value pairs that can be used to group and search for servers.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setEndpointDetails(EndpointDetails endpointDetails)
The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. This parameter
is required when you specify a value for the EndpointType
parameter.
endpointDetails
- The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. This
parameter is required when you specify a value for the EndpointType
parameter.public EndpointDetails getEndpointDetails()
The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. This parameter
is required when you specify a value for the EndpointType
parameter.
EndpointType
parameter.public CreateServerRequest withEndpointDetails(EndpointDetails endpointDetails)
The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. This parameter
is required when you specify a value for the EndpointType
parameter.
endpointDetails
- The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. This
parameter is required when you specify a value for the EndpointType
parameter.public void setEndpointType(String endpointType)
The type of VPC endpoint that you want your SFTP server to connect to. If you connect to a VPC endpoint, your SFTP server isn't accessible over the public internet.
endpointType
- The type of VPC endpoint that you want your SFTP server to connect to. If you connect to a VPC endpoint,
your SFTP server isn't accessible over the public internet.EndpointType
public String getEndpointType()
The type of VPC endpoint that you want your SFTP server to connect to. If you connect to a VPC endpoint, your SFTP server isn't accessible over the public internet.
EndpointType
public CreateServerRequest withEndpointType(String endpointType)
The type of VPC endpoint that you want your SFTP server to connect to. If you connect to a VPC endpoint, your SFTP server isn't accessible over the public internet.
endpointType
- The type of VPC endpoint that you want your SFTP server to connect to. If you connect to a VPC endpoint,
your SFTP server isn't accessible over the public internet.EndpointType
public CreateServerRequest withEndpointType(EndpointType endpointType)
The type of VPC endpoint that you want your SFTP server to connect to. If you connect to a VPC endpoint, your SFTP server isn't accessible over the public internet.
endpointType
- The type of VPC endpoint that you want your SFTP server to connect to. If you connect to a VPC endpoint,
your SFTP server isn't accessible over the public internet.EndpointType
public void setHostKey(String hostKey)
The RSA private key as generated by the ssh-keygen -N "" -f my-new-server-key
command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see "https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" in the AWS SFTP User Guide.
hostKey
- The RSA private key as generated by the ssh-keygen -N "" -f my-new-server-key
command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see "https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" in the AWS SFTP User Guide.
public String getHostKey()
The RSA private key as generated by the ssh-keygen -N "" -f my-new-server-key
command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see "https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" in the AWS SFTP User Guide.
ssh-keygen -N "" -f my-new-server-key
command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see "https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" in the AWS SFTP User Guide.
public CreateServerRequest withHostKey(String hostKey)
The RSA private key as generated by the ssh-keygen -N "" -f my-new-server-key
command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see "https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" in the AWS SFTP User Guide.
hostKey
- The RSA private key as generated by the ssh-keygen -N "" -f my-new-server-key
command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see "https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" in the AWS SFTP User Guide.
public void setIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)
This parameter is required when the IdentityProviderType
is set to API_GATEWAY
. Accepts
an array containing all of the information required to call a customer-supplied authentication API, including the
API Gateway URL. This property is not required when the IdentityProviderType
is set to
SERVICE_MANAGED
.
identityProviderDetails
- This parameter is required when the IdentityProviderType
is set to API_GATEWAY
.
Accepts an array containing all of the information required to call a customer-supplied authentication
API, including the API Gateway URL. This property is not required when the
IdentityProviderType
is set to SERVICE_MANAGED
.public IdentityProviderDetails getIdentityProviderDetails()
This parameter is required when the IdentityProviderType
is set to API_GATEWAY
. Accepts
an array containing all of the information required to call a customer-supplied authentication API, including the
API Gateway URL. This property is not required when the IdentityProviderType
is set to
SERVICE_MANAGED
.
IdentityProviderType
is set to API_GATEWAY
.
Accepts an array containing all of the information required to call a customer-supplied authentication
API, including the API Gateway URL. This property is not required when the
IdentityProviderType
is set to SERVICE_MANAGED
.public CreateServerRequest withIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)
This parameter is required when the IdentityProviderType
is set to API_GATEWAY
. Accepts
an array containing all of the information required to call a customer-supplied authentication API, including the
API Gateway URL. This property is not required when the IdentityProviderType
is set to
SERVICE_MANAGED
.
identityProviderDetails
- This parameter is required when the IdentityProviderType
is set to API_GATEWAY
.
Accepts an array containing all of the information required to call a customer-supplied authentication
API, including the API Gateway URL. This property is not required when the
IdentityProviderType
is set to SERVICE_MANAGED
.public void setIdentityProviderType(String identityProviderType)
Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED
,
which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the
API_GATEWAY
value to integrate with an identity provider of your choosing. The
API_GATEWAY
setting requires you to provide an API Gateway endpoint URL to call for authentication
using the IdentityProviderDetails
parameter.
identityProviderType
- Specifies the mode of authentication for the SFTP server. The default value is
SERVICE_MANAGED
, which allows you to store and access SFTP user credentials within the AWS
Transfer for SFTP service. Use the API_GATEWAY
value to integrate with an identity provider
of your choosing. The API_GATEWAY
setting requires you to provide an API Gateway endpoint URL
to call for authentication using the IdentityProviderDetails
parameter.IdentityProviderType
public String getIdentityProviderType()
Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED
,
which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the
API_GATEWAY
value to integrate with an identity provider of your choosing. The
API_GATEWAY
setting requires you to provide an API Gateway endpoint URL to call for authentication
using the IdentityProviderDetails
parameter.
SERVICE_MANAGED
, which allows you to store and access SFTP user credentials within the AWS
Transfer for SFTP service. Use the API_GATEWAY
value to integrate with an identity provider
of your choosing. The API_GATEWAY
setting requires you to provide an API Gateway endpoint
URL to call for authentication using the IdentityProviderDetails
parameter.IdentityProviderType
public CreateServerRequest withIdentityProviderType(String identityProviderType)
Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED
,
which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the
API_GATEWAY
value to integrate with an identity provider of your choosing. The
API_GATEWAY
setting requires you to provide an API Gateway endpoint URL to call for authentication
using the IdentityProviderDetails
parameter.
identityProviderType
- Specifies the mode of authentication for the SFTP server. The default value is
SERVICE_MANAGED
, which allows you to store and access SFTP user credentials within the AWS
Transfer for SFTP service. Use the API_GATEWAY
value to integrate with an identity provider
of your choosing. The API_GATEWAY
setting requires you to provide an API Gateway endpoint URL
to call for authentication using the IdentityProviderDetails
parameter.IdentityProviderType
public CreateServerRequest withIdentityProviderType(IdentityProviderType identityProviderType)
Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED
,
which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the
API_GATEWAY
value to integrate with an identity provider of your choosing. The
API_GATEWAY
setting requires you to provide an API Gateway endpoint URL to call for authentication
using the IdentityProviderDetails
parameter.
identityProviderType
- Specifies the mode of authentication for the SFTP server. The default value is
SERVICE_MANAGED
, which allows you to store and access SFTP user credentials within the AWS
Transfer for SFTP service. Use the API_GATEWAY
value to integrate with an identity provider
of your choosing. The API_GATEWAY
setting requires you to provide an API Gateway endpoint URL
to call for authentication using the IdentityProviderDetails
parameter.IdentityProviderType
public void setLoggingRole(String loggingRole)
A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
loggingRole
- A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for
monitoring and auditing purposes.public String getLoggingRole()
A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
public CreateServerRequest withLoggingRole(String loggingRole)
A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
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> getTags()
Key-value pairs that can be used to group and search for servers.
public void setTags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for servers.
tags
- Key-value pairs that can be used to group and search for servers.public CreateServerRequest withTags(Tag... tags)
Key-value pairs that can be used to group and search for servers.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- Key-value pairs that can be used to group and search for servers.public CreateServerRequest withTags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for servers.
tags
- Key-value pairs that can be used to group and search for servers.public String toString()
toString
in class Object
Object.toString()
public CreateServerRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.