organizationmanagerSamlFederation.go

// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package yandex

import (
	"context"
	"reflect"

	"github.com/pkg/errors"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// Allows management of a single SAML Federation within an existing Yandex.Cloud Organization.
//
// ## Example Usage
//
// ```go
// package main
//
// import (
// 	"github.com/pulumi/pulumi-yandex/sdk/go/yandex"
// 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
// )
//
// func main() {
// 	pulumi.Run(func(ctx *pulumi.Context) error {
// 		_, err := yandex.NewOrganizationmanagerSamlFederation(ctx, "federation", &yandex.OrganizationmanagerSamlFederationArgs{
// 			Description:    pulumi.String("My new SAML federation"),
// 			Issuer:         pulumi.String("my-issuer"),
// 			OrganizationId: pulumi.String("sdf4*********3fr"),
// 			SsoBinding:     pulumi.String("POST"),
// 			SsoUrl:         pulumi.String("https://my-sso.url"),
// 		})
// 		if err != nil {
// 			return err
// 		}
// 		return nil
// 	})
// }
// ```
//
// ## Import
//
// A Yandex SAML Federation can be imported using the `id` of the resource, e.g.
//
// ```sh
//  $ pulumi import yandex:index/organizationmanagerSamlFederation:OrganizationmanagerSamlFederation federation "federation_id"
// ```
type OrganizationmanagerSamlFederation struct {
	pulumi.CustomResourceState

	// Add new users automatically on successful authentication. The user will get the `resource-manager.clouds.member` role automatically, but you need to grant other roles to them. If the value is `false`, users who aren't added to the cloud can't log in, even if they have authenticated on your server.
	AutoCreateAccountOnLogin pulumi.BoolOutput `pulumi:"autoCreateAccountOnLogin"`
	// Use case-insensitive name ids.
	CaseInsensitiveNameIds pulumi.BoolOutput `pulumi:"caseInsensitiveNameIds"`
	// The lifetime of a Browser cookie in seconds. If the cookie is still valid, the management console authenticates the user immediately and redirects them to the home page. The default value is `8h`.
	CookieMaxAge pulumi.StringOutput `pulumi:"cookieMaxAge"`
	// (Computed) The SAML Federation creation timestamp.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// The description of the SAML Federation.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The ID of the IdP server to be used for authentication. The IdP server also responds to IAM with this ID after the user authenticates.
	Issuer pulumi.StringOutput `pulumi:"issuer"`
	// A set of key/value label pairs assigned to the SAML Federation.
	Labels pulumi.StringMapOutput `pulumi:"labels"`
	// The name of the SAML Federation.
	Name pulumi.StringOutput `pulumi:"name"`
	// The organization to attach this SAML Federation to.
	OrganizationId pulumi.StringOutput `pulumi:"organizationId"`
	// Federation security settings, structure is documented below.
	SecuritySettings OrganizationmanagerSamlFederationSecuritySettingsOutput `pulumi:"securitySettings"`
	// Single sign-on endpoint binding type. Most Identity Providers support the `POST` binding type. SAML Binding is a mapping of a SAML protocol message onto standard messaging formats and/or communications protocols.
	SsoBinding pulumi.StringOutput `pulumi:"ssoBinding"`
	// Single sign-on endpoint URL. Specify the link to the IdP login page here.
	SsoUrl pulumi.StringOutput `pulumi:"ssoUrl"`
}

// NewOrganizationmanagerSamlFederation registers a new resource with the given unique name, arguments, and options.
func NewOrganizationmanagerSamlFederation(ctx *pulumi.Context,
	name string, args *OrganizationmanagerSamlFederationArgs, opts ...pulumi.ResourceOption) (*OrganizationmanagerSamlFederation, error) {
	if args == nil {
		return nil, errors.New("missing one or more required arguments")
	}

	if args.Issuer == nil {
		return nil, errors.New("invalid value for required argument 'Issuer'")
	}
	if args.OrganizationId == nil {
		return nil, errors.New("invalid value for required argument 'OrganizationId'")
	}
	if args.SsoBinding == nil {
		return nil, errors.New("invalid value for required argument 'SsoBinding'")
	}
	if args.SsoUrl == nil {
		return nil, errors.New("invalid value for required argument 'SsoUrl'")
	}
	var resource OrganizationmanagerSamlFederation
	err := ctx.RegisterResource("yandex:index/organizationmanagerSamlFederation:OrganizationmanagerSamlFederation", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetOrganizationmanagerSamlFederation gets an existing OrganizationmanagerSamlFederation resource's state with the given name, ID, and optional
// state properties that are used to uniquely qualify the lookup (nil if not required).
func GetOrganizationmanagerSamlFederation(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *OrganizationmanagerSamlFederationState, opts ...pulumi.ResourceOption) (*OrganizationmanagerSamlFederation, error) {
	var resource OrganizationmanagerSamlFederation
	err := ctx.ReadResource("yandex:index/organizationmanagerSamlFederation:OrganizationmanagerSamlFederation", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering OrganizationmanagerSamlFederation resources.
type organizationmanagerSamlFederationState struct {
	// Add new users automatically on successful authentication. The user will get the `resource-manager.clouds.member` role automatically, but you need to grant other roles to them. If the value is `false`, users who aren't added to the cloud can't log in, even if they have authenticated on your server.
	AutoCreateAccountOnLogin *bool `pulumi:"autoCreateAccountOnLogin"`
	// Use case-insensitive name ids.
	CaseInsensitiveNameIds *bool `pulumi:"caseInsensitiveNameIds"`
	// The lifetime of a Browser cookie in seconds. If the cookie is still valid, the management console authenticates the user immediately and redirects them to the home page. The default value is `8h`.
	CookieMaxAge *string `pulumi:"cookieMaxAge"`
	// (Computed) The SAML Federation creation timestamp.
	CreatedAt *string `pulumi:"createdAt"`
	// The description of the SAML Federation.
	Description *string `pulumi:"description"`
	// The ID of the IdP server to be used for authentication. The IdP server also responds to IAM with this ID after the user authenticates.
	Issuer *string `pulumi:"issuer"`
	// A set of key/value label pairs assigned to the SAML Federation.
	Labels map[string]string `pulumi:"labels"`
	// The name of the SAML Federation.
	Name *string `pulumi:"name"`
	// The organization to attach this SAML Federation to.
	OrganizationId *string `pulumi:"organizationId"`
	// Federation security settings, structure is documented below.
	SecuritySettings *OrganizationmanagerSamlFederationSecuritySettings `pulumi:"securitySettings"`
	// Single sign-on endpoint binding type. Most Identity Providers support the `POST` binding type. SAML Binding is a mapping of a SAML protocol message onto standard messaging formats and/or communications protocols.
	SsoBinding *string `pulumi:"ssoBinding"`
	// Single sign-on endpoint URL. Specify the link to the IdP login page here.
	SsoUrl *string `pulumi:"ssoUrl"`
}

type OrganizationmanagerSamlFederationState struct {
	// Add new users automatically on successful authentication. The user will get the `resource-manager.clouds.member` role automatically, but you need to grant other roles to them. If the value is `false`, users who aren't added to the cloud can't log in, even if they have authenticated on your server.
	AutoCreateAccountOnLogin pulumi.BoolPtrInput
	// Use case-insensitive name ids.
	CaseInsensitiveNameIds pulumi.BoolPtrInput
	// The lifetime of a Browser cookie in seconds. If the cookie is still valid, the management console authenticates the user immediately and redirects them to the home page. The default value is `8h`.
	CookieMaxAge pulumi.StringPtrInput
	// (Computed) The SAML Federation creation timestamp.
	CreatedAt pulumi.StringPtrInput
	// The description of the SAML Federation.
	Description pulumi.StringPtrInput
	// The ID of the IdP server to be used for authentication. The IdP server also responds to IAM with this ID after the user authenticates.
	Issuer pulumi.StringPtrInput
	// A set of key/value label pairs assigned to the SAML Federation.
	Labels pulumi.StringMapInput
	// The name of the SAML Federation.
	Name pulumi.StringPtrInput
	// The organization to attach this SAML Federation to.
	OrganizationId pulumi.StringPtrInput
	// Federation security settings, structure is documented below.
	SecuritySettings OrganizationmanagerSamlFederationSecuritySettingsPtrInput
	// Single sign-on endpoint binding type. Most Identity Providers support the `POST` binding type. SAML Binding is a mapping of a SAML protocol message onto standard messaging formats and/or communications protocols.
	SsoBinding pulumi.StringPtrInput
	// Single sign-on endpoint URL. Specify the link to the IdP login page here.
	SsoUrl pulumi.StringPtrInput
}

func (OrganizationmanagerSamlFederationState) ElementType() reflect.Type {
	return reflect.TypeOf((*organizationmanagerSamlFederationState)(nil)).Elem()
}

type organizationmanagerSamlFederationArgs struct {
	// Add new users automatically on successful authentication. The user will get the `resource-manager.clouds.member` role automatically, but you need to grant other roles to them. If the value is `false`, users who aren't added to the cloud can't log in, even if they have authenticated on your server.
	AutoCreateAccountOnLogin *bool `pulumi:"autoCreateAccountOnLogin"`
	// Use case-insensitive name ids.
	CaseInsensitiveNameIds *bool `pulumi:"caseInsensitiveNameIds"`
	// The lifetime of a Browser cookie in seconds. If the cookie is still valid, the management console authenticates the user immediately and redirects them to the home page. The default value is `8h`.
	CookieMaxAge *string `pulumi:"cookieMaxAge"`
	// The description of the SAML Federation.
	Description *string `pulumi:"description"`
	// The ID of the IdP server to be used for authentication. The IdP server also responds to IAM with this ID after the user authenticates.
	Issuer string `pulumi:"issuer"`
	// A set of key/value label pairs assigned to the SAML Federation.
	Labels map[string]string `pulumi:"labels"`
	// The name of the SAML Federation.
	Name *string `pulumi:"name"`
	// The organization to attach this SAML Federation to.
	OrganizationId string `pulumi:"organizationId"`
	// Federation security settings, structure is documented below.
	SecuritySettings *OrganizationmanagerSamlFederationSecuritySettings `pulumi:"securitySettings"`
	// Single sign-on endpoint binding type. Most Identity Providers support the `POST` binding type. SAML Binding is a mapping of a SAML protocol message onto standard messaging formats and/or communications protocols.
	SsoBinding string `pulumi:"ssoBinding"`
	// Single sign-on endpoint URL. Specify the link to the IdP login page here.
	SsoUrl string `pulumi:"ssoUrl"`
}

// The set of arguments for constructing a OrganizationmanagerSamlFederation resource.
type OrganizationmanagerSamlFederationArgs struct {
	// Add new users automatically on successful authentication. The user will get the `resource-manager.clouds.member` role automatically, but you need to grant other roles to them. If the value is `false`, users who aren't added to the cloud can't log in, even if they have authenticated on your server.
	AutoCreateAccountOnLogin pulumi.BoolPtrInput
	// Use case-insensitive name ids.
	CaseInsensitiveNameIds pulumi.BoolPtrInput
	// The lifetime of a Browser cookie in seconds. If the cookie is still valid, the management console authenticates the user immediately and redirects them to the home page. The default value is `8h`.
	CookieMaxAge pulumi.StringPtrInput
	// The description of the SAML Federation.
	Description pulumi.StringPtrInput
	// The ID of the IdP server to be used for authentication. The IdP server also responds to IAM with this ID after the user authenticates.
	Issuer pulumi.StringInput
	// A set of key/value label pairs assigned to the SAML Federation.
	Labels pulumi.StringMapInput
	// The name of the SAML Federation.
	Name pulumi.StringPtrInput
	// The organization to attach this SAML Federation to.
	OrganizationId pulumi.StringInput
	// Federation security settings, structure is documented below.
	SecuritySettings OrganizationmanagerSamlFederationSecuritySettingsPtrInput
	// Single sign-on endpoint binding type. Most Identity Providers support the `POST` binding type. SAML Binding is a mapping of a SAML protocol message onto standard messaging formats and/or communications protocols.
	SsoBinding pulumi.StringInput
	// Single sign-on endpoint URL. Specify the link to the IdP login page here.
	SsoUrl pulumi.StringInput
}

func (OrganizationmanagerSamlFederationArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*organizationmanagerSamlFederationArgs)(nil)).Elem()
}

type OrganizationmanagerSamlFederationInput interface {
	pulumi.Input

	ToOrganizationmanagerSamlFederationOutput() OrganizationmanagerSamlFederationOutput
	ToOrganizationmanagerSamlFederationOutputWithContext(ctx context.Context) OrganizationmanagerSamlFederationOutput
}

func (*OrganizationmanagerSamlFederation) ElementType() reflect.Type {
	return reflect.TypeOf((**OrganizationmanagerSamlFederation)(nil)).Elem()
}

func (i *OrganizationmanagerSamlFederation) ToOrganizationmanagerSamlFederationOutput() OrganizationmanagerSamlFederationOutput {
	return i.ToOrganizationmanagerSamlFederationOutputWithContext(context.Background())
}

func (i *OrganizationmanagerSamlFederation) ToOrganizationmanagerSamlFederationOutputWithContext(ctx context.Context) OrganizationmanagerSamlFederationOutput {
	return pulumi.ToOutputWithContext(ctx, i).(OrganizationmanagerSamlFederationOutput)
}

// OrganizationmanagerSamlFederationArrayInput is an input type that accepts OrganizationmanagerSamlFederationArray and OrganizationmanagerSamlFederationArrayOutput values.
// You can construct a concrete instance of `OrganizationmanagerSamlFederationArrayInput` via:
//
//          OrganizationmanagerSamlFederationArray{ OrganizationmanagerSamlFederationArgs{...} }
type OrganizationmanagerSamlFederationArrayInput interface {
	pulumi.Input

	ToOrganizationmanagerSamlFederationArrayOutput() OrganizationmanagerSamlFederationArrayOutput
	ToOrganizationmanagerSamlFederationArrayOutputWithContext(context.Context) OrganizationmanagerSamlFederationArrayOutput
}

type OrganizationmanagerSamlFederationArray []OrganizationmanagerSamlFederationInput

func (OrganizationmanagerSamlFederationArray) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*OrganizationmanagerSamlFederation)(nil)).Elem()
}

