oidcRole.go

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

package identity

import (
	"context"
	"reflect"

	"errors"
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// ## Example Usage
//
// You need to create a role with a named key.
// At creation time, the key can be created independently of the role. However, the key must
// exist before the role can be used to issue tokens. You must also configure the key with the
// role's Client ID to allow the role to use the key.
//
// <!--Start PulumiCodeChooser -->
// ```go
// package main
//
// import (
//
//	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/identity"
//	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
//
// )
//
//	func main() {
//		pulumi.Run(func(ctx *pulumi.Context) error {
//			cfg := config.New(ctx, "")
//			key := "key"
//			if param := cfg.Get("key"); param != "" {
//				key = param
//			}
//			role, err := identity.NewOidcRole(ctx, "role", &identity.OidcRoleArgs{
//				Key: pulumi.String(key),
//			})
//			if err != nil {
//				return err
//			}
//			_, err = identity.NewOidcKey(ctx, "keyOidcKey", &identity.OidcKeyArgs{
//				Algorithm: pulumi.String("RS256"),
//				AllowedClientIds: pulumi.StringArray{
//					role.ClientId,
//				},
//			})
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
//
// If you want to create the key first before creating the role, you can use a separate
// resource to configure the allowed Client ID on
// the key.
//
// <!--Start PulumiCodeChooser -->
// ```go
// package main
//
// import (
//
//	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/identity"
//	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
//	func main() {
//		pulumi.Run(func(ctx *pulumi.Context) error {
//			key, err := identity.NewOidcKey(ctx, "key", &identity.OidcKeyArgs{
//				Algorithm: pulumi.String("RS256"),
//			})
//			if err != nil {
//				return err
//			}
//			roleOidcRole, err := identity.NewOidcRole(ctx, "roleOidcRole", &identity.OidcRoleArgs{
//				Key: key.Name,
//			})
//			if err != nil {
//				return err
//			}
//			_, err = identity.NewOidcKeyAllowedClientID(ctx, "roleOidcKeyAllowedClientID", &identity.OidcKeyAllowedClientIDArgs{
//				KeyName:         key.Name,
//				AllowedClientId: roleOidcRole.ClientId,
//			})
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
//
// ## Import
//
// The key can be imported with the role name, for example:
//
// ```sh
// $ pulumi import vault:identity/oidcRole:OidcRole role role
// ```
type OidcRole struct {
	pulumi.CustomResourceState

	// The value that will be included in the `aud` field of all the OIDC identity
	// tokens issued by this role
	ClientId pulumi.StringOutput `pulumi:"clientId"`
	// A configured named key, the key must already exist
	// before tokens can be issued.
	Key pulumi.StringOutput `pulumi:"key"`
	// Name of the OIDC Role to create.
	Name pulumi.StringOutput `pulumi:"name"`
	// The namespace to provision the resource in.
	// The value should not contain leading or trailing forward slashes.
	// The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
	// *Available only for Vault Enterprise*.
	Namespace pulumi.StringPtrOutput `pulumi:"namespace"`
	// The template string to use for generating tokens. This may be in
	// string-ified JSON or base64 format. See the
	// [documentation](https://www.vaultproject.io/docs/secrets/identity/index.html#token-contents-and-templates)
	// for the template format.
	Template pulumi.StringPtrOutput `pulumi:"template"`
	// TTL of the tokens generated against the role in number of seconds.
	Ttl pulumi.IntPtrOutput `pulumi:"ttl"`
}

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

	if args.Key == nil {
		return nil, errors.New("invalid value for required argument 'Key'")
	}
	opts = internal.PkgResourceDefaultOpts(opts)
	var resource OidcRole
	err := ctx.RegisterResource("vault:identity/oidcRole:OidcRole", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetOidcRole gets an existing OidcRole 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 GetOidcRole(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *OidcRoleState, opts ...pulumi.ResourceOption) (*OidcRole, error) {
	var resource OidcRole
	err := ctx.ReadResource("vault:identity/oidcRole:OidcRole", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering OidcRole resources.
type oidcRoleState struct {
	// The value that will be included in the `aud` field of all the OIDC identity
	// tokens issued by this role
	ClientId *string `pulumi:"clientId"`
	// A configured named key, the key must already exist
	// before tokens can be issued.
	Key *string `pulumi:"key"`
	// Name of the OIDC Role to create.
	Name *string `pulumi:"name"`
	// The namespace to provision the resource in.
	// The value should not contain leading or trailing forward slashes.
	// The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
	// *Available only for Vault Enterprise*.
	Namespace *string `pulumi:"namespace"`
	// The template string to use for generating tokens. This may be in
	// string-ified JSON or base64 format. See the
	// [documentation](https://www.vaultproject.io/docs/secrets/identity/index.html#token-contents-and-templates)
	// for the template format.
	Template *string `pulumi:"template"`
	// TTL of the tokens generated against the role in number of seconds.
	Ttl *int `pulumi:"ttl"`
}

type OidcRoleState struct {
	// The value that will be included in the `aud` field of all the OIDC identity
	// tokens issued by this role
	ClientId pulumi.StringPtrInput
	// A configured named key, the key must already exist
	// before tokens can be issued.
	Key pulumi.StringPtrInput
	// Name of the OIDC Role to create.
	Name pulumi.StringPtrInput
	// The namespace to provision the resource in.
	// The value should not contain leading or trailing forward slashes.
	// The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
	// *Available only for Vault Enterprise*.
	Namespace pulumi.StringPtrInput
	// The template string to use for generating tokens. This may be in
	// string-ified JSON or base64 format. See the
	// [documentation](https://www.vaultproject.io/docs/secrets/identity/index.html#token-contents-and-templates)
	// for the template format.
	Template pulumi.StringPtrInput
	// TTL of the tokens generated against the role in number of seconds.
	Ttl pulumi.IntPtrInput
}

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

type oidcRoleArgs struct {
	// The value that will be included in the `aud` field of all the OIDC identity
	// tokens issued by this role
	ClientId *string `pulumi:"clientId"`
	// A configured named key, the key must already exist
	// before tokens can be issued.
	Key string `pulumi:"key"`
	// Name of the OIDC Role to create.
	Name *string `pulumi:"name"`
	// The namespace to provision the resource in.
	// The value should not contain leading or trailing forward slashes.
	// The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
	// *Available only for Vault Enterprise*.
	Namespace *string `pulumi:"namespace"`
	// The template string to use for generating tokens. This may be in
	// string-ified JSON or base64 format. See the
	// [documentation](https://www.vaultproject.io/docs/secrets/identity/index.html#token-contents-and-templates)
	// for the template format.
	Template *string `pulumi:"template"`
	// TTL of the tokens generated against the role in number of seconds.
	Ttl *int `pulumi:"ttl"`
}

// The set of arguments for constructing a OidcRole resource.
type OidcRoleArgs struct {
	// The value that will be included in the `aud` field of all the OIDC identity
	// tokens issued by this role
	ClientId pulumi.StringPtrInput
	// A configured named key, the key must already exist
	// before tokens can be issued.
	Key pulumi.StringInput
	// Name of the OIDC Role to create.
	Name pulumi.StringPtrInput
	// The namespace to provision the resource in.
	// The value should not contain leading or trailing forward slashes.
	// The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
	// *Available only for Vault Enterprise*.
	Namespace pulumi.StringPtrInput
	// The template string to use for generating tokens. This may be in
	// string-ified JSON or base64 format. See the
	// [documentation](https://www.vaultproject.io/docs/secrets/identity/index.html#token-contents-and-templates)
	// for the template format.
	Template pulumi.StringPtrInput
	// TTL of the tokens generated against the role in number of seconds.
	Ttl pulumi.IntPtrInput
}

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

type OidcRoleInput interface {
	pulumi.Input

	ToOidcRoleOutput() OidcRoleOutput
	ToOidcRoleOutputWithContext(ctx context.Context) OidcRoleOutput
}

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

func (i *OidcRole) ToOidcRoleOutput() OidcRoleOutput {
	return i.ToOidcRoleOutputWithContext(context.Background())
}

func (i *OidcRole) ToOidcRoleOutputWithContext(ctx context.Context) OidcRoleOutput {
	return pulumi.ToOutputWithContext(ctx, i).(OidcRoleOutput)
}

// OidcRoleArrayInput is an input type that accepts OidcRoleArray and OidcRoleArrayOutput values.
// You can construct a concrete instance of `OidcRoleArrayInput` via:
//
//	OidcRoleArray{ OidcRoleArgs{...} }
type OidcRoleArrayInput interface {
	pulumi.Input

	ToOidcRoleArrayOutput() OidcRoleArrayOutput
	ToOidcRoleArrayOutputWithContext(context.Context) OidcRoleArrayOutput
}

type OidcRoleArray []OidcRoleInput

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

func (i OidcRoleArray) ToOidcRoleArrayOutput() OidcRoleArrayOutput {
	return i.ToOidcRoleArrayOutputWithContext(context.Background())
}

func (i OidcRoleArray) ToOidcRoleArrayOutputWithContext(ctx context.Context) OidcRoleArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(OidcRoleArrayOutput)
}

// OidcRoleMapInput is an input type that accepts OidcRoleMap and OidcRoleMapOutput values.
// You can construct a concrete instance of `OidcRoleMapInput` via:
//
//	OidcRoleMap{ "key": OidcRoleArgs{...} }
type OidcRoleMapInput interface {
	pulumi.Input

	ToOidcRoleMapOutput() OidcRoleMapOutput
	ToOidcRoleMapOutputWithContext(context.Context) OidcRoleMapOutput
}

type OidcRoleMap map[string]OidcRoleInput

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

func (i OidcRoleMap) ToOidcRoleMapOutput() OidcRoleMapOutput {
	return i.ToOidcRoleMapOutputWithContext(context.Background())
}

func (i OidcRoleMap) ToOidcRoleMapOutputWithContext(ctx context.Context) OidcRoleMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(OidcRoleMapOutput)
}

type OidcRoleOutput struct{ *pulumi.OutputState }

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

func (o OidcRoleOutput) ToOidcRoleOutput() OidcRoleOutput {
	return o
}

func (o OidcRoleOutput) ToOidcRoleOutputWithContext(ctx context.Context) OidcRoleOutput {
	return o
}

// The value that will be included in the `aud` field of all the OIDC identity
// tokens issued by this role
func (o OidcRoleOutput) ClientId() pulumi.StringOutput {
	return o.ApplyT(func(v *OidcRole) pulumi.StringOutput { return v.ClientId }).(pulumi.StringOutput)
}

// A configured named key, the key must already exist
// before tokens can be issued.
func (o OidcRoleOutput) Key() pulumi.StringOutput {
	return o.ApplyT(func(v *OidcRole) pulumi.StringOutput { return v.Key }).(pulumi.StringOutput)
}

// Name of the OIDC Role to create.
func (o OidcRoleOutput) Name() pulumi.StringOutput {
	return o.ApplyT(func(v *OidcRole) pulumi.StringOutput { return v.Name }).(pulumi.StringOutput)
}

// The namespace to provision the resource in.
// The value should not contain leading or trailing forward slashes.
// The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
// *Available only for Vault Enterprise*.
func (o OidcRoleOutput) Namespace() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *OidcRole) pulumi.StringPtrOutput { return v.Namespace }).(pulumi.StringPtrOutput)
}

