CfnExecutionPlanPropsMixin

class aws_cdk.mixins_preview.aws_kendraranking.mixins.CfnExecutionPlanPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a rescore execution plan.

A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You set the number of capacity units that you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search service’s results.

For an example of using the CreateRescoreExecutionPlan API, including using the Python and Java SDKs, see Semantically ranking a search service’s results .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendraranking-executionplan.html
CloudformationResource:: AWS::KendraRanking::ExecutionPlan
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_kendraranking import mixins as kendraranking_mixins

cfn_execution_plan_props_mixin = kendraranking_mixins.CfnExecutionPlanPropsMixin(kendraranking_mixins.CfnExecutionPlanMixinProps(
    capacity_units=kendraranking_mixins.CfnExecutionPlanPropsMixin.CapacityUnitsConfigurationProperty(
        rescore_capacity_units=123
    ),
    description="description",
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::KendraRanking::ExecutionPlan.

Parameters:

props (Union[CfnExecutionPlanMixinProps, 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 = ['capacityUnits', 'description', 'name', '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

CapacityUnitsConfigurationProperty

class CfnExecutionPlanPropsMixin.CapacityUnitsConfigurationProperty(*, rescore_capacity_units=None)

Bases: object

Sets additional capacity units configured for your rescore execution plan.

A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You can add and remove capacity units to fit your usage requirements.

Parameters:: rescore_capacity_units (Union[int, float, None]) – The amount of extra capacity for your rescore execution plan. A single extra capacity unit for a rescore execution plan provides 0.01 rescore requests per second. You can add up to 1000 extra capacity units.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendraranking-executionplan-capacityunitsconfiguration.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_kendraranking import mixins as kendraranking_mixins

capacity_units_configuration_property = kendraranking_mixins.CfnExecutionPlanPropsMixin.CapacityUnitsConfigurationProperty(
    rescore_capacity_units=123
)

Attributes

rescore_capacity_units

The amount of extra capacity for your rescore execution plan.

A single extra capacity unit for a rescore execution plan provides 0.01 rescore requests per second. You can add up to 1000 extra capacity units.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendraranking-executionplan-capacityunitsconfiguration.html#cfn-kendraranking-executionplan-capacityunitsconfiguration-rescorecapacityunits