-
Notifications
You must be signed in to change notification settings - Fork 249
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(aws-fargate-sns): New Construct (#574)
* Initial upload * cfn_nag issue * README updates and fixes * Additional tests, Self review items * Better variable names * respond to comments * Respond to comments
- Loading branch information
Showing
18 changed files
with
3,402 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 4 additions & 0 deletions
4
source/patterns/@aws-solutions-constructs/aws-fargate-sns/.eslintignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| lib/*.js | ||
| test/*.js | ||
| *.d.ts | ||
| coverage |
15 changes: 15 additions & 0 deletions
15
source/patterns/@aws-solutions-constructs/aws-fargate-sns/.gitignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| lib/*.js | ||
| test/*.js | ||
| *.js.map | ||
| *.d.ts | ||
| node_modules | ||
| *.generated.ts | ||
| dist | ||
| .jsii | ||
|
|
||
| .LAST_BUILD | ||
| .nyc_output | ||
| coverage | ||
| .nycrc | ||
| .LAST_PACKAGE | ||
| *.snk |
21 changes: 21 additions & 0 deletions
21
source/patterns/@aws-solutions-constructs/aws-fargate-sns/.npmignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Exclude typescript source and config | ||
| *.ts | ||
| tsconfig.json | ||
| coverage | ||
| .nyc_output | ||
| *.tgz | ||
| *.snk | ||
| *.tsbuildinfo | ||
|
|
||
| # Include javascript files and typescript declarations | ||
| !*.js | ||
| !*.d.ts | ||
|
|
||
| # Exclude jsii outdir | ||
| dist | ||
|
|
||
| # Include .jsii | ||
| !.jsii | ||
|
|
||
| # Include .jsii | ||
| !.jsii |
109 changes: 109 additions & 0 deletions
109
source/patterns/@aws-solutions-constructs/aws-fargate-sns/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| # aws-fargate-sns module | ||
| <!--BEGIN STABILITY BANNER--> | ||
|
|
||
| --- | ||
|
|
||
|  | ||
|
|
||
| > All classes are under active development and subject to non-backward compatible changes or removal in any | ||
| > future version. These are not subject to the [Semantic Versioning](https://semver.org/) model. | ||
| > 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. | ||
| --- | ||
| <!--END STABILITY BANNER--> | ||
|
|
||
| | **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>| | ||
| |:-------------|:-------------| | ||
| <div style="height:8px"></div> | ||
|
|
||
| | **Language** | **Package** | | ||
| |:-------------|-----------------| | ||
| | Python|`aws_solutions_constructs.aws_fargate_sns`| | ||
| | Typescript|`@aws-solutions-constructs/aws-fargate-sns`| | ||
| | Java|`software.amazon.awsconstructs.services.fargatesns`| | ||
|
|
||
| This AWS Solutions Construct implements an AWS Fargate service that can write to an Amazon SNS topic | ||
|
|
||
| Here is a minimal deployable pattern definition in Typescript: | ||
|
|
||
| ``` typescript | ||
| import { FargateToSns, FargateToSnsProps } from '@aws-solutions-constructs/aws-fargate-sns'; | ||
|
|
||
| // Obtain a pre-existing certificate from your account | ||
| const certificate = acm.Certificate.fromCertificateArn( | ||
| scope, | ||
| 'existing-cert', | ||
| "arn:aws:acm:us-east-1:123456789012:certificate/11112222-3333-1234-1234-123456789012" | ||
| ); | ||
|
|
||
| const props: FargateToSnsProps = { | ||
| publicApi: true, | ||
| ecrRepositoryArn: "arn of a repo in ECR in your account", | ||
| }); | ||
|
|
||
| new FargateToSns(stack, 'test-construct', props); | ||
| ``` | ||
|
|
||
| ## Initializer | ||
|
|
||
| ``` text | ||
| new FargateToSns(scope: Construct, id: string, props: FargateToSnsProps); | ||
| ``` | ||
|
|
||
| _Parameters_ | ||
|
|
||
| * scope [`Construct`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.Construct.html) | ||
| * id `string` | ||
| * props [`FargateToSnsProps`](#pattern-construct-props) | ||
|
|
||
| ## Pattern Construct Props | ||
|
|
||
| | **Name** | **Type** | **Description** | | ||
| |:-------------|:----------------|-----------------| | ||
| | publicApi | boolean | Whether the construct is deploying a private or public API. This has implications for the VPC and ALB. | | ||
| | vpcProps? | [ec2.VpcProps](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.VpcProps.html) | Optional custom properties for a VPC the construct will create. This VPC will be used by the new ALB and 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.IVpc](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_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. | | ||
| | clusterProps? | [ecs.ClusterProps](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-ecs.ClusterProps.html) | Optional properties to create a new ECS cluster. To provide an existing cluster, use the cluster attribute of fargateServiceProps. | | ||
| | 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* | | ||
| | ecrImageVersion? | string | The version of the image to use from the repository. Defaults to 'Latest' | | ||
| | containerDefinitionProps? | [ecs.ContainerDefinitionProps \| any](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-ecs.ContainerDefinitionProps.html) | Optional props to define the container created for the Fargate Service (defaults found in fargate-defaults.ts) | | ||
| | fargateTaskDefinitionProps? | [ecs.FargateTaskDefinitionProps \| any](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-ecs.FargateTaskDefinitionProps.html) | Optional props to define the Fargate Task Definition for this construct (defaults found in fargate-defaults.ts) | | ||
| | fargateServiceProps? | [ecs.FargateServiceProps \| any](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_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. | | ||
| | existingFargateServiceObject? | [ecs.FargateService](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_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: existingImageObject, ecrImageVersion, containerDefintionProps, fargateTaskDefinitionProps, ecrRepositoryArn, fargateServiceProps, clusterProps, existingClusterInterface | | ||
| | existingContainerDefinitionObject? | [ecs.ContainerDefinition](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-ecs.ContainerDefinition.html) | A container definition already instantiated as part of a Fargate service. This must be the container in the existingFargateServiceObject | | ||
| |existingTopicObj?|[sns.Topic](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-sns.Topic.html)|Existing instance of SNS Topic object, providing both this and `topicProps` will cause an error.| | ||
| |topicProps?|[sns.TopicProps](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sns.TopicProps.html)|Optional user provided properties to override the default properties for the SNS topic.| | ||
| |topicArnEnvironmentVariableName?|string|Optional Name for the SNS topic arn environment variable set for the container.| | ||
| |topicNameEnvironmentVariableName?|string|Optional Name for the SNS topic name environment variable set for the container.| | ||
|
|
||
| ## Pattern Properties | ||
|
|
||
| | **Name** | **Type** | **Description** | | ||
| |:-------------|:----------------|-----------------| | ||
| | vpc | [ec2.IVpc](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.IVpc.html) | The VPC used by the construct (whether created by the construct or providedb by the client) | | ||
| | service | [ecs.FargateService](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-ecs.FargateService.html) | The AWS Fargate service used by this construct (whether created by this construct or passed to this construct at initialization) | | ||
| | container | [ecs.ContainerDefinition](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-ecs.ContainerDefinition.html) | The container associated with the AWS Fargate service in the service property. | | ||
| |snsTopic|[`sns.Topic`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sns.Topic.html)|Returns an instance of the SNS topic created by the pattern.| | ||
|
|
||
| ## Default settings | ||
|
|
||
| Out of the box implementation of the Construct without any override will set the following defaults: | ||
|
|
||
| ### AWS Fargate Service | ||
| * Sets up an AWS Fargate service | ||
| * Uses the existing service if provided | ||
| * Creates a new service if none provided. | ||
| * Service will run in isolated subnets if available, then private subnets if available and finally public subnets | ||
| * Adds environment variables to the container with the ARN and Name of the SNS topic | ||
| * Add permissions to the container IAM role allowing it to publish to the SNS topic | ||
|
|
||
| ### Amazon SNS Topic | ||
| * Sets up an Amazon SNS topic | ||
| * Uses an existing topic if one is provided, otherwise creates a new one | ||
| * Adds an Interface Endpoint to the VPC for SNS (the service by default runs in Isolated or Private subnets) | ||
|
|
||
| ## Architecture | ||
|  | ||
|
|
||
| *** | ||
| © Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. |
Binary file added
BIN
+68.8 KB
source/patterns/@aws-solutions-constructs/aws-fargate-sns/architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.