Package software.amazon.awscdk.services.kendraranking

Class CfnExecutionPlan

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.kendraranking.CfnExecutionPlan
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:58.189Z") @Stability(Stable) public class CfnExecutionPlan extends CfnResource implements IInspectable
A CloudFormation AWS::KendraRanking::ExecutionPlan.

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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kendraranking.*;
 CfnExecutionPlan cfnExecutionPlan = CfnExecutionPlan.Builder.create(this, "MyCfnExecutionPlan")
         .name("name")
         // the properties below are optional
         .capacityUnits(CapacityUnitsConfigurationProperty.builder()
                 .rescoreCapacityUnits(123)
                 .build())
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnExecutionPlan

      protected CfnExecutionPlan(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnExecutionPlan

      protected CfnExecutionPlan(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnExecutionPlan

      @Stability(Stable) public CfnExecutionPlan(@NotNull Construct scope, @NotNull String id, @NotNull CfnExecutionPlanProps props)
      Create a new AWS::KendraRanking::ExecutionPlan.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the rescore execution plan.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The identifier of the rescore execution plan.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      A list of key-value pairs that identify or categorize your rescore execution plan.

      You can also use tags to help control access to the rescore execution plan. Tag keys and values can consist of Unicode letters, digits, white space. They can also consist of underscore, period, colon, equal, plus, and asperand.

    • getName

      @Stability(Stable) @NotNull public String getName()
      A name for the rescore execution plan.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A name for the rescore execution plan.

    • getCapacityUnits

      @Stability(Stable) @Nullable public Object getCapacityUnits()
      You can set additional capacity units to meet the needs of your rescore execution plan.

      You are given a single capacity unit by default. If you want to use the default capacity, you don't set additional capacity units. For more information on the default capacity and additional capacity units, see Adjusting capacity .

    • setCapacityUnits

      @Stability(Stable) public void setCapacityUnits(@Nullable CfnExecutionPlan.CapacityUnitsConfigurationProperty value)
      You can set additional capacity units to meet the needs of your rescore execution plan.

      You are given a single capacity unit by default. If you want to use the default capacity, you don't set additional capacity units. For more information on the default capacity and additional capacity units, see Adjusting capacity .

    • setCapacityUnits

      @Stability(Stable) public void setCapacityUnits(@Nullable IResolvable value)
      You can set additional capacity units to meet the needs of your rescore execution plan.

      You are given a single capacity unit by default. If you want to use the default capacity, you don't set additional capacity units. For more information on the default capacity and additional capacity units, see Adjusting capacity .

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description for the rescore execution plan.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description for the rescore execution plan.