aws_kendra_faq

Documentation

Index

• type Args
• type DataArgs
• type DataS3PathAttributes
  • func (sp DataS3PathAttributes) Bucket() terra.StringValue
  • func (sp DataS3PathAttributes) InternalRef() (terra.Reference, error)
  • func (sp DataS3PathAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (sp DataS3PathAttributes) InternalWithRef(ref terra.Reference) DataS3PathAttributes
  • func (sp DataS3PathAttributes) Key() terra.StringValue
• type DataS3PathState
• type DataSource
  • func Data(name string, args DataArgs) *DataSource
  • func (akf *DataSource) Attributes() dataAwsKendraFaqAttributes
  • func (akf *DataSource) Configuration() interface{}
  • func (akf *DataSource) DataSource() string
  • func (akf *DataSource) LocalName() string
• type Resource
  • func New(name string, args Args) *Resource
  • func (akf *Resource) Attributes() awsKendraFaqAttributes
  • func (akf *Resource) Configuration() interface{}
  • func (akf *Resource) DependOn() terra.Reference
  • func (akf *Resource) Dependencies() terra.Dependencies
  • func (akf *Resource) ImportState(state io.Reader) error
  • func (akf *Resource) LifecycleManagement() *terra.Lifecycle
  • func (akf *Resource) LocalName() string
  • func (akf *Resource) State() (*awsKendraFaqState, bool)
  • func (akf *Resource) StateMust() *awsKendraFaqState
  • func (akf *Resource) Type() string
• type S3Path
• type S3PathAttributes
  • func (sp S3PathAttributes) Bucket() terra.StringValue
  • func (sp S3PathAttributes) InternalRef() (terra.Reference, error)
  • func (sp S3PathAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (sp S3PathAttributes) InternalWithRef(ref terra.Reference) S3PathAttributes
  • func (sp S3PathAttributes) Key() terra.StringValue
• type S3PathState
• type Timeouts
• type TimeoutsAttributes
  • func (t TimeoutsAttributes) Create() terra.StringValue
  • func (t TimeoutsAttributes) Delete() terra.StringValue
  • func (t TimeoutsAttributes) InternalRef() (terra.Reference, error)
  • func (t TimeoutsAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (t TimeoutsAttributes) InternalWithRef(ref terra.Reference) TimeoutsAttributes
• type TimeoutsState

Types

type Args

type Args struct {
	// Description: string, optional
	Description terra.StringValue `hcl:"description,attr"`
	// FileFormat: string, optional
	FileFormat terra.StringValue `hcl:"file_format,attr"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// IndexId: string, required
	IndexId terra.StringValue `hcl:"index_id,attr" validate:"required"`
	// LanguageCode: string, optional
	LanguageCode terra.StringValue `hcl:"language_code,attr"`
	// Name: string, required
	Name terra.StringValue `hcl:"name,attr" validate:"required"`
	// RoleArn: string, required
	RoleArn terra.StringValue `hcl:"role_arn,attr" validate:"required"`
	// Tags: map of string, optional
	Tags terra.MapValue[terra.StringValue] `hcl:"tags,attr"`
	// TagsAll: map of string, optional
	TagsAll terra.MapValue[terra.StringValue] `hcl:"tags_all,attr"`
	// S3Path: required
	S3Path *S3Path `hcl:"s3_path,block" validate:"required"`
	// Timeouts: optional
	Timeouts *Timeouts `hcl:"timeouts,block"`
}

Args contains the configurations for aws_kendra_faq.

type DataArgs

type DataArgs struct {
	// FaqId: string, required
	FaqId terra.StringValue `hcl:"faq_id,attr" validate:"required"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// IndexId: string, required
	IndexId terra.StringValue `hcl:"index_id,attr" validate:"required"`
	// Tags: map of string, optional
	Tags terra.MapValue[terra.StringValue] `hcl:"tags,attr"`
}

DataArgs contains the configurations for aws_kendra_faq.

type DataS3PathAttributes

type DataS3PathAttributes struct {
	// contains filtered or unexported fields
}

func (DataS3PathAttributes) Bucket

func (sp DataS3PathAttributes) Bucket() terra.StringValue

func (DataS3PathAttributes) InternalRef

func (sp DataS3PathAttributes) InternalRef() (terra.Reference, error)

func (DataS3PathAttributes) InternalTokens

func (sp DataS3PathAttributes) InternalTokens() (hclwrite.Tokens, error)

func (DataS3PathAttributes) InternalWithRef

func (sp DataS3PathAttributes) InternalWithRef(ref terra.Reference) DataS3PathAttributes

func (DataS3PathAttributes) Key

func (sp DataS3PathAttributes) Key() terra.StringValue

type DataS3PathState

type DataS3PathState struct {
	Bucket string `json:"bucket"`
	Key    string `json:"key"`
}

type DataSource

type DataSource struct {
	Name string
	Args DataArgs
}

DataSource represents the Terraform data resource aws_kendra_faq.

func Data

func Data(name string, args DataArgs) *DataSource

Data creates a new instance of DataSource.

func (*DataSource) Attributes

func (akf *DataSource) Attributes() dataAwsKendraFaqAttributes

Attributes returns the attributes for DataSource.

func (*DataSource) Configuration

func (akf *DataSource) Configuration() interface{}

Configuration returns the configuration (args) for DataSource.

func (*DataSource) DataSource

func (akf *DataSource) DataSource() string

DataSource returns the Terraform object type for DataSource.

func (*DataSource) LocalName

func (akf *DataSource) LocalName() string

LocalName returns the local name for DataSource.

type Resource

type Resource struct {
	Name string
	Args Args

	DependsOn terra.Dependencies
	Lifecycle *terra.Lifecycle
	// contains filtered or unexported fields
}

Resource represents the Terraform resource aws_kendra_faq.

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (akf *Resource) Attributes() awsKendraFaqAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

func (akf *Resource) Configuration() interface{}

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

func (akf *Resource) DependOn() terra.Reference

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

func (akf *Resource) Dependencies() terra.Dependencies

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

func (akf *Resource) ImportState(state io.Reader) error

ImportState imports the given attribute values into Resource's state.

func (*Resource) LifecycleManagement

func (akf *Resource) LifecycleManagement() *terra.Lifecycle

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (akf *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (akf *Resource) State() (*awsKendraFaqState, bool)

State returns the state and a bool indicating if Resource has state.

func (*Resource) StateMust

func (akf *Resource) StateMust() *awsKendraFaqState

StateMust returns the state for Resource. Panics if the state is nil.

func (*Resource) Type

func (akf *Resource) Type() string

Type returns the Terraform object type for Resource.

type S3Path

type S3Path struct {
	// Bucket: string, required
	Bucket terra.StringValue `hcl:"bucket,attr" validate:"required"`
	// Key: string, required
	Key terra.StringValue `hcl:"key,attr" validate:"required"`
}

type S3PathAttributes

type S3PathAttributes struct {
	// contains filtered or unexported fields
}

func (S3PathAttributes) Bucket

func (sp S3PathAttributes) Bucket() terra.StringValue

func (S3PathAttributes) InternalRef

func (sp S3PathAttributes) InternalRef() (terra.Reference, error)

func (S3PathAttributes) InternalTokens

func (sp S3PathAttributes) InternalTokens() (hclwrite.Tokens, error)

func (S3PathAttributes) InternalWithRef

func (sp S3PathAttributes) InternalWithRef(ref terra.Reference) S3PathAttributes

func (S3PathAttributes) Key

func (sp S3PathAttributes) Key() terra.StringValue

type S3PathState

type S3PathState struct {
	Bucket string `json:"bucket"`
	Key    string `json:"key"`
}

type Timeouts

type Timeouts struct {
	// Create: string, optional
	Create terra.StringValue `hcl:"create,attr"`
	// Delete: string, optional
	Delete terra.StringValue `hcl:"delete,attr"`
}

type TimeoutsAttributes

type TimeoutsAttributes struct {
	// contains filtered or unexported fields
}

func (TimeoutsAttributes) Create

func (t TimeoutsAttributes) Create() terra.StringValue

func (TimeoutsAttributes) Delete

func (t TimeoutsAttributes) Delete() terra.StringValue

func (TimeoutsAttributes) InternalRef

func (t TimeoutsAttributes) InternalRef() (terra.Reference, error)

func (TimeoutsAttributes) InternalTokens

func (t TimeoutsAttributes) InternalTokens() (hclwrite.Tokens, error)

func (TimeoutsAttributes) InternalWithRef

func (t TimeoutsAttributes) InternalWithRef(ref terra.Reference) TimeoutsAttributes

type TimeoutsState

type TimeoutsState struct {
	Create string `json:"create"`
	Delete string `json:"delete"`
}