aws-solutions-constructs.aws-fargate-sqs 2.85.2__py3-none-any.whl → 2.85.4__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. aws_solutions_constructs/aws_fargate_sqs/__init__.py +1 -142
  2. aws_solutions_constructs/aws_fargate_sqs/_jsii/__init__.py +2 -2
  3. aws_solutions_constructs/aws_fargate_sqs/_jsii/aws-fargate-sqs@2.85.4.jsii.tgz +0 -0
  4. aws_solutions_constructs_aws_fargate_sqs-2.85.4.dist-info/METADATA +28 -0
  5. aws_solutions_constructs_aws_fargate_sqs-2.85.4.dist-info/RECORD +9 -0
  6. aws_solutions_constructs/aws_fargate_sqs/_jsii/aws-fargate-sqs@2.85.2.jsii.tgz +0 -0
  7. aws_solutions_constructs_aws_fargate_sqs-2.85.2.dist-info/METADATA +0 -169
  8. aws_solutions_constructs_aws_fargate_sqs-2.85.2.dist-info/RECORD +0 -9
  9. {aws_solutions_constructs_aws_fargate_sqs-2.85.2.dist-info → aws_solutions_constructs_aws_fargate_sqs-2.85.4.dist-info}/LICENSE +0 -0
  10. {aws_solutions_constructs_aws_fargate_sqs-2.85.2.dist-info → aws_solutions_constructs_aws_fargate_sqs-2.85.4.dist-info}/WHEEL +0 -0
  11. {aws_solutions_constructs_aws_fargate_sqs-2.85.2.dist-info → aws_solutions_constructs_aws_fargate_sqs-2.85.4.dist-info}/top_level.txt +0 -0
