Interface RecommendationJobInputConfig.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<RecommendationJobInputConfig.Builder,RecommendationJobInputConfig>
,SdkBuilder<RecommendationJobInputConfig.Builder,RecommendationJobInputConfig>
,SdkPojo
- Enclosing class:
- RecommendationJobInputConfig
public static interface RecommendationJobInputConfig.Builder extends SdkPojo, CopyableBuilder<RecommendationJobInputConfig.Builder,RecommendationJobInputConfig>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default RecommendationJobInputConfig.Builder
containerConfig(Consumer<RecommendationJobContainerConfig.Builder> containerConfig)
Specifies mandatory fields for running an Inference Recommender job.RecommendationJobInputConfig.Builder
containerConfig(RecommendationJobContainerConfig containerConfig)
Specifies mandatory fields for running an Inference Recommender job.RecommendationJobInputConfig.Builder
endpointConfigurations(Collection<EndpointInputConfiguration> endpointConfigurations)
Specifies the endpoint configuration to use for a job.RecommendationJobInputConfig.Builder
endpointConfigurations(Consumer<EndpointInputConfiguration.Builder>... endpointConfigurations)
Specifies the endpoint configuration to use for a job.RecommendationJobInputConfig.Builder
endpointConfigurations(EndpointInputConfiguration... endpointConfigurations)
Specifies the endpoint configuration to use for a job.RecommendationJobInputConfig.Builder
endpoints(Collection<EndpointInfo> endpoints)
Existing customer endpoints on which to run an Inference Recommender job.RecommendationJobInputConfig.Builder
endpoints(Consumer<EndpointInfo.Builder>... endpoints)
Existing customer endpoints on which to run an Inference Recommender job.RecommendationJobInputConfig.Builder
endpoints(EndpointInfo... endpoints)
Existing customer endpoints on which to run an Inference Recommender job.RecommendationJobInputConfig.Builder
jobDurationInSeconds(Integer jobDurationInSeconds)
Specifies the maximum duration of the job, in seconds.RecommendationJobInputConfig.Builder
modelName(String modelName)
The name of the created model.RecommendationJobInputConfig.Builder
modelPackageVersionArn(String modelPackageVersionArn)
The Amazon Resource Name (ARN) of a versioned model package.default RecommendationJobInputConfig.Builder
resourceLimit(Consumer<RecommendationJobResourceLimit.Builder> resourceLimit)
Defines the resource limit of the job.RecommendationJobInputConfig.Builder
resourceLimit(RecommendationJobResourceLimit resourceLimit)
Defines the resource limit of the job.default RecommendationJobInputConfig.Builder
trafficPattern(Consumer<TrafficPattern.Builder> trafficPattern)
Specifies the traffic pattern of the job.RecommendationJobInputConfig.Builder
trafficPattern(TrafficPattern trafficPattern)
Specifies the traffic pattern of the job.RecommendationJobInputConfig.Builder
volumeKmsKeyId(String volumeKmsKeyId)
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.default RecommendationJobInputConfig.Builder
vpcConfig(Consumer<RecommendationJobVpcConfig.Builder> vpcConfig)
Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.RecommendationJobInputConfig.Builder
vpcConfig(RecommendationJobVpcConfig vpcConfig)
Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
modelPackageVersionArn
RecommendationJobInputConfig.Builder modelPackageVersionArn(String modelPackageVersionArn)
The Amazon Resource Name (ARN) of a versioned model package.
- Parameters:
modelPackageVersionArn
- The Amazon Resource Name (ARN) of a versioned model package.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
modelName
RecommendationJobInputConfig.Builder modelName(String modelName)
The name of the created model.
- Parameters:
modelName
- The name of the created model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobDurationInSeconds
RecommendationJobInputConfig.Builder jobDurationInSeconds(Integer jobDurationInSeconds)
Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.
- Parameters:
jobDurationInSeconds
- Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trafficPattern
RecommendationJobInputConfig.Builder trafficPattern(TrafficPattern trafficPattern)
Specifies the traffic pattern of the job.
- Parameters:
trafficPattern
- Specifies the traffic pattern of the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trafficPattern
default RecommendationJobInputConfig.Builder trafficPattern(Consumer<TrafficPattern.Builder> trafficPattern)
Specifies the traffic pattern of the job.
This is a convenience method that creates an instance of theTrafficPattern.Builder
avoiding the need to create one manually viaTrafficPattern.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totrafficPattern(TrafficPattern)
.- Parameters:
trafficPattern
- a consumer that will call methods onTrafficPattern.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
trafficPattern(TrafficPattern)
-
resourceLimit
RecommendationJobInputConfig.Builder resourceLimit(RecommendationJobResourceLimit resourceLimit)
Defines the resource limit of the job.
- Parameters:
resourceLimit
- Defines the resource limit of the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceLimit
default RecommendationJobInputConfig.Builder resourceLimit(Consumer<RecommendationJobResourceLimit.Builder> resourceLimit)
Defines the resource limit of the job.
This is a convenience method that creates an instance of theRecommendationJobResourceLimit.Builder
avoiding the need to create one manually viaRecommendationJobResourceLimit.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresourceLimit(RecommendationJobResourceLimit)
.- Parameters:
resourceLimit
- a consumer that will call methods onRecommendationJobResourceLimit.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
resourceLimit(RecommendationJobResourceLimit)
-
endpointConfigurations
RecommendationJobInputConfig.Builder endpointConfigurations(Collection<EndpointInputConfiguration> endpointConfigurations)
Specifies the endpoint configuration to use for a job.
- Parameters:
endpointConfigurations
- Specifies the endpoint configuration to use for a job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endpointConfigurations
RecommendationJobInputConfig.Builder endpointConfigurations(EndpointInputConfiguration... endpointConfigurations)
Specifies the endpoint configuration to use for a job.
- Parameters:
endpointConfigurations
- Specifies the endpoint configuration to use for a job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endpointConfigurations
RecommendationJobInputConfig.Builder endpointConfigurations(Consumer<EndpointInputConfiguration.Builder>... endpointConfigurations)
Specifies the endpoint configuration to use for a job.
This is a convenience method that creates an instance of theEndpointInputConfiguration.Builder
avoiding the need to create one manually viaEndpointInputConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#endpointConfigurations(List
.) - Parameters:
endpointConfigurations
- a consumer that will call methods onEndpointInputConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#endpointConfigurations(java.util.Collection
)
-
volumeKmsKeyId
RecommendationJobInputConfig.Builder volumeKmsKeyId(String volumeKmsKeyId)
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.
The SageMaker execution role must have
kms:CreateGrant
permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not havekms:CreateGrant
permission.The
KmsKeyId
can be any of the following formats:-
// KMS Key ID
"1234abcd-12ab-34cd-56ef-1234567890ab"
-
// Amazon Resource Name (ARN) of a KMS Key
"arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"
-
// KMS Key Alias
"alias/ExampleAlias"
-
// Amazon Resource Name (ARN) of a KMS Key Alias
"arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"
For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
- Parameters:
volumeKmsKeyId
- The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.The SageMaker execution role must have
kms:CreateGrant
permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not havekms:CreateGrant
permission.The
KmsKeyId
can be any of the following formats:-
// KMS Key ID
"1234abcd-12ab-34cd-56ef-1234567890ab"
-
// Amazon Resource Name (ARN) of a KMS Key
"arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"
-
// KMS Key Alias
"alias/ExampleAlias"
-
// Amazon Resource Name (ARN) of a KMS Key Alias
"arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"
For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
containerConfig
RecommendationJobInputConfig.Builder containerConfig(RecommendationJobContainerConfig containerConfig)
Specifies mandatory fields for running an Inference Recommender job. The fields specified in
ContainerConfig
override the corresponding fields in the model package.- Parameters:
containerConfig
- Specifies mandatory fields for running an Inference Recommender job. The fields specified inContainerConfig
override the corresponding fields in the model package.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
containerConfig
default RecommendationJobInputConfig.Builder containerConfig(Consumer<RecommendationJobContainerConfig.Builder> containerConfig)
Specifies mandatory fields for running an Inference Recommender job. The fields specified in
This is a convenience method that creates an instance of theContainerConfig
override the corresponding fields in the model package.RecommendationJobContainerConfig.Builder
avoiding the need to create one manually viaRecommendationJobContainerConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocontainerConfig(RecommendationJobContainerConfig)
.- Parameters:
containerConfig
- a consumer that will call methods onRecommendationJobContainerConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
containerConfig(RecommendationJobContainerConfig)
-
endpoints
RecommendationJobInputConfig.Builder endpoints(Collection<EndpointInfo> endpoints)
Existing customer endpoints on which to run an Inference Recommender job.
- Parameters:
endpoints
- Existing customer endpoints on which to run an Inference Recommender job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endpoints
RecommendationJobInputConfig.Builder endpoints(EndpointInfo... endpoints)
Existing customer endpoints on which to run an Inference Recommender job.
- Parameters:
endpoints
- Existing customer endpoints on which to run an Inference Recommender job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endpoints
RecommendationJobInputConfig.Builder endpoints(Consumer<EndpointInfo.Builder>... endpoints)
Existing customer endpoints on which to run an Inference Recommender job.
This is a convenience method that creates an instance of theEndpointInfo.Builder
avoiding the need to create one manually viaEndpointInfo.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#endpoints(List
.) - Parameters:
endpoints
- a consumer that will call methods onEndpointInfo.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#endpoints(java.util.Collection
)
-
vpcConfig
RecommendationJobInputConfig.Builder vpcConfig(RecommendationJobVpcConfig vpcConfig)
Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.
- Parameters:
vpcConfig
- Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcConfig
default RecommendationJobInputConfig.Builder vpcConfig(Consumer<RecommendationJobVpcConfig.Builder> vpcConfig)
Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.
This is a convenience method that creates an instance of theRecommendationJobVpcConfig.Builder
avoiding the need to create one manually viaRecommendationJobVpcConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovpcConfig(RecommendationJobVpcConfig)
.- Parameters:
vpcConfig
- a consumer that will call methods onRecommendationJobVpcConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
vpcConfig(RecommendationJobVpcConfig)
-
-