1. Packages
  2. Venafi Provider
  3. API Docs
  4. SshConfig
Venafi v1.10.4 published on Wednesday, Oct 16, 2024 by Pulumi

venafi.SshConfig

Explore with Pulumi AI

venafi logo
Venafi v1.10.4 published on Wednesday, Oct 16, 2024 by Pulumi

    Provides access to retrieve configuration from SSH certificate issuance template from Venafi Trust Protection Platform.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as venafi from "@pulumi/venafi";
    
    const cit = new venafi.SshConfig("cit", {template: "devops-terraform-cit"});
    
    import pulumi
    import pulumi_venafi as venafi
    
    cit = venafi.SshConfig("cit", template="devops-terraform-cit")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-venafi/sdk/go/venafi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := venafi.NewSshConfig(ctx, "cit", &venafi.SshConfigArgs{
    			Template: pulumi.String("devops-terraform-cit"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Venafi = Pulumi.Venafi;
    
    return await Deployment.RunAsync(() => 
    {
        var cit = new Venafi.SshConfig("cit", new()
        {
            Template = "devops-terraform-cit",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.venafi.SshConfig;
    import com.pulumi.venafi.SshConfigArgs;
    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 cit = new SshConfig("cit", SshConfigArgs.builder()
                .template("devops-terraform-cit")
                .build());
    
        }
    }
    
    resources:
      cit:
        type: venafi:SshConfig
        properties:
          template: devops-terraform-cit
    

    Create SshConfig Resource

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

    Constructor syntax

    new SshConfig(name: string, args: SshConfigArgs, opts?: CustomResourceOptions);
    @overload
    def SshConfig(resource_name: str,
                  args: SshConfigArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def SshConfig(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  template: Optional[str] = None)
    func NewSshConfig(ctx *Context, name string, args SshConfigArgs, opts ...ResourceOption) (*SshConfig, error)
    public SshConfig(string name, SshConfigArgs args, CustomResourceOptions? opts = null)
    public SshConfig(String name, SshConfigArgs args)
    public SshConfig(String name, SshConfigArgs args, CustomResourceOptions options)
    
    type: venafi:SshConfig
    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 SshConfigArgs
    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 SshConfigArgs
    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 SshConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SshConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SshConfigArgs
    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 sshConfigResource = new Venafi.SshConfig("sshConfigResource", new()
    {
        Template = "string",
    });
    
    example, err := venafi.NewSshConfig(ctx, "sshConfigResource", &venafi.SshConfigArgs{
    	Template: pulumi.String("string"),
    })
    
    var sshConfigResource = new SshConfig("sshConfigResource", SshConfigArgs.builder()
        .template("string")
        .build());
    
    ssh_config_resource = venafi.SshConfig("sshConfigResource", template="string")
    
    const sshConfigResource = new venafi.SshConfig("sshConfigResource", {template: "string"});
    
    type: venafi:SshConfig
    properties:
        template: string
    

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

    Template string
    The SSH certificate issuing template.
    Template string
    The SSH certificate issuing template.
    template String
    The SSH certificate issuing template.
    template string
    The SSH certificate issuing template.
    template str
    The SSH certificate issuing template.
    template String
    The SSH certificate issuing template.

    Outputs

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

    CaPublicKey string
    (Optional, string) The template's CA public key.
    Id string
    The provider-assigned unique ID for this managed resource.
    Principals List<string>
    (Optional, set of strings) A list of user names exported from the template.
    CaPublicKey string
    (Optional, string) The template's CA public key.
    Id string
    The provider-assigned unique ID for this managed resource.
    Principals []string
    (Optional, set of strings) A list of user names exported from the template.
    caPublicKey String
    (Optional, string) The template's CA public key.
    id String
    The provider-assigned unique ID for this managed resource.
    principals List<String>
    (Optional, set of strings) A list of user names exported from the template.
    caPublicKey string
    (Optional, string) The template's CA public key.
    id string
    The provider-assigned unique ID for this managed resource.
    principals string[]
    (Optional, set of strings) A list of user names exported from the template.
    ca_public_key str
    (Optional, string) The template's CA public key.
    id str
    The provider-assigned unique ID for this managed resource.
    principals Sequence[str]
    (Optional, set of strings) A list of user names exported from the template.
    caPublicKey String
    (Optional, string) The template's CA public key.
    id String
    The provider-assigned unique ID for this managed resource.
    principals List<String>
    (Optional, set of strings) A list of user names exported from the template.

    Look up Existing SshConfig Resource

    Get an existing SshConfig 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?: SshConfigState, opts?: CustomResourceOptions): SshConfig
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ca_public_key: Optional[str] = None,
            principals: Optional[Sequence[str]] = None,
            template: Optional[str] = None) -> SshConfig
    func GetSshConfig(ctx *Context, name string, id IDInput, state *SshConfigState, opts ...ResourceOption) (*SshConfig, error)
    public static SshConfig Get(string name, Input<string> id, SshConfigState? state, CustomResourceOptions? opts = null)
    public static SshConfig get(String name, Output<String> id, SshConfigState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    CaPublicKey string
    (Optional, string) The template's CA public key.
    Principals List<string>
    (Optional, set of strings) A list of user names exported from the template.
    Template string
    The SSH certificate issuing template.
    CaPublicKey string
    (Optional, string) The template's CA public key.
    Principals []string
    (Optional, set of strings) A list of user names exported from the template.
    Template string
    The SSH certificate issuing template.
    caPublicKey String
    (Optional, string) The template's CA public key.
    principals List<String>
    (Optional, set of strings) A list of user names exported from the template.
    template String
    The SSH certificate issuing template.
    caPublicKey string
    (Optional, string) The template's CA public key.
    principals string[]
    (Optional, set of strings) A list of user names exported from the template.
    template string
    The SSH certificate issuing template.
    ca_public_key str
    (Optional, string) The template's CA public key.
    principals Sequence[str]
    (Optional, set of strings) A list of user names exported from the template.
    template str
    The SSH certificate issuing template.
    caPublicKey String
    (Optional, string) The template's CA public key.
    principals List<String>
    (Optional, set of strings) A list of user names exported from the template.
    template String
    The SSH certificate issuing template.

    Package Details

    Repository
    Venafi pulumi/pulumi-venafi
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the venafi Terraform Provider.
    venafi logo
    Venafi v1.10.4 published on Wednesday, Oct 16, 2024 by Pulumi