Class CloudWatchOutputConfig

java.lang.Object
software.amazon.awssdk.services.bedrockagentcorecontrol.model.CloudWatchOutputConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CloudWatchOutputConfig.Builder,CloudWatchOutputConfig>
@Generated("software.amazon.awssdk:codegen") public final class CloudWatchOutputConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CloudWatchOutputConfig.Builder,CloudWatchOutputConfig>

The configuration for writing evaluation results to CloudWatch logs with embedded metric format (EMF) for monitoring.

See Also:

  • Method Details

    • logGroupName

      public final String logGroupName()

      The name of the CloudWatch log group where evaluation results will be written. An existing log group is used as-is; otherwise the service creates it, which requires the evaluation execution role to grant logs:CreateLogGroup on the log group. Don't specify this value when resultDestination is SOURCE_LOG_GROUP. The name can't be under the service-reserved /aws/bedrock-agentcore/evaluations/ namespace, apart from this configuration's own service-managed default group.

      Returns:
      The name of the CloudWatch log group where evaluation results will be written. An existing log group is used as-is; otherwise the service creates it, which requires the evaluation execution role to grant logs:CreateLogGroup on the log group. Don't specify this value when resultDestination is SOURCE_LOG_GROUP. The name can't be under the service-reserved /aws/bedrock-agentcore/evaluations/ namespace, apart from this configuration's own service-managed default group.

    • metricsNamespace

      public final String metricsNamespace()

      The CloudWatch metrics namespace where evaluation result metrics are published. If you omit this value, the service publishes metrics to Bedrock-AgentCore/Evaluations. This value can't begin with AWS/.

      Returns:
      The CloudWatch metrics namespace where evaluation result metrics are published. If you omit this value, the service publishes metrics to Bedrock-AgentCore/Evaluations. This value can't begin with AWS/.

    • resultDestination

      public final ResultDestination resultDestination()

      The destination where evaluation results are written. Valid values:

      • DEDICATED_LOG_GROUP (default) – Writes results to a dedicated result log group.

      • SOURCE_LOG_GROUP – Writes results back to the log group that the agent traces were read from. If you use this value, don't specify logGroupName.

      If the service returns an enum value that is not available in the current SDK version, resultDestination will return ResultDestination.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resultDestinationAsString().

      Returns:
      The destination where evaluation results are written. Valid values:

      • DEDICATED_LOG_GROUP (default) – Writes results to a dedicated result log group.

      • SOURCE_LOG_GROUP – Writes results back to the log group that the agent traces were read from. If you use this value, don't specify logGroupName.

      See Also:

    • resultDestinationAsString

      public final String resultDestinationAsString()

      The destination where evaluation results are written. Valid values:

      • DEDICATED_LOG_GROUP (default) – Writes results to a dedicated result log group.

      • SOURCE_LOG_GROUP – Writes results back to the log group that the agent traces were read from. If you use this value, don't specify logGroupName.

      If the service returns an enum value that is not available in the current SDK version, resultDestination will return ResultDestination.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resultDestinationAsString().

      Returns:
      The destination where evaluation results are written. Valid values:

      • DEDICATED_LOG_GROUP (default) – Writes results to a dedicated result log group.

      • SOURCE_LOG_GROUP – Writes results back to the log group that the agent traces were read from. If you use this value, don't specify logGroupName.

      See Also:

    • toBuilder

      public CloudWatchOutputConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CloudWatchOutputConfig.Builder,CloudWatchOutputConfig>
      Returns:
      a builder for type T

    • builder

      public static CloudWatchOutputConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CloudWatchOutputConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.