AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

BedrockCreateModelCustomizationJob

A Step Functions Task to create model customization in Bedrock.

Import

import { BedrockCreateModelCustomizationJob } from 'aws-cdk-lib/aws-stepfunctions-tasks';

Or use the module namespace:

import * as stepfunctions_tasks from 'aws-cdk-lib/aws-stepfunctions-tasks';
// stepfunctions_tasks.BedrockCreateModelCustomizationJob

Properties

Configuration passed to the constructor as BedrockCreateModelCustomizationJobProps.

baseModelRequired
IModel

The base model.

customModelNameRequired
string

A name for the resulting custom model. The maximum length is 63 characters.

jobNameRequired
string

A name for the fine-tuning job. The maximum length is 63 characters.

outputDataRequired
OutputBucketConfiguration

The S3 bucket configuration where the output data is stored.

trainingDataRequired
TrainingBucketConfiguration

The S3 bucket configuration where the training data is stored.

clientRequestTokenOptional
string

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

customizationTypeOptional
CustomizationType

The customization type.

Default: FINE_TUNING

customModelKmsKeyOptional
IKey

The custom model is encrypted at rest using this key.

Default: - encrypted with the AWS owned key

customModelTagsOptional
CustomModelTag[]

Tags to attach to the resulting custom model. The maximum number of tags is 200.

Default: - no tags

hyperParametersOptional
{ [key: string]: string }

Parameters related to tuning the model.

Default: - use default hyperparameters

jobTagsOptional
CustomModelTag[]

Tags to attach to the job. The maximum number of tags is 200.

Default: - no tags

roleOptional
IRoleRef

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

validationDataOptional
ValidationBucketConfiguration[]

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

vpcConfigOptional
IBedrockCreateModelCustomizationJobVpcConfig

The VPC configuration.

Default: - no VPC configuration

2 properties inherited from TaskStateBaseProps
resultPathOptionalinherited from TaskStateBaseProps
string

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: $

resultSelectorOptionalinherited from TaskStateBaseProps
{ [key: string]: any }

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

3 properties inherited from StateBaseProps
commentOptionalinherited from StateBaseProps
string

A comment describing this state.

Default: No comment

queryLanguageOptionalinherited from StateBaseProps
QueryLanguage

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

stateNameOptionalinherited from StateBaseProps
string

Optional name for this state.

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

6 properties inherited from TaskStateBaseOptions
credentialsOptionalinherited from TaskStateBaseOptions
Credentials

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)

heartbeatOptionalDeprecatedinherited from TaskStateBaseOptions
Duration

Timeout for the heartbeat.

Default: - None

Deprecated: use `heartbeatTimeout`

heartbeatTimeoutOptionalinherited from TaskStateBaseOptions
Timeout

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

Default: - None

integrationPatternOptionalinherited from TaskStateBaseOptions
IntegrationPattern

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`.

taskTimeoutOptionalinherited from TaskStateBaseOptions
Timeout

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

Default: - None

timeoutOptionalDeprecatedinherited from TaskStateBaseOptions
Duration

Timeout for the task.

Default: - None

Deprecated: use `taskTimeout`

1 property inherited from AssignableStateOptions
assignOptionalinherited from AssignableStateOptions
{ [key: string]: any }

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

2 properties inherited from JsonPathCommonOptions
inputPathOptionalinherited from JsonPathCommonOptions
string

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: $

outputPathOptionalinherited from JsonPathCommonOptions
string

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: $

1 property inherited from JsonataCommonOptions
outputsOptionalinherited from JsonataCommonOptions
any

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

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter