Class DkimSigningAttributes

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

An object that contains configuration for Bring Your Own DKIM (BYODKIM), or, for Easy DKIM

See Also:

  • Method Details

    • domainSigningSelector

      public final String domainSigningSelector()

      [Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.

      Returns:
      [Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.

    • domainSigningPrivateKey

      public final String domainSigningPrivateKey()

      [Bring Your Own DKIM] A private key that's used to generate a DKIM signature.

      The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.

      Returns:
      [Bring Your Own DKIM] A private key that's used to generate a DKIM signature.

      The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.

    • nextSigningKeyLength

      public final DkimSigningKeyLength nextSigningKeyLength()

      [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.

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

      Returns:
      [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
      See Also:

    • nextSigningKeyLengthAsString

      public final String nextSigningKeyLengthAsString()

      [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.

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

      Returns:
      [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
      See Also:

    • domainSigningAttributesOrigin

      public final DkimSigningAttributesOrigin domainSigningAttributesOrigin()

      The attribute to use for configuring DKIM for the identity depends on the operation:

      1. For PutEmailIdentityDkimSigningAttributes:

      2. For CreateEmailIdentity when replicating a parent identity's DKIM configuration:

        • Allowed values: All values except AWS_SES and EXTERNAL

      • AWS_SES – Configure DKIM for the identity by using Easy DKIM.

      • EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).

      • AWS_SES_<REGION> – Configure DKIM for the identity by replicating the signing attributes of a parent identity in another Amazon Web Services Region, using Deterministic Easy-DKIM (DEED). Replace <REGION> with the Amazon Web Services Region of the parent identity, in uppercase with each hyphen replaced by an underscore. You can specify any Amazon Web Services Region in which Amazon SES supports DEED. For example, to replicate from a parent identity in us-east-1, specify AWS_SES_US_EAST_1.

        The parent identity must already exist in the specified Amazon Web Services Region and have Easy DKIM configured.

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

      Returns:
      The attribute to use for configuring DKIM for the identity depends on the operation:

      1. For PutEmailIdentityDkimSigningAttributes:

      2. For CreateEmailIdentity when replicating a parent identity's DKIM configuration:

        • Allowed values: All values except AWS_SES and EXTERNAL

      • AWS_SES – Configure DKIM for the identity by using Easy DKIM.

      • EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).

      • AWS_SES_<REGION> – Configure DKIM for the identity by replicating the signing attributes of a parent identity in another Amazon Web Services Region, using Deterministic Easy-DKIM (DEED). Replace <REGION> with the Amazon Web Services Region of the parent identity, in uppercase with each hyphen replaced by an underscore. You can specify any Amazon Web Services Region in which Amazon SES supports DEED. For example, to replicate from a parent identity in us-east-1, specify AWS_SES_US_EAST_1.

        The parent identity must already exist in the specified Amazon Web Services Region and have Easy DKIM configured.

      See Also:

    • domainSigningAttributesOriginAsString

      public final String domainSigningAttributesOriginAsString()

      The attribute to use for configuring DKIM for the identity depends on the operation:

      1. For PutEmailIdentityDkimSigningAttributes:

      2. For CreateEmailIdentity when replicating a parent identity's DKIM configuration:

        • Allowed values: All values except AWS_SES and EXTERNAL

      • AWS_SES – Configure DKIM for the identity by using Easy DKIM.

      • EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).

      • AWS_SES_<REGION> – Configure DKIM for the identity by replicating the signing attributes of a parent identity in another Amazon Web Services Region, using Deterministic Easy-DKIM (DEED). Replace <REGION> with the Amazon Web Services Region of the parent identity, in uppercase with each hyphen replaced by an underscore. You can specify any Amazon Web Services Region in which Amazon SES supports DEED. For example, to replicate from a parent identity in us-east-1, specify AWS_SES_US_EAST_1.

        The parent identity must already exist in the specified Amazon Web Services Region and have Easy DKIM configured.

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

      Returns:
      The attribute to use for configuring DKIM for the identity depends on the operation:

      1. For PutEmailIdentityDkimSigningAttributes:

      2. For CreateEmailIdentity when replicating a parent identity's DKIM configuration:

        • Allowed values: All values except AWS_SES and EXTERNAL

      • AWS_SES – Configure DKIM for the identity by using Easy DKIM.

      • EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).

      • AWS_SES_<REGION> – Configure DKIM for the identity by replicating the signing attributes of a parent identity in another Amazon Web Services Region, using Deterministic Easy-DKIM (DEED). Replace <REGION> with the Amazon Web Services Region of the parent identity, in uppercase with each hyphen replaced by an underscore. You can specify any Amazon Web Services Region in which Amazon SES supports DEED. For example, to replicate from a parent identity in us-east-1, specify AWS_SES_US_EAST_1.

        The parent identity must already exist in the specified Amazon Web Services Region and have Easy DKIM configured.

      See Also:

    • toBuilder

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

    • builder

      public static DkimSigningAttributes.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.