func (i OrganizationmanagerSamlFederationArray) ToOrganizationmanagerSamlFederationArrayOutput() OrganizationmanagerSamlFederationArrayOutput {
	return i.ToOrganizationmanagerSamlFederationArrayOutputWithContext(context.Background())
}

func (i OrganizationmanagerSamlFederationArray) ToOrganizationmanagerSamlFederationArrayOutputWithContext(ctx context.Context) OrganizationmanagerSamlFederationArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(OrganizationmanagerSamlFederationArrayOutput)
}

// OrganizationmanagerSamlFederationMapInput is an input type that accepts OrganizationmanagerSamlFederationMap and OrganizationmanagerSamlFederationMapOutput values.
// You can construct a concrete instance of `OrganizationmanagerSamlFederationMapInput` via:
//
//          OrganizationmanagerSamlFederationMap{ "key": OrganizationmanagerSamlFederationArgs{...} }
type OrganizationmanagerSamlFederationMapInput interface {
	pulumi.Input

	ToOrganizationmanagerSamlFederationMapOutput() OrganizationmanagerSamlFederationMapOutput
	ToOrganizationmanagerSamlFederationMapOutputWithContext(context.Context) OrganizationmanagerSamlFederationMapOutput
}

type OrganizationmanagerSamlFederationMap map[string]OrganizationmanagerSamlFederationInput

