Cisco Meraki v0.2.4, Jun 14 24

Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

meraki.organizations.Saml

Explore with Pulumi AI

Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

Example Usage

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

const example = new meraki.organizations.Saml("example", {
    enabled: true,
    organizationId: "string",
});
export const merakiOrganizationsSamlExample = example;

import pulumi
import pulumi_meraki as meraki

example = meraki.organizations.Saml("example",
    enabled=True,
    organization_id="string")
pulumi.export("merakiOrganizationsSamlExample", example)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := organizations.NewSaml(ctx, "example", &organizations.SamlArgs{
			Enabled:        pulumi.Bool(true),
			OrganizationId: pulumi.String("string"),
		})
		if err != nil {
			return err
		}
		ctx.Export("merakiOrganizationsSamlExample", example)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Meraki.Organizations.Saml("example", new()
    {
        Enabled = true,
        OrganizationId = "string",
    });

    return new Dictionary<string, object?>
    {
        ["merakiOrganizationsSamlExample"] = example,
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.organizations.Saml;
import com.pulumi.meraki.organizations.SamlArgs;
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 example = new Saml("example", SamlArgs.builder()
            .enabled(true)
            .organizationId("string")
            .build());

        ctx.export("merakiOrganizationsSamlExample", example);
    }
}

resources:
  example:
    type: meraki:organizations:Saml
    properties:
      enabled: true
      organizationId: string
outputs:
  merakiOrganizationsSamlExample: ${example}

Create Saml Resource

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

Constructor syntax

new Saml(name: string, args: SamlArgs, opts?: CustomResourceOptions);

@overload
def Saml(resource_name: str,
         args: SamlArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Saml(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         organization_id: Optional[str] = None,
         enabled: Optional[bool] = None)

func NewSaml(ctx *Context, name string, args SamlArgs, opts ...ResourceOption) (*Saml, error)

public Saml(string name, SamlArgs args, CustomResourceOptions? opts = null)

public Saml(String name, SamlArgs args)
public Saml(String name, SamlArgs args, CustomResourceOptions options)

type: meraki:organizations:Saml
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 SamlArgs: 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 SamlArgs: 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 SamlArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SamlArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SamlArgs: 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 samlResource = new Meraki.Organizations.Saml("samlResource", new()
{
    OrganizationId = "string",
    Enabled = false,
});

example, err := organizations.NewSaml(ctx, "samlResource", &organizations.SamlArgs{
	OrganizationId: pulumi.String("string"),
	Enabled:        pulumi.Bool(false),
})

var samlResource = new Saml("samlResource", SamlArgs.builder()
    .organizationId("string")
    .enabled(false)
    .build());

saml_resource = meraki.organizations.Saml("samlResource",
    organization_id="string",
    enabled=False)

const samlResource = new meraki.organizations.Saml("samlResource", {
    organizationId: "string",
    enabled: false,
});

type: meraki:organizations:Saml
properties:
    enabled: false
    organizationId: string

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

OrganizationId string: organizationId path parameter. Organization ID
Enabled bool: Toggle depicting if SAML SSO settings are enabled

OrganizationId string: organizationId path parameter. Organization ID
Enabled bool: Toggle depicting if SAML SSO settings are enabled

organizationId String: organizationId path parameter. Organization ID
enabled Boolean: Toggle depicting if SAML SSO settings are enabled

organizationId string: organizationId path parameter. Organization ID
enabled boolean: Toggle depicting if SAML SSO settings are enabled

organization_id str: organizationId path parameter. Organization ID
enabled bool: Toggle depicting if SAML SSO settings are enabled

organizationId String: organizationId path parameter. Organization ID
enabled Boolean: Toggle depicting if SAML SSO settings are enabled

Outputs

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

Get an existing Saml 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?: SamlState, opts?: CustomResourceOptions): Saml

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        organization_id: Optional[str] = None) -> Saml

func GetSaml(ctx *Context, name string, id IDInput, state *SamlState, opts ...ResourceOption) (*Saml, error)

public static Saml Get(string name, Input<string> id, SamlState? state, CustomResourceOptions? opts = null)

public static Saml get(String name, Output<String> id, SamlState 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:

Enabled bool: Toggle depicting if SAML SSO settings are enabled
OrganizationId string: organizationId path parameter. Organization ID

Enabled bool: Toggle depicting if SAML SSO settings are enabled
OrganizationId string: organizationId path parameter. Organization ID

enabled Boolean: Toggle depicting if SAML SSO settings are enabled
organizationId String: organizationId path parameter. Organization ID

enabled boolean: Toggle depicting if SAML SSO settings are enabled
organizationId string: organizationId path parameter. Organization ID

enabled bool: Toggle depicting if SAML SSO settings are enabled
organization_id str: organizationId path parameter. Organization ID

enabled Boolean: Toggle depicting if SAML SSO settings are enabled
organizationId String: organizationId path parameter. Organization ID

Import

$ pulumi import meraki:organizations/saml:Saml example "organization_id"

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

Package Details

Repository: meraki pulumi/pulumi-meraki
License: Apache-2.0
Notes: This Pulumi package is based on the meraki Terraform Provider.

Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

pulumi/pulumi-meraki

meraki.organizations.Saml

On this page

On this page

Example Usage

Create Saml Resource

Constructor syntax

Parameters

Constructor example

Saml Resource Properties

Inputs

Outputs

Look up Existing Saml Resource

Import

Package Details

On this page

On this page