github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/kendra/experience.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 kendra

import (
	"context"
	"reflect"

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

// Resource for managing an AWS Kendra Experience.
//
// ## Example Usage
//
// ### Basic Usage
//
// <!--Start PulumiCodeChooser -->
// ```go
// package main
//
// import (
//
//	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kendra"
//	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
//	func main() {
//		pulumi.Run(func(ctx *pulumi.Context) error {
//			_, err := kendra.NewExperience(ctx, "example", &kendra.ExperienceArgs{
//				IndexId:     pulumi.Any(exampleAwsKendraIndex.Id),
//				Description: pulumi.String("My Kendra Experience"),
//				Name:        pulumi.String("example"),
//				RoleArn:     pulumi.Any(exampleAwsIamRole.Arn),
//				Configuration: &kendra.ExperienceConfigurationArgs{
//					ContentSourceConfiguration: &kendra.ExperienceConfigurationContentSourceConfigurationArgs{
//						DirectPutContent: pulumi.Bool(true),
//						FaqIds: pulumi.StringArray{
//							exampleAwsKendraFaq.FaqId,
//						},
//					},
//					UserIdentityConfiguration: &kendra.ExperienceConfigurationUserIdentityConfigurationArgs{
//						IdentityAttributeName: pulumi.String("12345ec453-1546651e-79c4-4554-91fa-00b43ccfa245"),
//					},
//				},
//			})
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
//
// ## Import
//
// Using `pulumi import`, import Kendra Experience using the unique identifiers of the experience and index separated by a slash (`/`). For example:
//
// ```sh
// $ pulumi import aws:kendra/experience:Experience example 1045d08d-66ef-4882-b3ed-dfb7df183e90/b34dfdf7-1f2b-4704-9581-79e00296845f
// ```
type Experience struct {
	pulumi.CustomResourceState

	// ARN of the Experience.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// Configuration information for your Amazon Kendra experience. The provider will only perform drift detection of its value when present in a configuration. Detailed below.
	Configuration ExperienceConfigurationOutput `pulumi:"configuration"`
	// A description for your Amazon Kendra experience.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
	Endpoints ExperienceEndpointArrayOutput `pulumi:"endpoints"`
	// The unique identifier of the experience.
	ExperienceId pulumi.StringOutput `pulumi:"experienceId"`
	// The identifier of the index for your Amazon Kendra experience.
	IndexId pulumi.StringOutput `pulumi:"indexId"`
	// A name for your Amazon Kendra experience.
	Name pulumi.StringOutput `pulumi:"name"`
	// The Amazon Resource Name (ARN) of a role with permission to access `Query API`, `QuerySuggestions API`, `SubmitFeedback API`, and `AWS SSO` that stores your user and group information. For more information, see [IAM roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
	//
	// The following arguments are optional:
	RoleArn pulumi.StringOutput `pulumi:"roleArn"`
	// The current processing status of your Amazon Kendra experience.
	Status pulumi.StringOutput `pulumi:"status"`
}

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

	if args.IndexId == nil {
		return nil, errors.New("invalid value for required argument 'IndexId'")
	}
	if args.RoleArn == nil {
		return nil, errors.New("invalid value for required argument 'RoleArn'")
	}
	opts = internal.PkgResourceDefaultOpts(opts)
	var resource Experience
	err := ctx.RegisterResource("aws:kendra/experience:Experience", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetExperience gets an existing Experience 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 GetExperience(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ExperienceState, opts ...pulumi.ResourceOption) (*Experience, error) {
	var resource Experience
	err := ctx.ReadResource("aws:kendra/experience:Experience", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering Experience resources.
type experienceState struct {
	// ARN of the Experience.
	Arn *string `pulumi:"arn"`
	// Configuration information for your Amazon Kendra experience. The provider will only perform drift detection of its value when present in a configuration. Detailed below.
	Configuration *ExperienceConfiguration `pulumi:"configuration"`
	// A description for your Amazon Kendra experience.
	Description *string `pulumi:"description"`
	// Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
	Endpoints []ExperienceEndpoint `pulumi:"endpoints"`
	// The unique identifier of the experience.
	ExperienceId *string `pulumi:"experienceId"`
	// The identifier of the index for your Amazon Kendra experience.
	IndexId *string `pulumi:"indexId"`
	// A name for your Amazon Kendra experience.
	Name *string `pulumi:"name"`
	// The Amazon Resource Name (ARN) of a role with permission to access `Query API`, `QuerySuggestions API`, `SubmitFeedback API`, and `AWS SSO` that stores your user and group information. For more information, see [IAM roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
	//
	// The following arguments are optional:
	RoleArn *string `pulumi:"roleArn"`
	// The current processing status of your Amazon Kendra experience.
	Status *string `pulumi:"status"`
}

type ExperienceState struct {
	// ARN of the Experience.
	Arn pulumi.StringPtrInput
	// Configuration information for your Amazon Kendra experience. The provider will only perform drift detection of its value when present in a configuration. Detailed below.
	Configuration ExperienceConfigurationPtrInput
	// A description for your Amazon Kendra experience.
	Description pulumi.StringPtrInput
	// Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
	Endpoints ExperienceEndpointArrayInput
	// The unique identifier of the experience.
	ExperienceId pulumi.StringPtrInput
	// The identifier of the index for your Amazon Kendra experience.
	IndexId pulumi.StringPtrInput
	// A name for your Amazon Kendra experience.
	Name pulumi.StringPtrInput
	// The Amazon Resource Name (ARN) of a role with permission to access `Query API`, `QuerySuggestions API`, `SubmitFeedback API`, and `AWS SSO` that stores your user and group information. For more information, see [IAM roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
	//
	// The following arguments are optional:
	RoleArn pulumi.StringPtrInput
	// The current processing status of your Amazon Kendra experience.
	Status pulumi.StringPtrInput
}

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

type experienceArgs struct {
	// Configuration information for your Amazon Kendra experience. The provider will only perform drift detection of its value when present in a configuration. Detailed below.
	Configuration *ExperienceConfiguration `pulumi:"configuration"`
	// A description for your Amazon Kendra experience.
	Description *string `pulumi:"description"`
	// The identifier of the index for your Amazon Kendra experience.
	IndexId string `pulumi:"indexId"`
	// A name for your Amazon Kendra experience.
	Name *string `pulumi:"name"`
	// The Amazon Resource Name (ARN) of a role with permission to access `Query API`, `QuerySuggestions API`, `SubmitFeedback API`, and `AWS SSO` that stores your user and group information. For more information, see [IAM roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
	//
	// The following arguments are optional:
	RoleArn string `pulumi:"roleArn"`
}

// The set of arguments for constructing a Experience resource.
type ExperienceArgs struct {
	// Configuration information for your Amazon Kendra experience. The provider will only perform drift detection of its value when present in a configuration. Detailed below.
	Configuration ExperienceConfigurationPtrInput
	// A description for your Amazon Kendra experience.
	Description pulumi.StringPtrInput
	// The identifier of the index for your Amazon Kendra experience.
	IndexId pulumi.StringInput
	// A name for your Amazon Kendra experience.
	Name pulumi.StringPtrInput
	// The Amazon Resource Name (ARN) of a role with permission to access `Query API`, `QuerySuggestions API`, `SubmitFeedback API`, and `AWS SSO` that stores your user and group information. For more information, see [IAM roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
	//
	// The following arguments are optional:
	RoleArn pulumi.StringInput
}

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

type ExperienceInput interface {
	pulumi.Input

	ToExperienceOutput() ExperienceOutput
	ToExperienceOutputWithContext(ctx context.Context) ExperienceOutput
}

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

func (i *Experience) ToExperienceOutput() ExperienceOutput {
	return i.ToExperienceOutputWithContext(context.Background())
}

func (i *Experience) ToExperienceOutputWithContext(ctx context.Context) ExperienceOutput {
	return pulumi.ToOutputWithContext(ctx, i).(ExperienceOutput)
}

// ExperienceArrayInput is an input type that accepts ExperienceArray and ExperienceArrayOutput values.
// You can construct a concrete instance of `ExperienceArrayInput` via:
//
//	ExperienceArray{ ExperienceArgs{...} }
type ExperienceArrayInput interface {
	pulumi.Input

	ToExperienceArrayOutput() ExperienceArrayOutput
	ToExperienceArrayOutputWithContext(context.Context) ExperienceArrayOutput
}

type ExperienceArray []ExperienceInput

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

func (i ExperienceArray) ToExperienceArrayOutput() ExperienceArrayOutput {
	return i.ToExperienceArrayOutputWithContext(context.Background())
}

func (i ExperienceArray) ToExperienceArrayOutputWithContext(ctx context.Context) ExperienceArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(ExperienceArrayOutput)
}

// ExperienceMapInput is an input type that accepts ExperienceMap and ExperienceMapOutput values.
// You can construct a concrete instance of `ExperienceMapInput` via:
//
//	ExperienceMap{ "key": ExperienceArgs{...} }
type ExperienceMapInput interface {
	pulumi.Input

	ToExperienceMapOutput() ExperienceMapOutput
	ToExperienceMapOutputWithContext(context.Context) ExperienceMapOutput
}

type ExperienceMap map[string]ExperienceInput

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

func (i ExperienceMap) ToExperienceMapOutput() ExperienceMapOutput {
	return i.ToExperienceMapOutputWithContext(context.Background())
}

func (i ExperienceMap) ToExperienceMapOutputWithContext(ctx context.Context) ExperienceMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(ExperienceMapOutput)
}

type ExperienceOutput struct{ *pulumi.OutputState }

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

func (o ExperienceOutput) ToExperienceOutput() ExperienceOutput {
	return o
}

func (o ExperienceOutput) ToExperienceOutputWithContext(ctx context.Context) ExperienceOutput {
	return o
}

// ARN of the Experience.
func (o ExperienceOutput) Arn() pulumi.StringOutput {
	return o.ApplyT(func(v *Experience) pulumi.StringOutput { return v.Arn }).(pulumi.StringOutput)
}

// Configuration information for your Amazon Kendra experience. The provider will only perform drift detection of its value when present in a configuration. Detailed below.
func (o ExperienceOutput) Configuration() ExperienceConfigurationOutput {
	return o.ApplyT(func(v *Experience) ExperienceConfigurationOutput { return v.Configuration }).(ExperienceConfigurationOutput)
}

// A description for your Amazon Kendra experience.
func (o ExperienceOutput) Description() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *Experience) pulumi.StringPtrOutput { return v.Description }).(pulumi.StringPtrOutput)
}

// Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
func (o ExperienceOutput) Endpoints() ExperienceEndpointArrayOutput {
	return o.ApplyT(func(v *Experience) ExperienceEndpointArrayOutput { return v.Endpoints }).(ExperienceEndpointArrayOutput)
}

// The unique identifier of the experience.
func (o ExperienceOutput) ExperienceId() pulumi.StringOutput {
	return o.ApplyT(func(v *Experience) pulumi.StringOutput { return v.ExperienceId }).(pulumi.StringOutput)
}

// The identifier of the index for your Amazon Kendra experience.
func (o ExperienceOutput) IndexId() pulumi.StringOutput {
	return o.ApplyT(func(v *Experience) pulumi.StringOutput { return v.IndexId }).(pulumi.StringOutput)
}

// A name for your Amazon Kendra experience.
func (o ExperienceOutput) Name() pulumi.StringOutput {
	return o.ApplyT(func(v *Experience) pulumi.StringOutput { return v.Name }).(pulumi.StringOutput)
}

// The Amazon Resource Name (ARN) of a role with permission to access `Query API`, `QuerySuggestions API`, `SubmitFeedback API`, and `AWS SSO` that stores your user and group information. For more information, see [IAM roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
//
// The following arguments are optional:
func (o ExperienceOutput) RoleArn() pulumi.StringOutput {
	return o.ApplyT(func(v *Experience) pulumi.StringOutput { return v.RoleArn }).(pulumi.StringOutput)
}

