awssolutionsconstructsawscloudfrontmediastore

README

aws-cloudfront-mediastore module

---

---

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

Language	Package
Python	aws_solutions_constructs.aws_cloudfront_mediastore
TypeScript	@aws-solutions-constructs/aws-cloudfront-mediastore
Java	software.amazon.awsconstructs.services.cloudfrontmediastore

Overview

This AWS Solutions Construct implements an Amazon CloudFront distribution to an AWS Elemental MediaStore container.

Here is a minimal deployable pattern definition in TypeScript:

import { CloudFrontToMediaStore } from '@aws-solutions-constructs/aws-cloudfront-mediastore';

new CloudFrontToMediaStore(this, 'test-cloudfront-mediastore-default', {});

Initializer

new CloudFrontToMediaStore(scope: Construct, id: string, props: CloudFrontToMediaStoreProps);

Parameters

• scope Construct
• id string
• props CloudFrontToMediaStoreProps

Pattern Construct Props

Name	Type	Description
existingMediaStoreContainerObj?	mediastore.CfnContainer	Optional user provided MediaStore container to override the default MediaStore container.
mediaStoreContainerProps?	mediastore.CfnContainerProps	Optional user provided props to override the default props for the MediaStore Container.
cloudFrontDistributionProps?	cloudfront.DistributionProps|any	Optional user provided props to override the default props for the CloudFront Distribution.
insertHttpSecurityHeaders?	boolean	Optional user provided props to turn on/off the automatic injection of best practice HTTP security headers in all responses from CloudFront
cloudFrontLoggingBucketProps?	s3.BucketProps	Optional user provided props to override the default props for the CloudFront Logging Bucket.

Pattern Properties

Name	Type	Description
cloudFrontWebDistribution	cloudfront.CloudFrontWebDistribution	Returns an instance of cloudfront.CloudFrontWebDistribution created by the construct.
mediaStoreContainer	mediastore.CfnContainer	Returns an instance of mediastore.CfnContainer.
cloudFrontLoggingBucket	s3.Bucket	Returns an instance of s3.Bucket as the logging bucket for the CloudFront Web Distribution.
cloudFrontOriginRequestPolicy	cloudfront.OriginRequestPolicy	Returns an instance of cloudfront.OriginRequestPolicy created by the construct for the CloudFront Web Distribution.
cloudFrontOriginAccessIdentity?	cloudfront.OriginAccessIdentity	Returns an instance of cloudfront.OriginAccessIdentity created by the construct for the CloudFront Web Distribution origin custom headers and the MediaStore Container policy.
cloudFrontFunction?	cloudfront.Function	Returns an instance of the Cloudfront function created by the pattern.

Default settings

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

Amazon CloudFront

• Configure access logging for CloudFront Web Distribution
• Enable CloudFront Origin Request Policy for AWS Elemental MediaStore Container
• Set User-Agent custom header with CloudFront Origin Access Identity
• Enable automatic injection of best practice HTTP security headers in all responses from CloudFront WebDistribution

AWS Elemental MediaStore

• Set the deletion policy to retain the resource
• Set the container name with the CloudFormation stack name
• Set the default Container Cross-origin resource sharing (CORS) policy
• Set the default Object Life Cycle policy
• Set the default Container Policy to allow only aws:UserAgent with CloudFront Origin Access Identity
• Set the default Metric Policy
• Enable the access logging

Architecture

---

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

Documentation

Overview

CDK Constructs for Amazon CloudFront to AWS Elemental MediaStore integration.

Index

• func CloudFrontToMediaStore_IsConstruct(x interface{}) *bool
• func NewCloudFrontToMediaStore_Override(c CloudFrontToMediaStore, scope constructs.Construct, id *string, ...)
• type CloudFrontToMediaStore
  • func NewCloudFrontToMediaStore(scope constructs.Construct, id *string, props *CloudFrontToMediaStoreProps) CloudFrontToMediaStore
• type CloudFrontToMediaStoreProps

Functions

func CloudFrontToMediaStore_IsConstruct

func CloudFrontToMediaStore_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCloudFrontToMediaStore_Override

func NewCloudFrontToMediaStore_Override(c CloudFrontToMediaStore, scope constructs.Construct, id *string, props *CloudFrontToMediaStoreProps)

Types

type CloudFrontToMediaStore

type CloudFrontToMediaStore interface {
	constructs.Construct
	CloudFrontFunction() awscloudfront.Function
	CloudFrontLoggingBucket() awss3.Bucket
	CloudFrontOriginAccessIdentity() awscloudfront.OriginAccessIdentity
	CloudFrontOriginRequestPolicy() awscloudfront.OriginRequestPolicy
	CloudFrontWebDistribution() awscloudfront.Distribution
	MediaStoreContainer() awsmediastore.CfnContainer
	Node() constructs.Node
	ToString() *string
}

func NewCloudFrontToMediaStore

func NewCloudFrontToMediaStore(scope constructs.Construct, id *string, props *CloudFrontToMediaStoreProps) CloudFrontToMediaStore

type CloudFrontToMediaStoreProps

type CloudFrontToMediaStoreProps struct {
	// Optional user provided props to override the default props for the CloudFront.
	CloudFrontDistributionProps interface{} `json:"cloudFrontDistributionProps"`
	// Optional user provided props to override the default props for the CloudFront Logging Bucket.
	CloudFrontLoggingBucketProps *awss3.BucketProps `json:"cloudFrontLoggingBucketProps"`
	// Existing instance of mediastore.CfnContainer obejct.
	ExistingMediaStoreContainerObj awsmediastore.CfnContainer `json:"existingMediaStoreContainerObj"`
	// Optional user provided props to turn on/off the automatic injection of best practice HTTP security headers in all responses from cloudfront.
	InsertHttpSecurityHeaders *bool `json:"insertHttpSecurityHeaders"`
	// Optional user provided props to override the default props for the MediaStore.
	MediaStoreContainerProps *awsmediastore.CfnContainerProps `json:"mediaStoreContainerProps"`
}