Class: Aws::Transfer::Types::CreateServerRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb

Overview

Note:

When making an API call, you may pass CreateServerRequest data as a hash:

{
  certificate: "Certificate",
  domain: "S3", # accepts S3, EFS
  endpoint_details: {
    address_allocation_ids: ["AddressAllocationId"],
    subnet_ids: ["SubnetId"],
    vpc_endpoint_id: "VpcEndpointId",
    vpc_id: "VpcId",
    security_group_ids: ["SecurityGroupId"],
  },
  endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
  host_key: "HostKey",
  identity_provider_details: {
    url: "Url",
    invocation_role: "Role",
    directory_id: "DirectoryId",
    function: "Function",
  },
  identity_provider_type: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, API_GATEWAY, AWS_DIRECTORY_SERVICE, AWS_LAMBDA
  logging_role: "Role",
  protocols: ["SFTP"], # accepts SFTP, FTP, FTPS
  protocol_details: {
    passive_ip: "PassiveIp",
    tls_session_resumption_mode: "DISABLED", # accepts DISABLED, ENABLED, ENFORCED
  },
  security_policy_name: "SecurityPolicyName",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  workflow_details: {
    on_upload: [ # required
      {
        workflow_id: "WorkflowId", # required
        execution_role: "Role", # required
      },
    ],
  },
}

Constant Summary collapse

SENSITIVE =
[:host_key]

Instance Attribute Summary collapse

Instance Attribute Details

#certificateString

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

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

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

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

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

  • 2048-bit RSA (RSA_2048)

  • 4096-bit RSA (RSA_4096)

  • Elliptic Prime Curve 256 bit (EC_prime256v1)

  • Elliptic Prime Curve 384 bit (EC_secp384r1)

  • Elliptic Prime Curve 521 bit (EC_secp521r1)

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

Returns:

  • (String)


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 519

class CreateServerRequest < Struct.new(
  :certificate,
  :domain,
  :endpoint_details,
  :endpoint_type,
  :host_key,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :protocol_details,
  :security_policy_name,
  :tags,
  :workflow_details)
  SENSITIVE = [:host_key]
  include Aws::Structure
end

#domainString

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.

After the server is created, the domain cannot be changed.

Returns:

  • (String)


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 519

class CreateServerRequest < Struct.new(
  :certificate,
  :domain,
  :endpoint_details,
  :endpoint_type,
  :host_key,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :protocol_details,
  :security_policy_name,
  :tags,
  :workflow_details)
  SENSITIVE = [:host_key]
  include Aws::Structure
end

#endpoint_detailsTypes::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 IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 519

class CreateServerRequest < Struct.new(
  :certificate,
  :domain,
  :endpoint_details,
  :endpoint_type,
  :host_key,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :protocol_details,
  :security_policy_name,
  :tags,
  :workflow_details)
  SENSITIVE = [:host_key]
  include Aws::Structure
end

#endpoint_typeString

The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

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.

Returns:

  • (String)


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 519

class CreateServerRequest < Struct.new(
  :certificate,
  :domain,
  :endpoint_details,
  :endpoint_type,
  :host_key,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :protocol_details,
  :security_policy_name,
  :tags,
  :workflow_details)
  SENSITIVE = [:host_key]
  include Aws::Structure
end

#host_keyString

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 Amazon Web Services Transfer Family User Guide.

Returns:

  • (String)


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 519

class CreateServerRequest < Struct.new(
  :certificate,
  :domain,
  :endpoint_details,
  :endpoint_type,
  :host_key,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :protocol_details,
  :security_policy_name,
  :tags,
  :workflow_details)
  SENSITIVE = [:host_key]
  include Aws::Structure
end

#identity_provider_detailsTypes::IdentityProviderDetails

Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 519

class CreateServerRequest < Struct.new(
  :certificate,
  :domain,
  :endpoint_details,
  :endpoint_type,
  :host_key,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :protocol_details,
  :security_policy_name,
  :tags,
  :workflow_details)
  SENSITIVE = [:host_key]
  include Aws::Structure
end

#identity_provider_typeString

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 Amazon Web Services Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID 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 API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

Use the AWS_LAMBDA value to directly use a 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.

Returns:

  • (String)


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 519

class CreateServerRequest < Struct.new(
  :certificate,
  :domain,
  :endpoint_details,
  :endpoint_type,
  :host_key,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :protocol_details,
  :security_policy_name,
  :tags,
  :workflow_details)
  SENSITIVE = [:host_key]
  include Aws::Structure
end

#logging_roleString

Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.

Returns:

  • (String)


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 519

class CreateServerRequest < Struct.new(
  :certificate,
  :domain,
  :endpoint_details,
  :endpoint_type,
  :host_key,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :protocol_details,
  :security_policy_name,
  :tags,
  :workflow_details)
  SENSITIVE = [:host_key]
  include Aws::Structure
end

#protocol_detailsTypes::ProtocolDetails

The protocol settings that are configured for your server.

Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols). Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.

Use the TlsSessionResumptionMode parameter to determine whether or not your Transfer server resumes recent, negotiated sessions through a unique session ID.



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 519

class CreateServerRequest < Struct.new(
  :certificate,
  :domain,
  :endpoint_details,
  :endpoint_type,
  :host_key,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :protocol_details,
  :security_policy_name,
  :tags,
  :workflow_details)
  SENSITIVE = [:host_key]
  include Aws::Structure
end

#protocolsArray<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:

  • SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

  • FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

  • FTP (File Transfer Protocol): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in Amazon Web Services Certificate Manager (ACM) which is 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 AWS_DIRECTORY_SERVICE or 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.

Returns:

  • (Array<String>)


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 519

class CreateServerRequest < Struct.new(
  :certificate,
  :domain,
  :endpoint_details,
  :endpoint_type,
  :host_key,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :protocol_details,
  :security_policy_name,
  :tags,
  :workflow_details)
  SENSITIVE = [:host_key]
  include Aws::Structure
end

#security_policy_nameString

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

Returns:

  • (String)


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 519

class CreateServerRequest < Struct.new(
  :certificate,
  :domain,
  :endpoint_details,
  :endpoint_type,
  :host_key,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :protocol_details,
  :security_policy_name,
  :tags,
  :workflow_details)
  SENSITIVE = [:host_key]
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 519

class CreateServerRequest < Struct.new(
  :certificate,
  :domain,
  :endpoint_details,
  :endpoint_type,
  :host_key,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :protocol_details,
  :security_policy_name,
  :tags,
  :workflow_details)
  SENSITIVE = [:host_key]
  include Aws::Structure
end

#workflow_detailsTypes::WorkflowDetails

Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 519

class CreateServerRequest < Struct.new(
  :certificate,
  :domain,
  :endpoint_details,
  :endpoint_type,
  :host_key,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :protocol_details,
  :security_policy_name,
  :tags,
  :workflow_details)
  SENSITIVE = [:host_key]
  include Aws::Structure
end