Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Splunk Provider
  3. API Docs
  4. AdminSamlGroups
Splunk v1.2.14 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-splunk

splunk.AdminSamlGroups

Explore with Pulumi AI

splunk logo
Splunk v1.2.14 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-splunk

    # Resource: splunk.AdminSamlGroups

    Manage external groups in an IdP response to internal Splunk roles.

    Example Usage

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

const saml_group = new splunk.AdminSamlGroups("saml-group", {
    name: "mygroup",
    roles: [
        "admin",
        "power",
    ],
});

    import pulumi
import pulumi_splunk as splunk

saml_group = splunk.AdminSamlGroups("saml-group",
    name="mygroup",
    roles=[
        "admin",
        "power",
    ])

    package main

import (
	"github.com/pulumi/pulumi-splunk/sdk/go/splunk"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := splunk.NewAdminSamlGroups(ctx, "saml-group", &splunk.AdminSamlGroupsArgs{
			Name: pulumi.String("mygroup"),
			Roles: pulumi.StringArray{
				pulumi.String("admin"),
				pulumi.String("power"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Splunk = Pulumi.Splunk;

return await Deployment.RunAsync(() => 
{
    var saml_group = new Splunk.AdminSamlGroups("saml-group", new()
    {
        Name = "mygroup",
        Roles = new[]
        {
            "admin",
            "power",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.splunk.AdminSamlGroups;
import com.pulumi.splunk.AdminSamlGroupsArgs;
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 saml_group = new AdminSamlGroups("saml-group", AdminSamlGroupsArgs.builder()
            .name("mygroup")
            .roles(            
                "admin",
                "power")
            .build());

    }
}

    resources:
  saml-group:
    type: splunk:AdminSamlGroups
    properties:
      name: mygroup
      roles:
        - admin
        - power

    Create AdminSamlGroups Resource

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

    Constructor syntax

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

@overload
def AdminSamlGroups(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    name: Optional[str] = None,
                    roles: Optional[Sequence[str]] = None)
    func NewAdminSamlGroups(ctx *Context, name string, args *AdminSamlGroupsArgs, opts ...ResourceOption) (*AdminSamlGroups, error)
    public AdminSamlGroups(string name, AdminSamlGroupsArgs? args = null, CustomResourceOptions? opts = null)
    public AdminSamlGroups(String name, AdminSamlGroupsArgs args)
public AdminSamlGroups(String name, AdminSamlGroupsArgs args, CustomResourceOptions options)

    type: splunk:AdminSamlGroups
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 AdminSamlGroupsArgs
    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 AdminSamlGroupsArgs
    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 AdminSamlGroupsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AdminSamlGroupsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AdminSamlGroupsArgs
    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 adminSamlGroupsResource = new Splunk.AdminSamlGroups("adminSamlGroupsResource", new()
{
    Name = "string",
    Roles = new[]
    {
        "string",
    },
});

    example, err := splunk.NewAdminSamlGroups(ctx, "adminSamlGroupsResource", &splunk.AdminSamlGroupsArgs{
	Name: pulumi.String("string"),
	Roles: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var adminSamlGroupsResource = new AdminSamlGroups("adminSamlGroupsResource", AdminSamlGroupsArgs.builder()
    .name("string")
    .roles("string")
    .build());

    admin_saml_groups_resource = splunk.AdminSamlGroups("adminSamlGroupsResource",
    name="string",
    roles=["string"])

    const adminSamlGroupsResource = new splunk.AdminSamlGroups("adminSamlGroupsResource", {
    name: "string",
    roles: ["string"],
});

    type: splunk:AdminSamlGroups
properties:
    name: string
    roles:
        - string

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

    Name string
    The name of the external group.
    Roles List<string>
    List of internal roles assigned to the group.
    Name string
    The name of the external group.
    Roles []string
    List of internal roles assigned to the group.
    name String
    The name of the external group.
    roles List<String>
    List of internal roles assigned to the group.
    name string
    The name of the external group.
    roles string[]
    List of internal roles assigned to the group.
    name str
    The name of the external group.
    roles Sequence[str]
    List of internal roles assigned to the group.
    name String
    The name of the external group.
    roles List<String>
    List of internal roles assigned to the group.

    Outputs

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

    Get an existing AdminSamlGroups 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?: AdminSamlGroupsState, opts?: CustomResourceOptions): AdminSamlGroups
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        roles: Optional[Sequence[str]] = None) -> AdminSamlGroups
    func GetAdminSamlGroups(ctx *Context, name string, id IDInput, state *AdminSamlGroupsState, opts ...ResourceOption) (*AdminSamlGroups, error)
    public static AdminSamlGroups Get(string name, Input<string> id, AdminSamlGroupsState? state, CustomResourceOptions? opts = null)
    public static AdminSamlGroups get(String name, Output<String> id, AdminSamlGroupsState 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:
    Name string
    The name of the external group.
    Roles List<string>
    List of internal roles assigned to the group.
    Name string
    The name of the external group.
    Roles []string
    List of internal roles assigned to the group.
    name String
    The name of the external group.
    roles List<String>
    List of internal roles assigned to the group.
    name string
    The name of the external group.
    roles string[]
    List of internal roles assigned to the group.
    name str
    The name of the external group.
    roles Sequence[str]
    List of internal roles assigned to the group.
    name String
    The name of the external group.
    roles List<String>
    List of internal roles assigned to the group.

    Import

    SAML groups can be imported using the id, e.g.

    $ pulumi import splunk:index/adminSamlGroups:AdminSamlGroups saml-group mygroup

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Splunk pulumi/pulumi-splunk
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the splunk Terraform Provider.
    splunk logo
    Splunk v1.2.14 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-splunk