io.github.cdklabs.generative_ai_cdk_constructs.bedrock.AgentActionGroup Maven / Gradle / Ivy
Show all versions of generative-ai-cdk-constructs Show documentation
package io.github.cdklabs.generative_ai_cdk_constructs.bedrock;
/**
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-10-01T15:41:28.668Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = io.github.cdklabs.generative_ai_cdk_constructs.$Module.class, fqn = "@cdklabs/generative-ai-cdk-constructs.bedrock.AgentActionGroup")
public class AgentActionGroup extends software.constructs.Construct {
protected AgentActionGroup(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected AgentActionGroup(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param scope This parameter is required.
* @param id This parameter is required.
* @param props This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public AgentActionGroup(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull io.github.cdklabs.generative_ai_cdk_constructs.bedrock.AgentActionGroupProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* (experimental) The unique identifier of the action group.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getActionGroupName() {
return software.amazon.jsii.Kernel.get(this, "actionGroupName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) The action group.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.bedrock.CfnAgent.AgentActionGroupProperty getActionGroupProperty() {
return software.amazon.jsii.Kernel.get(this, "actionGroupProperty", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.bedrock.CfnAgent.AgentActionGroupProperty.class));
}
/**
* (experimental) The Lambda function containing the business logic that is carried out upon invoking the action.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ActionGroupExecutor getActionGroupExecutor() {
return software.amazon.jsii.Kernel.get(this, "actionGroupExecutor", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ActionGroupExecutor.class));
}
/**
* (experimental) The action group state.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable java.lang.String getActionGroupState() {
return software.amazon.jsii.Kernel.get(this, "actionGroupState", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) The API schema.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ApiSchemaConfig getApiSchema() {
return software.amazon.jsii.Kernel.get(this, "apiSchema", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ApiSchemaConfig.class));
}
/**
* (experimental) The description.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable java.lang.String getDescription() {
return software.amazon.jsii.Kernel.get(this, "description", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) A list of action groups associated with the agent.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.bedrock.CfnAgent.FunctionSchemaProperty getFunctionSchema() {
return software.amazon.jsii.Kernel.get(this, "functionSchema", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.bedrock.CfnAgent.FunctionSchemaProperty.class));
}
/**
* (experimental) The parent action group signature.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable java.lang.String getParentActionGroupSignature() {
return software.amazon.jsii.Kernel.get(this, "parentActionGroupSignature", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) The skip resource in use check on delete.
*
* Default: - false
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable java.lang.Boolean getSkipResourceInUseCheckOnDelete() {
return software.amazon.jsii.Kernel.get(this, "skipResourceInUseCheckOnDelete", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) A fluent builder for {@link io.github.cdklabs.generative_ai_cdk_constructs.bedrock.AgentActionGroup}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param scope This parameter is required.
* @param id This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static Builder create(final software.constructs.Construct scope, final java.lang.String id) {
return new Builder(scope, id);
}
private final software.constructs.Construct scope;
private final java.lang.String id;
private final io.github.cdklabs.generative_ai_cdk_constructs.bedrock.AgentActionGroupProps.Builder props;
private Builder(final software.constructs.Construct scope, final java.lang.String id) {
this.scope = scope;
this.id = id;
this.props = new io.github.cdklabs.generative_ai_cdk_constructs.bedrock.AgentActionGroupProps.Builder();
}
/**
* (experimental) The name of the action group.
*
* Default: - a name is generated by CloudFormation.
*
* @return {@code this}
* @param actionGroupName The name of the action group. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder actionGroupName(final java.lang.String actionGroupName) {
this.props.actionGroupName(actionGroupName);
return this;
}
/**
* @return {@code this}
* @param actionGroupExecutor This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder actionGroupExecutor(final io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ActionGroupExecutor actionGroupExecutor) {
this.props.actionGroupExecutor(actionGroupExecutor);
return this;
}
/**
* (experimental) Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
*
* @return {@code this}
* @param actionGroupState Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder actionGroupState(final java.lang.String actionGroupState) {
this.props.actionGroupState(actionGroupState);
return this;
}
/**
* (experimental) Contains details about the S3 object containing the OpenAPI schema for the action group.
*
* For more information, see
* Action group OpenAPI schemas.
*
* @return {@code this}
* @param apiSchema Contains details about the S3 object containing the OpenAPI schema for the action group. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder apiSchema(final io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ApiSchema apiSchema) {
this.props.apiSchema(apiSchema);
return this;
}
/**
* (experimental) A description of the action group.
*
* @return {@code this}
* @param description A description of the action group. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder description(final java.lang.String description) {
this.props.description(description);
return this;
}
/**
* (experimental) Defines functions that each define parameters that the agent needs to invoke from the user.
*
* @return {@code this}
* @param functionSchema Defines functions that each define parameters that the agent needs to invoke from the user. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder functionSchema(final software.amazon.awscdk.services.bedrock.CfnAgent.FunctionSchemaProperty functionSchema) {
this.props.functionSchema(functionSchema);
return this;
}
/**
* (experimental) If you specify this value as AMAZON.UserInput, the agent will prompt additional information from the user when it doesn't have enough information to respond to an utterance. Leave this field blank if you don't want the agent to prompt additional information.
*
* @return {@code this}
* @param parentActionGroupSignature If you specify this value as AMAZON.UserInput, the agent will prompt additional information from the user when it doesn't have enough information to respond to an utterance. Leave this field blank if you don't want the agent to prompt additional information. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder parentActionGroupSignature(final java.lang.String parentActionGroupSignature) {
this.props.parentActionGroupSignature(parentActionGroupSignature);
return this;
}
/**
* (experimental) Specifies whether the agent should skip the resource in use check on delete.
*
* @return {@code this}
* @param skipResourceInUseCheckOnDelete Specifies whether the agent should skip the resource in use check on delete. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder skipResourceInUseCheckOnDelete(final java.lang.Boolean skipResourceInUseCheckOnDelete) {
this.props.skipResourceInUseCheckOnDelete(skipResourceInUseCheckOnDelete);
return this;
}
/**
* @return a newly built instance of {@link io.github.cdklabs.generative_ai_cdk_constructs.bedrock.AgentActionGroup}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public io.github.cdklabs.generative_ai_cdk_constructs.bedrock.AgentActionGroup build() {
return new io.github.cdklabs.generative_ai_cdk_constructs.bedrock.AgentActionGroup(
this.scope,
this.id,
this.props.build()
);
}
}
}