Class SqsDestinationImpl
- All Implemented Interfaces:
Destination
,SqsDestination
,io.vrap.rmf.base.client.ModelBase
AWS SQS is a pull-queue on AWS. The queue must be a Standard queue type with a MaximumMessageSize
of 256 KB
.
We recommend setting authenticationMode
to IAM
, to avoid unnecessary key management. For IAM authentication and before creating the Subscription, give permissions to the following user account: 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. Otherwise, a test message will not be sent.
If you prefer to use Credentials
for authentication, we recommend creating an IAM user with an accessKey
and accessSecret
pair specifically for each Subscription.
The IAM user should only have the sqs:SendMessage
permission on this queue.
-
Nested Class Summary
Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase
io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle
-
Field Summary
Fields inherited from interface com.commercetools.api.models.subscription.SqsDestination
SQS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Only present ifauthenticationMode
is set toCredentials
.Only present ifauthenticationMode
is set toCredentials
.Defines the method of authentication for the SQS queue.URL of the Amazon SQS queue.AWS Region the message queue is located in.getType()
int
hashCode()
void
setAccessKey
(String accessKey) Only present ifauthenticationMode
is set toCredentials
.void
setAccessSecret
(String accessSecret) Only present ifauthenticationMode
is set toCredentials
.void
setAuthenticationMode
(AwsAuthenticationMode authenticationMode) Defines the method of authentication for the SQS queue.void
setQueueUrl
(String queueUrl) URL of the Amazon SQS queue.void
AWS Region the message queue is located in.Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.commercetools.api.models.subscription.Destination
withDestination
Methods inherited from interface io.vrap.rmf.base.client.ModelBase
reflectionString, reflectionString
Methods inherited from interface com.commercetools.api.models.subscription.SqsDestination
withSqsDestination
-
Constructor Details
-
SqsDestinationImpl
public SqsDestinationImpl()create empty instance
-
-
Method Details
-
getType
- Specified by:
getType
in interfaceDestination
- Returns:
- type
-
getAccessKey
Only present if
authenticationMode
is set toCredentials
.- Specified by:
getAccessKey
in interfaceSqsDestination
- Returns:
- accessKey
-
getAccessSecret
Only present if
authenticationMode
is set toCredentials
.- Specified by:
getAccessSecret
in interfaceSqsDestination
- Returns:
- accessSecret
-
getQueueUrl
URL of the Amazon SQS queue.
- Specified by:
getQueueUrl
in interfaceSqsDestination
- Returns:
- queueUrl
-
getRegion
AWS Region the message queue is located in.
- Specified by:
getRegion
in interfaceSqsDestination
- Returns:
- region
-
getAuthenticationMode
Defines the method of authentication for the SQS queue.
- Specified by:
getAuthenticationMode
in interfaceSqsDestination
- Returns:
- authenticationMode
-
setAccessKey
Description copied from interface:SqsDestination
Only present if
authenticationMode
is set toCredentials
.- Specified by:
setAccessKey
in interfaceSqsDestination
- Parameters:
accessKey
- value to be set
-
setAccessSecret
Description copied from interface:SqsDestination
Only present if
authenticationMode
is set toCredentials
.- Specified by:
setAccessSecret
in interfaceSqsDestination
- Parameters:
accessSecret
- value to be set
-
setQueueUrl
Description copied from interface:SqsDestination
URL of the Amazon SQS queue.
- Specified by:
setQueueUrl
in interfaceSqsDestination
- Parameters:
queueUrl
- value to be set
-
setRegion
Description copied from interface:SqsDestination
AWS Region the message queue is located in.
- Specified by:
setRegion
in interfaceSqsDestination
- Parameters:
region
- value to be set
-
setAuthenticationMode
Description copied from interface:SqsDestination
Defines the method of authentication for the SQS queue.
- Specified by:
setAuthenticationMode
in interfaceSqsDestination
- Parameters:
authenticationMode
- value to be set
-
equals
-
hashCode
public int hashCode()
-