Class: AWSCDK::Sagemaker::CfnEndpointProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/cfn_endpoint_props.rb

Overview

Properties for defining a CfnEndpoint.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(endpoint_config_name:, deployment_config: nil, endpoint_name: nil, exclude_retained_variant_properties: nil, retain_all_variant_properties: nil, retain_deployment_config: nil, tags: nil) ⇒ CfnEndpointProps

Returns a new instance of CfnEndpointProps.

Parameters:

  • endpoint_config_name (String) —

    The name of the AWS::SageMaker::EndpointConfig resource that specifies the configuration for the endpoint. For more information, see CreateEndpointConfig .

  • deployment_config (AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnEndpoint::DeploymentConfigProperty, nil) (defaults to: nil) —

    The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

  • endpoint_name (String, nil) (defaults to: nil) —

    The name of the endpoint.

  • exclude_retained_variant_properties (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnEndpoint::VariantPropertyProperty>, nil) (defaults to: nil) —

    When you are updating endpoint resources with RetainAllVariantProperties whose value is set to true , ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig . If you don't specify a value for ExcludeAllVariantProperties , no variant properties are overridden. Don't use this property when creating new endpoint resources or when RetainAllVariantProperties is set to false .

  • retain_all_variant_properties (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight.

  • retain_deployment_config (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether to reuse the last deployment configuration.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    A list of key-value pairs to apply to this resource.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'sagemaker/cfn_endpoint_props.rb', line 16

def initialize(endpoint_config_name:, deployment_config: nil, endpoint_name: nil, exclude_retained_variant_properties: nil, retain_all_variant_properties: nil, retain_deployment_config: nil, tags: nil)
  @endpoint_config_name = endpoint_config_name
  Jsii::Type.check_type(@endpoint_config_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpointConfigName")
  @deployment_config = deployment_config.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnEndpoint::DeploymentConfigProperty.new(**deployment_config.transform_keys(&:to_sym)) : deployment_config
  Jsii::Type.check_type(@deployment_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRW5kcG9pbnQuRGVwbG95bWVudENvbmZpZ1Byb3BlcnR5In1dfX0=")), "deploymentConfig") unless @deployment_config.nil?
  @endpoint_name = endpoint_name
  Jsii::Type.check_type(@endpoint_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpointName") unless @endpoint_name.nil?
  @exclude_retained_variant_properties = exclude_retained_variant_properties
  Jsii::Type.check_type(@exclude_retained_variant_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbkVuZHBvaW50LlZhcmlhbnRQcm9wZXJ0eVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "excludeRetainedVariantProperties") unless @exclude_retained_variant_properties.nil?
  @retain_all_variant_properties = retain_all_variant_properties
  Jsii::Type.check_type(@retain_all_variant_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "retainAllVariantProperties") unless @retain_all_variant_properties.nil?
  @retain_deployment_config = retain_deployment_config
  Jsii::Type.check_type(@retain_deployment_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "retainDeploymentConfig") unless @retain_deployment_config.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#deployment_config ⇒ AWSCDK::IResolvable, ... (readonly)

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

Returns:

See Also:



42
43
44
 
# File 'sagemaker/cfn_endpoint_props.rb', line 42

def deployment_config
  @deployment_config
end

#endpoint_config_name ⇒ String (readonly)

The name of the AWS::SageMaker::EndpointConfig resource that specifies the configuration for the endpoint. For more information, see CreateEndpointConfig .

Returns:

  • (String)

See Also:



37
38
39
 
# File 'sagemaker/cfn_endpoint_props.rb', line 37

def endpoint_config_name
  @endpoint_config_name
end

#endpoint_name ⇒ String? (readonly)

The name of the endpoint.

The name must be unique within an AWS Region in your AWS account. The name is case-insensitive in CreateEndpoint , but the case is preserved and must be matched in .

Returns:

  • (String, nil)

See Also:



49
50
51
 
# File 'sagemaker/cfn_endpoint_props.rb', line 49

def endpoint_name
  @endpoint_name
end

#exclude_retained_variant_properties ⇒ AWSCDK::IResolvable, ... (readonly)

When you are updating endpoint resources with RetainAllVariantProperties whose value is set to true , ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig . If you don't specify a value for ExcludeAllVariantProperties , no variant properties are overridden. Don't use this property when creating new endpoint resources or when RetainAllVariantProperties is set to false .

Returns:

See Also:



54
55
56
 
# File 'sagemaker/cfn_endpoint_props.rb', line 54

def exclude_retained_variant_properties
  @exclude_retained_variant_properties
end

#retain_all_variant_properties ⇒ Boolean, ... (readonly)

When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight.

To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true . To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false . Use this property only when updating endpoint resources, not when creating new endpoint resources.

Returns:

See Also:



61
62
63
 
# File 'sagemaker/cfn_endpoint_props.rb', line 61

def retain_all_variant_properties
  @retain_all_variant_properties
end

#retain_deployment_config ⇒ Boolean, ... (readonly)

Specifies whether to reuse the last deployment configuration.

The default value is false (the configuration is not reused).

Returns:

See Also:



68
69
70
 
# File 'sagemaker/cfn_endpoint_props.rb', line 68

def retain_deployment_config
  @retain_deployment_config
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

A list of key-value pairs to apply to this resource.

For more information, see Resource Tag and Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .

Returns:

See Also:



75
76
77
 
# File 'sagemaker/cfn_endpoint_props.rb', line 75

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
 
# File 'sagemaker/cfn_endpoint_props.rb', line 77

def self.jsii_properties
  {
    :endpoint_config_name => "endpointConfigName",
    :deployment_config => "deploymentConfig",
    :endpoint_name => "endpointName",
    :exclude_retained_variant_properties => "excludeRetainedVariantProperties",
    :retain_all_variant_properties => "retainAllVariantProperties",
    :retain_deployment_config => "retainDeploymentConfig",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'sagemaker/cfn_endpoint_props.rb', line 89

def to_jsii
  result = {}
  result.merge!({
    "endpointConfigName" => @endpoint_config_name,
    "deploymentConfig" => @deployment_config,
    "endpointName" => @endpoint_name,
    "excludeRetainedVariantProperties" => @exclude_retained_variant_properties,
    "retainAllVariantProperties" => @retain_all_variant_properties,
    "retainDeploymentConfig" => @retain_deployment_config,
    "tags" => @tags,
  })
  result.compact
end