// The template string to use for generating tokens. This may be in
// string-ified JSON or base64 format. See the
// [documentation](https://www.vaultproject.io/docs/secrets/identity/index.html#token-contents-and-templates)
// for the template format.
func (o OidcRoleOutput) Template() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *OidcRole) pulumi.StringPtrOutput { return v.Template }).(pulumi.StringPtrOutput)
}

// TTL of the tokens generated against the role in number of seconds.
func (o OidcRoleOutput) Ttl() pulumi.IntPtrOutput {
	return o.ApplyT(func(v *OidcRole) pulumi.IntPtrOutput { return v.Ttl }).(pulumi.IntPtrOutput)
}

type OidcRoleArrayOutput struct{ *pulumi.OutputState }

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

func (o OidcRoleArrayOutput) ToOidcRoleArrayOutput() OidcRoleArrayOutput {
	return o
}

func (o OidcRoleArrayOutput) ToOidcRoleArrayOutputWithContext(ctx context.Context) OidcRoleArrayOutput {
	return o
}

func (o OidcRoleArrayOutput) Index(i pulumi.IntInput) OidcRoleOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *OidcRole {
		return vs[0].([]*OidcRole)[vs[1].(int)]
	}).(OidcRoleOutput)
}

type OidcRoleMapOutput struct{ *pulumi.OutputState }

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

func (o OidcRoleMapOutput) ToOidcRoleMapOutput() OidcRoleMapOutput {
	return o
}

func (o OidcRoleMapOutput) ToOidcRoleMapOutputWithContext(ctx context.Context) OidcRoleMapOutput {
	return o
}

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

func init() {
	pulumi.RegisterInputType(reflect.TypeOf((*OidcRoleInput)(nil)).Elem(), &OidcRole{})
	pulumi.RegisterInputType(reflect.TypeOf((*OidcRoleArrayInput)(nil)).Elem(), OidcRoleArray{})
	pulumi.RegisterInputType(reflect.TypeOf((*OidcRoleMapInput)(nil)).Elem(), OidcRoleMap{})
	pulumi.RegisterOutputType(OidcRoleOutput{})
	pulumi.RegisterOutputType(OidcRoleArrayOutput{})
	pulumi.RegisterOutputType(OidcRoleMapOutput{})
}