CfnFaqPropsMixin

class aws_cdk.mixins_preview.aws_kendra.mixins.CfnFaqPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates an new set of frequently asked question (FAQ) questions and answers.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html
CloudformationResource:: AWS::Kendra::Faq
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_kendra import mixins as kendra_mixins

cfn_faq_props_mixin = kendra_mixins.CfnFaqPropsMixin(kendra_mixins.CfnFaqMixinProps(
    description="description",
    file_format="fileFormat",
    index_id="indexId",
    language_code="languageCode",
    name="name",
    role_arn="roleArn",
    s3_path=kendra_mixins.CfnFaqPropsMixin.S3PathProperty(
        bucket="bucket",
        key="key"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Kendra::Faq.

Parameters:

props (Union[CfnFaqMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'fileFormat', 'indexId', 'languageCode', 'name', 'roleArn', 's3Path', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

S3PathProperty

class CfnFaqPropsMixin.S3PathProperty(*, bucket=None, key=None)

Bases: object

Information required to find a specific file in an Amazon S3 bucket.

Parameters:

bucket (Optional[str]) – The name of the S3 bucket that contains the file.
key (Optional[str]) – The name of the file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-faq-s3path.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_kendra import mixins as kendra_mixins

s3_path_property = kendra_mixins.CfnFaqPropsMixin.S3PathProperty(
    bucket="bucket",
    key="key"
)

Attributes

bucket

The name of the S3 bucket that contains the file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-faq-s3path.html#cfn-kendra-faq-s3path-bucket

key

The name of the file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-faq-s3path.html#cfn-kendra-faq-s3path-key