getLockBoxSecret.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 yandex

import (
	"context"
	"reflect"

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

// Get information about Yandex Cloud Lockbox secret. For more information,
// see [the official documentation](https://cloud.yandex.com/en/docs/lockbox/).
//
// ## 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 {
//			mySecret, err := yandex.GetLockBoxSecret(ctx, &GetLockBoxSecretArgs{
//				SecretId: pulumi.StringRef("some ID"),
//			}, nil)
//			if err != nil {
//				return err
//			}
//			ctx.Export("mySecretCreatedAt", mySecret.CreatedAt)
//			return nil
//		})
//	}
//
// ```
func GetLockBoxSecret(ctx *pulumi.Context, args *GetLockBoxSecretArgs, opts ...pulumi.InvokeOption) (*GetLockBoxSecretResult, error) {
	opts = pkgInvokeDefaultOpts(opts)
	var rv GetLockBoxSecretResult
	err := ctx.Invoke("yandex:index/getLockBoxSecret:getLockBoxSecret", args, &rv, opts...)
	if err != nil {
		return nil, err
	}
	return &rv, nil
}

// A collection of arguments for invoking getLockBoxSecret.
type GetLockBoxSecretArgs struct {
	// Folder that the secret belongs to. If value is omitted, the default provider folder is used.
	FolderId *string `pulumi:"folderId"`
	// Name of the Lockbox secret.
	Name *string `pulumi:"name"`
	// The Yandex Cloud Lockbox secret ID.
	SecretId *string `pulumi:"secretId"`
}

// A collection of values returned by getLockBoxSecret.
type GetLockBoxSecretResult struct {
	// The version creation timestamp.
	CreatedAt string `pulumi:"createdAt"`
	// Information about the current version of the Yandex Cloud Lockbox secret.
	CurrentVersions []GetLockBoxSecretCurrentVersion `pulumi:"currentVersions"`
	// Whether the Yandex Cloud Lockbox secret is protected from deletion.
	DeletionProtection bool `pulumi:"deletionProtection"`
	// The version description.
	Description string `pulumi:"description"`
	// ID of the folder that the Yandex Cloud Lockbox secret belongs to.
	FolderId string `pulumi:"folderId"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The KMS key used to encrypt the Yandex Cloud Lockbox secret (if an explicit key was used).
	KmsKeyId string `pulumi:"kmsKeyId"`
	// A set of key/value label pairs assigned to the Yandex Cloud Lockbox secret.
	Labels map[string]string `pulumi:"labels"`
	// The Yandex Cloud Lockbox secret name.
	Name string `pulumi:"name"`
	// The secret ID the version belongs to (it's the same as the `secretId` argument indicated above)
	SecretId *string `pulumi:"secretId"`
	// The version status.
	Status string `pulumi:"status"`
}

func GetLockBoxSecretOutput(ctx *pulumi.Context, args GetLockBoxSecretOutputArgs, opts ...pulumi.InvokeOption) GetLockBoxSecretResultOutput {
	return pulumi.ToOutputWithContext(context.Background(), args).
		ApplyT(func(v interface{}) (GetLockBoxSecretResult, error) {
			args := v.(GetLockBoxSecretArgs)
			r, err := GetLockBoxSecret(ctx, &args, opts...)
			var s GetLockBoxSecretResult
			if r != nil {
				s = *r
			}
			return s, err
		}).(GetLockBoxSecretResultOutput)
}

// A collection of arguments for invoking getLockBoxSecret.
type GetLockBoxSecretOutputArgs struct {
	// Folder that the secret belongs to. If value is omitted, the default provider folder is used.
	FolderId pulumi.StringPtrInput `pulumi:"folderId"`
	// Name of the Lockbox secret.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// The Yandex Cloud Lockbox secret ID.
	SecretId pulumi.StringPtrInput `pulumi:"secretId"`
}

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

// A collection of values returned by getLockBoxSecret.
type GetLockBoxSecretResultOutput struct{ *pulumi.OutputState }

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

func (o GetLockBoxSecretResultOutput) ToGetLockBoxSecretResultOutput() GetLockBoxSecretResultOutput {
	return o
}

func (o GetLockBoxSecretResultOutput) ToGetLockBoxSecretResultOutputWithContext(ctx context.Context) GetLockBoxSecretResultOutput {
	return o
}

// The version creation timestamp.
func (o GetLockBoxSecretResultOutput) CreatedAt() pulumi.StringOutput {
	return o.ApplyT(func(v GetLockBoxSecretResult) string { return v.CreatedAt }).(pulumi.StringOutput)
}

// Information about the current version of the Yandex Cloud Lockbox secret.
func (o GetLockBoxSecretResultOutput) CurrentVersions() GetLockBoxSecretCurrentVersionArrayOutput {
	return o.ApplyT(func(v GetLockBoxSecretResult) []GetLockBoxSecretCurrentVersion { return v.CurrentVersions }).(GetLockBoxSecretCurrentVersionArrayOutput)
}

// Whether the Yandex Cloud Lockbox secret is protected from deletion.
func (o GetLockBoxSecretResultOutput) DeletionProtection() pulumi.BoolOutput {
	return o.ApplyT(func(v GetLockBoxSecretResult) bool { return v.DeletionProtection }).(pulumi.BoolOutput)
}

// The version description.
func (o GetLockBoxSecretResultOutput) Description() pulumi.StringOutput {
	return o.ApplyT(func(v GetLockBoxSecretResult) string { return v.Description }).(pulumi.StringOutput)
}

// ID of the folder that the Yandex Cloud Lockbox secret belongs to.
func (o GetLockBoxSecretResultOutput) FolderId() pulumi.StringOutput {
	return o.ApplyT(func(v GetLockBoxSecretResult) string { return v.FolderId }).(pulumi.StringOutput)
}

// The provider-assigned unique ID for this managed resource.
func (o GetLockBoxSecretResultOutput) Id() pulumi.StringOutput {
	return o.ApplyT(func(v GetLockBoxSecretResult) string { return v.Id }).(pulumi.StringOutput)
}

// The KMS key used to encrypt the Yandex Cloud Lockbox secret (if an explicit key was used).
func (o GetLockBoxSecretResultOutput) KmsKeyId() pulumi.StringOutput {
	return o.ApplyT(func(v GetLockBoxSecretResult) string { return v.KmsKeyId }).(pulumi.StringOutput)
}

// A set of key/value label pairs assigned to the Yandex Cloud Lockbox secret.
func (o GetLockBoxSecretResultOutput) Labels() pulumi.StringMapOutput {
	return o.ApplyT(func(v GetLockBoxSecretResult) map[string]string { return v.Labels }).(pulumi.StringMapOutput)
}

// The Yandex Cloud Lockbox secret name.
func (o GetLockBoxSecretResultOutput) Name() pulumi.StringOutput {
	return o.ApplyT(func(v GetLockBoxSecretResult) string { return v.Name }).(pulumi.StringOutput)
}

// The secret ID the version belongs to (it's the same as the `secretId` argument indicated above)
func (o GetLockBoxSecretResultOutput) SecretId() pulumi.StringPtrOutput {
	return o.ApplyT(func(v GetLockBoxSecretResult) *string { return v.SecretId }).(pulumi.StringPtrOutput)
}

// The version status.
func (o GetLockBoxSecretResultOutput) Status() pulumi.StringOutput {
	return o.ApplyT(func(v GetLockBoxSecretResult) string { return v.Status }).(pulumi.StringOutput)
}

func init() {
	pulumi.RegisterOutputType(GetLockBoxSecretResultOutput{})
}