Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data ListedServer = ListedServer' {}
- newListedServer :: Text -> ListedServer
- listedServer_domain :: Lens' ListedServer (Maybe Domain)
- listedServer_endpointType :: Lens' ListedServer (Maybe EndpointType)
- listedServer_identityProviderType :: Lens' ListedServer (Maybe IdentityProviderType)
- listedServer_loggingRole :: Lens' ListedServer (Maybe Text)
- listedServer_serverId :: Lens' ListedServer (Maybe Text)
- listedServer_state :: Lens' ListedServer (Maybe State)
- listedServer_userCount :: Lens' ListedServer (Maybe Int)
- listedServer_arn :: Lens' ListedServer Text
Documentation
data ListedServer Source #
Returns properties of a file transfer protocol-enabled server that was specified.
See: newListedServer
smart constructor.
ListedServer' | |
|
Instances
Create a value of ListedServer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domain:ListedServer'
, listedServer_domain
- Specifies the domain of the storage system that is used for file
transfers.
$sel:endpointType:ListedServer'
, listedServer_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.
$sel:identityProviderType:ListedServer'
, listedServer_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 or the
IdentityProviderDetails
data type.
$sel:loggingRole:ListedServer'
, listedServer_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.
$sel:serverId:ListedServer'
, listedServer_serverId
- Specifies the unique system assigned identifier for the servers that
were listed.
$sel:state:ListedServer'
, listedServer_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.
$sel:userCount:ListedServer'
, listedServer_userCount
- Specifies the number of users that are assigned to a server you
specified with the ServerId
.
$sel:arn:ListedServer'
, listedServer_arn
- Specifies the unique Amazon Resource Name (ARN) for a server to be
listed.
listedServer_domain :: Lens' ListedServer (Maybe Domain) Source #
Specifies the domain of the storage system that is used for file transfers.
listedServer_endpointType :: Lens' ListedServer (Maybe EndpointType) Source #
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.
listedServer_identityProviderType :: Lens' ListedServer (Maybe IdentityProviderType) Source #
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 or the
IdentityProviderDetails
data type.
listedServer_loggingRole :: Lens' ListedServer (Maybe Text) Source #
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.
listedServer_serverId :: Lens' ListedServer (Maybe Text) Source #
Specifies the unique system assigned identifier for the servers that were listed.
listedServer_state :: Lens' ListedServer (Maybe State) Source #
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.
listedServer_userCount :: Lens' ListedServer (Maybe Int) Source #
Specifies the number of users that are assigned to a server you
specified with the ServerId
.
listedServer_arn :: Lens' ListedServer Text Source #
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.