NAME

Paws::Transfer::CreateServer - Arguments for method CreateServer on Paws::Transfer

DESCRIPTION

This class represents the parameters used for calling the method CreateServer on the AWS Transfer for SFTP service. Use the attributes of this class as arguments to method CreateServer.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateServer.

SYNOPSIS

my $transfer = Paws->service('Transfer');
my $CreateServerResponse = $transfer->CreateServer(
  EndpointDetails => {
    AddressAllocationIds => [ 'MyAddressAllocationId', ... ],    # OPTIONAL
    SubnetIds            => [ 'MySubnetId',            ... ],    # OPTIONAL
    VpcEndpointId        => 'MyVpcEndpointId',  # min: 22, max: 22; OPTIONAL
    VpcId                => 'MyVpcId',          # OPTIONAL
  },    # OPTIONAL
  EndpointType            => 'PUBLIC',       # OPTIONAL
  HostKey                 => 'MyHostKey',    # OPTIONAL
  IdentityProviderDetails => {
    InvocationRole => 'MyRole',              # min: 20, max: 2048; OPTIONAL
    Url            => 'MyUrl',               # max: 255; OPTIONAL
  },    # OPTIONAL
  IdentityProviderType => 'SERVICE_MANAGED',    # OPTIONAL
  LoggingRole          => 'MyRole',             # OPTIONAL
  Tags                 => [
    {
      Key   => 'MyTagKey',      # max: 128
      Value => 'MyTagValue',    # max: 256

    },
    ...
  ],    # OPTIONAL
);

# Results:
my $ServerId = $CreateServerResponse->ServerId;

# Returns a L<Paws::Transfer::CreateServerResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/transfer/CreateServer

ATTRIBUTES

EndpointDetails => Paws::Transfer::EndpointDetails

The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.

EndpointType => Str

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

Valid values are: "PUBLIC", "VPC", "VPC_ENDPOINT"

HostKey => Str

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

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

For more information, see "https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" in the AWS SFTP User Guide.

IdentityProviderDetails => Paws::Transfer::IdentityProviderDetails

This parameter is required when the 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. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.

IdentityProviderType => Str

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

Valid values are: "SERVICE_MANAGED", "API_GATEWAY"

LoggingRole => Str

A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

Tags => ArrayRef[Paws::Transfer::Tag]

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

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateServer in Paws::Transfer

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

cpanm Paws::SDK::Config

perl -MCPAN -e shell
install Paws::SDK::Config