Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixSamlEndpoint
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

aviatrix.AviatrixSamlEndpoint

Explore with Pulumi AI

aviatrix logo
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

    Import

    saml_endpoint can be imported using the SAML endpoint_name, e.g.

     $ pulumi import aviatrix:index/aviatrixSamlEndpoint:AviatrixSamlEndpoint test saml-test

    Example Usage

    using System.Collections.Generic;
using System.IO;
using Pulumi;
using Aviatrix = Pulumi.Aviatrix;

return await Deployment.RunAsync(() => 
{
    // Create an Aviatrix AWS SAML Endpoint
    var testSamlEndpoint = new Aviatrix.AviatrixSamlEndpoint("testSamlEndpoint", new()
    {
        EndpointName = "saml-test",
        IdpMetadataType = "Text",
        IdpMetadata = File.ReadAllText("idp_metadata.xml"),
    });

});

    package main

import (
	"io/ioutil"

	"github.com/astipkovits/pulumi-aviatrix/sdk/go/aviatrix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func readFileOrPanic(path string) pulumi.StringPtrInput {
	data, err := ioutil.ReadFile(path)
	if err != nil {
		panic(err.Error())
	}
	return pulumi.String(string(data))
}

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aviatrix.NewAviatrixSamlEndpoint(ctx, "testSamlEndpoint", &aviatrix.AviatrixSamlEndpointArgs{
			EndpointName:    pulumi.String("saml-test"),
			IdpMetadataType: pulumi.String("Text"),
			IdpMetadata:     readFileOrPanic("idp_metadata.xml"),
		})
		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.AviatrixSamlEndpoint;
import com.pulumi.aviatrix.AviatrixSamlEndpointArgs;
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 testSamlEndpoint = new AviatrixSamlEndpoint("testSamlEndpoint", AviatrixSamlEndpointArgs.builder()        
            .endpointName("saml-test")
            .idpMetadataType("Text")
            .idpMetadata(Files.readString(Paths.get("idp_metadata.xml")))
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as aviatrix from "@astipkovits/aviatrix";
import * as fs from "fs";

// Create an Aviatrix AWS SAML Endpoint
const testSamlEndpoint = new aviatrix.AviatrixSamlEndpoint("testSamlEndpoint", {
    endpointName: "saml-test",
    idpMetadataType: "Text",
    idpMetadata: fs.readFileSync("idp_metadata.xml"),
});

    import pulumi
import pulumi_aviatrix as aviatrix

# Create an Aviatrix AWS SAML Endpoint
test_saml_endpoint = aviatrix.AviatrixSamlEndpoint("testSamlEndpoint",
    endpoint_name="saml-test",
    idp_metadata_type="Text",
    idp_metadata=(lambda path: open(path).read())("idp_metadata.xml"))

    resources:
  # Create an Aviatrix AWS SAML Endpoint
  testSamlEndpoint:
    type: aviatrix:AviatrixSamlEndpoint
    properties:
      endpointName: saml-test
      idpMetadataType: Text
      idpMetadata:
        fn::readFile: idp_metadata.xml

    using System.Collections.Generic;
using Pulumi;
using Aviatrix = Pulumi.Aviatrix;

return await Deployment.RunAsync(() => 
{
    // Create an Aviatrix AWS SAML Endpoint using Metadata UDL
    var testSamlEndpoint = new Aviatrix.AviatrixSamlEndpoint("testSamlEndpoint", new()
    {
        EndpointName = "saml-test",
        IdpMetadataType = "URL",
        IdpMetadataUrl = "https://dev-xyzz.okta.com/app/asdfasdfwfwf/sso/saml/metadata",
    });

});

    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.NewAviatrixSamlEndpoint(ctx, "testSamlEndpoint", &aviatrix.AviatrixSamlEndpointArgs{
			EndpointName:    pulumi.String("saml-test"),
			IdpMetadataType: pulumi.String("URL"),
			IdpMetadataUrl:  pulumi.String("https://dev-xyzz.okta.com/app/asdfasdfwfwf/sso/saml/metadata"),
		})
		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.AviatrixSamlEndpoint;
import com.pulumi.aviatrix.AviatrixSamlEndpointArgs;
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 testSamlEndpoint = new AviatrixSamlEndpoint("testSamlEndpoint", AviatrixSamlEndpointArgs.builder()        
            .endpointName("saml-test")
            .idpMetadataType("URL")
            .idpMetadataUrl("https://dev-xyzz.okta.com/app/asdfasdfwfwf/sso/saml/metadata")
            .build());

    }
}

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

