@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ListedServer extends Object implements Serializable, Cloneable, StructuredPojo
Returns properties of a file transfer protocol-enabled server that was specified.
Constructor and Description |
---|
ListedServer() |
Modifier and Type | Method and Description |
---|---|
ListedServer |
clone() |
boolean |
equals(Object obj) |
String |
getArn()
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
|
String |
getDomain()
Specifies the domain of the storage system that is used for file transfers.
|
String |
getEndpointType()
Specifies the type of VPC endpoint that your server is connected to.
|
String |
getIdentityProviderType()
The mode of authentication for a server.
|
String |
getLoggingRole()
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on
Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents.
|
String |
getServerId()
Specifies the unique system assigned identifier for the servers that were listed.
|
String |
getState()
The condition of the server that was described.
|
Integer |
getUserCount()
Specifies the number of users that are assigned to a server you specified with the
ServerId . |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setArn(String arn)
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
|
void |
setDomain(String domain)
Specifies the domain of the storage system that is used for file transfers.
|
void |
setEndpointType(String endpointType)
Specifies the type of VPC endpoint that your server is connected to.
|
void |
setIdentityProviderType(String identityProviderType)
The mode of authentication for a server.
|
void |
setLoggingRole(String loggingRole)
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on
Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents.
|
void |
setServerId(String serverId)
Specifies the unique system assigned identifier for the servers that were listed.
|
void |
setState(String state)
The condition of the server that was described.
|
void |
setUserCount(Integer userCount)
Specifies the number of users that are assigned to a server you specified with the
ServerId . |
String |
toString()
Returns a string representation of this object.
|
ListedServer |
withArn(String arn)
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
|
ListedServer |
withDomain(Domain domain)
Specifies the domain of the storage system that is used for file transfers.
|
ListedServer |
withDomain(String domain)
Specifies the domain of the storage system that is used for file transfers.
|
ListedServer |
withEndpointType(EndpointType endpointType)
Specifies the type of VPC endpoint that your server is connected to.
|
ListedServer |
withEndpointType(String endpointType)
Specifies the type of VPC endpoint that your server is connected to.
|
ListedServer |
withIdentityProviderType(IdentityProviderType identityProviderType)
The mode of authentication for a server.
|
ListedServer |
withIdentityProviderType(String identityProviderType)
The mode of authentication for a server.
|
ListedServer |
withLoggingRole(String loggingRole)
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on
Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents.
|
ListedServer |
withServerId(String serverId)
Specifies the unique system assigned identifier for the servers that were listed.
|
ListedServer |
withState(State state)
The condition of the server that was described.
|
ListedServer |
withState(String state)
The condition of the server that was described.
|
ListedServer |
withUserCount(Integer userCount)
Specifies the number of users that are assigned to a server you specified with the
ServerId . |
public void setArn(String arn)
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
arn
- Specifies the unique Amazon Resource Name (ARN) for a server to be listed.public String getArn()
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
public ListedServer withArn(String arn)
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
arn
- Specifies the unique Amazon Resource Name (ARN) for a server to be listed.public void setDomain(String domain)
Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.
domain
- Specifies the domain of the storage system that is used for file transfers. There are two domains
available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The
default value is S3.Domain
public String getDomain()
Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.
Domain
public ListedServer withDomain(String domain)
Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.
domain
- Specifies the domain of the storage system that is used for file transfers. There are two domains
available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The
default value is S3.Domain
public ListedServer withDomain(Domain domain)
Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.
domain
- Specifies the domain of the storage system that is used for file transfers. There are two domains
available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The
default value is S3.Domain
public void setIdentityProviderType(String identityProviderType)
The mode of authentication for a server. The default value is SERVICE_MANAGED
, which allows you to
store and access user credentials within the Transfer Family service.
Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in Directory Service for
Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web
Services using AD Connector. This option also requires you to provide a Directory ID by using the
IdentityProviderDetails
parameter.
Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The
API_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for
authentication by using the IdentityProviderDetails
parameter.
Use the AWS_LAMBDA
value to directly use an Lambda function as your identity provider. If you choose
this value, you must specify the ARN for the Lambda function in the Function
parameter for the
IdentityProviderDetails
data type.
identityProviderType
- The mode of authentication for a server. The default value is SERVICE_MANAGED
, which allows
you to store and access user credentials within the Transfer Family service.
Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in Directory Service
for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon
Web Services using AD Connector. This option also requires you to provide a Directory ID by using the
IdentityProviderDetails
parameter.
Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The
API_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for
authentication by using the IdentityProviderDetails
parameter.
Use the AWS_LAMBDA
value to directly use an Lambda function as your identity provider. If you
choose this value, you must specify the ARN for the Lambda function in the Function
parameter
for the IdentityProviderDetails
data type.
IdentityProviderType
public String getIdentityProviderType()
The mode of authentication for a server. The default value is SERVICE_MANAGED
, which allows you to
store and access user credentials within the Transfer Family service.
Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in Directory Service for
Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web
Services using AD Connector. This option also requires you to provide a Directory ID by using the
IdentityProviderDetails
parameter.
Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The
API_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for
authentication by using the IdentityProviderDetails
parameter.
Use the AWS_LAMBDA
value to directly use an Lambda function as your identity provider. If you choose
this value, you must specify the ARN for the Lambda function in the Function
parameter for the
IdentityProviderDetails
data type.
SERVICE_MANAGED
, which allows
you to store and access user credentials within the Transfer Family service.
Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in Directory Service
for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon
Web Services using AD Connector. This option also requires you to provide a Directory ID by using the
IdentityProviderDetails
parameter.
Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The
API_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for
authentication by using the IdentityProviderDetails
parameter.
Use the AWS_LAMBDA
value to directly use an Lambda function as your identity provider. If
you choose this value, you must specify the ARN for the Lambda function in the Function
parameter for the IdentityProviderDetails
data type.
IdentityProviderType
public ListedServer withIdentityProviderType(String identityProviderType)
The mode of authentication for a server. The default value is SERVICE_MANAGED
, which allows you to
store and access user credentials within the Transfer Family service.
Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in Directory Service for
Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web
Services using AD Connector. This option also requires you to provide a Directory ID by using the
IdentityProviderDetails
parameter.
Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The
API_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for
authentication by using the IdentityProviderDetails
parameter.
Use the AWS_LAMBDA
value to directly use an Lambda function as your identity provider. If you choose
this value, you must specify the ARN for the Lambda function in the Function
parameter for the
IdentityProviderDetails
data type.
identityProviderType
- The mode of authentication for a server. The default value is SERVICE_MANAGED
, which allows
you to store and access user credentials within the Transfer Family service.
Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in Directory Service
for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon
Web Services using AD Connector. This option also requires you to provide a Directory ID by using the
IdentityProviderDetails
parameter.
Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The
API_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for
authentication by using the IdentityProviderDetails
parameter.
Use the AWS_LAMBDA
value to directly use an Lambda function as your identity provider. If you
choose this value, you must specify the ARN for the Lambda function in the Function
parameter
for the IdentityProviderDetails
data type.
IdentityProviderType
public ListedServer withIdentityProviderType(IdentityProviderType identityProviderType)
The mode of authentication for a server. The default value is SERVICE_MANAGED
, which allows you to
store and access user credentials within the Transfer Family service.
Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in Directory Service for
Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web
Services using AD Connector. This option also requires you to provide a Directory ID by using the
IdentityProviderDetails
parameter.
Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The
API_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for
authentication by using the IdentityProviderDetails
parameter.
Use the AWS_LAMBDA
value to directly use an Lambda function as your identity provider. If you choose
this value, you must specify the ARN for the Lambda function in the Function
parameter for the
IdentityProviderDetails
data type.
identityProviderType
- The mode of authentication for a server. The default value is SERVICE_MANAGED
, which allows
you to store and access user credentials within the Transfer Family service.
Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in Directory Service
for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon
Web Services using AD Connector. This option also requires you to provide a Directory ID by using the
IdentityProviderDetails
parameter.
Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The
API_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for
authentication by using the IdentityProviderDetails
parameter.
Use the AWS_LAMBDA
value to directly use an Lambda function as your identity provider. If you
choose this value, you must specify the ARN for the Lambda function in the Function
parameter
for the IdentityProviderDetails
data type.
IdentityProviderType
public void setEndpointType(String endpointType)
Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
endpointType
- Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC
endpoint, your server isn't accessible over the public internet.EndpointType
public String getEndpointType()
Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
EndpointType
public ListedServer withEndpointType(String endpointType)
Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
endpointType
- Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC
endpoint, your server isn't accessible over the public internet.EndpointType
public ListedServer withEndpointType(EndpointType endpointType)
Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
endpointType
- Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC
endpoint, your server isn't accessible over the public internet.EndpointType
public void setLoggingRole(String loggingRole)
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
loggingRole
- The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to
turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity
in your CloudWatch logs.public String getLoggingRole()
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
public ListedServer withLoggingRole(String loggingRole)
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
loggingRole
- The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to
turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity
in your CloudWatch logs.public void setServerId(String serverId)
Specifies the unique system assigned identifier for the servers that were listed.
serverId
- Specifies the unique system assigned identifier for the servers that were listed.public String getServerId()
Specifies the unique system assigned identifier for the servers that were listed.
public ListedServer withServerId(String serverId)
Specifies the unique system assigned identifier for the servers that were listed.
serverId
- Specifies the unique system assigned identifier for the servers that were listed.public void setState(String state)
The condition of the server that was described. A value of ONLINE
indicates that the server can
accept jobs and transfer files. A State
value of OFFLINE
means that the server cannot
perform file transfer operations.
The states of STARTING
and STOPPING
indicate that the server is in an intermediate
state, either not fully able to respond, or not fully offline. The values of START_FAILED
or
STOP_FAILED
can indicate an error condition.
state
- The condition of the server that was described. A value of ONLINE
indicates that the server
can accept jobs and transfer files. A State
value of OFFLINE
means that the
server cannot perform file transfer operations.
The states of STARTING
and STOPPING
indicate that the server is in an
intermediate state, either not fully able to respond, or not fully offline. The values of
START_FAILED
or STOP_FAILED
can indicate an error condition.
State
public String getState()
The condition of the server that was described. A value of ONLINE
indicates that the server can
accept jobs and transfer files. A State
value of OFFLINE
means that the server cannot
perform file transfer operations.
The states of STARTING
and STOPPING
indicate that the server is in an intermediate
state, either not fully able to respond, or not fully offline. The values of START_FAILED
or
STOP_FAILED
can indicate an error condition.
ONLINE
indicates that the server
can accept jobs and transfer files. A State
value of OFFLINE
means that the
server cannot perform file transfer operations.
The states of STARTING
and STOPPING
indicate that the server is in an
intermediate state, either not fully able to respond, or not fully offline. The values of
START_FAILED
or STOP_FAILED
can indicate an error condition.
State
public ListedServer withState(String state)
The condition of the server that was described. A value of ONLINE
indicates that the server can
accept jobs and transfer files. A State
value of OFFLINE
means that the server cannot
perform file transfer operations.
The states of STARTING
and STOPPING
indicate that the server is in an intermediate
state, either not fully able to respond, or not fully offline. The values of START_FAILED
or
STOP_FAILED
can indicate an error condition.
state
- The condition of the server that was described. A value of ONLINE
indicates that the server
can accept jobs and transfer files. A State
value of OFFLINE
means that the
server cannot perform file transfer operations.
The states of STARTING
and STOPPING
indicate that the server is in an
intermediate state, either not fully able to respond, or not fully offline. The values of
START_FAILED
or STOP_FAILED
can indicate an error condition.
State
public ListedServer withState(State state)
The condition of the server that was described. A value of ONLINE
indicates that the server can
accept jobs and transfer files. A State
value of OFFLINE
means that the server cannot
perform file transfer operations.
The states of STARTING
and STOPPING
indicate that the server is in an intermediate
state, either not fully able to respond, or not fully offline. The values of START_FAILED
or
STOP_FAILED
can indicate an error condition.
state
- The condition of the server that was described. A value of ONLINE
indicates that the server
can accept jobs and transfer files. A State
value of OFFLINE
means that the
server cannot perform file transfer operations.
The states of STARTING
and STOPPING
indicate that the server is in an
intermediate state, either not fully able to respond, or not fully offline. The values of
START_FAILED
or STOP_FAILED
can indicate an error condition.
State
public void setUserCount(Integer userCount)
Specifies the number of users that are assigned to a server you specified with the ServerId
.
userCount
- Specifies the number of users that are assigned to a server you specified with the ServerId
.public Integer getUserCount()
Specifies the number of users that are assigned to a server you specified with the ServerId
.
ServerId
.public ListedServer withUserCount(Integer userCount)
Specifies the number of users that are assigned to a server you specified with the ServerId
.
userCount
- Specifies the number of users that are assigned to a server you specified with the ServerId
.public String toString()
toString
in class Object
Object.toString()
public ListedServer clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.