1. Packages
  2. Gcore Provider
  3. API Docs
  4. StorageSftp
gcore 0.19.0 published on Monday, Apr 14, 2025 by g-core

gcore.StorageSftp

Explore with Pulumi AI

Represent sftp storage resource. https://storage.gcore.com/storage/list

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcore from "@pulumi/gcore";

const exampleSftp = new gcore.StorageSftp("exampleSftp", {
    location: "mia",
    sshKeyIds: [199],
});
Copy
import pulumi
import pulumi_gcore as gcore

example_sftp = gcore.StorageSftp("exampleSftp",
    location="mia",
    ssh_key_ids=[199])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/gcore"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gcore.NewStorageSftp(ctx, "exampleSftp", &gcore.StorageSftpArgs{
			Location: pulumi.String("mia"),
			SshKeyIds: pulumi.Float64Array{
				pulumi.Float64(199),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcore = Pulumi.Gcore;

return await Deployment.RunAsync(() => 
{
    var exampleSftp = new Gcore.StorageSftp("exampleSftp", new()
    {
        Location = "mia",
        SshKeyIds = new[]
        {
            199,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcore.StorageSftp;
import com.pulumi.gcore.StorageSftpArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleSftp = new StorageSftp("exampleSftp", StorageSftpArgs.builder()
            .location("mia")
            .sshKeyIds(199)
            .build());

    }
}
Copy
resources:
  exampleSftp:
    type: gcore:StorageSftp
    properties:
      location: mia
      sshKeyIds:
        - 199
Copy

Create StorageSftp Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new StorageSftp(name: string, args: StorageSftpArgs, opts?: CustomResourceOptions);
@overload
def StorageSftp(resource_name: str,
                args: StorageSftpArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def StorageSftp(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                location: Optional[str] = None,
                generated_sftp_endpoint: Optional[str] = None,
                generated_password: Optional[bool] = None,
                client_id: Optional[float] = None,
                http_expires_header_value: Optional[str] = None,
                http_servername_alias: Optional[str] = None,
                generated_http_endpoint: Optional[str] = None,
                name: Optional[str] = None,
                password: Optional[str] = None,
                ssh_key_ids: Optional[Sequence[float]] = None,
                storage_id: Optional[float] = None,
                storage_sftp_id: Optional[str] = None,
                update_after_create: Optional[bool] = None)
func NewStorageSftp(ctx *Context, name string, args StorageSftpArgs, opts ...ResourceOption) (*StorageSftp, error)
public StorageSftp(string name, StorageSftpArgs args, CustomResourceOptions? opts = null)
public StorageSftp(String name, StorageSftpArgs args)
public StorageSftp(String name, StorageSftpArgs args, CustomResourceOptions options)
type: gcore:StorageSftp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. StorageSftpArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. StorageSftpArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. StorageSftpArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. StorageSftpArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. StorageSftpArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var storageSftpResource = new Gcore.StorageSftp("storageSftpResource", new()
{
    Location = "string",
    GeneratedSftpEndpoint = "string",
    GeneratedPassword = false,
    ClientId = 0,
    HttpExpiresHeaderValue = "string",
    HttpServernameAlias = "string",
    GeneratedHttpEndpoint = "string",
    Name = "string",
    Password = "string",
    SshKeyIds = new[]
    {
        0,
    },
    StorageId = 0,
    StorageSftpId = "string",
    UpdateAfterCreate = false,
});
Copy
example, err := gcore.NewStorageSftp(ctx, "storageSftpResource", &gcore.StorageSftpArgs{
Location: pulumi.String("string"),
GeneratedSftpEndpoint: pulumi.String("string"),
GeneratedPassword: pulumi.Bool(false),
ClientId: pulumi.Float64(0),
HttpExpiresHeaderValue: pulumi.String("string"),
HttpServernameAlias: pulumi.String("string"),
GeneratedHttpEndpoint: pulumi.String("string"),
Name: pulumi.String("string"),
Password: pulumi.String("string"),
SshKeyIds: pulumi.Float64Array{
pulumi.Float64(0),
},
StorageId: pulumi.Float64(0),
StorageSftpId: pulumi.String("string"),
UpdateAfterCreate: pulumi.Bool(false),
})
Copy
var storageSftpResource = new StorageSftp("storageSftpResource", StorageSftpArgs.builder()
    .location("string")
    .generatedSftpEndpoint("string")
    .generatedPassword(false)
    .clientId(0)
    .httpExpiresHeaderValue("string")
    .httpServernameAlias("string")
    .generatedHttpEndpoint("string")
    .name("string")
    .password("string")
    .sshKeyIds(0)
    .storageId(0)
    .storageSftpId("string")
    .updateAfterCreate(false)
    .build());
Copy
storage_sftp_resource = gcore.StorageSftp("storageSftpResource",
    location="string",
    generated_sftp_endpoint="string",
    generated_password=False,
    client_id=0,
    http_expires_header_value="string",
    http_servername_alias="string",
    generated_http_endpoint="string",
    name="string",
    password="string",
    ssh_key_ids=[0],
    storage_id=0,
    storage_sftp_id="string",
    update_after_create=False)
Copy
const storageSftpResource = new gcore.StorageSftp("storageSftpResource", {
    location: "string",
    generatedSftpEndpoint: "string",
    generatedPassword: false,
    clientId: 0,
    httpExpiresHeaderValue: "string",
    httpServernameAlias: "string",
    generatedHttpEndpoint: "string",
    name: "string",
    password: "string",
    sshKeyIds: [0],
    storageId: 0,
    storageSftpId: "string",
    updateAfterCreate: false,
});
Copy
type: gcore:StorageSftp
properties:
    clientId: 0
    generatedHttpEndpoint: string
    generatedPassword: false
    generatedSftpEndpoint: string
    httpExpiresHeaderValue: string
    httpServernameAlias: string
    location: string
    name: string
    password: string
    sshKeyIds:
        - 0
    storageId: 0
    storageSftpId: string
    updateAfterCreate: false
Copy

StorageSftp Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The StorageSftp resource accepts the following input properties:

Location This property is required. string
A location of new storage resource. One of (ams, sin, fra, mia)
ClientId double
An client id of new storage resource.
GeneratedHttpEndpoint string
A http sftp entry point for new storage resource.
GeneratedPassword bool
An auto generated sftp password for new storage resource.
GeneratedSftpEndpoint string
A ssh sftp entry point for new storage resource.
HttpExpiresHeaderValue string
A expires date of storage resource.
HttpServernameAlias string
An alias of storage resource.
Name string
A name of new storage resource.
Password string
A sftp password for new storage resource.
SshKeyIds List<double>
An ssh keys IDs to link with new sftp storage resource only. https://storage.gcore.com/ssh-key/list
StorageId double
An id of new storage resource.
StorageSftpId string
The ID of this resource.
UpdateAfterCreate bool
A temporary flag. An internal cheat, to skip update ssh keys. Skip it.
Location This property is required. string
A location of new storage resource. One of (ams, sin, fra, mia)
ClientId float64
An client id of new storage resource.
GeneratedHttpEndpoint string
A http sftp entry point for new storage resource.
GeneratedPassword bool
An auto generated sftp password for new storage resource.
GeneratedSftpEndpoint string
A ssh sftp entry point for new storage resource.
HttpExpiresHeaderValue string
A expires date of storage resource.
HttpServernameAlias string
An alias of storage resource.
Name string
A name of new storage resource.
Password string
A sftp password for new storage resource.
SshKeyIds []float64
An ssh keys IDs to link with new sftp storage resource only. https://storage.gcore.com/ssh-key/list
StorageId float64
An id of new storage resource.
StorageSftpId string
The ID of this resource.
UpdateAfterCreate bool
A temporary flag. An internal cheat, to skip update ssh keys. Skip it.
location This property is required. String
A location of new storage resource. One of (ams, sin, fra, mia)
clientId Double
An client id of new storage resource.
generatedHttpEndpoint String
A http sftp entry point for new storage resource.
generatedPassword Boolean
An auto generated sftp password for new storage resource.
generatedSftpEndpoint String
A ssh sftp entry point for new storage resource.
httpExpiresHeaderValue String
A expires date of storage resource.
httpServernameAlias String
An alias of storage resource.
name String
A name of new storage resource.
password String
A sftp password for new storage resource.
sshKeyIds List<Double>
An ssh keys IDs to link with new sftp storage resource only. https://storage.gcore.com/ssh-key/list
storageId Double
An id of new storage resource.
storageSftpId String
The ID of this resource.
updateAfterCreate Boolean
A temporary flag. An internal cheat, to skip update ssh keys. Skip it.
location This property is required. string
A location of new storage resource. One of (ams, sin, fra, mia)
clientId number
An client id of new storage resource.
generatedHttpEndpoint string
A http sftp entry point for new storage resource.
generatedPassword boolean
An auto generated sftp password for new storage resource.
generatedSftpEndpoint string
A ssh sftp entry point for new storage resource.
httpExpiresHeaderValue string
A expires date of storage resource.
httpServernameAlias string
An alias of storage resource.
name string
A name of new storage resource.
password string
A sftp password for new storage resource.
sshKeyIds number[]
An ssh keys IDs to link with new sftp storage resource only. https://storage.gcore.com/ssh-key/list
storageId number
An id of new storage resource.
storageSftpId string
The ID of this resource.
updateAfterCreate boolean
A temporary flag. An internal cheat, to skip update ssh keys. Skip it.
location This property is required. str
A location of new storage resource. One of (ams, sin, fra, mia)
client_id float
An client id of new storage resource.
generated_http_endpoint str
A http sftp entry point for new storage resource.
generated_password bool
An auto generated sftp password for new storage resource.
generated_sftp_endpoint str
A ssh sftp entry point for new storage resource.
http_expires_header_value str
A expires date of storage resource.
http_servername_alias str
An alias of storage resource.
name str
A name of new storage resource.
password str
A sftp password for new storage resource.
ssh_key_ids Sequence[float]
An ssh keys IDs to link with new sftp storage resource only. https://storage.gcore.com/ssh-key/list
storage_id float
An id of new storage resource.
storage_sftp_id str
The ID of this resource.
update_after_create bool
A temporary flag. An internal cheat, to skip update ssh keys. Skip it.
location This property is required. String
A location of new storage resource. One of (ams, sin, fra, mia)
clientId Number
An client id of new storage resource.
generatedHttpEndpoint String
A http sftp entry point for new storage resource.
generatedPassword Boolean
An auto generated sftp password for new storage resource.
generatedSftpEndpoint String
A ssh sftp entry point for new storage resource.
httpExpiresHeaderValue String
A expires date of storage resource.
httpServernameAlias String
An alias of storage resource.
name String
A name of new storage resource.
password String
A sftp password for new storage resource.
sshKeyIds List<Number>
An ssh keys IDs to link with new sftp storage resource only. https://storage.gcore.com/ssh-key/list
storageId Number
An id of new storage resource.
storageSftpId String
The ID of this resource.
updateAfterCreate Boolean
A temporary flag. An internal cheat, to skip update ssh keys. Skip it.

Outputs

All input properties are implicitly available as output properties. Additionally, the StorageSftp resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing StorageSftp Resource

Get an existing StorageSftp resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: StorageSftpState, opts?: CustomResourceOptions): StorageSftp
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[float] = None,
        generated_http_endpoint: Optional[str] = None,
        generated_password: Optional[bool] = None,
        generated_sftp_endpoint: Optional[str] = None,
        http_expires_header_value: Optional[str] = None,
        http_servername_alias: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        ssh_key_ids: Optional[Sequence[float]] = None,
        storage_id: Optional[float] = None,
        storage_sftp_id: Optional[str] = None,
        update_after_create: Optional[bool] = None) -> StorageSftp
func GetStorageSftp(ctx *Context, name string, id IDInput, state *StorageSftpState, opts ...ResourceOption) (*StorageSftp, error)
public static StorageSftp Get(string name, Input<string> id, StorageSftpState? state, CustomResourceOptions? opts = null)
public static StorageSftp get(String name, Output<String> id, StorageSftpState state, CustomResourceOptions options)
resources:  _:    type: gcore:StorageSftp    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ClientId double
An client id of new storage resource.
GeneratedHttpEndpoint string
A http sftp entry point for new storage resource.
GeneratedPassword bool
An auto generated sftp password for new storage resource.
GeneratedSftpEndpoint string
A ssh sftp entry point for new storage resource.
HttpExpiresHeaderValue string
A expires date of storage resource.
HttpServernameAlias string
An alias of storage resource.
Location string
A location of new storage resource. One of (ams, sin, fra, mia)
Name string
A name of new storage resource.
Password string
A sftp password for new storage resource.
SshKeyIds List<double>
An ssh keys IDs to link with new sftp storage resource only. https://storage.gcore.com/ssh-key/list
StorageId double
An id of new storage resource.
StorageSftpId string
The ID of this resource.
UpdateAfterCreate bool
A temporary flag. An internal cheat, to skip update ssh keys. Skip it.
ClientId float64
An client id of new storage resource.
GeneratedHttpEndpoint string
A http sftp entry point for new storage resource.
GeneratedPassword bool
An auto generated sftp password for new storage resource.
GeneratedSftpEndpoint string
A ssh sftp entry point for new storage resource.
HttpExpiresHeaderValue string
A expires date of storage resource.
HttpServernameAlias string
An alias of storage resource.
Location string
A location of new storage resource. One of (ams, sin, fra, mia)
Name string
A name of new storage resource.
Password string
A sftp password for new storage resource.
SshKeyIds []float64
An ssh keys IDs to link with new sftp storage resource only. https://storage.gcore.com/ssh-key/list
StorageId float64
An id of new storage resource.
StorageSftpId string
The ID of this resource.
UpdateAfterCreate bool
A temporary flag. An internal cheat, to skip update ssh keys. Skip it.
clientId Double
An client id of new storage resource.
generatedHttpEndpoint String
A http sftp entry point for new storage resource.
generatedPassword Boolean
An auto generated sftp password for new storage resource.
generatedSftpEndpoint String
A ssh sftp entry point for new storage resource.
httpExpiresHeaderValue String
A expires date of storage resource.
httpServernameAlias String
An alias of storage resource.
location String
A location of new storage resource. One of (ams, sin, fra, mia)
name String
A name of new storage resource.
password String
A sftp password for new storage resource.
sshKeyIds List<Double>
An ssh keys IDs to link with new sftp storage resource only. https://storage.gcore.com/ssh-key/list
storageId Double
An id of new storage resource.
storageSftpId String
The ID of this resource.
updateAfterCreate Boolean
A temporary flag. An internal cheat, to skip update ssh keys. Skip it.
clientId number
An client id of new storage resource.
generatedHttpEndpoint string
A http sftp entry point for new storage resource.
generatedPassword boolean
An auto generated sftp password for new storage resource.
generatedSftpEndpoint string
A ssh sftp entry point for new storage resource.
httpExpiresHeaderValue string
A expires date of storage resource.
httpServernameAlias string
An alias of storage resource.
location string
A location of new storage resource. One of (ams, sin, fra, mia)
name string
A name of new storage resource.
password string
A sftp password for new storage resource.
sshKeyIds number[]
An ssh keys IDs to link with new sftp storage resource only. https://storage.gcore.com/ssh-key/list
storageId number
An id of new storage resource.
storageSftpId string
The ID of this resource.
updateAfterCreate boolean
A temporary flag. An internal cheat, to skip update ssh keys. Skip it.
client_id float
An client id of new storage resource.
generated_http_endpoint str
A http sftp entry point for new storage resource.
generated_password bool
An auto generated sftp password for new storage resource.
generated_sftp_endpoint str
A ssh sftp entry point for new storage resource.
http_expires_header_value str
A expires date of storage resource.
http_servername_alias str
An alias of storage resource.
location str
A location of new storage resource. One of (ams, sin, fra, mia)
name str
A name of new storage resource.
password str
A sftp password for new storage resource.
ssh_key_ids Sequence[float]
An ssh keys IDs to link with new sftp storage resource only. https://storage.gcore.com/ssh-key/list
storage_id float
An id of new storage resource.
storage_sftp_id str
The ID of this resource.
update_after_create bool
A temporary flag. An internal cheat, to skip update ssh keys. Skip it.
clientId Number
An client id of new storage resource.
generatedHttpEndpoint String
A http sftp entry point for new storage resource.
generatedPassword Boolean
An auto generated sftp password for new storage resource.
generatedSftpEndpoint String
A ssh sftp entry point for new storage resource.
httpExpiresHeaderValue String
A expires date of storage resource.
httpServernameAlias String
An alias of storage resource.
location String
A location of new storage resource. One of (ams, sin, fra, mia)
name String
A name of new storage resource.
password String
A sftp password for new storage resource.
sshKeyIds List<Number>
An ssh keys IDs to link with new sftp storage resource only. https://storage.gcore.com/ssh-key/list
storageId Number
An id of new storage resource.
storageSftpId String
The ID of this resource.
updateAfterCreate Boolean
A temporary flag. An internal cheat, to skip update ssh keys. Skip it.

Package Details

Repository
gcore g-core/terraform-provider-gcore
License
Notes
This Pulumi package is based on the gcore Terraform Provider.