func (OrganizationmanagerSamlFederationMap) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*OrganizationmanagerSamlFederation)(nil)).Elem()
}

func (i OrganizationmanagerSamlFederationMap) ToOrganizationmanagerSamlFederationMapOutput() OrganizationmanagerSamlFederationMapOutput {
	return i.ToOrganizationmanagerSamlFederationMapOutputWithContext(context.Background())
}

func (i OrganizationmanagerSamlFederationMap) ToOrganizationmanagerSamlFederationMapOutputWithContext(ctx context.Context) OrganizationmanagerSamlFederationMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(OrganizationmanagerSamlFederationMapOutput)
}

type OrganizationmanagerSamlFederationOutput struct{ *pulumi.OutputState }

func (OrganizationmanagerSamlFederationOutput) ElementType() reflect.Type {
	return reflect.TypeOf((**OrganizationmanagerSamlFederation)(nil)).Elem()
}

func (o OrganizationmanagerSamlFederationOutput) ToOrganizationmanagerSamlFederationOutput() OrganizationmanagerSamlFederationOutput {
	return o
}

func (o OrganizationmanagerSamlFederationOutput) ToOrganizationmanagerSamlFederationOutputWithContext(ctx context.Context) OrganizationmanagerSamlFederationOutput {
	return o
}

