Struct aws_sdk_sagemaker::types::builders::OutputDataConfigBuilder
source · #[non_exhaustive]pub struct OutputDataConfigBuilder { /* private fields */ }
Expand description
A builder for OutputDataConfig
.
Implementations§
source§impl OutputDataConfigBuilder
impl OutputDataConfigBuilder
sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. 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:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
-
// KMS Key Alias
"alias/ExampleAlias"
-
// Amazon Resource Name (ARN) of a KMS Key Alias
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt
. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide. If the output data is stored in Amazon S3 Express One Zone, it is encrypted with server-side encryption with Amazon S3 managed keys (SSE-S3). KMS key is not supported for Amazon S3 Express One Zone
The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob
, CreateTransformJob
, or CreateHyperParameterTuningJob
requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.
sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. 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:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
-
// KMS Key Alias
"alias/ExampleAlias"
-
// Amazon Resource Name (ARN) of a KMS Key Alias
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt
. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide. If the output data is stored in Amazon S3 Express One Zone, it is encrypted with server-side encryption with Amazon S3 managed keys (SSE-S3). KMS key is not supported for Amazon S3 Express One Zone
The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob
, CreateTransformJob
, or CreateHyperParameterTuningJob
requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.
sourcepub fn get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &Option<String>
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. 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:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
-
// KMS Key Alias
"alias/ExampleAlias"
-
// Amazon Resource Name (ARN) of a KMS Key Alias
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt
. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide. If the output data is stored in Amazon S3 Express One Zone, it is encrypted with server-side encryption with Amazon S3 managed keys (SSE-S3). KMS key is not supported for Amazon S3 Express One Zone
The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob
, CreateTransformJob
, or CreateHyperParameterTuningJob
requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.
sourcepub fn s3_output_path(self, input: impl Into<String>) -> Self
pub fn s3_output_path(self, input: impl Into<String>) -> Self
Identifies the S3 path where you want SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix
.
sourcepub fn set_s3_output_path(self, input: Option<String>) -> Self
pub fn set_s3_output_path(self, input: Option<String>) -> Self
Identifies the S3 path where you want SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix
.
sourcepub fn get_s3_output_path(&self) -> &Option<String>
pub fn get_s3_output_path(&self) -> &Option<String>
Identifies the S3 path where you want SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix
.
sourcepub fn compression_type(self, input: OutputCompressionType) -> Self
pub fn compression_type(self, input: OutputCompressionType) -> Self
The model output compression type. Select None
to output an uncompressed model, recommended for large model outputs. Defaults to gzip.
sourcepub fn set_compression_type(self, input: Option<OutputCompressionType>) -> Self
pub fn set_compression_type(self, input: Option<OutputCompressionType>) -> Self
The model output compression type. Select None
to output an uncompressed model, recommended for large model outputs. Defaults to gzip.
sourcepub fn get_compression_type(&self) -> &Option<OutputCompressionType>
pub fn get_compression_type(&self) -> &Option<OutputCompressionType>
The model output compression type. Select None
to output an uncompressed model, recommended for large model outputs. Defaults to gzip.
sourcepub fn build(self) -> OutputDataConfig
pub fn build(self) -> OutputDataConfig
Consumes the builder and constructs a OutputDataConfig
.
Trait Implementations§
source§impl Clone for OutputDataConfigBuilder
impl Clone for OutputDataConfigBuilder
source§fn clone(&self) -> OutputDataConfigBuilder
fn clone(&self) -> OutputDataConfigBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for OutputDataConfigBuilder
impl Debug for OutputDataConfigBuilder
source§impl Default for OutputDataConfigBuilder
impl Default for OutputDataConfigBuilder
source§fn default() -> OutputDataConfigBuilder
fn default() -> OutputDataConfigBuilder
source§impl PartialEq for OutputDataConfigBuilder
impl PartialEq for OutputDataConfigBuilder
source§fn eq(&self, other: &OutputDataConfigBuilder) -> bool
fn eq(&self, other: &OutputDataConfigBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.