Experience class
Resource for managing an AWS Kendra Experience.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.kendra.Experience("example", {
configuration: {
contentSourceConfiguration: {
directPutContent: true,
faqIds: [exampleAwsKendraFaq.faqId],
},
userIdentityConfiguration: {
identityAttributeName: "12345ec453-1546651e-79c4-4554-91fa-00b43ccfa245",
},
},
indexId: exampleAwsKendraIndex.id,
description: "My Kendra Experience",
name: "example",
roleArn: exampleAwsIamRole.arn,
});
import pulumi
import pulumi_aws as aws
example = aws.kendra.Experience("example",
configuration={
"content_source_configuration": {
"direct_put_content": True,
"faq_ids": [example_aws_kendra_faq["faqId"]],
},
"user_identity_configuration": {
"identity_attribute_name": "12345ec453-1546651e-79c4-4554-91fa-00b43ccfa245",
},
},
index_id=example_aws_kendra_index["id"],
description="My Kendra Experience",
name="example",
role_arn=example_aws_iam_role["arn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Kendra.Experience("example", new()
{
Configuration = new Aws.Kendra.Inputs.ExperienceConfigurationArgs
{
ContentSourceConfiguration = new Aws.Kendra.Inputs.ExperienceConfigurationContentSourceConfigurationArgs
{
DirectPutContent = true,
FaqIds = new[]
{
exampleAwsKendraFaq.FaqId,
},
},
UserIdentityConfiguration = new Aws.Kendra.Inputs.ExperienceConfigurationUserIdentityConfigurationArgs
{
IdentityAttributeName = "12345ec453-1546651e-79c4-4554-91fa-00b43ccfa245",
},
},
IndexId = exampleAwsKendraIndex.Id,
Description = "My Kendra Experience",
Name = "example",
RoleArn = exampleAwsIamRole.Arn,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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{
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"),
},
},
IndexId: pulumi.Any(exampleAwsKendraIndex.Id),
Description: pulumi.String("My Kendra Experience"),
Name: pulumi.String("example"),
RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_kendra_experience" "example" {
configuration = {
content_source_configuration = {
direct_put_content = true
faq_ids = [exampleAwsKendraFaq.faqId]
}
user_identity_configuration = {
identity_attribute_name = "12345ec453-1546651e-79c4-4554-91fa-00b43ccfa245"
}
}
index_id = exampleAwsKendraIndex.id
description = "My Kendra Experience"
name = "example"
role_arn = exampleAwsIamRole.arn
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kendra.Experience;
import com.pulumi.aws.kendra.ExperienceArgs;
import com.pulumi.aws.kendra.inputs.ExperienceConfigurationArgs;
import com.pulumi.aws.kendra.inputs.ExperienceConfigurationContentSourceConfigurationArgs;
import com.pulumi.aws.kendra.inputs.ExperienceConfigurationUserIdentityConfigurationArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 example = new Experience("example", ExperienceArgs.builder()
.configuration(ExperienceConfigurationArgs.builder()
.contentSourceConfiguration(ExperienceConfigurationContentSourceConfigurationArgs.builder()
.directPutContent(true)
.faqIds(exampleAwsKendraFaq.faqId())
.build())
.userIdentityConfiguration(ExperienceConfigurationUserIdentityConfigurationArgs.builder()
.identityAttributeName("12345ec453-1546651e-79c4-4554-91fa-00b43ccfa245")
.build())
.build())
.indexId(exampleAwsKendraIndex.id())
.description("My Kendra Experience")
.name("example")
.roleArn(exampleAwsIamRole.arn())
.build());
}
}
resources:
example:
type: aws:kendra:Experience
properties:
configuration:
contentSourceConfiguration:
directPutContent: true
faqIds:
- ${exampleAwsKendraFaq.faqId}
userIdentityConfiguration:
identityAttributeName: 12345ec453-1546651e-79c4-4554-91fa-00b43ccfa245
indexId: ${exampleAwsKendraIndex.id}
description: My Kendra Experience
name: example
roleArn: ${exampleAwsIamRole.arn}
Import
Using pulumi import, import Kendra Experience using the unique identifiers of the experience and index separated by a slash (/). For example:
$ pulumi import aws:kendra/experience:Experience example 1045d08d-66ef-4882-b3ed-dfb7df183e90/b34dfdf7-1f2b-4704-9581-79e00296845f
Constructors
- Experience(String name, {ExperienceArgs? args, CustomResourceOptions? options})
-
Creates a new Experience.
nameThe Pulumi resource name.argsArguments used to configure this Experience. The set of arguments for Experience.optionsResource options controlling this resource's behavior. - Experience.reference(String urn)
- Creates a typed reference to an existing Experience resource.
Properties
-
arn
↔ Output<
String> -
ARN of the Experience.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
configuration
↔ Output<
ExperienceConfiguration> -
Configuration information for your Amazon Kendra experience. The provider will only perform drift detection of its value when present in a configuration. Detailed below.
latefinal
-
description
↔ Output<
String?> -
A description for your Amazon Kendra experience.
latefinal
-
endpoints
↔ Output<
List< ExperienceEndpoint> > -
Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
latefinal
-
experienceId
↔ Output<
String> -
The unique identifier of the experience.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
indexId
↔ Output<
String> -
The identifier of the index for your Amazon Kendra experience.
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
A name for your Amazon Kendra experience.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
roleArn
↔ Output<
String> -
ARN of a role with permission to access
Query API,QuerySuggestions API,SubmitFeedback API, andAWS SSOthat stores your user and group information. For more information, see IAM roles for Amazon Kendra.latefinal - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
status
↔ Output<
String> -
The current processing status of your Amazon Kendra experience.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {ExperienceState? state, CustomResourceOptions? options}) → Experience -
Gets an existing Experience resource's state with the given
nameandid.