Package software.amazon.awscdk.services.stepfunctions.tasks

Class BedrockCreateModelCustomizationJobProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.stepfunctions.tasks.BedrockCreateModelCustomizationJobProps.Jsii$Proxy

All Implemented Interfaces:

AssignableStateOptions, JsonataCommonOptions, JsonPathCommonOptions, StateBaseProps, BedrockCreateModelCustomizationJobProps, TaskStateBaseOptions, TaskStateBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

BedrockCreateModelCustomizationJobProps

@Stability(Stable)
@Internal
public static final class BedrockCreateModelCustomizationJobProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements BedrockCreateModelCustomizationJobProps

An implementation for BedrockCreateModelCustomizationJobProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.tasks.BedrockCreateModelCustomizationJobProps

BedrockCreateModelCustomizationJobProps.Builder, BedrockCreateModelCustomizationJobProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(BedrockCreateModelCustomizationJobProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the BedrockCreateModelCustomizationJobProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Map<String,Object>	getAssign()	Workflow variables to store in this step.
final IModel	getBaseModel()	The base model.
final String	getClientRequestToken()	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
final String	getComment()	A comment describing this state.
final Credentials	getCredentials()	Credentials for an IAM Role that the State Machine assumes for executing the task.
final CustomizationType	getCustomizationType()	The customization type.
final IKey	getCustomModelKmsKey()	The custom model is encrypted at rest using this key.
final String	getCustomModelName()	A name for the resulting custom model.
final List<CustomModelTag>	getCustomModelTags()	Tags to attach to the resulting custom model.
final Duration	getHeartbeat()	(deprecated) Timeout for the heartbeat.
final Timeout	getHeartbeatTimeout()	Timeout for the heartbeat.
final Map<String,String>	getHyperParameters()	Parameters related to tuning the model.
final String	getInputPath()	JSONPath expression to select part of the state to be the input to this state.
final IntegrationPattern	getIntegrationPattern()	AWS Step Functions integrates with services directly in the Amazon States Language.
final String	getJobName()	A name for the fine-tuning job.
final List<CustomModelTag>	getJobTags()	Tags to attach to the job.
final OutputBucketConfiguration	getOutputData()	The S3 bucket configuration where the output data is stored.
final String	getOutputPath()	JSONPath expression to select part of the state to be the output to this state.
final Object	getOutputs()	Used to specify and transform output from the state.
final QueryLanguage	getQueryLanguage()	The name of the query language used by the state.
final String	getResultPath()	JSONPath expression to indicate where to inject the state's output.
final Map<String,Object>	getResultSelector()	The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
final IRole	getRole()	The IAM role that Amazon Bedrock can assume to perform tasks on your behalf.
final String	getStateName()	Optional name for this state.
final Timeout	getTaskTimeout()	Timeout for the task.
final Duration	getTimeout()	(deprecated) Timeout for the task.
final TrainingBucketConfiguration	getTrainingData()	The S3 bucket configuration where the training data is stored.
final List<ValidationBucketConfiguration>	getValidationData()	The S3 bucket configuration where the validation data is stored.
final IBedrockCreateModelCustomizationJobVpcConfig	getVpcConfig()	The VPC configuration.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(BedrockCreateModelCustomizationJobProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the BedrockCreateModelCustomizationJobProps.Builder.

Method Details

getBaseModel

public final IModel getBaseModel()

Description copied from interface: BedrockCreateModelCustomizationJobProps

The base model.

Specified by:

getBaseModel in interface BedrockCreateModelCustomizationJobProps

getCustomModelName

public final String getCustomModelName()

Description copied from interface: BedrockCreateModelCustomizationJobProps

A name for the resulting custom model.

The maximum length is 63 characters.

Specified by:

getCustomModelName in interface BedrockCreateModelCustomizationJobProps

getJobName

public final String getJobName()

Description copied from interface: BedrockCreateModelCustomizationJobProps

A name for the fine-tuning job.

The maximum length is 63 characters.

Specified by:

getJobName in interface BedrockCreateModelCustomizationJobProps

getOutputData

public final OutputBucketConfiguration getOutputData()

Description copied from interface: BedrockCreateModelCustomizationJobProps

The S3 bucket configuration where the output data is stored.

Specified by:

getOutputData in interface BedrockCreateModelCustomizationJobProps

See Also:

• https://docs.aws.amazon.com/bedrock/latest/APIReference/API_OutputDataConfig.html

getTrainingData

public final TrainingBucketConfiguration getTrainingData()

Description copied from interface: BedrockCreateModelCustomizationJobProps

The S3 bucket configuration where the training data is stored.

Specified by:

getTrainingData in interface BedrockCreateModelCustomizationJobProps

See Also:

• https://docs.aws.amazon.com/bedrock/latest/APIReference/API_TrainingDataConfig.html

getClientRequestToken

public final String getClientRequestToken()

Description copied from interface: BedrockCreateModelCustomizationJobProps

A unique, case-sensitive identifier to ensure that the API request completes no more than one time.

If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error.

The maximum length is 256 characters.

Default: - no client request token

Specified by:

getClientRequestToken in interface BedrockCreateModelCustomizationJobProps

See Also:

• https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

getCustomizationType

public final CustomizationType getCustomizationType()

Description copied from interface: BedrockCreateModelCustomizationJobProps

The customization type.

Default: FINE_TUNING

Specified by:

getCustomizationType in interface BedrockCreateModelCustomizationJobProps

getCustomModelKmsKey

public final IKey getCustomModelKmsKey()

Description copied from interface: BedrockCreateModelCustomizationJobProps

The custom model is encrypted at rest using this key.

Default: - encrypted with the AWS owned key

Specified by:

getCustomModelKmsKey in interface BedrockCreateModelCustomizationJobProps

See Also:

• https://docs.aws.amazon.com/bedrock/latest/userguide/encryption-custom-job.html

getCustomModelTags

public final List<CustomModelTag> getCustomModelTags()

Description copied from interface: BedrockCreateModelCustomizationJobProps

Tags to attach to the resulting custom model.

The maximum number of tags is 200.

Default: - no tags

Specified by:

getCustomModelTags in interface BedrockCreateModelCustomizationJobProps

getHyperParameters

public final Map<String,String> getHyperParameters()

Description copied from interface: BedrockCreateModelCustomizationJobProps

Parameters related to tuning the model.

Default: - use default hyperparameters

Specified by:

getHyperParameters in interface BedrockCreateModelCustomizationJobProps

See Also:

• https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html

getJobTags

public final List<CustomModelTag> getJobTags()

Description copied from interface: BedrockCreateModelCustomizationJobProps

Tags to attach to the job.

The maximum number of tags is 200.

Default: - no tags

Specified by:

getJobTags in interface BedrockCreateModelCustomizationJobProps

getRole

public final IRole getRole()

Description copied from interface: BedrockCreateModelCustomizationJobProps

The IAM role that Amazon Bedrock can assume to perform tasks on your behalf.

For example, during model training, Amazon Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission.

Default: - use auto generated role

Specified by:

getRole in interface BedrockCreateModelCustomizationJobProps

getValidationData

public final List<ValidationBucketConfiguration> getValidationData()

Description copied from interface: BedrockCreateModelCustomizationJobProps

The S3 bucket configuration where the validation data is stored.

If you don't provide a validation dataset, specify the evaluation percentage by the Evaluation percentage hyperparameter.

The maximum number is 10.

Default: undefined - validate using a subset of the training data

Specified by:

getValidationData in interface BedrockCreateModelCustomizationJobProps

See Also:

• https://docs.aws.amazon.com/bedrock/latest/APIReference/API_Validator.html

getVpcConfig

public final IBedrockCreateModelCustomizationJobVpcConfig getVpcConfig()

Description copied from interface: BedrockCreateModelCustomizationJobProps

The VPC configuration.

Default: - no VPC configuration

Specified by:

getVpcConfig in interface BedrockCreateModelCustomizationJobProps

getResultPath

public final String getResultPath()

Description copied from interface: TaskStateBaseProps

JSONPath expression to indicate where to inject the state's output.

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Default: $

Specified by:

getResultPath in interface TaskStateBaseProps

getResultSelector

public final Map<String,Object> getResultSelector()

Description copied from interface: TaskStateBaseProps

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Default: - None

Specified by:

getResultSelector in interface TaskStateBaseProps

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

getComment

public final String getComment()

Description copied from interface: StateBaseProps

A comment describing this state.

Default: No comment

Specified by:

getComment in interface StateBaseProps

getQueryLanguage

public final QueryLanguage getQueryLanguage()

Description copied from interface: StateBaseProps

The name of the query language used by the state.

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Default: - JSONPath

Specified by:

getQueryLanguage in interface StateBaseProps

getStateName

public final String getStateName()

Description copied from interface: StateBaseProps

Optional name for this state.

Default: - The construct ID will be used as state name

Specified by:

getStateName in interface StateBaseProps

getCredentials

public final Credentials getCredentials()

Description copied from interface: TaskStateBaseOptions

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

Default: - None (Task is executed using the State Machine's execution role)

Specified by:

getCredentials in interface TaskStateBaseOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html

getHeartbeat

public final Duration getHeartbeat()

Description copied from interface: TaskStateBaseOptions

(deprecated) Timeout for the heartbeat.

Default: - None

Specified by:

getHeartbeat in interface TaskStateBaseOptions

getHeartbeatTimeout

public final Timeout getHeartbeatTimeout()

Description copied from interface: TaskStateBaseOptions

Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Default: - None

Specified by:

getHeartbeatTimeout in interface TaskStateBaseOptions

getIntegrationPattern

public final IntegrationPattern getIntegrationPattern()

Description copied from interface: TaskStateBaseOptions

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.

Specified by:

getIntegrationPattern in interface TaskStateBaseOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html

getTaskTimeout

public final Timeout getTaskTimeout()

Description copied from interface: TaskStateBaseOptions

Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Default: - None

Specified by:

getTaskTimeout in interface TaskStateBaseOptions

getTimeout

public final Duration getTimeout()

Description copied from interface: TaskStateBaseOptions

(deprecated) Timeout for the task.

Default: - None

Specified by:

getTimeout in interface TaskStateBaseOptions

getAssign

public final Map<String,Object> getAssign()

Description copied from interface: AssignableStateOptions

Workflow variables to store in this step.

Using workflow variables, you can store data in a step and retrieve that data in future steps.

Default: - Not assign variables

Specified by:

getAssign in interface AssignableStateOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

getInputPath

public final String getInputPath()

Description copied from interface: JsonPathCommonOptions

JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Default: $

Specified by:

getInputPath in interface JsonPathCommonOptions

getOutputPath

public final String getOutputPath()

Description copied from interface: JsonPathCommonOptions

JSONPath expression to select part of the state to be the output to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Default: $

Specified by:

getOutputPath in interface JsonPathCommonOptions

getOutputs

public final Object getOutputs()

Description copied from interface: JsonataCommonOptions

Used to specify and transform output from the state.

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Default: - $states.result or $states.errorOutput

Specified by:

getOutputs in interface JsonataCommonOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object