transfer

class pulumi_aws.transfer.GetServerResult(arn=None, endpoint=None, identity_provider_type=None, invocation_role=None, logging_role=None, server_id=None, url=None, id=None)

A collection of values returned by getServer.

arn = None

Amazon Resource Name (ARN) of Transfer Server

endpoint = None

The endpoint of the Transfer Server (e.g. s-12345678.server.transfer.REGION.amazonaws.com)

identity_provider_type = None

The mode of authentication enabled for this service. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the service. API_GATEWAY indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice.

invocation_role = None

Amazon Resource Name (ARN) of the IAM role used to authenticate the user account with an identity_provider_type of API_GATEWAY.

logging_role = None

Amazon Resource Name (ARN) of an IAM role that allows the service to write your SFTP users’ activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

url = None

URL of the service endpoint used to authenticate users with an identity_provider_type of API_GATEWAY.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.transfer.Server(resource_name, opts=None, endpoint_details=None, endpoint_type=None, force_destroy=None, identity_provider_type=None, invocation_role=None, logging_role=None, tags=None, url=None, __name__=None, __opts__=None)

Provides a AWS Transfer Server resource.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • endpoint_details (pulumi.Input[dict]) – The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. Fields documented below.
  • endpoint_type (pulumi.Input[str]) – The type of endpoint that you want your SFTP server connect to. If you connect to a VPC_ENDPOINT, your SFTP server isn’t accessible over the public internet. If you want to connect your SFTP server via public internet, set PUBLIC.
  • force_destroy (pulumi.Input[bool]) – A boolean that indicates all users associated with the server should be deleted so that the Server can be destroyed without error. The default value is false.
  • identity_provider_type (pulumi.Input[str]) – The mode of authentication enabled for this service. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the service. API_GATEWAY indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice.
  • invocation_role (pulumi.Input[str]) – Amazon Resource Name (ARN) of the IAM role used to authenticate the user account with an identity_provider_type of API_GATEWAY.
  • logging_role (pulumi.Input[str]) – Amazon Resource Name (ARN) of an IAM role that allows the service to write your SFTP users’ activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
  • url (pulumi.Input[str]) –
    • URL of the service endpoint used to authenticate users with an identity_provider_type of API_GATEWAY.
arn = None

Amazon Resource Name (ARN) of Transfer Server

endpoint = None

The endpoint of the Transfer Server (e.g. s-12345678.server.transfer.REGION.amazonaws.com)

endpoint_details = None

The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. Fields documented below.

endpoint_type = None

The type of endpoint that you want your SFTP server connect to. If you connect to a VPC_ENDPOINT, your SFTP server isn’t accessible over the public internet. If you want to connect your SFTP server via public internet, set PUBLIC.

force_destroy = None

A boolean that indicates all users associated with the server should be deleted so that the Server can be destroyed without error. The default value is false.

identity_provider_type = None

The mode of authentication enabled for this service. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the service. API_GATEWAY indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice.

invocation_role = None

Amazon Resource Name (ARN) of the IAM role used to authenticate the user account with an identity_provider_type of API_GATEWAY.

logging_role = None

Amazon Resource Name (ARN) of an IAM role that allows the service to write your SFTP users’ activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

tags = None

A mapping of tags to assign to the resource.

url = None
  • URL of the service endpoint used to authenticate users with an identity_provider_type of API_GATEWAY.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.transfer.SshKey(resource_name, opts=None, body=None, server_id=None, user_name=None, __name__=None, __opts__=None)

Provides a AWS Transfer User SSH Key resource.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • body (pulumi.Input[str]) – The public key portion of an SSH key pair.
  • server_id (pulumi.Input[str]) – The Server ID of the Transfer Server (e.g. s-12345678)
  • user_name (pulumi.Input[str]) – The name of the user account that is assigned to one or more servers.
body = None

The public key portion of an SSH key pair.

server_id = None

The Server ID of the Transfer Server (e.g. s-12345678)

user_name = None

The name of the user account that is assigned to one or more servers.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.transfer.User(resource_name, opts=None, home_directory=None, policy=None, role=None, server_id=None, tags=None, user_name=None, __name__=None, __opts__=None)

Provides a AWS Transfer User resource. Managing SSH keys can be accomplished with the ``aws_transfer_ssh_key` resource <https://www.terraform.io/docs/providers/aws/r/transfer_ssh_key.html>`_.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • home_directory (pulumi.Input[str]) – The landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a /. The first item in the path is the name of the home bucket (accessible as ${Transfer:HomeBucket} in the policy) and the rest is the home directory (accessible as ${Transfer:HomeDirectory} in the policy). For example, /example-bucket-1234/username would set the home bucket to example-bucket-1234 and the home directory to username.
  • policy (pulumi.Input[str]) – An IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. Since the IAM variable syntax matches Terraform’s interpolation syntax, they must be escaped inside Terraform configuration strings ($${Transfer:UserName}). These are evaluated on-the-fly when navigating the bucket.
  • role (pulumi.Input[str]) – Amazon Resource Name (ARN) of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.
  • server_id (pulumi.Input[str]) – The Server ID of the Transfer Server (e.g. s-12345678)
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
  • user_name (pulumi.Input[str]) – The name used for log in to your SFTP server.
arn = None

Amazon Resource Name (ARN) of Transfer User

home_directory = None

The landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a /. The first item in the path is the name of the home bucket (accessible as ${Transfer:HomeBucket} in the policy) and the rest is the home directory (accessible as ${Transfer:HomeDirectory} in the policy). For example, /example-bucket-1234/username would set the home bucket to example-bucket-1234 and the home directory to username.

policy = None

An IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. Since the IAM variable syntax matches Terraform’s interpolation syntax, they must be escaped inside Terraform configuration strings ($${Transfer:UserName}). These are evaluated on-the-fly when navigating the bucket.

role = None

Amazon Resource Name (ARN) of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.

server_id = None

The Server ID of the Transfer Server (e.g. s-12345678)

tags = None

A mapping of tags to assign to the resource.

user_name = None

The name used for log in to your SFTP server.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_aws.transfer.get_server(server_id=None, opts=None)

Use this data source to get the ARN of an AWS Transfer Server for use in other resources.