Package: aws-solutions-constructs.aws-fargate-sqs
aws-fargate-sqs module---All classes are under active development and subject to non-backward compatible changes or removal in any
future version. These are not subject to theSemantic Versioningmodel.
This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.Reference Documentation:https://docs.aws.amazon.com/solutions/latest/constructs/LanguagePackagePythonaws_solutions_constructs.aws_fargate_sqsTypescript@aws-solutions-constructs/aws-fargate-sqsJavasoftware.amazon.awsconstructs.services.fargatesqsOverviewThis AWS Solutions Construct implements an AWS Fargate service that can write to an Amazon SQS queueHere is a minimal deployable pattern definition:Typescriptimport{Construct}from'constructs';import{Stack,StackProps}from'aws-cdk-lib';import{FargateToSqs,FargateToSqsProps}from'@aws-solutions-constructs/aws-fargate-sqs';constconstructProps:FargateToSqsProps={publicApi:true,ecrRepositoryArn:"arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo"};newFargateToSqs(this,'test-construct',constructProps);Pythonfromaws_solutions_constructs.aws_fargate_sqsimportFargateToSqs,FargateToSqsPropsfromaws_cdkimport(Stack)fromconstructsimportConstructFargateToSqs(self,'test_construct',public_api=True,ecr_repository_arn="arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo")Javaimportsoftware.constructs.Construct;importsoftware.amazon.awscdk.Stack;importsoftware.amazon.awscdk.StackProps;importsoftware.amazon.awsconstructs.services.fargatesqs.*;newFargateToSqs(this,"test_construct",newFargateToSqsProps.Builder().publicApi(true).ecrRepositoryArn("arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo").build());Pattern Construct PropsNameTypeDescriptionpublicApibooleanWhether the construct is deploying a private or public API. This has implications for the VPC.vpcProps?ec2.VpcPropsOptional custom properties for a VPC the construct will create. This VPC will be used by any Private Hosted Zone the construct creates (that's why loadBalancerProps and privateHostedZoneProps can't include a VPC). Providing both this and existingVpc is an error.existingVpc?ec2.IVpcAn existing VPC in which to deploy the construct. Providing both this and vpcProps is an error. If the client provides an existing load balancer and/or existing Private Hosted Zone, those constructs must exist in this VPC.clusterProps?ecs.ClusterPropsOptional properties to create a new ECS cluster. To provide an existing cluster, use the cluster attribute of fargateServiceProps.ecrRepositoryArn?stringThe arn of an ECR Repository containing the image to use to generate the containers. Either this or the image property of containerDefinitionProps must be provided. format: arn:aws:ecr:region:account number:repository/Repository NameecrImageVersion?stringThe version of the image to use from the repository. Defaults to 'Latest'containerDefinitionProps?[ecs.ContainerDefinitionPropsany](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinitionProps.html)fargateTaskDefinitionProps?[ecs.FargateTaskDefinitionPropsany](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateTaskDefinitionProps.html)fargateServiceProps?[ecs.FargateServicePropsany](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateServiceProps.html)existingFargateServiceObject?ecs.FargateServiceA Fargate Service already instantiated (probably by another Solutions Construct). If this is specified, then no props defining a new service can be provided, including: ecrImageVersion, containerDefinitionProps, fargateTaskDefinitionProps, ecrRepositoryArn, fargateServiceProps, clusterPropsexistingContainerDefinitionObject?ecs.ContainerDefinitionA container definition already instantiated as part of a Fargate service. This must be the container in the existingFargateServiceObjectexistingQueueObj?sqs.QueueAn optional, existing SQS queue to be used instead of the default queue. Providing both this and queueProps will cause an error.queueProps?sqs.QueuePropsOptional user-provided properties to override the default properties for the SQS queue.deployDeadLetterQueue?booleanWhether to create a secondary queue to be used as a dead letter queue. Defaults totrue.deadLetterQueueProps?sqs.QueuePropsOptional user-provided props to override the default props for the dead letter queue. Only used if thedeployDeadLetterQueueproperty is set to true.maxReceiveCount?integerThe number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue. Defaults to15.queueUrlEnvironmentVariableName?stringOptional Name for the container environment variable set to the URL of the queue. Default: SQS_QUEUE_URLqueueArnEnvironmentVariableName?stringOptional Name for the container environment variable set to the arn of the queue. Default: SQS_QUEUE_ARNqueuePermissions?string[]Optional queue permissions to grant to the Fargate service. One or more of the following may be specified:Read,Write. Default isWriteenableEncryptionWithCustomerManagedKey?booleanIf no key is provided, this flag determines whether the queue is encrypted with a new CMK or an AWS managed key. This flag is ignored if any of the following are defined: queueProps.encryptionMasterKey, encryptionKey or encryptionKeyProps.encryptionKey?kms.KeyAn optional, imported encryption key to encrypt the SQS Queue with.encryptionKeyProps?kms.KeyPropsOptional user provided properties to override the default properties for the KMS encryption key used to encrypt the SQS queue with.Pattern PropertiesNameTypeDescriptionvpcec2.IVpcThe VPC used by the construct (whether created by the construct or provided by the client)serviceecs.FargateServiceThe AWS Fargate service used by this construct (whether created by this construct or passed to this construct at initialization)containerecs.ContainerDefinitionThe container associated with the AWS Fargate service in the service property.sqsQueuesqs.QueueReturns an instance of the SQS queue created by the pattern.deadLetterQueue?sqs.QueueReturns an instance of the dead letter queue created by the pattern, if one is deployed.Default settingsOut of the box implementation of the Construct without any override will set the following defaults:AWS Fargate ServiceSets up an AWS Fargate serviceUses the existing service if providedCreates a new service if none provided.Service will run in isolated subnets if available, then private subnets if available and finally public subnetsAdds environment variables to the container with the name of the SQS queueAdd permissions to the container IAM role allowing it to publish to the SQS queueAmazon SQS QueueSets up an Amazon SQS queueUses an existing queue if one is provided, otherwise creates a new oneAdds an Interface Endpoint to the VPC for SQS (the service by default runs in Isolated or Private subnets)Architecture© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.