Struct CreateEndpointConfigInput

#[non_exhaustive]
pub struct CreateEndpointConfigInput {
    pub endpoint_config_name: Option<String>,
    pub production_variants: Option<Vec<ProductionVariant>>,
    pub data_capture_config: Option<DataCaptureConfig>,
    pub tags: Option<Vec<Tag>>,
    pub kms_key_id: Option<String>,
    pub async_inference_config: Option<AsyncInferenceConfig>,
    pub explainer_config: Option<ExplainerConfig>,
    pub shadow_production_variants: Option<Vec<ProductionVariant>>,
    pub execution_role_arn: Option<String>,
    pub vpc_config: Option<VpcConfig>,
    pub enable_network_isolation: Option<bool>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

endpoint_config_name: Option<String>

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

production_variants: Option<Vec<ProductionVariant>>

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

data_capture_config: Option<DataCaptureConfig>

Configuration to control how SageMaker AI captures inference data.

tags: Option<Vec<Tag>>

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.

kms_key_id: Option<String>

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.

async_inference_config: Option<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.

explainer_config: Option<ExplainerConfig>

A member of CreateEndpointConfig that enables explainers.

shadow_production_variants: Option<Vec<ProductionVariant>>

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.

execution_role_arn: Option<String>

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

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

vpc_config: Option<VpcConfig>

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.

enable_network_isolation: Option<bool>

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.

Implementations

impl CreateEndpointConfigInput

pub fn endpoint_config_name(&self) -> Option<&str>

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

pub fn production_variants(&self) -> &[ProductionVariant]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .production_variants.is_none().

pub fn data_capture_config(&self) -> Option<&DataCaptureConfig>

Configuration to control how SageMaker AI captures inference data.

pub fn tags(&self) -> &[Tag]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn kms_key_id(&self) -> Option<&str>

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.

pub fn async_inference_config(&self) -> Option<&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.

pub fn explainer_config(&self) -> Option<&ExplainerConfig>

A member of CreateEndpointConfig that enables explainers.

pub fn shadow_production_variants(&self) -> &[ProductionVariant]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .shadow_production_variants.is_none().

pub fn execution_role_arn(&self) -> Option<&str>

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

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

pub fn vpc_config(&self) -> Option<&VpcConfig>

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.

pub fn enable_network_isolation(&self) -> Option<bool>

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.

impl CreateEndpointConfigInput

pub fn builder() -> CreateEndpointConfigInputBuilder

Creates a new builder-style object to manufacture CreateEndpointConfigInput.

Trait Implementations

impl Clone for CreateEndpointConfigInput

fn clone(&self) -> CreateEndpointConfigInput

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateEndpointConfigInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateEndpointConfigInput

fn eq(&self, other: &CreateEndpointConfigInput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateEndpointConfigInput