Interface ListedServer.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ListedServer.Builder,
,ListedServer> SdkBuilder<ListedServer.Builder,
,ListedServer> SdkPojo
- Enclosing class:
ListedServer
-
Method Summary
Modifier and TypeMethodDescriptionSpecifies the unique Amazon Resource Name (ARN) for a server to be listed.Specifies the domain of the storage system that is used for file transfers.Specifies the domain of the storage system that is used for file transfers.endpointType
(String endpointType) Specifies the type of VPC endpoint that your server is connected to.endpointType
(EndpointType endpointType) Specifies the type of VPC endpoint that your server is connected to.identityProviderType
(String identityProviderType) The mode of authentication for a server.identityProviderType
(IdentityProviderType identityProviderType) The mode of authentication for a server.loggingRole
(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.Specifies the unique system assigned identifier for the servers that were listed.The condition of the server that was described.The condition of the server that was described.Specifies the number of users that are assigned to a server you specified with theServerId
.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
arn
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
- Parameters:
arn
- Specifies the unique Amazon Resource Name (ARN) for a server to be listed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domain
Specifies the domain of the storage system that is used for file transfers.
- Parameters:
domain
- Specifies the domain of the storage system that is used for file transfers.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
domain
Specifies the domain of the storage system that is used for file transfers.
- Parameters:
domain
- Specifies the domain of the storage system that is used for file transfers.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theIdentityProviderDetails
parameter.Use the
API_GATEWAY
value to integrate with an identity provider of your choosing. TheAPI_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using theIdentityProviderDetails
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 theFunction
parameter for theIdentityProviderDetails
data type.- Parameters:
identityProviderType
- The mode of authentication for a server. The default value isSERVICE_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 theIdentityProviderDetails
parameter.Use the
API_GATEWAY
value to integrate with an identity provider of your choosing. TheAPI_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using theIdentityProviderDetails
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 theFunction
parameter for theIdentityProviderDetails
data type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theIdentityProviderDetails
parameter.Use the
API_GATEWAY
value to integrate with an identity provider of your choosing. TheAPI_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using theIdentityProviderDetails
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 theFunction
parameter for theIdentityProviderDetails
data type.- Parameters:
identityProviderType
- The mode of authentication for a server. The default value isSERVICE_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 theIdentityProviderDetails
parameter.Use the
API_GATEWAY
value to integrate with an identity provider of your choosing. TheAPI_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using theIdentityProviderDetails
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 theFunction
parameter for theIdentityProviderDetails
data type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serverId
Specifies the unique system assigned identifier for the servers that were listed.
- Parameters:
serverId
- Specifies the unique system assigned identifier for the servers that were listed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
state
The condition of the server that was described. A value of
ONLINE
indicates that the server can accept jobs and transfer files. AState
value ofOFFLINE
means that the server cannot perform file transfer operations.The states of
STARTING
andSTOPPING
indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values ofSTART_FAILED
orSTOP_FAILED
can indicate an error condition.- Parameters:
state
- The condition of the server that was described. A value ofONLINE
indicates that the server can accept jobs and transfer files. AState
value ofOFFLINE
means that the server cannot perform file transfer operations.The states of
STARTING
andSTOPPING
indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values ofSTART_FAILED
orSTOP_FAILED
can indicate an error condition.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
state
The condition of the server that was described. A value of
ONLINE
indicates that the server can accept jobs and transfer files. AState
value ofOFFLINE
means that the server cannot perform file transfer operations.The states of
STARTING
andSTOPPING
indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values ofSTART_FAILED
orSTOP_FAILED
can indicate an error condition.- Parameters:
state
- The condition of the server that was described. A value ofONLINE
indicates that the server can accept jobs and transfer files. AState
value ofOFFLINE
means that the server cannot perform file transfer operations.The states of
STARTING
andSTOPPING
indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values ofSTART_FAILED
orSTOP_FAILED
can indicate an error condition.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
userCount
Specifies the number of users that are assigned to a server you specified with the
ServerId
.- Parameters:
userCount
- Specifies the number of users that are assigned to a server you specified with theServerId
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-