aws_solutions_constructs/aws_fargate_sqs/__init__.py CHANGED
@@ -1,146 +1,5 @@
1
1
  r'''
2
- # aws-fargate-sqs module
3
-
4
- <!--BEGIN STABILITY BANNER-->---
5
-
6
-
7
- ![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
8
-
9
- > All classes are under active development and subject to non-backward compatible changes or removal in any
10
- > future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
11
- > 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.
12
-
13
- ---
14
- <!--END STABILITY BANNER-->
15
-
16
- | **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
17
- |:-------------|:-------------|
18
-
19
- <div style="height:8px"></div>
20
-
21
- | **Language** | **Package** |
22
- |:-------------|-----------------|
23
- |![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_fargate_sqs`|
24
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-fargate-sqs`|
25
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.fargatesqs`|
26
-
27
- ## Overview
28
-
29
- This AWS Solutions Construct implements an AWS Fargate service that can write to an Amazon SQS queue
30
-
31
- Here is a minimal deployable pattern definition:
32
-
33
- Typescript
34
-
35
- ```python
36
- import { Construct } from 'constructs';
37
- import { Stack, StackProps } from 'aws-cdk-lib';
38
- import { FargateToSqs, FargateToSqsProps } from '@aws-solutions-constructs/aws-fargate-sqs';
39
-
40
- const constructProps: FargateToSqsProps = {
41
- publicApi: true,
42
- ecrRepositoryArn: "arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo"
43
- };
44
-
45
- new FargateToSqs(this, 'test-construct', constructProps);
46
- ```
47
-
48
- Python
49
-
50
- ```python
51
- from aws_solutions_constructs.aws_fargate_sqs import FargateToSqs, FargateToSqsProps
52
- from aws_cdk import (
53
- Stack
54
- )
55
- from constructs import Construct
56
-
57
- FargateToSqs(self, 'test_construct',
58
- public_api=True,
59
- ecr_repository_arn="arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo")
60
- ```
61
-
62
- Java
63
-
64
- ```java
65
- import software.constructs.Construct;
66
-
67
- import software.amazon.awscdk.Stack;
68
- import software.amazon.awscdk.StackProps;
69
- import software.amazon.awsconstructs.services.fargatesqs.*;
70
-
71
- new FargateToSqs(this, "test_construct", new FargateToSqsProps.Builder()
72
- .publicApi(true)
73
- .ecrRepositoryArn("arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo")
74
- .build());
75
- ```
76
-
77
- ## Pattern Construct Props
78
-
79
- | **Name** | **Type** | **Description** |
80
- |:-------------|:----------------|-----------------|
81
- | publicApi | boolean | Whether the construct is deploying a private or public API. This has implications for the VPC. |
82
- | vpcProps? | [ec2.VpcProps](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.VpcProps.html) | Optional 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. |
83
- | existingVpc? | [ec2.IVpc](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | An 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. |
84
- | clusterProps? | [ecs.ClusterProps](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ClusterProps.html) | Optional properties to create a new ECS cluster. To provide an existing cluster, use the cluster attribute of fargateServiceProps. |
85
- | ecrRepositoryArn? | string | The 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 Name* |
86
- | ecrImageVersion? | string | The version of the image to use from the repository. Defaults to 'Latest' |
87
- | containerDefinitionProps? | [ecs.ContainerDefinitionProps | any](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinitionProps.html) | Optional props to define the container created for the Fargate Service (defaults found in fargate-defaults.ts) |
88
- | fargateTaskDefinitionProps? | [ecs.FargateTaskDefinitionProps | any](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateTaskDefinitionProps.html) | Optional props to define the Fargate Task Definition for this construct (defaults found in fargate-defaults.ts) |
89
- | fargateServiceProps? | [ecs.FargateServiceProps | any](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateServiceProps.html) | Optional values to override default Fargate Task definition properties (fargate-defaults.ts). The construct will default to launching the service is the most isolated subnets available (precedence: Isolated, Private and Public). Override those and other defaults here. |
90
- | existingFargateServiceObject? | [ecs.FargateService](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateService.html) | A 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, clusterProps |
91
- | existingContainerDefinitionObject? | [ecs.ContainerDefinition](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinition.html) | A container definition already instantiated as part of a Fargate service. This must be the container in the existingFargateServiceObject |
92
- |existingQueueObj?|[sqs.Queue](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|An optional, existing SQS queue to be used instead of the default queue. Providing both this and queueProps will cause an error.|
93
- |queueProps?|[sqs.QueueProps](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|Optional user-provided properties to override the default properties for the SQS queue.|
94
- |deployDeadLetterQueue?|boolean|Whether to create a secondary queue to be used as a dead letter queue. Defaults to `true`.|
95
- |deadLetterQueueProps?|[sqs.QueueProps](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|Optional user-provided props to override the default props for the dead letter queue. Only used if the `deployDeadLetterQueue` property is set to true.|
96
- |maxReceiveCount?|integer|The number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue. Defaults to `15`.|
97
- |queueUrlEnvironmentVariableName?|string|Optional Name for the container environment variable set to the URL of the queue. Default: SQS_QUEUE_URL |
98
- |queueArnEnvironmentVariableName?|string|Optional Name for the container environment variable set to the arn of the queue. Default: SQS_QUEUE_ARN |
99
- |queuePermissions?|`string[]`|Optional queue permissions to grant to the Fargate service. One or more of the following may be specified: `Read`,`Write`. Default is `Write`|
100
- |enableEncryptionWithCustomerManagedKey?|`boolean`|If 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.|
101
- |encryptionKey?|[`kms.Key`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html)|An optional, imported encryption key to encrypt the SQS Queue with.|
102
- |encryptionKeyProps?|[`kms.KeyProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html#construct-props)|Optional user provided properties to override the default properties for the KMS encryption key used to encrypt the SQS queue with.|
103
-
104
- ## Pattern Properties
105
-
106
- | **Name** | **Type** | **Description** |
107
- |:-------------|:----------------|-----------------|
108
- | vpc | [ec2.IVpc](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | The VPC used by the construct (whether created by the construct or provided by the client) |
109
- | service | [ecs.FargateService](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateService.html) | The AWS Fargate service used by this construct (whether created by this construct or passed to this construct at initialization) |
110
- | container | [ecs.ContainerDefinition](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinition.html) | The container associated with the AWS Fargate service in the service property. |
111
- |sqsQueue|[sqs.Queue](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of the SQS queue created by the pattern. |
112
- |deadLetterQueue?|[sqs.Queue](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of the dead letter queue created by the pattern, if one is deployed.|
113
-
114
- ## Default settings
115
-
116
- Out of the box implementation of the Construct without any override will set the following defaults:
117
-
118
- ### AWS Fargate Service
119
-
120
- * Sets up an AWS Fargate service
121
-
122
- * Uses the existing service if provided
123
- * Creates a new service if none provided.
124
-
125
- * Service will run in isolated subnets if available, then private subnets if available and finally public subnets
126
- * Adds environment variables to the container with the name of the SQS queue
127
- * Add permissions to the container IAM role allowing it to publish to the SQS queue
128
-
129
- ### Amazon SQS Queue
130
-
131
- * Sets up an Amazon SQS queue
132
-
133
- * Uses an existing queue if one is provided, otherwise creates a new one
134
- * Adds an Interface Endpoint to the VPC for SQS (the service by default runs in Isolated or Private subnets)
135
-
136
- ## Architecture
137
-
138
- ![Architecture Diagram](architecture.png)
139
-
140
- ---
141
-
142
-
143
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2
+ Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-fargate-sqs/README.adoc)
144
3
  '''
