aws-solutions-constructs.aws-fargate-sns 2.85.1__py3-none-any.whl → 2.85.3__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_sns/__init__.py +1 -137
  2. aws_solutions_constructs/aws_fargate_sns/_jsii/__init__.py +2 -2
  3. aws_solutions_constructs/aws_fargate_sns/_jsii/aws-fargate-sns@2.85.3.jsii.tgz +0 -0
  4. aws_solutions_constructs_aws_fargate_sns-2.85.3.dist-info/METADATA +28 -0
  5. aws_solutions_constructs_aws_fargate_sns-2.85.3.dist-info/RECORD +9 -0
  6. aws_solutions_constructs/aws_fargate_sns/_jsii/aws-fargate-sns@2.85.1.jsii.tgz +0 -0
  7. aws_solutions_constructs_aws_fargate_sns-2.85.1.dist-info/METADATA +0 -164
  8. aws_solutions_constructs_aws_fargate_sns-2.85.1.dist-info/RECORD +0 -9
  9. {aws_solutions_constructs_aws_fargate_sns-2.85.1.dist-info → aws_solutions_constructs_aws_fargate_sns-2.85.3.dist-info}/LICENSE +0 -0
  10. {aws_solutions_constructs_aws_fargate_sns-2.85.1.dist-info → aws_solutions_constructs_aws_fargate_sns-2.85.3.dist-info}/WHEEL +0 -0
  11. {aws_solutions_constructs_aws_fargate_sns-2.85.1.dist-info → aws_solutions_constructs_aws_fargate_sns-2.85.3.dist-info}/top_level.txt +0 -0
aws_solutions_constructs/aws_fargate_sns/__init__.py CHANGED
@@ -1,141 +1,5 @@
1
1
  r'''
2
- # aws-fargate-sns 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_sns`|
24
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-fargate-sns`|
25
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.fargatesns`|
26
-
27
- ## Overview
28
-
29
- This AWS Solutions Construct implements an AWS Fargate service that can write to an Amazon SNS topic
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 { FargateToSns, FargateToSnsProps } from '@aws-solutions-constructs/aws-fargate-sns';
39
-
40
- const constructProps: FargateToSnsProps = {
41
- publicApi: true,
42
- ecrRepositoryArn: "arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo"
43
- };
44
-
45
- new FargateToSns(this, 'test-construct', constructProps);
46
- ```
47
-
48
- Python
49
-
50
- ```python
51
- from aws_solutions_constructs.aws_fargate_sns import FargateToSns, FargateToSnsProps
52
- from aws_cdk import (
53
- Stack
54
- )
55
- from constructs import Construct
56
-
57
- FargateToSns(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.fargatesns.*;
70
-
71
- new FargateToSns(this, "test_construct", new FargateToSnsProps.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
- |existingTopicObj?|[sns.Topic](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sns.Topic.html)|Existing instance of SNS Topic object, providing both this and `topicProps` will cause an error.|
93
- |topicProps?|[sns.TopicProps](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sns.TopicProps.html)|Optional user provided properties to override the default properties for the SNS topic.|
94
- |topicArnEnvironmentVariableName?|string|Optional Name for the container environment variable set to the ARN of the topic. Default: SNS_TOPIC_ARN |
95
- |topicNameEnvironmentVariableName?|string|Optional Name for the container environment variable set to the name of the topic. Default: SNS_TOPIC_NAME |
96
- |enableEncryptionWithCustomerManagedKey?|`boolean`|If no key is provided, this flag determines whether the SNS Topic is encrypted with a new CMK or an AWS managed key. This flag is ignored if any of the following are defined: topicProps.masterKey, encryptionKey or encryptionKeyProps.|
97
- |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 SNS Topic with.|
98
- |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 SNS Topic with.|
99
-
100
- ## Pattern Properties
101
-
102
- | **Name** | **Type** | **Description** |
103
- |:-------------|:----------------|-----------------|
104
- | 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) |
105
- | 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) |
106
- | 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. |
107
- |snsTopic|[`sns.Topic`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sns.Topic.html)|Returns an instance of the SNS topic created by the pattern.|
108
-
109
- ## Default settings
110
-
111
- Out of the box implementation of the Construct without any override will set the following defaults:
112
-
113
- ### AWS Fargate Service
114
-
115
- * Sets up an AWS Fargate service
116
-
117
- * Uses the existing service if provided
118
- * Creates a new service if none provided.
119
-
120
- * Service will run in isolated subnets if available, then private subnets if available and finally public subnets
121
- * Adds environment variables to the container with the ARN and Name of the SNS topic
122
- * Add permissions to the container IAM role allowing it to publish to the SNS topic
123
-
124
- ### Amazon SNS Topic
125
-
126
- * Sets up an Amazon SNS topic
127
-
128
- * Uses an existing topic if one is provided, otherwise creates a new one
129
- * Adds an Interface Endpoint to the VPC for SNS (the service by default runs in Isolated or Private subnets)
130
-
131
- ## Architecture
132
-
133
- ![Architecture Diagram](architecture.png)
134
-
135
- ---
136
-
137
-
138
- © 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-sns/README.adoc)
139
3
  '''
140
4
  from pkgutil import extend_path
141
5
  __path__ = extend_path(__path__, __name__)
aws_solutions_constructs/aws_fargate_sns/_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-sns",
37
- "2.85.1",
37
+ "2.85.3",
38
38
  __name__[0:-6],
39
- "aws-fargate-sns@2.85.1.jsii.tgz",
39
+ "aws-fargate-sns@2.85.3.jsii.tgz",
40
40
  )
41
41
 
42
42
  __all__ = [
aws_solutions_constructs_aws_fargate_sns-2.85.3.dist-info/METADATA ADDED
@@ -0,0 +1,28 @@
1
+ Metadata-Version: 2.1
2
+ Name: aws-solutions-constructs.aws-fargate-sns
3
+ Version: 2.85.3
4
+ Summary: CDK Constructs for AWS Fargate to Amazon SNS 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.3
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-sns/README.adoc)
aws_solutions_constructs_aws_fargate_sns-2.85.3.dist-info/RECORD ADDED
@@ -0,0 +1,9 @@
1
+ aws_solutions_constructs/aws_fargate_sns/__init__.py,sha256=cJ5ZDdSjIPbHatAANBVH-PyNjstdxHu733wYul3RSF8,33207
2
+ aws_solutions_constructs/aws_fargate_sns/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
3
+ aws_solutions_constructs/aws_fargate_sns/_jsii/__init__.py,sha256=YvI6JQwE1ZCrOKhVshkWC252fx_e9I26jp_SjVH06TQ,1525
4
+ aws_solutions_constructs/aws_fargate_sns/_jsii/aws-fargate-sns@2.85.3.jsii.tgz,sha256=Uotmkh08MjvjVFk8-3g6Vc48r8aj4qMT3fUXaMOoybY,120375
5
+ aws_solutions_constructs_aws_fargate_sns-2.85.3.dist-info/LICENSE,sha256=wnT4A3LZDAEpNzcPDh8VCH0i4wjvmLJ86l3A0tCINmw,10279
6
+ aws_solutions_constructs_aws_fargate_sns-2.85.3.dist-info/METADATA,sha256=cbXp4SFYZhgXb-z8ZKOg1m4vy6gvpNgHgQDt0nIMCX4,1273
7
+ aws_solutions_constructs_aws_fargate_sns-2.85.3.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
8
+ aws_solutions_constructs_aws_fargate_sns-2.85.3.dist-info/top_level.txt,sha256=hi3us_KW7V1ocfOqVsNq1o3w552jCEgu_KsCckqYWsg,25
9
+ aws_solutions_constructs_aws_fargate_sns-2.85.3.dist-info/RECORD,,
aws_solutions_constructs_aws_fargate_sns-2.85.1.dist-info/METADATA DELETED
@@ -1,164 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: aws-solutions-constructs.aws-fargate-sns
3
- Version: 2.85.1
4
- Summary: CDK Constructs for AWS Fargate to Amazon SNS 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.1
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-sns 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_sns`|
50
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-fargate-sns`|
51
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.fargatesns`|
52
-
53
- ## Overview
54
-
55
- This AWS Solutions Construct implements an AWS Fargate service that can write to an Amazon SNS topic
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 { FargateToSns, FargateToSnsProps } from '@aws-solutions-constructs/aws-fargate-sns';
65
-
66
- const constructProps: FargateToSnsProps = {
67
- publicApi: true,
68
- ecrRepositoryArn: "arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo"
69
- };
70
-
71
- new FargateToSns(this, 'test-construct', constructProps);
72
- ```
73
-
74
- Python
75
-
76
- ```python
77
- from aws_solutions_constructs.aws_fargate_sns import FargateToSns, FargateToSnsProps
78
- from aws_cdk import (
79
- Stack
80
- )
81
- from constructs import Construct
82
-
83
- FargateToSns(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.fargatesns.*;
96
-
97
- new FargateToSns(this, "test_construct", new FargateToSnsProps.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
- |existingTopicObj?|[sns.Topic](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sns.Topic.html)|Existing instance of SNS Topic object, providing both this and `topicProps` will cause an error.|
119
- |topicProps?|[sns.TopicProps](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sns.TopicProps.html)|Optional user provided properties to override the default properties for the SNS topic.|
120
- |topicArnEnvironmentVariableName?|string|Optional Name for the container environment variable set to the ARN of the topic. Default: SNS_TOPIC_ARN |
121
- |topicNameEnvironmentVariableName?|string|Optional Name for the container environment variable set to the name of the topic. Default: SNS_TOPIC_NAME |
122
- |enableEncryptionWithCustomerManagedKey?|`boolean`|If no key is provided, this flag determines whether the SNS Topic is encrypted with a new CMK or an AWS managed key. This flag is ignored if any of the following are defined: topicProps.masterKey, encryptionKey or encryptionKeyProps.|
123
- |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 SNS Topic with.|
124
- |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 SNS Topic with.|
125
-
126
- ## Pattern Properties
127
-
128
- | **Name** | **Type** | **Description** |
129
- |:-------------|:----------------|-----------------|
130
- | 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) |
131
- | 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) |
132
- | 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. |
133
- |snsTopic|[`sns.Topic`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sns.Topic.html)|Returns an instance of the SNS topic created by the pattern.|
134
-
135
- ## Default settings
136
-
137
- Out of the box implementation of the Construct without any override will set the following defaults:
138
-
139
- ### AWS Fargate Service
140
-
141
- * Sets up an AWS Fargate service
142
-
143
- * Uses the existing service if provided
144
- * Creates a new service if none provided.
145
-
146
- * Service will run in isolated subnets if available, then private subnets if available and finally public subnets
147
- * Adds environment variables to the container with the ARN and Name of the SNS topic
148
- * Add permissions to the container IAM role allowing it to publish to the SNS topic
149
-
150
- ### Amazon SNS Topic
151
-
152
- * Sets up an Amazon SNS topic
153
-
154
- * Uses an existing topic if one is provided, otherwise creates a new one
155
- * Adds an Interface Endpoint to the VPC for SNS (the service by default runs in Isolated or Private subnets)
156
-
157
- ## Architecture
158
-
159
- ![Architecture Diagram](architecture.png)
160
-
161
- ---
162
-
163
-
164
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
aws_solutions_constructs_aws_fargate_sns-2.85.1.dist-info/RECORD DELETED
@@ -1,9 +0,0 @@
1
- aws_solutions_constructs/aws_fargate_sns/__init__.py,sha256=ayfAjfCT1uNtRn0BruiIrG-GCSZe1IM4VLTPUVk03gI,42180
2
- aws_solutions_constructs/aws_fargate_sns/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
3
- aws_solutions_constructs/aws_fargate_sns/_jsii/__init__.py,sha256=dMlICnixezTLxBNFV3ddqLGrmwD5eRuioUofpa6tFFg,1525
4
- aws_solutions_constructs/aws_fargate_sns/_jsii/aws-fargate-sns@2.85.1.jsii.tgz,sha256=wZJtp93OoVozhS4gjgn2L6rmEAnGa07dOK-WMInFebs,123281
5
- aws_solutions_constructs_aws_fargate_sns-2.85.1.dist-info/LICENSE,sha256=wnT4A3LZDAEpNzcPDh8VCH0i4wjvmLJ86l3A0tCINmw,10279
6
- aws_solutions_constructs_aws_fargate_sns-2.85.1.dist-info/METADATA,sha256=CJ6wS6KxSKu537_995opXZsfL3tIRXyBpIpSZK0vBZA,10246
7
- aws_solutions_constructs_aws_fargate_sns-2.85.1.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
8
- aws_solutions_constructs_aws_fargate_sns-2.85.1.dist-info/top_level.txt,sha256=hi3us_KW7V1ocfOqVsNq1o3w552jCEgu_KsCckqYWsg,25
9
- aws_solutions_constructs_aws_fargate_sns-2.85.1.dist-info/RECORD,,