Package: aws-solutions-constructs.aws-fargate-dynamodb
aws-fargate-dynamodb 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_dynamodbTypescript@aws-solutions-constructs/aws-fargate-dynamodbJavasoftware.amazon.awsconstructs.services.fargatedynamodbOverviewThis AWS Solutions Construct implements an AWS Fargate service that can write/read to an Amazon DynamoDB tableHere is a minimal deployable pattern definition:Typescriptimport{Construct}from'constructs';import{Stack,StackProps}from'aws-cdk-lib';import{FargateToDynamoDB,FargateToDynamoDBProps}from'@aws-solutions-constructs/aws-fargate-dynamodb';constconstructProps:FargateToDynamoDBProps={publicApi:true,ecrRepositoryArn:"arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",};newFargateToDynamoDB(stack,'test-construct',constructProps);Pythonfromaws_solutions_constructs.aws_fargate_dynamodbimportFargateToDynamoDB,FargateToDynamoDBPropsfromaws_cdkimport(Stack)fromconstructsimportConstructFargateToDynamoDB(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.fargatedynamodb.*;newFargateToDynamoDB(this,"test-construct",newFargateToDynamoDBProps.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.ContainerDefinitionProps | anyOptional props to define the container created for the Fargate Service (defaults found in fargate-defaults.ts)fargateTaskDefinitionProps?ecs.FargateTaskDefinitionProps | anyOptional props to define the Fargate Task Definition for this construct  (defaults found in fargate-defaults.ts)fargateServiceProps?ecs.FargateServiceProps | anyOptional 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.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 existingFargateServiceObjectdynamoTableProps?dynamodb.TablePropsOptional user provided props to override the default props for DynamoDB Table.existingTableInterface?dynamodb.ITableExisting instance of DynamoDB table object or interface, providing both this anddynamoTablePropswill cause an error.tablePermissions?stringOptional table permissions to grant to the Fargate service. One of the following may be specified:All,Read,ReadWrite,Write.tableArnEnvironmentVariableName?stringOptional Name for the container environment variable set to the ARN for the DynamoDB table. Default: DYNAMODB_TABLE_ARNtableEnvironmentVariableName?stringOptional Name for the container environment variable set to the DynamoDB table name. Default: DYNAMODB_TABLE_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.dynamoTableInterfacedynamodb.ITableReturns an instance ofdynamodb.ITablecreated by the construct or the interface provided in existingTableInterface.dynamoTable?dynamodb.TableReturns an instance ofdynamodb.Tablecreated by the construct. IMPORTANT: If existingTableInterface was provided in Pattern Construct Props, this property will beundefined.Default 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 DynamoDB tableAdd permissions to the container IAM role allowing it to publish to the DynamoDB tableAmazon DynamoDB TableSets up an Amazon DynamoDB tableUses an existing table if one is provided, otherwise creates a new oneAdds an Interface Endpoint to the VPC for DynamoDB (the service by default runs in Isolated or Private subnets)Architecture© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.