aws-solutions-constructs.aws-fargate-ssmstringparameter 2.85.2__tar.gz → 2.85.4__tar.gz

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 (20) hide show
  1. aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4/PKG-INFO +28 -0
  2. aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4/README.md +1 -0
  3. {aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2 → aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4}/setup.py +3 -3
  4. {aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2 → aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4}/src/aws_solutions_constructs/aws_fargate_ssmstringparameter/__init__.py +1 -142
  5. {aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2 → aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4}/src/aws_solutions_constructs/aws_fargate_ssmstringparameter/_jsii/__init__.py +2 -2
  6. aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4/src/aws_solutions_constructs/aws_fargate_ssmstringparameter/_jsii/aws-fargate-ssmstringparameter@2.85.4.jsii.tgz +0 -0
  7. aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4/src/aws_solutions_constructs.aws_fargate_ssmstringparameter.egg-info/PKG-INFO +28 -0
  8. {aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2 → aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4}/src/aws_solutions_constructs.aws_fargate_ssmstringparameter.egg-info/SOURCES.txt +1 -1
  9. {aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2 → aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4}/src/aws_solutions_constructs.aws_fargate_ssmstringparameter.egg-info/requires.txt +1 -1
  10. aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2/PKG-INFO +0 -169
  11. aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2/README.md +0 -142
  12. aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2/src/aws_solutions_constructs/aws_fargate_ssmstringparameter/_jsii/aws-fargate-ssmstringparameter@2.85.2.jsii.tgz +0 -0
  13. aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2/src/aws_solutions_constructs.aws_fargate_ssmstringparameter.egg-info/PKG-INFO +0 -169
  14. {aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2 → aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4}/LICENSE +0 -0
  15. {aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2 → aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4}/MANIFEST.in +0 -0
  16. {aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2 → aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4}/pyproject.toml +0 -0
  17. {aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2 → aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4}/setup.cfg +0 -0
  18. {aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2 → aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4}/src/aws_solutions_constructs/aws_fargate_ssmstringparameter/py.typed +0 -0
  19. {aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2 → aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4}/src/aws_solutions_constructs.aws_fargate_ssmstringparameter.egg-info/dependency_links.txt +0 -0
  20. {aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2 → aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4}/src/aws_solutions_constructs.aws_fargate_ssmstringparameter.egg-info/top_level.txt +0 -0
aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4/PKG-INFO ADDED
@@ -0,0 +1,28 @@
1
+ Metadata-Version: 2.1
2
+ Name: aws-solutions-constructs.aws-fargate-ssmstringparameter
3
+ Version: 2.85.4
4
+ Summary: CDK Constructs for AWS Fargate to AWS SSM Parameter Store 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-ssmstringparameter/README.adoc)
aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4/README.md ADDED
@@ -0,0 +1 @@
1
+ Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-fargate-ssmstringparameter/README.adoc)
{aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2 → aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4}/setup.py RENAMED
@@ -5,7 +5,7 @@ kwargs = json.loads(
5
5
  """
6
6
  {
7
7
  "name": "aws-solutions-constructs.aws-fargate-ssmstringparameter",
8
- "version": "2.85.2",
8
+ "version": "2.85.4",
9
9
  "description": "CDK Constructs for AWS Fargate to AWS SSM Parameter Store Integration",
10
10
  "license": "Apache-2.0",
11
11
  "url": "https://github.com/awslabs/aws-solutions-constructs.git",
@@ -26,7 +26,7 @@ kwargs = json.loads(
26
26
  ],
27
27
  "package_data": {
28
28
  "aws_solutions_constructs.aws_fargate_ssmstringparameter._jsii": [
29
- "aws-fargate-ssmstringparameter@2.85.2.jsii.tgz"
29
+ "aws-fargate-ssmstringparameter@2.85.4.jsii.tgz"
30
30
  ],
31
31
  "aws_solutions_constructs.aws_fargate_ssmstringparameter": [
32
32
  "py.typed"
@@ -35,7 +35,7 @@ kwargs = json.loads(
35
35
  "python_requires": "~=3.9",
36
36
  "install_requires": [
37
37
  "aws-cdk-lib>=2.193.0, <3.0.0",
38
- "aws-solutions-constructs.core==2.85.2",
38
+ "aws-solutions-constructs.core==2.85.4",
39
39
  "constructs>=10.0.0, <11.0.0",
40
40
  "jsii>=1.111.0, <2.0.0",
41
41
  "publication>=0.0.3",
{aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2 → aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4}/src/aws_solutions_constructs/aws_fargate_ssmstringparameter/__init__.py RENAMED
@@ -1,146 +1,5 @@
1
1
  r'''
2
- # aws-fargate-ssmstringparameter 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_ssmstringparameter`|
24
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-fargate-ssmstringparameter`|
25
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.fargatessmstringparameter`|
26
-
27
- ## Overview
28
-
29
- This AWS Solutions Construct implements an AWS Fargate service that can read/write to an AWS Systems Manager String Parameter
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 { FargateToSsmstringparameter, FargateToSsmstringparameterProps } from '@aws-solutions-constructs/aws-fargate-ssmstringparameter';
39
-
40
- const constructProps: FargateToSsmstringparameterProps = {
41
- publicApi: true,
42
- ecrRepositoryArn: "arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",
43
- stringParameterProps: { stringValue: "test-string-value" }
44
- };
45
-
46
- new FargateToSsmstringparameter(stack, 'test-construct', constructProps);
47
- ```
48
-
49
- Python
50
-
51
- ```python
52
- from aws_solutions_constructs.aws_fargate_ssmstringparameter import FargateToSsmstringparameter, FargateToSsmstringparameterProps
53
- from aws_cdk import (
54
- Stack,
55
- aws_ssm as ssm
56
- )
57
- from constructs import Construct
58
-
59
- FargateToSsmstringparameter(self, 'test_construct',
60
- public_api=True,
61
- ecr_repository_arn="arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",
62
- string_parameter_props=ssm.StringParameterProps(
63
- string_value="test-string-value"))
64
- ```
65
-
66
- Java
67
-
68
- ```java
69
- import software.constructs.Construct;
70
-
71
- import software.amazon.awscdk.Stack;
72
- import software.amazon.awscdk.StackProps;
73
- import software.amazon.awscdk.services.ssm.*;
74
- import software.amazon.awsconstructs.services.fargatessmstringparameter.*;
75
-
76
- new FargateToSsmstringparameter(this, "test-construct", new FargateToSsmstringparameterProps.Builder()
77
- .publicApi(true)
78
- .ecrRepositoryArn("arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo")
79
- .stringParameterProps(new StringParameterProps.Builder()
80
- .stringValue("test-string-value")
81
- .build())
82
- .build());
83
- ```
84
-
85
- ## Pattern Construct Props
86
-
87
- | **Name** | **Type** | **Description** |
88
- |:-------------|:----------------|-----------------|
89
- | publicApi | `boolean` | Whether the construct is deploying a private or public API. This has implications for the VPC. |
90
- | 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. |
91
- | 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. |
92
- | 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. |
93
- | 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* |
94
- | ecrImageVersion? | `string` | The version of the image to use from the repository. Defaults to 'Latest' |
95
- | 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) |
96
- | 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) |
97
- | 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. |
98
- | 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 |
99
- | 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 |
100
- |existingStringParameterObj?|[`ssm.StringParameter`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html)|Existing instance of SSM String parameter object, providing both this and `stringParameterProps` will cause an error|
101
- |stringParameterProps?|[`ssm.StringParameterProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameterProps.html)|Optional user provided props to override the default props for SSM String parameter. If existingStringParameterObj is not set stringParameterProps is required. The only supported [`ssm.StringParameterProps.type`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameterProps.html#type) is [`STRING`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.ParameterType.html#string) if a different value is provided it will be overridden.|
102
- |stringParameterPermissions?|`string`|Optional SSM String parameter permissions to grant to the Fargate service. One of the following may be specified: "Read", "ReadWrite".
103
- |stringParameterEnvironmentVariableName?|`string`|Optional Name for the container environment variable set to the SSM parameter name. Default: SSM_STRING_PARAMETER_NAME |
104
-
105
- ## Pattern Properties
106
-
107
- | **Name** | **Type** | **Description** |
108
- |:-------------|:----------------|-----------------|
109
- | 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) |
110
- | 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) |
111
- | 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. |
112
- |stringParameter|[`ssm.StringParameter`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html)|Returns an instance of `ssm.StringParameter` created by the construct|
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 ARN and Name of the SSM parameter
127
- * Add permissions to the container IAM role allowing it to read/write to the SSM parameter
128
-
129
- ### AWS SSM String Parameter
130
-
131
- * Sets up an AWS SSM String Parameter
132
-
133
- * Uses an existing parameter if one is provided, otherwise creates a new one
134
- * Adds an Interface Endpoint to the VPC for SSM parameter (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-ssmstringparameter/README.adoc)
144
3
  '''
145
4
  from pkgutil import extend_path
146
5
  __path__ = extend_path(__path__, __name__)
{aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2 → aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4}/src/aws_solutions_constructs/aws_fargate_ssmstringparameter/_jsii/__init__.py RENAMED
@@ -34,9 +34,9 @@ import constructs._jsii
34
34
 
35
35
  __jsii_assembly__ = jsii.JSIIAssembly.load(
36
36
  "@aws-solutions-constructs/aws-fargate-ssmstringparameter",
37
- "2.85.2",
37
+ "2.85.4",
38
38
  __name__[0:-6],
39
- "aws-fargate-ssmstringparameter@2.85.2.jsii.tgz",
39
+ "aws-fargate-ssmstringparameter@2.85.4.jsii.tgz",
40
40
  )
41
41
 
42
42
  __all__ = [
aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4/src/aws_solutions_constructs.aws_fargate_ssmstringparameter.egg-info/PKG-INFO ADDED
@@ -0,0 +1,28 @@
1
+ Metadata-Version: 2.1
2
+ Name: aws-solutions-constructs.aws-fargate-ssmstringparameter
3
+ Version: 2.85.4
4
+ Summary: CDK Constructs for AWS Fargate to AWS SSM Parameter Store 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-ssmstringparameter/README.adoc)
{aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2 → aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4}/src/aws_solutions_constructs.aws_fargate_ssmstringparameter.egg-info/SOURCES.txt RENAMED
@@ -11,4 +11,4 @@ src/aws_solutions_constructs.aws_fargate_ssmstringparameter.egg-info/top_level.t
11
11
  src/aws_solutions_constructs/aws_fargate_ssmstringparameter/__init__.py
12
12
  src/aws_solutions_constructs/aws_fargate_ssmstringparameter/py.typed
13
13
  src/aws_solutions_constructs/aws_fargate_ssmstringparameter/_jsii/__init__.py
14
- src/aws_solutions_constructs/aws_fargate_ssmstringparameter/_jsii/aws-fargate-ssmstringparameter@2.85.2.jsii.tgz
14
+ src/aws_solutions_constructs/aws_fargate_ssmstringparameter/_jsii/aws-fargate-ssmstringparameter@2.85.4.jsii.tgz
{aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2 → aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.4}/src/aws_solutions_constructs.aws_fargate_ssmstringparameter.egg-info/requires.txt RENAMED
@@ -1,5 +1,5 @@
1
1
  aws-cdk-lib<3.0.0,>=2.193.0
2
- aws-solutions-constructs.core==2.85.2
2
+ aws-solutions-constructs.core==2.85.4
3
3
  constructs<11.0.0,>=10.0.0
4
4
  jsii<2.0.0,>=1.111.0
5
5
  publication>=0.0.3
aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2/PKG-INFO DELETED
@@ -1,169 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: aws-solutions-constructs.aws-fargate-ssmstringparameter
3
- Version: 2.85.2
4
- Summary: CDK Constructs for AWS Fargate to AWS SSM Parameter Store 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-ssmstringparameter 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_ssmstringparameter`|
50
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-fargate-ssmstringparameter`|
51
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.fargatessmstringparameter`|
52
-
53
- ## Overview
54
-
55
- This AWS Solutions Construct implements an AWS Fargate service that can read/write to an AWS Systems Manager String Parameter
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 { FargateToSsmstringparameter, FargateToSsmstringparameterProps } from '@aws-solutions-constructs/aws-fargate-ssmstringparameter';
65
-
66
- const constructProps: FargateToSsmstringparameterProps = {
67
- publicApi: true,
68
- ecrRepositoryArn: "arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",
69
- stringParameterProps: { stringValue: "test-string-value" }
70
- };
71
-
72
- new FargateToSsmstringparameter(stack, 'test-construct', constructProps);
73
- ```
74
-
75
- Python
76
-
77
- ```python
78
- from aws_solutions_constructs.aws_fargate_ssmstringparameter import FargateToSsmstringparameter, FargateToSsmstringparameterProps
79
- from aws_cdk import (
80
- Stack,
81
- aws_ssm as ssm
82
- )
83
- from constructs import Construct
84
-
85
- FargateToSsmstringparameter(self, 'test_construct',
86
- public_api=True,
87
- ecr_repository_arn="arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",
88
- string_parameter_props=ssm.StringParameterProps(
89
- string_value="test-string-value"))
90
- ```
91
-
92
- Java
93
-
94
- ```java
95
- import software.constructs.Construct;
96
-
97
- import software.amazon.awscdk.Stack;
98
- import software.amazon.awscdk.StackProps;
99
- import software.amazon.awscdk.services.ssm.*;
100
- import software.amazon.awsconstructs.services.fargatessmstringparameter.*;
101
-
102
- new FargateToSsmstringparameter(this, "test-construct", new FargateToSsmstringparameterProps.Builder()
103
- .publicApi(true)
104
- .ecrRepositoryArn("arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo")
105
- .stringParameterProps(new StringParameterProps.Builder()
106
- .stringValue("test-string-value")
107
- .build())
108
- .build());
109
- ```
110
-
111
- ## Pattern Construct Props
112
-
113
- | **Name** | **Type** | **Description** |
114
- |:-------------|:----------------|-----------------|
115
- | publicApi | `boolean` | Whether the construct is deploying a private or public API. This has implications for the VPC. |
116
- | 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. |
117
- | 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. |
118
- | 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. |
119
- | 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* |
120
- | ecrImageVersion? | `string` | The version of the image to use from the repository. Defaults to 'Latest' |
121
- | 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) |
122
- | 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) |
123
- | 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. |
124
- | 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 |
125
- | 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 |
126
- |existingStringParameterObj?|[`ssm.StringParameter`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html)|Existing instance of SSM String parameter object, providing both this and `stringParameterProps` will cause an error|
127
- |stringParameterProps?|[`ssm.StringParameterProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameterProps.html)|Optional user provided props to override the default props for SSM String parameter. If existingStringParameterObj is not set stringParameterProps is required. The only supported [`ssm.StringParameterProps.type`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameterProps.html#type) is [`STRING`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.ParameterType.html#string) if a different value is provided it will be overridden.|
128
- |stringParameterPermissions?|`string`|Optional SSM String parameter permissions to grant to the Fargate service. One of the following may be specified: "Read", "ReadWrite".
129
- |stringParameterEnvironmentVariableName?|`string`|Optional Name for the container environment variable set to the SSM parameter name. Default: SSM_STRING_PARAMETER_NAME |
130
-
131
- ## Pattern Properties
132
-
133
- | **Name** | **Type** | **Description** |
134
- |:-------------|:----------------|-----------------|
135
- | 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) |
136
- | 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) |
137
- | 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. |
138
- |stringParameter|[`ssm.StringParameter`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html)|Returns an instance of `ssm.StringParameter` created by the construct|
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 ARN and Name of the SSM parameter
153
- * Add permissions to the container IAM role allowing it to read/write to the SSM parameter
154
-
155
- ### AWS SSM String Parameter
156
-
157
- * Sets up an AWS SSM String Parameter
158
-
159
- * Uses an existing parameter if one is provided, otherwise creates a new one
160
- * Adds an Interface Endpoint to the VPC for SSM parameter (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_ssmstringparameter-2.85.2/README.md DELETED
@@ -1,142 +0,0 @@
1
- # aws-fargate-ssmstringparameter module
2
-
3
- <!--BEGIN STABILITY BANNER-->---
4
-
5
-
6
- ![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
7
-
8
- > All classes are under active development and subject to non-backward compatible changes or removal in any
9
- > future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
10
- > 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.
11
-
12
- ---
13
- <!--END STABILITY BANNER-->
14
-
15
- | **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
16
- |:-------------|:-------------|
17
-
18
- <div style="height:8px"></div>
19
-
20
- | **Language** | **Package** |
21
- |:-------------|-----------------|
22
- |![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_fargate_ssmstringparameter`|
23
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-fargate-ssmstringparameter`|
24
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.fargatessmstringparameter`|
25
-
26
- ## Overview
27
-
28
- This AWS Solutions Construct implements an AWS Fargate service that can read/write to an AWS Systems Manager String Parameter
29
-
30
- Here is a minimal deployable pattern definition:
31
-
32
- Typescript
33
-
34
- ```python
35
- import { Construct } from 'constructs';
36
- import { Stack, StackProps } from 'aws-cdk-lib';
37
- import { FargateToSsmstringparameter, FargateToSsmstringparameterProps } from '@aws-solutions-constructs/aws-fargate-ssmstringparameter';
38
-
39
- const constructProps: FargateToSsmstringparameterProps = {
40
- publicApi: true,
41
- ecrRepositoryArn: "arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",
42
- stringParameterProps: { stringValue: "test-string-value" }
43
- };
44
-
45
- new FargateToSsmstringparameter(stack, 'test-construct', constructProps);
46
- ```
47
-
48
- Python
49
-
50
- ```python
51
- from aws_solutions_constructs.aws_fargate_ssmstringparameter import FargateToSsmstringparameter, FargateToSsmstringparameterProps
52
- from aws_cdk import (
53
- Stack,
54
- aws_ssm as ssm
55
- )
56
- from constructs import Construct
57
-
58
- FargateToSsmstringparameter(self, 'test_construct',
59
- public_api=True,
60
- ecr_repository_arn="arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",
61
- string_parameter_props=ssm.StringParameterProps(
62
- string_value="test-string-value"))
63
- ```
64
-
65
- Java
66
-
67
- ```java
68
- import software.constructs.Construct;
69
-
70
- import software.amazon.awscdk.Stack;
71
- import software.amazon.awscdk.StackProps;
72
- import software.amazon.awscdk.services.ssm.*;
73
- import software.amazon.awsconstructs.services.fargatessmstringparameter.*;
74
-
75
- new FargateToSsmstringparameter(this, "test-construct", new FargateToSsmstringparameterProps.Builder()
76
- .publicApi(true)
77
- .ecrRepositoryArn("arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo")
78
- .stringParameterProps(new StringParameterProps.Builder()
79
- .stringValue("test-string-value")
80
- .build())
81
- .build());
82
- ```
83
-
84
- ## Pattern Construct Props
85
-
86
- | **Name** | **Type** | **Description** |
87
- |:-------------|:----------------|-----------------|
88
- | publicApi | `boolean` | Whether the construct is deploying a private or public API. This has implications for the VPC. |
89
- | 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. |
90
- | 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. |
91
- | 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. |
92
- | 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* |
93
- | ecrImageVersion? | `string` | The version of the image to use from the repository. Defaults to 'Latest' |
94
- | 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) |
95
- | 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) |
96
- | 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. |
97
- | 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 |
98
- | 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 |
99
- |existingStringParameterObj?|[`ssm.StringParameter`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html)|Existing instance of SSM String parameter object, providing both this and `stringParameterProps` will cause an error|
100
- |stringParameterProps?|[`ssm.StringParameterProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameterProps.html)|Optional user provided props to override the default props for SSM String parameter. If existingStringParameterObj is not set stringParameterProps is required. The only supported [`ssm.StringParameterProps.type`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameterProps.html#type) is [`STRING`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.ParameterType.html#string) if a different value is provided it will be overridden.|
101
- |stringParameterPermissions?|`string`|Optional SSM String parameter permissions to grant to the Fargate service. One of the following may be specified: "Read", "ReadWrite".
102
- |stringParameterEnvironmentVariableName?|`string`|Optional Name for the container environment variable set to the SSM parameter name. Default: SSM_STRING_PARAMETER_NAME |
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
- |stringParameter|[`ssm.StringParameter`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html)|Returns an instance of `ssm.StringParameter` created by the construct|
112
-
113
- ## Default settings
114
-
115
- Out of the box implementation of the Construct without any override will set the following defaults:
116
-
117
- ### AWS Fargate Service
118
-
119
- * Sets up an AWS Fargate service
120
-
121
- * Uses the existing service if provided
122
- * Creates a new service if none provided.
123
-
124
- * Service will run in isolated subnets if available, then private subnets if available and finally public subnets
125
- * Adds environment variables to the container with the ARN and Name of the SSM parameter
126
- * Add permissions to the container IAM role allowing it to read/write to the SSM parameter
127
-
128
- ### AWS SSM String Parameter
129
-
130
- * Sets up an AWS SSM String Parameter
131
-
132
- * Uses an existing parameter if one is provided, otherwise creates a new one
133
- * Adds an Interface Endpoint to the VPC for SSM parameter (the service by default runs in Isolated or Private subnets)
134
-
135
- ## Architecture
136
-
137
- ![Architecture Diagram](architecture.png)
138
-
139
- ---
140
-
141
-
142
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
aws_solutions_constructs_aws_fargate_ssmstringparameter-2.85.2/src/aws_solutions_constructs.aws_fargate_ssmstringparameter.egg-info/PKG-INFO DELETED
@@ -1,169 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: aws-solutions-constructs.aws-fargate-ssmstringparameter
3
- Version: 2.85.2
4
- Summary: CDK Constructs for AWS Fargate to AWS SSM Parameter Store 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-ssmstringparameter 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_ssmstringparameter`|
50
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-fargate-ssmstringparameter`|
51
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.fargatessmstringparameter`|
52
-
53
- ## Overview
54
-
55
- This AWS Solutions Construct implements an AWS Fargate service that can read/write to an AWS Systems Manager String Parameter
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 { FargateToSsmstringparameter, FargateToSsmstringparameterProps } from '@aws-solutions-constructs/aws-fargate-ssmstringparameter';
65
-
66
- const constructProps: FargateToSsmstringparameterProps = {
67
- publicApi: true,
68
- ecrRepositoryArn: "arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",
69
- stringParameterProps: { stringValue: "test-string-value" }
70
- };
71
-
72
- new FargateToSsmstringparameter(stack, 'test-construct', constructProps);
73
- ```
74
-
75
- Python
76
-
77
- ```python
78
- from aws_solutions_constructs.aws_fargate_ssmstringparameter import FargateToSsmstringparameter, FargateToSsmstringparameterProps
79
- from aws_cdk import (
80
- Stack,
81
- aws_ssm as ssm
82
- )
83
- from constructs import Construct
84
-
85
- FargateToSsmstringparameter(self, 'test_construct',
86
- public_api=True,
87
- ecr_repository_arn="arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",
88
- string_parameter_props=ssm.StringParameterProps(
89
- string_value="test-string-value"))
90
- ```
91
-
92
- Java
93
-
94
- ```java
95
- import software.constructs.Construct;
96
-
97
- import software.amazon.awscdk.Stack;
98
- import software.amazon.awscdk.StackProps;
99
- import software.amazon.awscdk.services.ssm.*;
100
- import software.amazon.awsconstructs.services.fargatessmstringparameter.*;
101
-
102
- new FargateToSsmstringparameter(this, "test-construct", new FargateToSsmstringparameterProps.Builder()
103
- .publicApi(true)
104
- .ecrRepositoryArn("arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo")
105
- .stringParameterProps(new StringParameterProps.Builder()
106
- .stringValue("test-string-value")
107
- .build())
108
- .build());
109
- ```
110
-
111
- ## Pattern Construct Props
112
-
113
- | **Name** | **Type** | **Description** |
114
- |:-------------|:----------------|-----------------|
115
- | publicApi | `boolean` | Whether the construct is deploying a private or public API. This has implications for the VPC. |
116
- | 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. |
117
- | 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. |
118
- | 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. |
119
- | 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* |
120
- | ecrImageVersion? | `string` | The version of the image to use from the repository. Defaults to 'Latest' |
121
- | 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) |
122
- | 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) |
123
- | 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. |
124
- | 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 |
125
- | 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 |
126
- |existingStringParameterObj?|[`ssm.StringParameter`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html)|Existing instance of SSM String parameter object, providing both this and `stringParameterProps` will cause an error|
127
- |stringParameterProps?|[`ssm.StringParameterProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameterProps.html)|Optional user provided props to override the default props for SSM String parameter. If existingStringParameterObj is not set stringParameterProps is required. The only supported [`ssm.StringParameterProps.type`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameterProps.html#type) is [`STRING`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.ParameterType.html#string) if a different value is provided it will be overridden.|
128
- |stringParameterPermissions?|`string`|Optional SSM String parameter permissions to grant to the Fargate service. One of the following may be specified: "Read", "ReadWrite".
129
- |stringParameterEnvironmentVariableName?|`string`|Optional Name for the container environment variable set to the SSM parameter name. Default: SSM_STRING_PARAMETER_NAME |
130
-
131
- ## Pattern Properties
132
-
133
- | **Name** | **Type** | **Description** |
134
- |:-------------|:----------------|-----------------|
135
- | 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) |
136
- | 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) |
137
- | 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. |
138
- |stringParameter|[`ssm.StringParameter`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html)|Returns an instance of `ssm.StringParameter` created by the construct|
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 ARN and Name of the SSM parameter
153
- * Add permissions to the container IAM role allowing it to read/write to the SSM parameter
154
-
155
- ### AWS SSM String Parameter
156
-
157
- * Sets up an AWS SSM String Parameter
158
-
159
- * Uses an existing parameter if one is provided, otherwise creates a new one
160
- * Adds an Interface Endpoint to the VPC for SSM parameter (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.