145
4
  from pkgutil import extend_path
146
5
  __path__ = extend_path(__path__, __name__)
aws_solutions_constructs/aws_fargate_sqs/_jsii/__init__.py CHANGED
@@ -34,9 +34,9 @@ import constructs._jsii
34
34
 
35
35
  __jsii_assembly__ = jsii.JSIIAssembly.load(
36
36
  "@aws-solutions-constructs/aws-fargate-sqs",
37
- "2.85.2",
37
+ "2.85.4",
38
38
  __name__[0:-6],
39
- "aws-fargate-sqs@2.85.2.jsii.tgz",
39
+ "aws-fargate-sqs@2.85.4.jsii.tgz",
40
40
  )
41
41
 
42
42
  __all__ = [
aws_solutions_constructs_aws_fargate_sqs-2.85.4.dist-info/METADATA ADDED
@@ -0,0 +1,28 @@
1
+ Metadata-Version: 2.1
2
+ Name: aws-solutions-constructs.aws-fargate-sqs
3
+ Version: 2.85.4
4
+ Summary: CDK Constructs for AWS Fargate to Amazon SQS integration
5
+ Home-page: https://github.com/awslabs/aws-solutions-constructs.git
6
+ Author: Amazon Web Services
7
+ License: Apache-2.0
8
+ Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
9
+ Classifier: Intended Audience :: Developers
10
+ Classifier: Operating System :: OS Independent
11
+ Classifier: Programming Language :: JavaScript
12
+ Classifier: Programming Language :: Python :: 3 :: Only
13
+ Classifier: Programming Language :: Python :: 3.9
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Typing :: Typed
17
+ Classifier: License :: OSI Approved
18
+ Requires-Python: ~=3.9
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Requires-Dist: aws-cdk-lib<3.0.0,>=2.193.0
22
+ Requires-Dist: aws-solutions-constructs.core==2.85.4
23
+ Requires-Dist: constructs<11.0.0,>=10.0.0
24
+ Requires-Dist: jsii<2.0.0,>=1.111.0
25
+ Requires-Dist: publication>=0.0.3
26
+ Requires-Dist: typeguard<4.3.0,>=2.13.3
27
+
28
+ Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-fargate-sqs/README.adoc)
aws_solutions_constructs_aws_fargate_sqs-2.85.4.dist-info/RECORD ADDED
@@ -0,0 +1,9 @@
1
+ aws_solutions_constructs/aws_fargate_sqs/__init__.py,sha256=fKU-aw6mL9QcmqAoN7hAMbusQSASnChcWlz_pZwTQQE,39431
2
+ aws_solutions_constructs/aws_fargate_sqs/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
3
+ aws_solutions_constructs/aws_fargate_sqs/_jsii/__init__.py,sha256=EJjIzWkRv8zf8pBsLPL6iBuoEEp9GrrlbMQ2jGNPdrY,1525
4
+ aws_solutions_constructs/aws_fargate_sqs/_jsii/aws-fargate-sqs@2.85.4.jsii.tgz,sha256=vnwbGBfycJd3pRFb2Hdo3GIStancSYwLVi_T0F9ji2Y,166646
5
+ aws_solutions_constructs_aws_fargate_sqs-2.85.4.dist-info/LICENSE,sha256=wnT4A3LZDAEpNzcPDh8VCH0i4wjvmLJ86l3A0tCINmw,10279
6
+ aws_solutions_constructs_aws_fargate_sqs-2.85.4.dist-info/METADATA,sha256=f_jGvN-C0p0BX-12LMReKD0IAd1EM4i8noU4GQkeLyY,1273
7
+ aws_solutions_constructs_aws_fargate_sqs-2.85.4.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
8
+ aws_solutions_constructs_aws_fargate_sqs-2.85.4.dist-info/top_level.txt,sha256=hi3us_KW7V1ocfOqVsNq1o3w552jCEgu_KsCckqYWsg,25
9
+ aws_solutions_constructs_aws_fargate_sqs-2.85.4.dist-info/RECORD,,
aws_solutions_constructs_aws_fargate_sqs-2.85.2.dist-info/METADATA DELETED
@@ -1,169 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: aws-solutions-constructs.aws-fargate-sqs
3
- Version: 2.85.2
4
- Summary: CDK Constructs for AWS Fargate to Amazon SQS integration
5
- Home-page: https://github.com/awslabs/aws-solutions-constructs.git
6
- Author: Amazon Web Services
7
- License: Apache-2.0
8
- Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
9
- Classifier: Intended Audience :: Developers
10
- Classifier: Operating System :: OS Independent
11
- Classifier: Programming Language :: JavaScript
12
- Classifier: Programming Language :: Python :: 3 :: Only
13
- Classifier: Programming Language :: Python :: 3.9
14
- Classifier: Programming Language :: Python :: 3.10
15
- Classifier: Programming Language :: Python :: 3.11
16
- Classifier: Typing :: Typed
17
- Classifier: License :: OSI Approved
18
- Requires-Python: ~=3.9
19
- Description-Content-Type: text/markdown
20
- License-File: LICENSE
21
- Requires-Dist: aws-cdk-lib<3.0.0,>=2.193.0
22
- Requires-Dist: aws-solutions-constructs.core==2.85.2
23
- Requires-Dist: constructs<11.0.0,>=10.0.0
24
- Requires-Dist: jsii<2.0.0,>=1.111.0
25
- Requires-Dist: publication>=0.0.3
26
- Requires-Dist: typeguard<4.3.0,>=2.13.3
27
-
28
- # aws-fargate-sqs module
29
-
30
- <!--BEGIN STABILITY BANNER-->---
31
-
32
-
33
- ![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
34
-
35
- > All classes are under active development and subject to non-backward compatible changes or removal in any
36
- > future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
37
- > 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.
38
-
39
- ---
40
- <!--END STABILITY BANNER-->
41
-
42
- | **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
43
- |:-------------|:-------------|
44
-
45
- <div style="height:8px"></div>
46
-
47
- | **Language** | **Package** |
48
- |:-------------|-----------------|
49
- |![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_fargate_sqs`|
50
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-fargate-sqs`|
51
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.fargatesqs`|
52
-
53
- ## Overview
54
-
55
- This AWS Solutions Construct implements an AWS Fargate service that can write to an Amazon SQS queue
56
-
57
- Here is a minimal deployable pattern definition:
58
-
59
- Typescript
60
-
61
- ```python
62
- import { Construct } from 'constructs';
63
- import { Stack, StackProps } from 'aws-cdk-lib';
64
- import { FargateToSqs, FargateToSqsProps } from '@aws-solutions-constructs/aws-fargate-sqs';
65
-
66
- const constructProps: FargateToSqsProps = {
67
- publicApi: true,
68
- ecrRepositoryArn: "arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo"
69
- };
70
-
71
- new FargateToSqs(this, 'test-construct', constructProps);
72
- ```
73
-
74
- Python
75
-
76
- ```python
77
- from aws_solutions_constructs.aws_fargate_sqs import FargateToSqs, FargateToSqsProps
78
- from aws_cdk import (
79
- Stack
80
- )
81
- from constructs import Construct
82
-
83
- FargateToSqs(self, 'test_construct',
84
- public_api=True,
85
- ecr_repository_arn="arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo")
86
- ```
87
-
88
- Java
89
-
90
- ```java
91
- import software.constructs.Construct;
92
-
93
- import software.amazon.awscdk.Stack;
94
- import software.amazon.awscdk.StackProps;
95
- import software.amazon.awsconstructs.services.fargatesqs.*;
96
-
97
- new FargateToSqs(this, "test_construct", new FargateToSqsProps.Builder()
98
- .publicApi(true)
99
- .ecrRepositoryArn("arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo")
100
- .build());
101
- ```
102
-
103
- ## Pattern Construct Props
104
-
105
- | **Name** | **Type** | **Description** |
106
- |:-------------|:----------------|-----------------|
107
- | publicApi | boolean | Whether the construct is deploying a private or public API. This has implications for the VPC. |
108
- | vpcProps? | [ec2.VpcProps](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.VpcProps.html) | Optional 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. |
109
- | existingVpc? | [ec2.IVpc](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | An 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. |
110
- | clusterProps? | [ecs.ClusterProps](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ClusterProps.html) | Optional properties to create a new ECS cluster. To provide an existing cluster, use the cluster attribute of fargateServiceProps. |
111
- | ecrRepositoryArn? | string | The 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 Name* |
112
- | ecrImageVersion? | string | The version of the image to use from the repository. Defaults to 'Latest' |
113
- | containerDefinitionProps? | [ecs.ContainerDefinitionProps | any](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinitionProps.html) | Optional props to define the container created for the Fargate Service (defaults found in fargate-defaults.ts) |
114
- | fargateTaskDefinitionProps? | [ecs.FargateTaskDefinitionProps | any](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateTaskDefinitionProps.html) | Optional props to define the Fargate Task Definition for this construct (defaults found in fargate-defaults.ts) |
115
- | fargateServiceProps? | [ecs.FargateServiceProps | any](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateServiceProps.html) | Optional values to override default Fargate Task definition properties (fargate-defaults.ts). The construct will default to launching the service is the most isolated subnets available (precedence: Isolated, Private and Public). Override those and other defaults here. |
116
- | existingFargateServiceObject? | [ecs.FargateService](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateService.html) | A 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, clusterProps |
117
- | existingContainerDefinitionObject? | [ecs.ContainerDefinition](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinition.html) | A container definition already instantiated as part of a Fargate service. This must be the container in the existingFargateServiceObject |
118
- |existingQueueObj?|[sqs.Queue](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|An optional, existing SQS queue to be used instead of the default queue. Providing both this and queueProps will cause an error.|
119
- |queueProps?|[sqs.QueueProps](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|Optional user-provided properties to override the default properties for the SQS queue.|
120
- |deployDeadLetterQueue?|boolean|Whether to create a secondary queue to be used as a dead letter queue. Defaults to `true`.|
121
- |deadLetterQueueProps?|[sqs.QueueProps](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|Optional user-provided props to override the default props for the dead letter queue. Only used if the `deployDeadLetterQueue` property is set to true.|
122
- |maxReceiveCount?|integer|The number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue. Defaults to `15`.|
123
- |queueUrlEnvironmentVariableName?|string|Optional Name for the container environment variable set to the URL of the queue. Default: SQS_QUEUE_URL |
124
- |queueArnEnvironmentVariableName?|string|Optional Name for the container environment variable set to the arn of the queue. Default: SQS_QUEUE_ARN |
125
- |queuePermissions?|`string[]`|Optional queue permissions to grant to the Fargate service. One or more of the following may be specified: `Read`,`Write`. Default is `Write`|
126
- |enableEncryptionWithCustomerManagedKey?|`boolean`|If 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.|
127
- |encryptionKey?|[`kms.Key`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html)|An optional, imported encryption key to encrypt the SQS Queue with.|
128
- |encryptionKeyProps?|[`kms.KeyProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html#construct-props)|Optional user provided properties to override the default properties for the KMS encryption key used to encrypt the SQS queue with.|
129
-
130
- ## Pattern Properties
131
-
132
- | **Name** | **Type** | **Description** |
133
- |:-------------|:----------------|-----------------|
134
- | vpc | [ec2.IVpc](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | The VPC used by the construct (whether created by the construct or provided by the client) |
135
- | service | [ecs.FargateService](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateService.html) | The AWS Fargate service used by this construct (whether created by this construct or passed to this construct at initialization) |
136
- | container | [ecs.ContainerDefinition](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinition.html) | The container associated with the AWS Fargate service in the service property. |
137
- |sqsQueue|[sqs.Queue](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of the SQS queue created by the pattern. |
138
- |deadLetterQueue?|[sqs.Queue](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of the dead letter queue created by the pattern, if one is deployed.|
139
-
140
- ## Default settings
141
-
142
- Out of the box implementation of the Construct without any override will set the following defaults:
143
-
144
- ### AWS Fargate Service
145
-
146
- * Sets up an AWS Fargate service
147
-
148
- * Uses the existing service if provided
149
- * Creates a new service if none provided.
150
-
151
- * Service will run in isolated subnets if available, then private subnets if available and finally public subnets
152
- * Adds environment variables to the container with the name of the SQS queue
153
- * Add permissions to the container IAM role allowing it to publish to the SQS queue
154
-
155
- ### Amazon SQS Queue
156
-
157
- * Sets up an Amazon SQS queue
158
-
159
- * Uses an existing queue if one is provided, otherwise creates a new one
160
- * Adds an Interface Endpoint to the VPC for SQS (the service by default runs in Isolated or Private subnets)
161
-
162
- ## Architecture
163
-
164
- ![Architecture Diagram](architecture.png)
165
-
166
- ---
167
-
168
-
169
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
aws_solutions_constructs_aws_fargate_sqs-2.85.2.dist-info/RECORD DELETED
@@ -1,9 +0,0 @@
1
- aws_solutions_constructs/aws_fargate_sqs/__init__.py,sha256=CH6P5kDkdGKkm6p1MriO8aGzoi719i46jcIgWfxow_Q,49348
2
- aws_solutions_constructs/aws_fargate_sqs/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
3
- aws_solutions_constructs/aws_fargate_sqs/_jsii/__init__.py,sha256=uemffbViJiWgzTJqkwtNBIeEYSuZlLyhi2Rg5_ao_vw,1525
4
- aws_solutions_constructs/aws_fargate_sqs/_jsii/aws-fargate-sqs@2.85.2.jsii.tgz,sha256=COt0NouzExgWXrFdbQXf-4D3_YhiynvyfazoXC7h-Rk,169426
5
- aws_solutions_constructs_aws_fargate_sqs-2.85.2.dist-info/LICENSE,sha256=wnT4A3LZDAEpNzcPDh8VCH0i4wjvmLJ86l3A0tCINmw,10279
6
- aws_solutions_constructs_aws_fargate_sqs-2.85.2.dist-info/METADATA,sha256=tFXRiRDaDJxsxSr2_MkjZfDp0SvEvL1DrHU34zlPaDo,11190
7
- aws_solutions_constructs_aws_fargate_sqs-2.85.2.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
8
- aws_solutions_constructs_aws_fargate_sqs-2.85.2.dist-info/top_level.txt,sha256=hi3us_KW7V1ocfOqVsNq1o3w552jCEgu_KsCckqYWsg,25
9
- aws_solutions_constructs_aws_fargate_sqs-2.85.2.dist-info/RECORD,,