Package: aws-solutions-constructs.aws-fargate-s3
aws-fargate-s3 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 theSemantic Versioningmodel.
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/LanguagePackagePythonaws_solutions_constructs.aws_fargate_s3Typescript@aws-solutions-constructs/aws-fargate-s3Javasoftware.amazon.awsconstructs.services.fargates3OverviewThis AWS Solutions Construct implements an AWS Fargate service that can write/read to an Amazon S3 BucketHere is a minimal deployable pattern definition:Typescriptimport{Construct}from'constructs';import{Stack,StackProps}from'aws-cdk-lib';import{FargateToS3,FargateToS3Props}from'@aws-solutions-constructs/aws-fargate-s3';constconstructProps:FargateToS3Props={publicApi:true,ecrRepositoryArn:"arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",};newFargateToS3(this,'test-construct',constructProps);Pythonfromaws_solutions_constructs.aws_fargate_s3importFargateToS3,FargateToS3Propsfromaws_cdkimport(Stack)fromconstructsimportConstructFargateToS3(self,'test_construct',public_api=True,ecr_repository_arn="arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo")Javaimportsoftware.constructs.Construct;importsoftware.amazon.awscdk.Stack;importsoftware.amazon.awscdk.StackProps;importsoftware.amazon.awsconstructs.services.fargates3.*;newFargateToS3(this,"test_construct",newFargateToS3Props.Builder().publicApi(true).ecrRepositoryArn("arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo").build());Pattern Construct PropsNameTypeDescriptionpublicApibooleanWhether the construct is deploying a private or public API. This has implications for the VPC.vpcProps?ec2.VpcPropsOptional 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.existingVpc?ec2.IVpcAn 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.ClusterPropsOptional properties to create a new ECS cluster. To provide an existing cluster, use the cluster attribute of fargateServiceProps.ecrRepositoryArn?stringThe 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 NameecrImageVersion?stringThe version of the image to use from the repository. Defaults to 'Latest'containerDefinitionProps?[ecs.ContainerDefinitionPropsany](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinitionProps.html)fargateTaskDefinitionProps?[ecs.FargateTaskDefinitionPropsany](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateTaskDefinitionProps.html)fargateServiceProps?[ecs.FargateServicePropsany](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateServiceProps.html)existingFargateServiceObject?ecs.FargateServiceA 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, clusterPropsexistingContainerDefinitionObject?ecs.ContainerDefinitionA container definition already instantiated as part of a Fargate service. This must be the container in the existingFargateServiceObjectexistingBucketInterface?s3.IBucketExisting S3 Bucket interface. Providing this property andbucketPropsresults in an error.bucketProps?s3.BucketPropsOptional user provided props to override the default props for the S3 Bucket.loggingBucketProps?s3.BucketPropsOptional user provided props to override the default props for the S3 Logging Bucket.logS3AccessLogs?booleanWhether 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 - truebucketPermissions?string[]Optional bucket permissions to grant to the Fargate service. One or more of the following may be specified:Delete,Read, andWrite. Default is ["Read", "Write"] which includes[s3:GetObject*, s3:GetBucket*, s3:List*, s3:DeleteObject*, s3:PutObject*, s3:Abort*].bucketArnEnvironmentVariableName?stringOptional Name for the container environment variable set to the bucket ARN. Default: S3_BUCKET_ARNbucketEnvironmentVariableName?stringOptional Optional Name for the container environment variable set to the bucket name. Default: S3_BUCKET_NAMEPattern PropertiesNameTypeDescriptionvpcec2.IVpcThe VPC used by the construct (whether created by the construct or provided by the client)serviceecs.FargateServiceThe AWS Fargate service used by this construct (whether created by this construct or passed to this construct at initialization)containerecs.ContainerDefinitionThe container associated with the AWS Fargate service in the service property.s3Bucket?s3.IBucketReturns an instance of s3.Bucket created by the constructs3BucketInterfaces3.IBucketReturns an instance of s3.IBucket created by the constructs3LoggingBucket?s3.BucketReturns an instance of s3.Bucket created by the constructDefault settingsOut of the box implementation of the Construct without any override will set the following defaults:AWS Fargate ServiceSets up an AWS Fargate serviceUses the existing service if providedCreates a new service if none provided.Service will run in isolated subnets if available, then private subnets if available and finally public subnetsAdds environment variables to the container with the ARN and Name of the S3 BucketAdd permissions to the container IAM role allowing it to publish to the S3 BucketAmazon S3 BucketSets up an Amazon S3 BucketUses an existing bucket if one is provided, otherwise creates a new oneAdds an Interface Endpoint to the VPC for S3 (the service by default runs in Isolated or Private subnets)Architecture© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.