type OrganizationmanagerSamlFederationArrayOutput struct{ *pulumi.OutputState }

func (OrganizationmanagerSamlFederationArrayOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*OrganizationmanagerSamlFederation)(nil)).Elem()
}

func (o OrganizationmanagerSamlFederationArrayOutput) ToOrganizationmanagerSamlFederationArrayOutput() OrganizationmanagerSamlFederationArrayOutput {
	return o
}

func (o OrganizationmanagerSamlFederationArrayOutput) ToOrganizationmanagerSamlFederationArrayOutputWithContext(ctx context.Context) OrganizationmanagerSamlFederationArrayOutput {
	return o
}

func (o OrganizationmanagerSamlFederationArrayOutput) Index(i pulumi.IntInput) OrganizationmanagerSamlFederationOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *OrganizationmanagerSamlFederation {
		return vs[0].([]*OrganizationmanagerSamlFederation)[vs[1].(int)]
	}).(OrganizationmanagerSamlFederationOutput)
}

type OrganizationmanagerSamlFederationMapOutput struct{ *pulumi.OutputState }

func (OrganizationmanagerSamlFederationMapOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*OrganizationmanagerSamlFederation)(nil)).Elem()
}

func (o OrganizationmanagerSamlFederationMapOutput) ToOrganizationmanagerSamlFederationMapOutput() OrganizationmanagerSamlFederationMapOutput {
	return o
}

