Interface CreateCustomModelRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BedrockRequest.Builder, Buildable, CopyableBuilder<CreateCustomModelRequest.Builder,CreateCustomModelRequest>, SdkBuilder<CreateCustomModelRequest.Builder,CreateCustomModelRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateCustomModelRequest
@Mutable @NotThreadSafe public static interface CreateCustomModelRequest.Builder extends BedrockRequest.Builder, SdkPojo, CopyableBuilder<CreateCustomModelRequest.Builder,CreateCustomModelRequest>

  • Method Details

    • modelName

      CreateCustomModelRequest.Builder modelName(String modelName)

      A unique name for the custom model.

      Parameters:
      modelName - A unique name for the custom model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelSourceConfig

      CreateCustomModelRequest.Builder modelSourceConfig(ModelDataSource modelSourceConfig)

      The data source for the model. The Amazon S3 URI in the model source must be for the Amazon-managed Amazon S3 bucket containing your model artifacts.

      Parameters:
      modelSourceConfig - The data source for the model. The Amazon S3 URI in the model source must be for the Amazon-managed Amazon S3 bucket containing your model artifacts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelSourceConfig

      default CreateCustomModelRequest.Builder modelSourceConfig(Consumer<ModelDataSource.Builder> modelSourceConfig)

      The data source for the model. The Amazon S3 URI in the model source must be for the Amazon-managed Amazon S3 bucket containing your model artifacts.

      This is a convenience method that creates an instance of the ModelDataSource.Builder avoiding the need to create one manually via ModelDataSource.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to modelSourceConfig(ModelDataSource).

      Parameters:
      modelSourceConfig - a consumer that will call methods on ModelDataSource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customModelDataSource

      CreateCustomModelRequest.Builder customModelDataSource(CustomModelDataSource customModelDataSource)

      The data source for the custom model. Use this field to specify a SageMaker AI model package ARN as the source for your custom model. Amazon Bedrock resolves the model package to retrieve the model artifacts.

      You can specify either customModelDataSource or modelSourceConfig, but not both.

      Parameters:
      customModelDataSource - The data source for the custom model. Use this field to specify a SageMaker AI model package ARN as the source for your custom model. Amazon Bedrock resolves the model package to retrieve the model artifacts.

      You can specify either customModelDataSource or modelSourceConfig, but not both.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customModelDataSource

      default CreateCustomModelRequest.Builder customModelDataSource(Consumer<CustomModelDataSource.Builder> customModelDataSource)

      The data source for the custom model. Use this field to specify a SageMaker AI model package ARN as the source for your custom model. Amazon Bedrock resolves the model package to retrieve the model artifacts.

      You can specify either customModelDataSource or modelSourceConfig, but not both.

      This is a convenience method that creates an instance of the CustomModelDataSource.Builder avoiding the need to create one manually via CustomModelDataSource.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customModelDataSource(CustomModelDataSource).

      Parameters:
      customModelDataSource - a consumer that will call methods on CustomModelDataSource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • modelKmsKeyArn

      CreateCustomModelRequest.Builder modelKmsKeyArn(String modelKmsKeyArn)

      The Amazon Resource Name (ARN) of the customer managed KMS key to encrypt the custom model. If you don't provide a KMS key, Amazon Bedrock uses an Amazon Web Services-managed KMS key to encrypt the model.

      If you provide a customer managed KMS key, your Amazon Bedrock service role must have permissions to use it. For more information see Encryption of imported models.

      Parameters:
      modelKmsKeyArn - The Amazon Resource Name (ARN) of the customer managed KMS key to encrypt the custom model. If you don't provide a KMS key, Amazon Bedrock uses an Amazon Web Services-managed KMS key to encrypt the model.

      If you provide a customer managed KMS key, your Amazon Bedrock service role must have permissions to use it. For more information see Encryption of imported models.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      CreateCustomModelRequest.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock assumes to perform tasks on your behalf. This role must have permissions to access the Amazon S3 bucket containing your model artifacts and the KMS key (if specified). For more information, see Setting up an IAM service role for importing models in the Amazon Bedrock User Guide.

      This field is required when you use modelSourceConfig with an Amazon S3 data source. It is not required when you use customModelDataSource with a model package ARN, because Amazon Bedrock uses its own credentials to access the model artifacts.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock assumes to perform tasks on your behalf. This role must have permissions to access the Amazon S3 bucket containing your model artifacts and the KMS key (if specified). For more information, see Setting up an IAM service role for importing models in the Amazon Bedrock User Guide.

      This field is required when you use modelSourceConfig with an Amazon S3 data source. It is not required when you use customModelDataSource with a model package ARN, because Amazon Bedrock uses its own credentials to access the model artifacts.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelTags

      CreateCustomModelRequest.Builder modelTags(Collection<Tag> modelTags)

      A list of key-value pairs to associate with the custom model resource. You can use these tags to organize and identify your resources.

      For more information, see Tagging resources in the Amazon Bedrock User Guide.

      Parameters:
      modelTags - A list of key-value pairs to associate with the custom model resource. You can use these tags to organize and identify your resources.

      For more information, see Tagging resources in the Amazon Bedrock User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelTags

      CreateCustomModelRequest.Builder modelTags(Tag... modelTags)

      A list of key-value pairs to associate with the custom model resource. You can use these tags to organize and identify your resources.

      For more information, see Tagging resources in the Amazon Bedrock User Guide.

      Parameters:
      modelTags - A list of key-value pairs to associate with the custom model resource. You can use these tags to organize and identify your resources.

      For more information, see Tagging resources in the Amazon Bedrock User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelTags

      CreateCustomModelRequest.Builder modelTags(Consumer<Tag.Builder>... modelTags)

      A list of key-value pairs to associate with the custom model resource. You can use these tags to organize and identify your resources.

      For more information, see Tagging resources in the Amazon Bedrock User Guide.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to modelTags(List<Tag>).

      Parameters:
      modelTags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientRequestToken

      CreateCustomModelRequest.Builder clientRequestToken(String clientRequestToken)

      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. For more information, see Ensuring idempotency.

      Parameters:
      clientRequestToken - 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. For more information, see Ensuring idempotency.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateCustomModelRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateCustomModelRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.