software.amazon.awssdk.services.sagemaker.model

Interface OutputDataConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<OutputDataConfig.Builder,OutputDataConfig>, SdkBuilder<OutputDataConfig.Builder,OutputDataConfig>, SdkPojo

Enclosing class:

OutputDataConfig

public static interface OutputDataConfig.Builder
extends SdkPojo, CopyableBuilder<OutputDataConfig.Builder,OutputDataConfig>

Method Summary

Modifier and Type	Method and Description
OutputDataConfig.Builder	kmsKeyId(String kmsKeyId) The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.
OutputDataConfig.Builder	s3OutputPath(String s3OutputPath) Identifies the S3 path where you want Amazon SageMaker to store the model artifacts.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

kmsKeyId

OutputDataConfig.Builder kmsKeyId(String kmsKeyId)

The AWS Key Management Service (AWS KMS) key that Amazon 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 don't provide the KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob request. Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

Parameters:

kmsKeyId - The AWS Key Management Service (AWS KMS) key that Amazon 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 don't provide the KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob request. Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

Returns:

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

s3OutputPath

OutputDataConfig.Builder s3OutputPath(String s3OutputPath)

Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

Parameters:

s3OutputPath - Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

Returns:

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