aws-fargate-secretsmanager - AWS Solutions Constructs
OverviewPattern Construct PropsPattern PropertiesDefault settingsArchitectureGithub

aws-fargate-secretsmanager

Stability:Experimental
Reference Documentation: https://docs.aws.amazon.com/solutions/latest/constructs/
Language Package

Python Logo Python

aws_solutions_constructs.aws_fargate_secretsmanager

Typescript Logo Typescript

@aws-solutions-constructs/aws-fargate-secretsmanager

Java Logo Java

software.amazon.awsconstructs.services.fargatesecretsmanager

Overview

This AWS Solutions Construct implements an AWS Fargate service that can write/read to an AWS Secrets Manager

Here is a minimal deployable pattern definition:

Example
Typescript
import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { FargateToSecretsmanager, FargateToSecretsmanagerProps } from '@aws-solutions-constructs/aws-fargate-secretsmanager';

const constructProps: FargateToSecretsmanagerProps = {
  publicApi: true,
  ecrRepositoryArn: "arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",
};

new FargateToSecretsmanager(stack, 'test-construct', constructProps);
Python
from aws_solutions_constructs.aws_fargate_secretsmanager import FargateToSecretsmanager, FargateToSecretsmanagerProps
from aws_cdk import (
    Stack
)
from constructs import Construct

FargateToSecretsmanager(self, 'test_construct',
            public_api=True,
            ecr_repository_arn="arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo")
Java
import software.constructs.Construct;

import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awsconstructs.services.fargatesecretsmanager.*;

new FargateToSecretsmanager(this, "test-construct", new FargateToSecretsmanagerProps.Builder()
        .publicApi(true)
        .ecrRepositoryArn("arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo")
        .build());

Pattern Construct Props

Name Type Description

publicApi

boolean

Whether the construct is deploying a private or public API. This has implications for the VPC.

vpcProps?

ec2.VpcProps

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 causes an error.

existingVpc?

ec2.IVpc

An existing VPC in which to deploy the construct. Providing both this and vpcProps causes 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

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

Optional props to define the container created for the Fargate Service (defaults found in fargate-defaults.ts)

fargateTaskDefinitionProps?

ecs.FargateTaskDefinitionProps | any

Optional props to define the Fargate Task Definition for this construct (defaults found in fargate-defaults.ts)

fargateServiceProps?

ecs.FargateServiceProps | any

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

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

existingContainerDefinitionObject?

ecs.ContainerDefinition

A container definition already instantiated as part of a Fargate service. This must be the container in the existingFargateServiceObject

secretProps?

secretsmanager.SecretProps

Optional user provided props to override the default props for Secrets Manager

existingSecretObj?

secretsmanager.Secret

Existing instance of Secrets Manager Secret object, If this is set then the secretProps is ignored

grantWriteAccess?

boolean

Optional write access to the Secret for the Fargate service (Read-Only by default)

secretEnvironmentVariableName?

string

Optional Name for the container environment variable set to the ARN of the secret. Default: SECRET_ARN

Pattern Properties

Name Type Description

vpc

ec2.IVpc

The VPC used by the construct (whether created by the construct or provided by the client)

service

ecs.FargateService

The AWS Fargate service used by this construct (whether created by this construct or passed to this construct at initialization)

container

ecs.ContainerDefinition

The container associated with the AWS Fargate service in the service property.

secret

secretsmanager.Secret

Returns an instance of secretsmanager.Secret created by the construct

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 Secrets Manager secret

    • Add permissions to the container IAM role allowing it to publish to the Secrets Manager secret

Amazon Secrets Manager Secret

  • Sets up an Amazon Secrets Manager secret

    • Uses an existing secret if one is provided, otherwise creates a new one

      • (default) random name

      • (default) random value

  • Adds an Interface Endpoint to the VPC for Secrets Manager (the service by default runs in Isolated or Private subnets)

  • Retain the Secret when deleting the CloudFormation stack

Architecture

Diagram showing the Fargate service, Secrets Manager secret and IAM role created by the construct

Github

Go to the Github repo for this pattern to view the code, read/create issues and pull requests and more.