// Create an Aviatrix AWS SAML Endpoint using Metadata UDL
const testSamlEndpoint = new aviatrix.AviatrixSamlEndpoint("test_saml_endpoint", {
    endpointName: "saml-test",
    idpMetadataType: "URL",
    idpMetadataUrl: "https://dev-xyzz.okta.com/app/asdfasdfwfwf/sso/saml/metadata",
});

    import pulumi
import pulumi_aviatrix as aviatrix

# Create an Aviatrix AWS SAML Endpoint using Metadata UDL
test_saml_endpoint = aviatrix.AviatrixSamlEndpoint("testSamlEndpoint",
    endpoint_name="saml-test",
    idp_metadata_type="URL",
    idp_metadata_url="https://dev-xyzz.okta.com/app/asdfasdfwfwf/sso/saml/metadata")

    resources:
  # Create an Aviatrix AWS SAML Endpoint using Metadata UDL
  testSamlEndpoint:
    type: aviatrix:AviatrixSamlEndpoint
    properties:
      endpointName: saml-test
      idpMetadataType: URL
      idpMetadataUrl: https://dev-xyzz.okta.com/app/asdfasdfwfwf/sso/saml/metadata

    using System.Collections.Generic;
using Pulumi;
using Aviatrix = Pulumi.Aviatrix;

return await Deployment.RunAsync(() => 
{
    // Create an Aviatrix AWS SAML Endpoint for Controller Login
    var testSamlEndpoint = new Aviatrix.AviatrixSamlEndpoint("testSamlEndpoint", new()
    {
        AccessSetBy = "controller",
        ControllerLogin = true,
        EndpointName = "saml-test",
        IdpMetadata = @var.Idp_metadata,
        IdpMetadataType = "Text",
        RbacGroups = new[]
        {
            "admin",
            "read_only",
        },
    });

});

    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.NewAviatrixSamlEndpoint(ctx, "testSamlEndpoint", &aviatrix.AviatrixSamlEndpointArgs{
			AccessSetBy:     pulumi.String("controller"),
			ControllerLogin: pulumi.Bool(true),
			EndpointName:    pulumi.String("saml-test"),
			IdpMetadata:     pulumi.Any(_var.Idp_metadata),
			IdpMetadataType: pulumi.String("Text"),
			RbacGroups: pulumi.StringArray{
				pulumi.String("admin"),
				pulumi.String("read_only"),
			},
		})
		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.AviatrixSamlEndpoint;
import com.pulumi.aviatrix.AviatrixSamlEndpointArgs;
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 testSamlEndpoint = new AviatrixSamlEndpoint("testSamlEndpoint", AviatrixSamlEndpointArgs.builder()        
            .accessSetBy("controller")
            .controllerLogin(true)
            .endpointName("saml-test")
            .idpMetadata(var_.idp_metadata())
            .idpMetadataType("Text")
            .rbacGroups(            
                "admin",
                "read_only")
            .build());

    }
}

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

// Create an Aviatrix AWS SAML Endpoint for Controller Login
const testSamlEndpoint = new aviatrix.AviatrixSamlEndpoint("test_saml_endpoint", {
    accessSetBy: "controller",
    controllerLogin: true,
    endpointName: "saml-test",
    idpMetadata: var_idp_metadata,
    idpMetadataType: "Text",
    rbacGroups: [
        "admin",
        "read_only",
    ],
});

    import pulumi
import pulumi_aviatrix as aviatrix