// The current processing status of your Amazon Kendra experience.
func (o ExperienceOutput) Status() pulumi.StringOutput {
	return o.ApplyT(func(v *Experience) pulumi.StringOutput { return v.Status }).(pulumi.StringOutput)
}

type ExperienceArrayOutput struct{ *pulumi.OutputState }

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

func (o ExperienceArrayOutput) ToExperienceArrayOutput() ExperienceArrayOutput {
	return o
}

func (o ExperienceArrayOutput) ToExperienceArrayOutputWithContext(ctx context.Context) ExperienceArrayOutput {
	return o
}

func (o ExperienceArrayOutput) Index(i pulumi.IntInput) ExperienceOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *Experience {
		return vs[0].([]*Experience)[vs[1].(int)]
	}).(ExperienceOutput)
}

type ExperienceMapOutput struct{ *pulumi.OutputState }

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

func (o ExperienceMapOutput) ToExperienceMapOutput() ExperienceMapOutput {
	return o
}

func (o ExperienceMapOutput) ToExperienceMapOutputWithContext(ctx context.Context) ExperienceMapOutput {
	return o
}

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

func init() {
	pulumi.RegisterInputType(reflect.TypeOf((*ExperienceInput)(nil)).Elem(), &Experience{})
	pulumi.RegisterInputType(reflect.TypeOf((*ExperienceArrayInput)(nil)).Elem(), ExperienceArray{})
	pulumi.RegisterInputType(reflect.TypeOf((*ExperienceMapInput)(nil)).Elem(), ExperienceMap{})
	pulumi.RegisterOutputType(ExperienceOutput{})
	pulumi.RegisterOutputType(ExperienceArrayOutput{})
	pulumi.RegisterOutputType(ExperienceMapOutput{})
}