aws-constructs-factories module

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 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.

| Reference Documentation:| https://docs.aws.amazon.com/solutions/latest/constructs/| |:-------------|:-------------|

| Language | Package | |:-------------|-----------------| | Python|aws_solutions_constructs.aws_constructs_factories| | Typescript|@aws-solutions-constructs/aws-constructs-factories| | Java|software.amazon.awsconstructs.services.constructsfactories|

Overview

This AWS Solutions Construct exposes the same code used to create our underlying resources as factories, so clients can create individual resources that are well-architected.

S3 Buckets

Create fully well-architected S3 buckets with as little as one function call. Here is a minimal deployable pattern definition:

Typescript

import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { ConstructsFactories } from '@aws-solutions-constructs/aws-constructs-factories';

const factories = new ConstructsFactories(this, 'MyFactories');

factories.s3BucketFactory('GoodBucket', {});

Python

from aws_cdk import (
    Stack,
)
from constructs import Construct

from aws_solutions_constructs import (
    aws_constructs_factories as cf
)

factories = cf.ConstructsFactories(self, 'MyFactories')
factories.s3_bucket_factory('GoodBucket')

Java

import software.constructs.Construct;
import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;

import software.amazon.awsconstructs.services.constructsfactories.ConstructsFactories;
import software.amazon.awsconstructs.services.constructsfactories.S3BucketFactoryProps;

final ConstructsFactories factories = new ConstructsFactories(this, "MyFactories");
factories.s3BucketFactory("GoodBucket", 
  new S3BucketFactoryProps.Builder().build());

S3BucketFactory Function Signature

s3BucketFactory(id: string, props: S3BucketFactoryProps): S3BucketFactoryResponse

S3BucketFactoryProps

| Name | Type | Description | |:-------------|:----------------|-----------------| |bucketProps?|s3.BucketProps|Optional user provided props to override the default props for the S3 Bucket.| |logS3AccessLogs?|boolean|Whether to turn on Access Logging for the S3 bucket. Creates an S3 bucket with associated storage costs for the logs. Enabling Access Logging is a best practice. default - true| |loggingBucketProps?|s3.BucketProps|Optional user provided props to override the default props for the S3 Logging Bucket.|

S3BucketFactoryResponse

| Name | Type | Description | |:-------------|:----------------|-----------------| |s3Bucket|s3.Bucket|The s3.Bucket created by the factory. | |s3LoggingBucket?|s3.Bucket|The s3.Bucket created by the construct as the logging bucket for the primary bucket. If the logS3AccessLogs property is false, this value will be undefined.|

Default settings

Out of the box implementation of the Construct without any override will set the following defaults:

• An S3 Content Bucket
  • AWS managed Server Side Encryption (AES256)
  • Lifecycle rule to transition objects to Glacier storage class in 90 days
  • Access Logging enabled
  • All Public access blocked
  • Versioning enabled
  • UpdateReplacePolicy is delete
  • Deletion policy is delete
  • Bucket policy requiring SecureTransport
• An S3 Bucket for Access Logs
  • AWS managed Server Side Encryption (AES256)
  • All public access blocked
  • Versioning enabled
  • UpdateReplacePolicy is delete
  • Deletion policy is delete
  • Bucket policy requiring SecureTransport
  • Bucket policy granting PutObject privileges to the S3 logging service, from the content bucket in the content bucket account.
  • cfn_nag suppression of access logging finding (not logging access to the access log bucket)

Architecture

© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.