1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixVpnCertDownload
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix

aviatrix.AviatrixVpnCertDownload

Explore with Pulumi AI

aviatrix logo
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix

    The aviatrix_vpn_cert_download resource manages the VPN Certificate Download configuration for SAML Authentication

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Aviatrix = Pulumi.Aviatrix;
    
    return await Deployment.RunAsync(() => 
    {
        // Set up the Aviatrix VPN Certificate Download configuration
        var testVpnCertDownload = new Aviatrix.AviatrixVpnCertDownload("testVpnCertDownload", new()
        {
            DownloadEnabled = true,
            SamlEndpoints = new[]
            {
                "saml_endpoint_name",
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/astipkovits/pulumi-aviatrix/sdk/go/aviatrix"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := aviatrix.NewAviatrixVpnCertDownload(ctx, "testVpnCertDownload", &aviatrix.AviatrixVpnCertDownloadArgs{
    			DownloadEnabled: pulumi.Bool(true),
    			SamlEndpoints: pulumi.StringArray{
    				pulumi.String("saml_endpoint_name"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aviatrix.AviatrixVpnCertDownload;
    import com.pulumi.aviatrix.AviatrixVpnCertDownloadArgs;
    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 testVpnCertDownload = new AviatrixVpnCertDownload("testVpnCertDownload", AviatrixVpnCertDownloadArgs.builder()        
                .downloadEnabled(true)
                .samlEndpoints("saml_endpoint_name")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aviatrix as aviatrix
    
    # Set up the Aviatrix VPN Certificate Download configuration
    test_vpn_cert_download = aviatrix.AviatrixVpnCertDownload("testVpnCertDownload",
        download_enabled=True,
        saml_endpoints=["saml_endpoint_name"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aviatrix from "@pulumi/aviatrix";
    
    // Set up the Aviatrix VPN Certificate Download configuration
    const testVpnCertDownload = new aviatrix.AviatrixVpnCertDownload("test_vpn_cert_download", {
        downloadEnabled: true,
        samlEndpoints: ["saml_endpoint_name"],
    });
    
    resources:
      # Set up the Aviatrix VPN Certificate Download configuration
      testVpnCertDownload:
        type: aviatrix:AviatrixVpnCertDownload
        properties:
          downloadEnabled: true
          samlEndpoints:
            - saml_endpoint_name
    

    Create AviatrixVpnCertDownload Resource

    new AviatrixVpnCertDownload(name: string, args?: AviatrixVpnCertDownloadArgs, opts?: CustomResourceOptions);
    @overload
    def AviatrixVpnCertDownload(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                download_enabled: Optional[bool] = None,
                                saml_endpoints: Optional[Sequence[str]] = None)
    @overload
    def AviatrixVpnCertDownload(resource_name: str,
                                args: Optional[AviatrixVpnCertDownloadArgs] = None,
                                opts: Optional[ResourceOptions] = None)
    func NewAviatrixVpnCertDownload(ctx *Context, name string, args *AviatrixVpnCertDownloadArgs, opts ...ResourceOption) (*AviatrixVpnCertDownload, error)
    public AviatrixVpnCertDownload(string name, AviatrixVpnCertDownloadArgs? args = null, CustomResourceOptions? opts = null)
    public AviatrixVpnCertDownload(String name, AviatrixVpnCertDownloadArgs args)
    public AviatrixVpnCertDownload(String name, AviatrixVpnCertDownloadArgs args, CustomResourceOptions options)
    
    type: aviatrix:AviatrixVpnCertDownload
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args AviatrixVpnCertDownloadArgs
    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 AviatrixVpnCertDownloadArgs
    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 AviatrixVpnCertDownloadArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixVpnCertDownloadArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixVpnCertDownloadArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    AviatrixVpnCertDownload Resource Properties

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

    Inputs

    The AviatrixVpnCertDownload resource accepts the following input properties:

    DownloadEnabled bool
    Whether the VPN Certificate download is enabled. Supported Values: "true", "false".
    SamlEndpoints List<string>
    List of SAML endpoint names for which the downloading should be enabled . Currently, only a single endpoint is supported. Example: ["saml_endpoint_1"].
    DownloadEnabled bool
    Whether the VPN Certificate download is enabled. Supported Values: "true", "false".
    SamlEndpoints []string
    List of SAML endpoint names for which the downloading should be enabled . Currently, only a single endpoint is supported. Example: ["saml_endpoint_1"].
    downloadEnabled Boolean
    Whether the VPN Certificate download is enabled. Supported Values: "true", "false".
    samlEndpoints List<String>
    List of SAML endpoint names for which the downloading should be enabled . Currently, only a single endpoint is supported. Example: ["saml_endpoint_1"].
    downloadEnabled boolean
    Whether the VPN Certificate download is enabled. Supported Values: "true", "false".
    samlEndpoints string[]
    List of SAML endpoint names for which the downloading should be enabled . Currently, only a single endpoint is supported. Example: ["saml_endpoint_1"].
    download_enabled bool
    Whether the VPN Certificate download is enabled. Supported Values: "true", "false".
    saml_endpoints Sequence[str]
    List of SAML endpoint names for which the downloading should be enabled . Currently, only a single endpoint is supported. Example: ["saml_endpoint_1"].
    downloadEnabled Boolean
    Whether the VPN Certificate download is enabled. Supported Values: "true", "false".
    samlEndpoints List<String>
    List of SAML endpoint names for which the downloading should be enabled . Currently, only a single endpoint is supported. Example: ["saml_endpoint_1"].

    Outputs

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

    Get an existing AviatrixVpnCertDownload 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?: AviatrixVpnCertDownloadState, opts?: CustomResourceOptions): AviatrixVpnCertDownload
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            download_enabled: Optional[bool] = None,
            saml_endpoints: Optional[Sequence[str]] = None) -> AviatrixVpnCertDownload
    func GetAviatrixVpnCertDownload(ctx *Context, name string, id IDInput, state *AviatrixVpnCertDownloadState, opts ...ResourceOption) (*AviatrixVpnCertDownload, error)
    public static AviatrixVpnCertDownload Get(string name, Input<string> id, AviatrixVpnCertDownloadState? state, CustomResourceOptions? opts = null)
    public static AviatrixVpnCertDownload get(String name, Output<String> id, AviatrixVpnCertDownloadState 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:
    DownloadEnabled bool
    Whether the VPN Certificate download is enabled. Supported Values: "true", "false".
    SamlEndpoints List<string>
    List of SAML endpoint names for which the downloading should be enabled . Currently, only a single endpoint is supported. Example: ["saml_endpoint_1"].
    DownloadEnabled bool
    Whether the VPN Certificate download is enabled. Supported Values: "true", "false".
    SamlEndpoints []string
    List of SAML endpoint names for which the downloading should be enabled . Currently, only a single endpoint is supported. Example: ["saml_endpoint_1"].
    downloadEnabled Boolean
    Whether the VPN Certificate download is enabled. Supported Values: "true", "false".
    samlEndpoints List<String>
    List of SAML endpoint names for which the downloading should be enabled . Currently, only a single endpoint is supported. Example: ["saml_endpoint_1"].
    downloadEnabled boolean
    Whether the VPN Certificate download is enabled. Supported Values: "true", "false".
    samlEndpoints string[]
    List of SAML endpoint names for which the downloading should be enabled . Currently, only a single endpoint is supported. Example: ["saml_endpoint_1"].
    download_enabled bool
    Whether the VPN Certificate download is enabled. Supported Values: "true", "false".
    saml_endpoints Sequence[str]
    List of SAML endpoint names for which the downloading should be enabled . Currently, only a single endpoint is supported. Example: ["saml_endpoint_1"].
    downloadEnabled Boolean
    Whether the VPN Certificate download is enabled. Supported Values: "true", "false".
    samlEndpoints List<String>
    List of SAML endpoint names for which the downloading should be enabled . Currently, only a single endpoint is supported. Example: ["saml_endpoint_1"].

    Import

    vpn_cert_download can be imported using the default id vpn_cert_download, e.g.

     $ pulumi import aviatrix:index/aviatrixVpnCertDownload:AviatrixVpnCertDownload test_vpn_cert_download vpn_cert_download
    

    Package Details

    Repository
    aviatrix astipkovits/pulumi-aviatrix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aviatrix Terraform Provider.
    aviatrix logo
    Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix