/ 
Paws-0.43
River stage two • 11 direct dependents • 13 total dependents
⭐ Starred 171 GitHub stars
/ Paws::Transfer::UpdateServer

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $transfer = Paws->service('Transfer');
my $UpdateServerResponse = $transfer->UpdateServer(
  ServerId        => 'MyServerId',
  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
  LoggingRole => 'MyNullableRole',    # OPTIONAL
);

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

# Returns a L<Paws::Transfer::UpdateServerResponse> 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/UpdateServer

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 associate one or more Elastic IP addresses with your server's endpoint.

EndpointType => Str

The type of 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, your SFTP server isn't accessible over the public internet.

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

HostKey => Str

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

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://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" in the AWS SFTP User Guide.

IdentityProviderDetails => Paws::Transfer::IdentityProviderDetails

This response parameter is an array containing all of the information required to call a customer's authentication API method.

LoggingRole => Str

A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

REQUIRED ServerId => Str

A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

SEE ALSO

This class forms part of Paws, documenting arguments for method UpdateServer 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