A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Aws/Transfer/Types/CreateServerRequest.html below:

CreateServerRequest — AWS SDK for Ruby V2

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Transfer::Types::CreateServerRequest
Inherits:
Struct show all
Defined in:
(unknown)
Overview Note:

When passing CreateServerRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  certificate: "Certificate",
  endpoint_details: {
    address_allocation_ids: ["AddressAllocationId"],
    subnet_ids: ["SubnetId"],
    vpc_endpoint_id: "VpcEndpointId",
    vpc_id: "VpcId",
    security_group_ids: ["SecurityGroupId"],
  },
  endpoint_type: "PUBLIC",   host_key: "HostKey",
  identity_provider_details: {
    url: "Url",
    invocation_role: "Role",
  },
  identity_provider_type: "SERVICE_MANAGED",   logging_role: "Role",
  protocols: ["SFTP"],   security_policy_name: "SecurityPolicyName",
  tags: [
    {
      key: "TagKey",       value: "TagValue",     },
  ],
}
Instance Attribute Summary collapse Instance Attribute Details #certificate ⇒ String

The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.

To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.

Certificates with the following cryptographic algorithms and key sizes are supported:

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

#endpoint_details ⇒ Types::EndpointDetails

The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IPs and make it accessible to clients over the internet. Your VPC\'s default security groups are automatically assigned to your endpoint.

#endpoint_type ⇒ String

The type of VPC endpoint that you want your server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server\'s endpoint and use VPC security groups to restrict traffic by the client\'s public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.

Possible values:

#host_key ⇒ String

The RSA private key as generated by the ssh-keygen -N "" -m PEM -f my-new-server-key command.

If you aren\'t planning to migrate existing users from an existing SFTP-enabled server to a new server, don\'t update the host key. Accidentally changing a server\'s host key can be disruptive.

For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.

#identity_provider_details ⇒ Types::IdentityProviderDetails

Required when 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. Not required when IdentityProviderType is set to SERVICE_MANAGED.

#identity_provider_type ⇒ String

Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the AWS Transfer Family 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.

Possible values:

#logging_role ⇒ String

Allows the service to write your users\' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

#protocols ⇒ Array<String>

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server\'s endpoint. The available protocols are:

If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.

If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be API_GATEWAY.

If Protocol includes FTP, then AddressAllocationIds cannot be associated.

If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.

#security_policy_name ⇒ String

Specifies the name of the security policy that is attached to the server.

#tags ⇒ Array<Types::Tag>

Key-value pairs that can be used to group and search for servers.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4