io.github.cdklabs.generative_ai_cdk_constructs.bedrock.AgentAlias 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-09-23T18:35:37.383Z")
@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.AgentAlias")
public class AgentAlias extends software.constructs.Construct implements io.github.cdklabs.generative_ai_cdk_constructs.bedrock.IAgentAlias {
protected AgentAlias(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected AgentAlias(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 AgentAlias(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.AgentAliasProps 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) Brings an Agent Alias from an existing one created outside of CDK.
*
* @param scope This parameter is required.
* @param id This parameter is required.
* @param aliasArn This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull io.github.cdklabs.generative_ai_cdk_constructs.bedrock.IAgentAlias fromAliasArn(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull java.lang.String aliasArn) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.AgentAlias.class, "fromAliasArn", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.IAgentAlias.class), new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(aliasArn, "aliasArn is required") });
}
/**
* (experimental) The unique identifier of the agent.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getAgentId() {
return software.amazon.jsii.Kernel.get(this, "agentId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) The ARN of the agent alias.
*
* Example:
*
*
* `arn:aws:bedrock:us-east-1:123456789012:agent-alias/DNCJJYQKSU/TCLCITFZTN`
*
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getAliasArn() {
return software.amazon.jsii.Kernel.get(this, "aliasArn", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) The unique identifier of the agent alias.
*
* Example:
*
*
* `TCLCITFZTN`
*
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getAliasId() {
return software.amazon.jsii.Kernel.get(this, "aliasId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) The name for the agent alias.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getAliasName() {
return software.amazon.jsii.Kernel.get(this, "aliasName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) A fluent builder for {@link io.github.cdklabs.generative_ai_cdk_constructs.bedrock.AgentAlias}.
*/
@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.AgentAliasProps.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.AgentAliasProps.Builder();
}
/**
* (experimental) The unique identifier of the agent.
*
* @return {@code this}
* @param agentId The unique identifier of the agent. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder agentId(final java.lang.String agentId) {
this.props.agentId(agentId);
return this;
}
/**
* (experimental) The version of the agent to associate with the agent alias.
*
* Default: - Creates a new version of the agent.
*
* @return {@code this}
* @param agentVersion The version of the agent to associate with the agent alias. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder agentVersion(final java.lang.String agentVersion) {
this.props.agentVersion(agentVersion);
return this;
}
/**
* (experimental) The name for the agent alias.
*
* Default: - 'latest'
*
* @return {@code this}
* @param aliasName The name for the agent alias. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder aliasName(final java.lang.String aliasName) {
this.props.aliasName(aliasName);
return this;
}
/**
* (experimental) Description for the agent alias.
*
* @return {@code this}
* @param description Description for the agent alias. 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) The list of resource update timestamps to let CloudFormation determine when to update the alias.
*
* @return {@code this}
* @param resourceUpdates The list of resource update timestamps to let CloudFormation determine when to update the alias. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder resourceUpdates(final java.util.List resourceUpdates) {
this.props.resourceUpdates(resourceUpdates);
return this;
}
/**
* (experimental) OPTIONAL: Tag (KEY-VALUE) bedrock agent resource.
*
* Default: - false
*
* @return {@code this}
* @param tags OPTIONAL: Tag (KEY-VALUE) bedrock agent resource. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder tags(final java.util.Map tags) {
this.props.tags(tags);
return this;
}
/**
* @return a newly built instance of {@link io.github.cdklabs.generative_ai_cdk_constructs.bedrock.AgentAlias}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public io.github.cdklabs.generative_ai_cdk_constructs.bedrock.AgentAlias build() {
return new io.github.cdklabs.generative_ai_cdk_constructs.bedrock.AgentAlias(
this.scope,
this.id,
this.props.build()
);
}
}
}