# Create an Aviatrix AWS SAML Endpoint for Controller Login
test_saml_endpoint = aviatrix.AviatrixSamlEndpoint("testSamlEndpoint",
    access_set_by="controller",
    controller_login=True,
    endpoint_name="saml-test",
    idp_metadata=var["idp_metadata"],
    idp_metadata_type="Text",
    rbac_groups=[
        "admin",
        "read_only",
    ])

    resources:
  # Create an Aviatrix AWS SAML Endpoint for Controller Login
  testSamlEndpoint:
    type: aviatrix:AviatrixSamlEndpoint
    properties:
      accessSetBy: controller
      controllerLogin: true
      endpointName: saml-test
      idpMetadata: ${var.idp_metadata}
      idpMetadataType: Text
      rbacGroups:
        - admin
        - read_only

    Create AviatrixSamlEndpoint Resource

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

    Constructor syntax

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

@overload
def AviatrixSamlEndpoint(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         endpoint_name: Optional[str] = None,
                         idp_metadata_type: Optional[str] = None,
                         access_set_by: Optional[str] = None,
                         controller_login: Optional[bool] = None,
                         custom_entity_id: Optional[str] = None,
                         custom_saml_request_template: Optional[str] = None,
                         idp_metadata: Optional[str] = None,
                         idp_metadata_url: Optional[str] = None,
                         rbac_groups: Optional[Sequence[str]] = None,
                         sign_authn_requests: Optional[bool] = None)
    func NewAviatrixSamlEndpoint(ctx *Context, name string, args AviatrixSamlEndpointArgs, opts ...ResourceOption) (*AviatrixSamlEndpoint, error)
    public AviatrixSamlEndpoint(string name, AviatrixSamlEndpointArgs args, CustomResourceOptions? opts = null)
    public AviatrixSamlEndpoint(String name, AviatrixSamlEndpointArgs args)
public AviatrixSamlEndpoint(String name, AviatrixSamlEndpointArgs args, CustomResourceOptions options)

    type: aviatrix:AviatrixSamlEndpoint
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 AviatrixSamlEndpointArgs
    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 AviatrixSamlEndpointArgs
    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 AviatrixSamlEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixSamlEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixSamlEndpointArgs
    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 aviatrixSamlEndpointResource = new Aviatrix.AviatrixSamlEndpoint("aviatrixSamlEndpointResource", new()
{
    EndpointName = "string",
    IdpMetadataType = "string",
    AccessSetBy = "string",
    ControllerLogin = false,
    CustomEntityId = "string",
    CustomSamlRequestTemplate = "string",
    IdpMetadata = "string",
    IdpMetadataUrl = "string",
    RbacGroups = new[]
    {
        "string",
    },
    SignAuthnRequests = false,
});

    example, err := aviatrix.NewAviatrixSamlEndpoint(ctx, "aviatrixSamlEndpointResource", &aviatrix.AviatrixSamlEndpointArgs{
	EndpointName:              pulumi.String("string"),
	IdpMetadataType:           pulumi.String("string"),
	AccessSetBy:               pulumi.String("string"),
	ControllerLogin:           pulumi.Bool(false),
	CustomEntityId:            pulumi.String("string"),
	CustomSamlRequestTemplate: pulumi.String("string"),
	IdpMetadata:               pulumi.String("string"),
	IdpMetadataUrl:            pulumi.String("string"),
	RbacGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	SignAuthnRequests: pulumi.Bool(false),
})

    var aviatrixSamlEndpointResource = new AviatrixSamlEndpoint("aviatrixSamlEndpointResource", AviatrixSamlEndpointArgs.builder()
    .endpointName("string")
    .idpMetadataType("string")
    .accessSetBy("string")
    .controllerLogin(false)
    .customEntityId("string")
    .customSamlRequestTemplate("string")
    .idpMetadata("string")
    .idpMetadataUrl("string")
    .rbacGroups("string")
    .signAuthnRequests(false)
    .build());

    aviatrix_saml_endpoint_resource = aviatrix.AviatrixSamlEndpoint("aviatrixSamlEndpointResource",
    endpoint_name="string",
    idp_metadata_type="string",
    access_set_by="string",
    controller_login=False,
    custom_entity_id="string",
    custom_saml_request_template="string",
    idp_metadata="string",
    idp_metadata_url="string",
    rbac_groups=["string"],
    sign_authn_requests=False)

    const aviatrixSamlEndpointResource = new aviatrix.AviatrixSamlEndpoint("aviatrixSamlEndpointResource", {
    endpointName: "string",
    idpMetadataType: "string",
    accessSetBy: "string",
    controllerLogin: false,
    customEntityId: "string",
    customSamlRequestTemplate: "string",
    idpMetadata: "string",
    idpMetadataUrl: "string",
    rbacGroups: ["string"],
    signAuthnRequests: false,
});

    type: aviatrix:AviatrixSamlEndpoint
properties:
    accessSetBy: string
    controllerLogin: false
    customEntityId: string
    customSamlRequestTemplate: string
    endpointName: string
    idpMetadata: string
    idpMetadataType: string
    idpMetadataUrl: string
    rbacGroups:
        - string
    signAuthnRequests: false

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

    EndpointName string
    The SAML endpoint name.
    IdpMetadataType string
    The IDP Metadata type. Can be either "Text" or "URL".
    AccessSetBy string
    Access type. Valid values: "controller", "profile_attribute". Default value: "controller".
    ControllerLogin bool
    Valid values: true, false. Default value: false. Set true for creating a saml endpoint for controller login.
    CustomEntityId string
    Custom Entity ID. Required to be non-empty for 'Custom' Entity ID type, empty for 'Hostname' Entity ID type.
    CustomSamlRequestTemplate string
    Custom SAML Request Template in string.
    IdpMetadata string
    The IDP Metadata from SAML provider. Required if idp_metadata_type is "Text" and should be unset if type is "URL". Normally the metadata is in XML format which may contain special characters. Best practice is to use the file function to read from a local Metadata XML file.
    IdpMetadataUrl string
    The IDP Metadata URL from SAML provider. Required if idp_metadata_type is "URL" and should be unset if type is "Text".
    RbacGroups List<string>
    List of rbac groups. Required for controller login and "access_set_by" of "controller".
    SignAuthnRequests bool
    Whether to sign SAML AuthnRequests
    EndpointName string
    The SAML endpoint name.
    IdpMetadataType string
    The IDP Metadata type. Can be either "Text" or "URL".
    AccessSetBy string
    Access type. Valid values: "controller", "profile_attribute". Default value: "controller".
    ControllerLogin bool
    Valid values: true, false. Default value: false. Set true for creating a saml endpoint for controller login.
    CustomEntityId string
    Custom Entity ID. Required to be non-empty for 'Custom' Entity ID type, empty for 'Hostname' Entity ID type.
    CustomSamlRequestTemplate string
    Custom SAML Request Template in string.
    IdpMetadata string
    The IDP Metadata from SAML provider. Required if idp_metadata_type is "Text" and should be unset if type is "URL". Normally the metadata is in XML format which may contain special characters. Best practice is to use the file function to read from a local Metadata XML file.
    IdpMetadataUrl string
    The IDP Metadata URL from SAML provider. Required if idp_metadata_type is "URL" and should be unset if type is "Text".
    RbacGroups []string
    List of rbac groups. Required for controller login and "access_set_by" of "controller".
    SignAuthnRequests bool
    Whether to sign SAML AuthnRequests
    endpointName String
    The SAML endpoint name.
    idpMetadataType String
    The IDP Metadata type. Can be either "Text" or "URL".
    accessSetBy String
    Access type. Valid values: "controller", "profile_attribute". Default value: "controller".
    controllerLogin Boolean
    Valid values: true, false. Default value: false. Set true for creating a saml endpoint for controller login.
    customEntityId String
    Custom Entity ID. Required to be non-empty for 'Custom' Entity ID type, empty for 'Hostname' Entity ID type.
    customSamlRequestTemplate String
    Custom SAML Request Template in string.
    idpMetadata String
    The IDP Metadata from SAML provider. Required if idp_metadata_type is "Text" and should be unset if type is "URL". Normally the metadata is in XML format which may contain special characters. Best practice is to use the file function to read from a local Metadata XML file.
    idpMetadataUrl String
    The IDP Metadata URL from SAML provider. Required if idp_metadata_type is "URL" and should be unset if type is "Text".
    rbacGroups List<String>
    List of rbac groups. Required for controller login and "access_set_by" of "controller".
    signAuthnRequests Boolean
    Whether to sign SAML AuthnRequests
    endpointName string
    The SAML endpoint name.
    idpMetadataType string
    The IDP Metadata type. Can be either "Text" or "URL".
    accessSetBy string
    Access type. Valid values: "controller", "profile_attribute". Default value: "controller".
    controllerLogin boolean
    Valid values: true, false. Default value: false. Set true for creating a saml endpoint for controller login.
    customEntityId string
    Custom Entity ID. Required to be non-empty for 'Custom' Entity ID type, empty for 'Hostname' Entity ID type.
    customSamlRequestTemplate string
    Custom SAML Request Template in string.
    idpMetadata string
    The IDP Metadata from SAML provider. Required if idp_metadata_type is "Text" and should be unset if type is "URL". Normally the metadata is in XML format which may contain special characters. Best practice is to use the file function to read from a local Metadata XML file.
    idpMetadataUrl string
    The IDP Metadata URL from SAML provider. Required if idp_metadata_type is "URL" and should be unset if type is "Text".
    rbacGroups string[]
    List of rbac groups. Required for controller login and "access_set_by" of "controller".
    signAuthnRequests boolean
    Whether to sign SAML AuthnRequests
    endpoint_name str
    The SAML endpoint name.
    idp_metadata_type str
    The IDP Metadata type. Can be either "Text" or "URL".
    access_set_by str
    Access type. Valid values: "controller", "profile_attribute". Default value: "controller".
    controller_login bool
    Valid values: true, false. Default value: false. Set true for creating a saml endpoint for controller login.
    custom_entity_id str
    Custom Entity ID. Required to be non-empty for 'Custom' Entity ID type, empty for 'Hostname' Entity ID type.
    custom_saml_request_template str
    Custom SAML Request Template in string.
    idp_metadata str
    The IDP Metadata from SAML provider. Required if idp_metadata_type is "Text" and should be unset if type is "URL". Normally the metadata is in XML format which may contain special characters. Best practice is to use the file function to read from a local Metadata XML file.
    idp_metadata_url str
    The IDP Metadata URL from SAML provider. Required if idp_metadata_type is "URL" and should be unset if type is "Text".
    rbac_groups Sequence[str]
    List of rbac groups. Required for controller login and "access_set_by" of "controller".
    sign_authn_requests bool
    Whether to sign SAML AuthnRequests
    endpointName String
    The SAML endpoint name.
    idpMetadataType String
    The IDP Metadata type. Can be either "Text" or "URL".
    accessSetBy String
    Access type. Valid values: "controller", "profile_attribute". Default value: "controller".
    controllerLogin Boolean
    Valid values: true, false. Default value: false. Set true for creating a saml endpoint for controller login.
    customEntityId String
    Custom Entity ID. Required to be non-empty for 'Custom' Entity ID type, empty for 'Hostname' Entity ID type.
    customSamlRequestTemplate String
    Custom SAML Request Template in string.
    idpMetadata String
    The IDP Metadata from SAML provider. Required if idp_metadata_type is "Text" and should be unset if type is "URL". Normally the metadata is in XML format which may contain special characters. Best practice is to use the file function to read from a local Metadata XML file.
    idpMetadataUrl String
    The IDP Metadata URL from SAML provider. Required if idp_metadata_type is "URL" and should be unset if type is "Text".
    rbacGroups List<String>
    List of rbac groups. Required for controller login and "access_set_by" of "controller".
    signAuthnRequests Boolean
    Whether to sign SAML AuthnRequests

    Outputs

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

    Get an existing AviatrixSamlEndpoint 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?: AviatrixSamlEndpointState, opts?: CustomResourceOptions): AviatrixSamlEndpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_set_by: Optional[str] = None,
        controller_login: Optional[bool] = None,
        custom_entity_id: Optional[str] = None,
        custom_saml_request_template: Optional[str] = None,
        endpoint_name: Optional[str] = None,
        idp_metadata: Optional[str] = None,
        idp_metadata_type: Optional[str] = None,
        idp_metadata_url: Optional[str] = None,
        rbac_groups: Optional[Sequence[str]] = None,
        sign_authn_requests: Optional[bool] = None) -> AviatrixSamlEndpoint
    func GetAviatrixSamlEndpoint(ctx *Context, name string, id IDInput, state *AviatrixSamlEndpointState, opts ...ResourceOption) (*AviatrixSamlEndpoint, error)
    public static AviatrixSamlEndpoint Get(string name, Input<string> id, AviatrixSamlEndpointState? state, CustomResourceOptions? opts = null)
    public static AviatrixSamlEndpoint get(String name, Output<String> id, AviatrixSamlEndpointState state, CustomResourceOptions options)
    resources:  _:    type: aviatrix:AviatrixSamlEndpoint    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:
    AccessSetBy string
    Access type. Valid values: "controller", "profile_attribute". Default value: "controller".
    ControllerLogin bool
    Valid values: true, false. Default value: false. Set true for creating a saml endpoint for controller login.
    CustomEntityId string
    Custom Entity ID. Required to be non-empty for 'Custom' Entity ID type, empty for 'Hostname' Entity ID type.
    CustomSamlRequestTemplate string
    Custom SAML Request Template in string.
    EndpointName string
    The SAML endpoint name.
    IdpMetadata string
    The IDP Metadata from SAML provider. Required if idp_metadata_type is "Text" and should be unset if type is "URL". Normally the metadata is in XML format which may contain special characters. Best practice is to use the file function to read from a local Metadata XML file.
    IdpMetadataType string
    The IDP Metadata type. Can be either "Text" or "URL".
    IdpMetadataUrl string
    The IDP Metadata URL from SAML provider. Required if idp_metadata_type is "URL" and should be unset if type is "Text".
    RbacGroups List<string>
    List of rbac groups. Required for controller login and "access_set_by" of "controller".
    SignAuthnRequests bool
    Whether to sign SAML AuthnRequests
    AccessSetBy string
    Access type. Valid values: "controller", "profile_attribute". Default value: "controller".
    ControllerLogin bool
    Valid values: true, false. Default value: false. Set true for creating a saml endpoint for controller login.
    CustomEntityId string
    Custom Entity ID. Required to be non-empty for 'Custom' Entity ID type, empty for 'Hostname' Entity ID type.
    CustomSamlRequestTemplate string
    Custom SAML Request Template in string.
    EndpointName string
    The SAML endpoint name.
    IdpMetadata string
    The IDP Metadata from SAML provider. Required if idp_metadata_type is "Text" and should be unset if type is "URL". Normally the metadata is in XML format which may contain special characters. Best practice is to use the file function to read from a local Metadata XML file.
    IdpMetadataType string
    The IDP Metadata type. Can be either "Text" or "URL".
    IdpMetadataUrl string
    The IDP Metadata URL from SAML provider. Required if idp_metadata_type is "URL" and should be unset if type is "Text".
    RbacGroups []string
    List of rbac groups. Required for controller login and "access_set_by" of "controller".
    SignAuthnRequests bool
    Whether to sign SAML AuthnRequests
    accessSetBy String
    Access type. Valid values: "controller", "profile_attribute". Default value: "controller".
    controllerLogin Boolean
    Valid values: true, false. Default value: false. Set true for creating a saml endpoint for controller login.
    customEntityId String
    Custom Entity ID. Required to be non-empty for 'Custom' Entity ID type, empty for 'Hostname' Entity ID type.
    customSamlRequestTemplate String
    Custom SAML Request Template in string.
    endpointName String
    The SAML endpoint name.
    idpMetadata String
    The IDP Metadata from SAML provider. Required if idp_metadata_type is "Text" and should be unset if type is "URL". Normally the metadata is in XML format which may contain special characters. Best practice is to use the file function to read from a local Metadata XML file.
    idpMetadataType String
    The IDP Metadata type. Can be either "Text" or "URL".
    idpMetadataUrl String
    The IDP Metadata URL from SAML provider. Required if idp_metadata_type is "URL" and should be unset if type is "Text".
    rbacGroups List<String>
    List of rbac groups. Required for controller login and "access_set_by" of "controller".
    signAuthnRequests Boolean
    Whether to sign SAML AuthnRequests
    accessSetBy string
    Access type. Valid values: "controller", "profile_attribute". Default value: "controller".
    controllerLogin boolean
    Valid values: true, false. Default value: false. Set true for creating a saml endpoint for controller login.
    customEntityId string
    Custom Entity ID. Required to be non-empty for 'Custom' Entity ID type, empty for 'Hostname' Entity ID type.
    customSamlRequestTemplate string
    Custom SAML Request Template in string.
    endpointName string
    The SAML endpoint name.
    idpMetadata string
    The IDP Metadata from SAML provider. Required if idp_metadata_type is "Text" and should be unset if type is "URL". Normally the metadata is in XML format which may contain special characters. Best practice is to use the file function to read from a local Metadata XML file.
    idpMetadataType string
    The IDP Metadata type. Can be either "Text" or "URL".
    idpMetadataUrl string
    The IDP Metadata URL from SAML provider. Required if idp_metadata_type is "URL" and should be unset if type is "Text".
    rbacGroups string[]
    List of rbac groups. Required for controller login and "access_set_by" of "controller".
    signAuthnRequests boolean
    Whether to sign SAML AuthnRequests
    access_set_by str
    Access type. Valid values: "controller", "profile_attribute". Default value: "controller".
    controller_login bool
    Valid values: true, false. Default value: false. Set true for creating a saml endpoint for controller login.
    custom_entity_id str
    Custom Entity ID. Required to be non-empty for 'Custom' Entity ID type, empty for 'Hostname' Entity ID type.
    custom_saml_request_template str
    Custom SAML Request Template in string.
    endpoint_name str
    The SAML endpoint name.
    idp_metadata str
    The IDP Metadata from SAML provider. Required if idp_metadata_type is "Text" and should be unset if type is "URL". Normally the metadata is in XML format which may contain special characters. Best practice is to use the file function to read from a local Metadata XML file.
    idp_metadata_type str
    The IDP Metadata type. Can be either "Text" or "URL".
    idp_metadata_url str
    The IDP Metadata URL from SAML provider. Required if idp_metadata_type is "URL" and should be unset if type is "Text".
    rbac_groups Sequence[str]
    List of rbac groups. Required for controller login and "access_set_by" of "controller".
    sign_authn_requests bool
    Whether to sign SAML AuthnRequests
    accessSetBy String
    Access type. Valid values: "controller", "profile_attribute". Default value: "controller".
    controllerLogin Boolean
    Valid values: true, false. Default value: false. Set true for creating a saml endpoint for controller login.
    customEntityId String
    Custom Entity ID. Required to be non-empty for 'Custom' Entity ID type, empty for 'Hostname' Entity ID type.
    customSamlRequestTemplate String
    Custom SAML Request Template in string.
    endpointName String
    The SAML endpoint name.
    idpMetadata String
    The IDP Metadata from SAML provider. Required if idp_metadata_type is "Text" and should be unset if type is "URL". Normally the metadata is in XML format which may contain special characters. Best practice is to use the file function to read from a local Metadata XML file.
    idpMetadataType String
    The IDP Metadata type. Can be either "Text" or "URL".
    idpMetadataUrl String
    The IDP Metadata URL from SAML provider. Required if idp_metadata_type is "URL" and should be unset if type is "Text".
    rbacGroups List<String>
    List of rbac groups. Required for controller login and "access_set_by" of "controller".
    signAuthnRequests Boolean
    Whether to sign SAML AuthnRequests

    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
    astipkovits/pulumi-aviatrix