io.github.cdklabs.generative_ai_cdk_constructs.BedrockCwDashboard Maven / Gradle / Ivy
Show all versions of generative-ai-cdk-constructs Show documentation
package io.github.cdklabs.generative_ai_cdk_constructs;
/**
* (experimental) The BedrockCwDashboard class.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-10-01T15:41:28.541Z")
@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.BedrockCwDashboard")
public class BedrockCwDashboard extends software.constructs.Construct {
protected BedrockCwDashboard(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected BedrockCwDashboard(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* (experimental) Constructs a new instance of the BedrockCwDashboard class.
*
* @param scope
- represents the scope for all the resources.
This parameter is required.
* @param id - this is a a scope-unique id.
This parameter is required.
* @param props - user provided props for the construct.
This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public BedrockCwDashboard(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.BedrockCwDashboardProps 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") });
}
/**
* @param props This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void addAllModelsMonitoring(final @org.jetbrains.annotations.NotNull io.github.cdklabs.generative_ai_cdk_constructs.ModelMonitoringProps props) {
software.amazon.jsii.Kernel.call(this, "addAllModelsMonitoring", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* @param modelName This parameter is required.
* @param modelId This parameter is required.
* @param props This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void addModelMonitoring(final @org.jetbrains.annotations.NotNull java.lang.String modelName, final @org.jetbrains.annotations.NotNull java.lang.String modelId, final @org.jetbrains.annotations.NotNull io.github.cdklabs.generative_ai_cdk_constructs.ModelMonitoringProps props) {
software.amazon.jsii.Kernel.call(this, "addModelMonitoring", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(modelName, "modelName is required"), java.util.Objects.requireNonNull(modelId, "modelId is required"), java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* (experimental) Returns the instance of CloudWatch dashboard used by the construct.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.cloudwatch.Dashboard getDashboard() {
return software.amazon.jsii.Kernel.get(this, "dashboard", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.cloudwatch.Dashboard.class));
}
/**
* (experimental) A fluent builder for {@link io.github.cdklabs.generative_ai_cdk_constructs.BedrockCwDashboard}.
*/
@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 - represents the scope for all the resources.
This parameter is required.
* @param id - this is a a scope-unique 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.BedrockCwDashboardProps.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.BedrockCwDashboardProps.Builder();
}
/**
* (experimental) Optional A name for the dashboard which will be created.
*
* If existingDashboard is defined, this value will be ignored.
* If not provided, the construct will create a new dashboard named 'BedrockMetricsDashboard'
*
* Default: - none
*
* @return {@code this}
* @param dashboardName Optional A name for the dashboard which will be created. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder dashboardName(final java.lang.String dashboardName) {
this.props.dashboardName(dashboardName);
return this;
}
/**
* (experimental) Optional An existing dashboard where metrics will be added to.
*
* If not provided, the construct will create a new dashboard
*
* Default: - none
*
* @return {@code this}
* @param existingDashboard Optional An existing dashboard where metrics will be added to. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder existingDashboard(final software.amazon.awscdk.services.cloudwatch.Dashboard existingDashboard) {
this.props.existingDashboard(existingDashboard);
return this;
}
/**
* @return a newly built instance of {@link io.github.cdklabs.generative_ai_cdk_constructs.BedrockCwDashboard}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public io.github.cdklabs.generative_ai_cdk_constructs.BedrockCwDashboard build() {
return new io.github.cdklabs.generative_ai_cdk_constructs.BedrockCwDashboard(
this.scope,
this.id,
this.props.build()
);
}
}
}