Class EncryptionConfig

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

An Key Management Service (KMS) key and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the CreateDataset and CreatePredictor requests.

See Also:

  • Method Details

    • roleArn

      public final String roleArn()

      The ARN of the IAM role that Amazon Forecast can assume to access the KMS key.

      Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

      Returns:
      The ARN of the IAM role that Amazon Forecast can assume to access the KMS key.

      Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

    • kmsKeyArn

      public final String kmsKeyArn()

      The Amazon Resource Name (ARN) of the KMS key.

      Returns:
      The Amazon Resource Name (ARN) of the KMS key.

    • toBuilder

      public EncryptionConfig.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<EncryptionConfig.Builder,EncryptionConfig>
      Returns:
      a builder for type T

    • builder

      public static EncryptionConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EncryptionConfig.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.