Class CfnExecutionPlan
A CloudFormation AWS::KendraRanking::ExecutionPlan
.
Inherited Members
Namespace: Amazon.CDK.AWS.KendraRanking
Assembly: Amazon.CDK.AWS.KendraRanking.dll
Syntax (csharp)
public class CfnExecutionPlan : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnExecutionPlan
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::KendraRanking::ExecutionPlan
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.KendraRanking;
var cfnExecutionPlan = new CfnExecutionPlan(this, "MyCfnExecutionPlan", new CfnExecutionPlanProps {
Name = "name",
// the properties below are optional
CapacityUnits = new CapacityUnitsConfigurationProperty {
RescoreCapacityUnits = 123
},
Description = "description",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnExecutionPlan(Construct, String, ICfnExecutionPlanProps) | Create a new |
CfnExecutionPlan(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnExecutionPlan(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The Amazon Resource Name (ARN) of the rescore execution plan. |
AttrId | The identifier of the rescore execution plan. |
CapacityUnits | You can set additional capacity units to meet the needs of your rescore execution plan. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A description for the rescore execution plan. |
Name | A name for the rescore execution plan. |
Tags | A list of key-value pairs that identify or categorize your rescore execution plan. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnExecutionPlan(Construct, String, ICfnExecutionPlanProps)
Create a new AWS::KendraRanking::ExecutionPlan
.
public CfnExecutionPlan(Construct scope, string id, ICfnExecutionPlanProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnExecutionPlanProps
- resource properties.
CfnExecutionPlan(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnExecutionPlan(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnExecutionPlan(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnExecutionPlan(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) of the rescore execution plan.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrId
The identifier of the rescore execution plan.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CapacityUnits
You can set additional capacity units to meet the needs of your rescore execution plan.
public virtual object CapacityUnits { get; set; }
Property Value
System.Object
Remarks
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 .
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A description for the rescore execution plan.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Name
A name for the rescore execution plan.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Tags
A list of key-value pairs that identify or categorize your rescore execution plan.
public virtual TagManager Tags { get; }
Property Value
Remarks
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.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>