Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. iam
  5. SamlProvider
Volcengine v0.0.26 published on Friday, Sep 13, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.iam.SamlProvider

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.26 published on Friday, Sep 13, 2024 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage iam saml provider

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var foo = new Volcengine.Iam.SamlProvider("foo", new()
    {
        EncodedSamlMetadataDocument = "your document",
        SamlProviderName = "terraform",
        SsoType = 2,
        Status = 1,
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iam.NewSamlProvider(ctx, "foo", &iam.SamlProviderArgs{
			EncodedSamlMetadataDocument: pulumi.String("your document"),
			SamlProviderName:            pulumi.String("terraform"),
			SsoType:                     pulumi.Int(2),
			Status:                      pulumi.Int(1),
		})
		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.volcengine.iam.SamlProvider;
import com.pulumi.volcengine.iam.SamlProviderArgs;
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 foo = new SamlProvider("foo", SamlProviderArgs.builder()        
            .encodedSamlMetadataDocument("your document")
            .samlProviderName("terraform")
            .ssoType(2)
            .status(1)
            .build());

    }
}

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.iam.SamlProvider("foo",
    encoded_saml_metadata_document="your document",
    saml_provider_name="terraform",
    sso_type=2,
    status=1)

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

const foo = new volcengine.iam.SamlProvider("foo", {
    encodedSamlMetadataDocument: "your document",
    samlProviderName: "terraform",
    ssoType: 2,
    status: 1,
});

    resources:
  foo:
    type: volcengine:iam:SamlProvider
    properties:
      encodedSamlMetadataDocument: your document
      samlProviderName: terraform
      ssoType: 2
      status: 1

    Create SamlProvider Resource

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

    Constructor syntax

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

@overload
def SamlProvider(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 encoded_saml_metadata_document: Optional[str] = None,
                 saml_provider_name: Optional[str] = None,
                 sso_type: Optional[int] = None,
                 description: Optional[str] = None,
                 status: Optional[int] = None)
    func NewSamlProvider(ctx *Context, name string, args SamlProviderArgs, opts ...ResourceOption) (*SamlProvider, error)
    public SamlProvider(string name, SamlProviderArgs args, CustomResourceOptions? opts = null)
    public SamlProvider(String name, SamlProviderArgs args)
public SamlProvider(String name, SamlProviderArgs args, CustomResourceOptions options)

    type: volcengine:iam:SamlProvider
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 SamlProviderArgs
    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 SamlProviderArgs
    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 SamlProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SamlProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SamlProviderArgs
    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 samlProviderResource = new Volcengine.Iam.SamlProvider("samlProviderResource", new()
{
    EncodedSamlMetadataDocument = "string",
    SamlProviderName = "string",
    SsoType = 0,
    Description = "string",
    Status = 0,
});

    example, err := iam.NewSamlProvider(ctx, "samlProviderResource", &iam.SamlProviderArgs{
	EncodedSamlMetadataDocument: pulumi.String("string"),
	SamlProviderName:            pulumi.String("string"),
	SsoType:                     pulumi.Int(0),
	Description:                 pulumi.String("string"),
	Status:                      pulumi.Int(0),
})

    var samlProviderResource = new SamlProvider("samlProviderResource", SamlProviderArgs.builder()
    .encodedSamlMetadataDocument("string")
    .samlProviderName("string")
    .ssoType(0)
    .description("string")
    .status(0)
    .build());

    saml_provider_resource = volcengine.iam.SamlProvider("samlProviderResource",
    encoded_saml_metadata_document="string",
    saml_provider_name="string",
    sso_type=0,
    description="string",
    status=0)

    const samlProviderResource = new volcengine.iam.SamlProvider("samlProviderResource", {
    encodedSamlMetadataDocument: "string",
    samlProviderName: "string",
    ssoType: 0,
    description: "string",
    status: 0,
});

    type: volcengine:iam:SamlProvider
properties:
    description: string
    encodedSamlMetadataDocument: string
    samlProviderName: string
    ssoType: 0
    status: 0

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

    EncodedSamlMetadataDocument string
    Metadata document, encoded in Base64.
    SamlProviderName string
    The name of the SAML provider.
    SsoType int
    SSO types, 1. Role-based SSO, 2. User-based SSO.
    Description string
    The description of the SAML provider.
    Status int
    User SSO status, 1. Enabled, 2. Disable other console login methods after enabling, 3. Disabled, is a required field when creating user SSO.
    EncodedSamlMetadataDocument string
    Metadata document, encoded in Base64.
    SamlProviderName string
    The name of the SAML provider.
    SsoType int
    SSO types, 1. Role-based SSO, 2. User-based SSO.
    Description string
    The description of the SAML provider.
    Status int
    User SSO status, 1. Enabled, 2. Disable other console login methods after enabling, 3. Disabled, is a required field when creating user SSO.
    encodedSamlMetadataDocument String
    Metadata document, encoded in Base64.
    samlProviderName String
    The name of the SAML provider.
    ssoType Integer
    SSO types, 1. Role-based SSO, 2. User-based SSO.
    description String
    The description of the SAML provider.
    status Integer
    User SSO status, 1. Enabled, 2. Disable other console login methods after enabling, 3. Disabled, is a required field when creating user SSO.
    encodedSamlMetadataDocument string
    Metadata document, encoded in Base64.
    samlProviderName string
    The name of the SAML provider.
    ssoType number
    SSO types, 1. Role-based SSO, 2. User-based SSO.
    description string
    The description of the SAML provider.
    status number
    User SSO status, 1. Enabled, 2. Disable other console login methods after enabling, 3. Disabled, is a required field when creating user SSO.
    encoded_saml_metadata_document str
    Metadata document, encoded in Base64.
    saml_provider_name str
    The name of the SAML provider.
    sso_type int
    SSO types, 1. Role-based SSO, 2. User-based SSO.
    description str
    The description of the SAML provider.
    status int
    User SSO status, 1. Enabled, 2. Disable other console login methods after enabling, 3. Disabled, is a required field when creating user SSO.
    encodedSamlMetadataDocument String
    Metadata document, encoded in Base64.
    samlProviderName String
    The name of the SAML provider.
    ssoType Number
    SSO types, 1. Role-based SSO, 2. User-based SSO.
    description String
    The description of the SAML provider.
    status Number
    User SSO status, 1. Enabled, 2. Disable other console login methods after enabling, 3. Disabled, is a required field when creating user SSO.

    Outputs

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

    CreateDate string
    Identity provider creation time, such as 20150123T123318Z.
    Id string
    The provider-assigned unique ID for this managed resource.
    Trn string
    The format for the resource name of an identity provider is trn:iam::${accountID}:saml-provider/{$SAMLProviderName}.
    UpdateDate string
    Identity provider update time, such as: 20150123T123318Z.
    CreateDate string
    Identity provider creation time, such as 20150123T123318Z.
    Id string
    The provider-assigned unique ID for this managed resource.
    Trn string
    The format for the resource name of an identity provider is trn:iam::${accountID}:saml-provider/{$SAMLProviderName}.
    UpdateDate string
    Identity provider update time, such as: 20150123T123318Z.
    createDate String
    Identity provider creation time, such as 20150123T123318Z.
    id String
    The provider-assigned unique ID for this managed resource.
    trn String
    The format for the resource name of an identity provider is trn:iam::${accountID}:saml-provider/{$SAMLProviderName}.
    updateDate String
    Identity provider update time, such as: 20150123T123318Z.
    createDate string
    Identity provider creation time, such as 20150123T123318Z.
    id string
    The provider-assigned unique ID for this managed resource.
    trn string
    The format for the resource name of an identity provider is trn:iam::${accountID}:saml-provider/{$SAMLProviderName}.
    updateDate string
    Identity provider update time, such as: 20150123T123318Z.
    create_date str
    Identity provider creation time, such as 20150123T123318Z.
    id str
    The provider-assigned unique ID for this managed resource.
    trn str
    The format for the resource name of an identity provider is trn:iam::${accountID}:saml-provider/{$SAMLProviderName}.
    update_date str
    Identity provider update time, such as: 20150123T123318Z.
    createDate String
    Identity provider creation time, such as 20150123T123318Z.
    id String
    The provider-assigned unique ID for this managed resource.
    trn String
    The format for the resource name of an identity provider is trn:iam::${accountID}:saml-provider/{$SAMLProviderName}.
    updateDate String
    Identity provider update time, such as: 20150123T123318Z.

    Look up Existing SamlProvider Resource

    Get an existing SamlProvider 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?: SamlProviderState, opts?: CustomResourceOptions): SamlProvider
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_date: Optional[str] = None,
        description: Optional[str] = None,
        encoded_saml_metadata_document: Optional[str] = None,
        saml_provider_name: Optional[str] = None,
        sso_type: Optional[int] = None,
        status: Optional[int] = None,
        trn: Optional[str] = None,
        update_date: Optional[str] = None) -> SamlProvider
    func GetSamlProvider(ctx *Context, name string, id IDInput, state *SamlProviderState, opts ...ResourceOption) (*SamlProvider, error)
    public static SamlProvider Get(string name, Input<string> id, SamlProviderState? state, CustomResourceOptions? opts = null)
    public static SamlProvider get(String name, Output<String> id, SamlProviderState 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:
    CreateDate string
    Identity provider creation time, such as 20150123T123318Z.
    Description string
    The description of the SAML provider.
    EncodedSamlMetadataDocument string
    Metadata document, encoded in Base64.
    SamlProviderName string
    The name of the SAML provider.
    SsoType int
    SSO types, 1. Role-based SSO, 2. User-based SSO.
    Status int
    User SSO status, 1. Enabled, 2. Disable other console login methods after enabling, 3. Disabled, is a required field when creating user SSO.
    Trn string
    The format for the resource name of an identity provider is trn:iam::${accountID}:saml-provider/{$SAMLProviderName}.
    UpdateDate string
    Identity provider update time, such as: 20150123T123318Z.
    CreateDate string
    Identity provider creation time, such as 20150123T123318Z.
    Description string
    The description of the SAML provider.
    EncodedSamlMetadataDocument string
    Metadata document, encoded in Base64.
    SamlProviderName string
    The name of the SAML provider.
    SsoType int
    SSO types, 1. Role-based SSO, 2. User-based SSO.
    Status int
    User SSO status, 1. Enabled, 2. Disable other console login methods after enabling, 3. Disabled, is a required field when creating user SSO.
    Trn string
    The format for the resource name of an identity provider is trn:iam::${accountID}:saml-provider/{$SAMLProviderName}.
    UpdateDate string
    Identity provider update time, such as: 20150123T123318Z.
    createDate String
    Identity provider creation time, such as 20150123T123318Z.
    description String
    The description of the SAML provider.
    encodedSamlMetadataDocument String
    Metadata document, encoded in Base64.
    samlProviderName String
    The name of the SAML provider.
    ssoType Integer
    SSO types, 1. Role-based SSO, 2. User-based SSO.
    status Integer
    User SSO status, 1. Enabled, 2. Disable other console login methods after enabling, 3. Disabled, is a required field when creating user SSO.
    trn String
    The format for the resource name of an identity provider is trn:iam::${accountID}:saml-provider/{$SAMLProviderName}.
    updateDate String
    Identity provider update time, such as: 20150123T123318Z.
    createDate string
    Identity provider creation time, such as 20150123T123318Z.
    description string
    The description of the SAML provider.
    encodedSamlMetadataDocument string
    Metadata document, encoded in Base64.
    samlProviderName string
    The name of the SAML provider.
    ssoType number
    SSO types, 1. Role-based SSO, 2. User-based SSO.
    status number
    User SSO status, 1. Enabled, 2. Disable other console login methods after enabling, 3. Disabled, is a required field when creating user SSO.
    trn string
    The format for the resource name of an identity provider is trn:iam::${accountID}:saml-provider/{$SAMLProviderName}.
    updateDate string
    Identity provider update time, such as: 20150123T123318Z.
    create_date str
    Identity provider creation time, such as 20150123T123318Z.
    description str
    The description of the SAML provider.
    encoded_saml_metadata_document str
    Metadata document, encoded in Base64.
    saml_provider_name str
    The name of the SAML provider.
    sso_type int
    SSO types, 1. Role-based SSO, 2. User-based SSO.
    status int
    User SSO status, 1. Enabled, 2. Disable other console login methods after enabling, 3. Disabled, is a required field when creating user SSO.
    trn str
    The format for the resource name of an identity provider is trn:iam::${accountID}:saml-provider/{$SAMLProviderName}.
    update_date str
    Identity provider update time, such as: 20150123T123318Z.
    createDate String
    Identity provider creation time, such as 20150123T123318Z.
    description String
    The description of the SAML provider.
    encodedSamlMetadataDocument String
    Metadata document, encoded in Base64.
    samlProviderName String
    The name of the SAML provider.
    ssoType Number
    SSO types, 1. Role-based SSO, 2. User-based SSO.
    status Number
    User SSO status, 1. Enabled, 2. Disable other console login methods after enabling, 3. Disabled, is a required field when creating user SSO.
    trn String
    The format for the resource name of an identity provider is trn:iam::${accountID}:saml-provider/{$SAMLProviderName}.
    updateDate String
    Identity provider update time, such as: 20150123T123318Z.

    Import

    IamSamlProvider can be imported using the id, e.g.

     $ pulumi import volcengine:iam/samlProvider:SamlProvider default SAMLProviderName

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

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.26 published on Friday, Sep 13, 2024 by Volcengine
    volcengine/pulumi-volcengine