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

Interface OutputDataConfig.Builder

    • Method Detail

      • kmsKeyId

        OutputDataConfig.Builder kmsKeyId​(String kmsKeyId)

        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.

        Parameters:
        kmsKeyId - 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.

        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 SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

        Parameters:
        s3OutputPath - Identifies the S3 path where you want 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.

      • compressionType

        OutputDataConfig.Builder compressionType​(String compressionType)

        The model output compression type. Select None to output an uncompressed model, recommended for large model outputs. Defaults to gzip.

        Parameters:
        compressionType - The model output compression type. Select None to output an uncompressed model, recommended for large model outputs. Defaults to gzip.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        OutputCompressionType, OutputCompressionType

      • compressionType

        OutputDataConfig.Builder compressionType​(OutputCompressionType compressionType)

        The model output compression type. Select None to output an uncompressed model, recommended for large model outputs. Defaults to gzip.

        Parameters:
        compressionType - The model output compression type. Select None to output an uncompressed model, recommended for large model outputs. Defaults to gzip.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        OutputCompressionType, OutputCompressionType