software.amazon.awscdk.services.kendraranking

Class CfnExecutionPlan

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:37.265Z")
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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnExecutionPlan.Builder A fluent builder for CfnExecutionPlan.
static interface	CfnExecutionPlan.CapacityUnitsConfigurationProperty Sets additional capacity units configured for your rescore execution plan.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnExecutionPlan(Construct scope, java.lang.String id, CfnExecutionPlanProps props) Create a new `AWS::KendraRanking::ExecutionPlan`.
protected	CfnExecutionPlan(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnExecutionPlan(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) of the rescore execution plan.
java.lang.String	getAttrId() The identifier of the rescore execution plan.
java.lang.Object	getCapacityUnits() You can set additional capacity units to meet the needs of your rescore execution plan.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() A description for the rescore execution plan.
java.lang.String	getName() A name for the rescore execution plan.
TagManager	getTags() A list of key-value pairs that identify or categorize your rescore execution plan.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setCapacityUnits(CfnExecutionPlan.CapacityUnitsConfigurationProperty value) You can set additional capacity units to meet the needs of your rescore execution plan.
void	setCapacityUnits(IResolvable value) You can set additional capacity units to meet the needs of your rescore execution plan.
void	setDescription(java.lang.String value) A description for the rescore execution plan.
void	setName(java.lang.String value) A name for the rescore execution plan.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnExecutionPlan

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

CfnExecutionPlan

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

CfnExecutionPlan

public CfnExecutionPlan(Construct scope,
                        java.lang.String id,
                        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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The Amazon Resource Name (ARN) of the rescore execution plan.

getAttrId

public java.lang.String getAttrId()

The identifier of the rescore execution plan.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

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

public java.lang.String getName()

A name for the rescore execution plan.

setName

public void setName(java.lang.String value)

A name for the rescore execution plan.

getCapacityUnits

public java.lang.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

public void setCapacityUnits(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

public void setCapacityUnits(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

public java.lang.String getDescription()

A description for the rescore execution plan.

setDescription

public void setDescription(java.lang.String value)

A description for the rescore execution plan.