Package software.amazon.awscdk.services.kendraranking

Interface CfnExecutionPlanProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnExecutionPlanProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:58.191Z")
@Stability(Stable)
public interface CfnExecutionPlanProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnExecutionPlan.

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.*;
 CfnExecutionPlanProps cfnExecutionPlanProps = CfnExecutionPlanProps.builder()
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnExecutionPlanProps.Builder	A builder for CfnExecutionPlanProps
static final class	CfnExecutionPlanProps.Jsii$Proxy	An implementation for CfnExecutionPlanProps

Method Summary

Modifier and Type	Method	Description
static CfnExecutionPlanProps.Builder	builder()
default Object	getCapacityUnits()	You can set additional capacity units to meet the needs of your rescore execution plan.
default String	getDescription()	A description for the rescore execution plan.
String	getName()	A name for the rescore execution plan.
default List<CfnTag>	getTags()	A list of key-value pairs that identify or categorize your rescore execution plan.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

A name for the rescore execution plan.

getCapacityUnits

@Stability(Stable)
@Nullable
default 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 .

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description for the rescore execution plan.

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> 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.

builder

@Stability(Stable)
static CfnExecutionPlanProps.Builder builder()

Returns:

a CfnExecutionPlanProps.Builder of CfnExecutionPlanProps