Package com.commercetools.api.models.subscription

Interface AwsAuthenticationMode

All Superinterfaces:
JsonEnum
All Known Implementing Classes:
AwsAuthenticationMode.AwsAuthenticationModeEnum
public interface AwsAuthenticationMode extends JsonEnum

Defines the method of authentication for AWS SQS and SNS Destinations.

  • Field Details

    • CREDENTIALS

      static final AwsAuthenticationMode CREDENTIALS

      Subscriptions with Credentials authentication mode are authenticated using an accessKey and accessSecret pair. This is the default authentication mode for backwards compatibility.

    • IAM

      static final AwsAuthenticationMode IAM

      Subscriptions with IAM authentication mode are authenticated using Identity and Access Management (IAM). For this authentication mode, the following user requires permissions to send messages to the queue or publish to the topic: arn:aws-cn:iam::417094354346:user/subscriptions if the Project is hosted in the China (AWS, Ningxia) Region; arn:aws:iam::362576667341:user/subscriptions for all other Regions. This is the recommended authentication mode, as it doesn't require additional key management.

  • Method Details

    • getJsonName

      String getJsonName()
      the JSON value
      Specified by:
      getJsonName in interface JsonEnum
      Returns:
      json value

    • name

      String name()
      the enum value
      Specified by:
      name in interface JsonEnum
      Returns:
      name

    • toString

      String toString()
      convert value to string
      Specified by:
      toString in interface JsonEnum
      Overrides:
      toString in class Object
      Returns:
      string representation

    • findEnum

      static AwsAuthenticationMode findEnum(String value)
      factory method for a enum value of AwsAuthenticationMode if no enum has been found an anonymous instance will be created
      Parameters:
      value - the enum value to be wrapped
      Returns:
      enum instance

    • findEnumViaJsonName

      static Optional<AwsAuthenticationMode> findEnumViaJsonName(String jsonName)
      method to find enum using the JSON value
      Parameters:
      jsonName - the json value to be wrapped
      Returns:
      optional of enum instance

    • values

      static AwsAuthenticationMode[] values()
      possible enum values
      Returns:
      array of possible enum values