func (o OrganizationmanagerSamlFederationMapOutput) ToOrganizationmanagerSamlFederationMapOutputWithContext(ctx context.Context) OrganizationmanagerSamlFederationMapOutput {
	return o
}

func (o OrganizationmanagerSamlFederationMapOutput) MapIndex(k pulumi.StringInput) OrganizationmanagerSamlFederationOutput {
	return pulumi.All(o, k).ApplyT(func(vs []interface{}) *OrganizationmanagerSamlFederation {
		return vs[0].(map[string]*OrganizationmanagerSamlFederation)[vs[1].(string)]
	}).(OrganizationmanagerSamlFederationOutput)
}

func init() {
	pulumi.RegisterInputType(reflect.TypeOf((*OrganizationmanagerSamlFederationInput)(nil)).Elem(), &OrganizationmanagerSamlFederation{})
	pulumi.RegisterInputType(reflect.TypeOf((*OrganizationmanagerSamlFederationArrayInput)(nil)).Elem(), OrganizationmanagerSamlFederationArray{})
	pulumi.RegisterInputType(reflect.TypeOf((*OrganizationmanagerSamlFederationMapInput)(nil)).Elem(), OrganizationmanagerSamlFederationMap{})
	pulumi.RegisterOutputType(OrganizationmanagerSamlFederationOutput{})
	pulumi.RegisterOutputType(OrganizationmanagerSamlFederationArrayOutput{})
	pulumi.RegisterOutputType(OrganizationmanagerSamlFederationMapOutput{})
}