Package software.amazon.awssdk.services.sagemaker.model

Interface CreateEndpointConfigRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateEndpointConfigRequest.Builder,CreateEndpointConfigRequest>, SageMakerRequest.Builder, SdkBuilder<CreateEndpointConfigRequest.Builder,CreateEndpointConfigRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateEndpointConfigRequest
public static interface CreateEndpointConfigRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateEndpointConfigRequest.Builder,CreateEndpointConfigRequest>

  • Method Details

    • endpointConfigName

      CreateEndpointConfigRequest.Builder endpointConfigName(String endpointConfigName)

      The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

      Parameters:
      endpointConfigName - The name of the endpoint configuration. You specify this name in a CreateEndpoint request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • productionVariants

      CreateEndpointConfigRequest.Builder productionVariants(Collection<ProductionVariant> productionVariants)

      An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

      Parameters:
      productionVariants - An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • productionVariants

      CreateEndpointConfigRequest.Builder productionVariants(ProductionVariant... productionVariants)

      An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

      Parameters:
      productionVariants - An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • productionVariants

      CreateEndpointConfigRequest.Builder productionVariants(Consumer<ProductionVariant.Builder>... productionVariants)

      An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

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

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

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

    • dataCaptureConfig

      CreateEndpointConfigRequest.Builder dataCaptureConfig(DataCaptureConfig dataCaptureConfig)
      Sets the value of the DataCaptureConfig property for this object.
      Parameters:
      dataCaptureConfig - The new value for the DataCaptureConfig property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataCaptureConfig

      default CreateEndpointConfigRequest.Builder dataCaptureConfig(Consumer<DataCaptureConfig.Builder> dataCaptureConfig)
      Sets the value of the DataCaptureConfig property for this object. This is a convenience method that creates an instance of the DataCaptureConfig.Builder avoiding the need to create one manually via DataCaptureConfig.builder().

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

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

    • tags

      CreateEndpointConfigRequest.Builder tags(Collection<Tag> tags)

      An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

      Parameters:
      tags - An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateEndpointConfigRequest.Builder tags(Tag... tags)

      An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

      Parameters:
      tags - An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateEndpointConfigRequest.Builder tags(Consumer<Tag.Builder>... tags)

      An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

      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 tags(List<Tag>).

      Parameters:
      tags - 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:

    • kmsKeyId

      CreateEndpointConfigRequest.Builder kmsKeyId(String kmsKeyId)

      The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

      The KmsKeyId can be any of the following formats:

      • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

      • Alias name: alias/ExampleAlias

      • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

      The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS

      Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.

      For a list of instance types that support local instance storage, see Instance Store Volumes.

      For more information about local instance storage encryption, see SSD Instance Store Volumes.

      Parameters:
      kmsKeyId - The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

      The KmsKeyId can be any of the following formats:

      • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

      • Alias name: alias/ExampleAlias

      • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

      The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS

      Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.

      For a list of instance types that support local instance storage, see Instance Store Volumes.

      For more information about local instance storage encryption, see SSD Instance Store Volumes.

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

    • asyncInferenceConfig

      CreateEndpointConfigRequest.Builder asyncInferenceConfig(AsyncInferenceConfig asyncInferenceConfig)

      Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

      Parameters:
      asyncInferenceConfig - Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • asyncInferenceConfig

      default CreateEndpointConfigRequest.Builder asyncInferenceConfig(Consumer<AsyncInferenceConfig.Builder> asyncInferenceConfig)

      Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

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

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

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

    • explainerConfig

      CreateEndpointConfigRequest.Builder explainerConfig(ExplainerConfig explainerConfig)

      A member of CreateEndpointConfig that enables explainers.

      Parameters:
      explainerConfig - A member of CreateEndpointConfig that enables explainers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • explainerConfig

      default CreateEndpointConfigRequest.Builder explainerConfig(Consumer<ExplainerConfig.Builder> explainerConfig)

      A member of CreateEndpointConfig that enables explainers.

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

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

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

    • shadowProductionVariants

      CreateEndpointConfigRequest.Builder shadowProductionVariants(Collection<ProductionVariant> shadowProductionVariants)

      An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants . If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants.

      Parameters:
      shadowProductionVariants - An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants. If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shadowProductionVariants

      CreateEndpointConfigRequest.Builder shadowProductionVariants(ProductionVariant... shadowProductionVariants)

      An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants . If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants.

      Parameters:
      shadowProductionVariants - An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants. If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shadowProductionVariants

      CreateEndpointConfigRequest.Builder shadowProductionVariants(Consumer<ProductionVariant.Builder>... shadowProductionVariants)

      An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants . If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants.

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

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

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

    • executionRoleArn

      CreateEndpointConfigRequest.Builder executionRoleArn(String executionRoleArn)

      The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform actions on your behalf. For more information, see SageMaker Roles.

      To be able to pass this role to Amazon SageMaker, the caller of this action must have the iam:PassRole permission.

      Parameters:
      executionRoleArn - The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform actions on your behalf. For more information, see SageMaker Roles.

      To be able to pass this role to Amazon SageMaker, the caller of this action must have the iam:PassRole permission.

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

    • vpcConfig

      CreateEndpointConfigRequest.Builder vpcConfig(VpcConfig vpcConfig)
      Sets the value of the VpcConfig property for this object.
      Parameters:
      vpcConfig - The new value for the VpcConfig property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      default CreateEndpointConfigRequest.Builder vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)
      Sets the value of the VpcConfig property for this object. This is a convenience method that creates an instance of the VpcConfig.Builder avoiding the need to create one manually via VpcConfig.builder().

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

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

    • enableNetworkIsolation

      CreateEndpointConfigRequest.Builder enableNetworkIsolation(Boolean enableNetworkIsolation)

      Sets whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.

      Parameters:
      enableNetworkIsolation - Sets whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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