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

Class EdgeOutputConfig

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.EdgeOutputConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EdgeOutputConfig.Builder,EdgeOutputConfig>
@Generated("software.amazon.awssdk:codegen") public final class EdgeOutputConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EdgeOutputConfig.Builder,EdgeOutputConfig>

The output configuration.

See Also:

  • Method Details

    • s3OutputLocation

      public final String s3OutputLocation()

      The Amazon Simple Storage (S3) bucker URI.

      Returns:
      The Amazon Simple Storage (S3) bucker URI.

    • kmsKeyId

      public final String kmsKeyId()

      The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

      Returns:
      The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

    • presetDeploymentType

      public final EdgePresetDeploymentType presetDeploymentType()

      The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

      If the service returns an enum value that is not available in the current SDK version, presetDeploymentType will return EdgePresetDeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from presetDeploymentTypeAsString().

      Returns:
      The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.
      See Also:

    • presetDeploymentTypeAsString

      public final String presetDeploymentTypeAsString()

      The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

      If the service returns an enum value that is not available in the current SDK version, presetDeploymentType will return EdgePresetDeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from presetDeploymentTypeAsString().

      Returns:
      The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.
      See Also:

    • presetDeploymentConfig

      public final String presetDeploymentConfig()

      The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:

      • ComponentName (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager packaging job.

      • ComponentDescription (optional) - Description of the component.

      • ComponentVersion (optional) - The version of the component.

        Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a major.minor.patch number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the semantic version specification.

      • PlatformOS (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.

      • PlatformArchitecture (optional) - The processor architecture for the platform.

        Supported architectures Windows include: Windows32_x86, Windows64_x64.

        Supported architectures for Linux include: Linux x86_64, Linux ARMV8.

      Returns:
      The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:

      • ComponentName (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager packaging job.

      • ComponentDescription (optional) - Description of the component.

      • ComponentVersion (optional) - The version of the component.

        Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a major.minor.patch number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the semantic version specification.

      • PlatformOS (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.

      • PlatformArchitecture (optional) - The processor architecture for the platform.

        Supported architectures Windows include: Windows32_x86, Windows64_x64.

        Supported architectures for Linux include: Linux x86_64, Linux ARMV8.

    • toBuilder

      public EdgeOutputConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<EdgeOutputConfig.Builder,EdgeOutputConfig>
      Returns:
      a builder for type T

    • builder

      public static EdgeOutputConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EdgeOutputConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.