1. Packages
  2. Mso Provider
  3. API Docs
  4. RemoteLocation
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet

mso.RemoteLocation

Explore with Pulumi AI

mso logo
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet

    Create RemoteLocation Resource

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

    Constructor syntax

    new RemoteLocation(name: string, args: RemoteLocationArgs, opts?: CustomResourceOptions);
    @overload
    def RemoteLocation(resource_name: str,
                       args: RemoteLocationArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def RemoteLocation(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       hostname: Optional[str] = None,
                       path: Optional[str] = None,
                       protocol: Optional[str] = None,
                       username: Optional[str] = None,
                       description: Optional[str] = None,
                       name: Optional[str] = None,
                       passphrase: Optional[str] = None,
                       password: Optional[str] = None,
                       port: Optional[float] = None,
                       remote_location_id: Optional[str] = None,
                       ssh_key: Optional[str] = None)
    func NewRemoteLocation(ctx *Context, name string, args RemoteLocationArgs, opts ...ResourceOption) (*RemoteLocation, error)
    public RemoteLocation(string name, RemoteLocationArgs args, CustomResourceOptions? opts = null)
    public RemoteLocation(String name, RemoteLocationArgs args)
    public RemoteLocation(String name, RemoteLocationArgs args, CustomResourceOptions options)
    
    type: mso:RemoteLocation
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args RemoteLocationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RemoteLocationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RemoteLocationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RemoteLocationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RemoteLocationArgs
    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 remoteLocationResource = new Mso.RemoteLocation("remoteLocationResource", new()
    {
        Hostname = "string",
        Path = "string",
        Protocol = "string",
        Username = "string",
        Description = "string",
        Name = "string",
        Passphrase = "string",
        Password = "string",
        Port = 0,
        RemoteLocationId = "string",
        SshKey = "string",
    });
    
    example, err := mso.NewRemoteLocation(ctx, "remoteLocationResource", &mso.RemoteLocationArgs{
    	Hostname:         pulumi.String("string"),
    	Path:             pulumi.String("string"),
    	Protocol:         pulumi.String("string"),
    	Username:         pulumi.String("string"),
    	Description:      pulumi.String("string"),
    	Name:             pulumi.String("string"),
    	Passphrase:       pulumi.String("string"),
    	Password:         pulumi.String("string"),
    	Port:             pulumi.Float64(0),
    	RemoteLocationId: pulumi.String("string"),
    	SshKey:           pulumi.String("string"),
    })
    
    var remoteLocationResource = new RemoteLocation("remoteLocationResource", RemoteLocationArgs.builder()
        .hostname("string")
        .path("string")
        .protocol("string")
        .username("string")
        .description("string")
        .name("string")
        .passphrase("string")
        .password("string")
        .port(0)
        .remoteLocationId("string")
        .sshKey("string")
        .build());
    
    remote_location_resource = mso.RemoteLocation("remoteLocationResource",
        hostname="string",
        path="string",
        protocol="string",
        username="string",
        description="string",
        name="string",
        passphrase="string",
        password="string",
        port=0,
        remote_location_id="string",
        ssh_key="string")
    
    const remoteLocationResource = new mso.RemoteLocation("remoteLocationResource", {
        hostname: "string",
        path: "string",
        protocol: "string",
        username: "string",
        description: "string",
        name: "string",
        passphrase: "string",
        password: "string",
        port: 0,
        remoteLocationId: "string",
        sshKey: "string",
    });
    
    type: mso:RemoteLocation
    properties:
        description: string
        hostname: string
        name: string
        passphrase: string
        password: string
        path: string
        port: 0
        protocol: string
        remoteLocationId: string
        sshKey: string
        username: string
    

    RemoteLocation 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 RemoteLocation resource accepts the following input properties:

    Hostname string
    Path string
    Protocol string
    Username string
    Description string
    Name string
    Passphrase string
    Password string
    Port double
    RemoteLocationId string
    SshKey string
    Hostname string
    Path string
    Protocol string
    Username string
    Description string
    Name string
    Passphrase string
    Password string
    Port float64
    RemoteLocationId string
    SshKey string
    hostname String
    path String
    protocol String
    username String
    description String
    name String
    passphrase String
    password String
    port Double
    remoteLocationId String
    sshKey String
    hostname string
    path string
    protocol string
    username string
    description string
    name string
    passphrase string
    password string
    port number
    remoteLocationId string
    sshKey string
    hostname String
    path String
    protocol String
    username String
    description String
    name String
    passphrase String
    password String
    port Number
    remoteLocationId String
    sshKey String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RemoteLocation 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 RemoteLocation Resource

    Get an existing RemoteLocation 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?: RemoteLocationState, opts?: CustomResourceOptions): RemoteLocation
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            hostname: Optional[str] = None,
            name: Optional[str] = None,
            passphrase: Optional[str] = None,
            password: Optional[str] = None,
            path: Optional[str] = None,
            port: Optional[float] = None,
            protocol: Optional[str] = None,
            remote_location_id: Optional[str] = None,
            ssh_key: Optional[str] = None,
            username: Optional[str] = None) -> RemoteLocation
    func GetRemoteLocation(ctx *Context, name string, id IDInput, state *RemoteLocationState, opts ...ResourceOption) (*RemoteLocation, error)
    public static RemoteLocation Get(string name, Input<string> id, RemoteLocationState? state, CustomResourceOptions? opts = null)
    public static RemoteLocation get(String name, Output<String> id, RemoteLocationState state, CustomResourceOptions options)
    resources:  _:    type: mso:RemoteLocation    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Description string
    Hostname string
    Name string
    Passphrase string
    Password string
    Path string
    Port double
    Protocol string
    RemoteLocationId string
    SshKey string
    Username string
    Description string
    Hostname string
    Name string
    Passphrase string
    Password string
    Path string
    Port float64
    Protocol string
    RemoteLocationId string
    SshKey string
    Username string
    description String
    hostname String
    name String
    passphrase String
    password String
    path String
    port Double
    protocol String
    remoteLocationId String
    sshKey String
    username String
    description string
    hostname string
    name string
    passphrase string
    password string
    path string
    port number
    protocol string
    remoteLocationId string
    sshKey string
    username string
    description String
    hostname String
    name String
    passphrase String
    password String
    path String
    port Number
    protocol String
    remoteLocationId String
    sshKey String
    username String

    Package Details

    Repository
    mso ciscodevnet/terraform-provider-mso
    License
    Notes
    This Pulumi package is based on the mso Terraform Provider.
    mso logo
    mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet