Package: aws-solutions-constructs.aws-fargate-stepfunctions
aws-fargate-stepfunctions 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_stepfunctionsTypescript@aws-solutions-constructs/aws-fargate-stepfunctionsJavasoftware.amazon.awsconstructs.services.fargatestepfunctionsOverviewThis AWS Solutions Construct implements an AWS Fargate service that can execute an AWS Step Functions state machineHere is a minimal deployable pattern definition:Typescriptimport{Construct}from'constructs';import{Stack,StackProps}from'aws-cdk-lib';import{FargateToStepfunctions,FargateToStepfunctionsProps}from'@aws-solutions-constructs/aws-fargate-stepfunctions';import*asstepfunctionsfrom'aws-cdk-lib/aws-stepfunctions';conststartState=newstepfunctions.Pass(this,'StartState');constconstructProps:FargateToStepfunctionsProps={publicApi:true,ecrRepositoryArn:"arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",stateMachineProps:{definition:startState}};newFargateToStepfunctions(this,'test-construct',constructProps);Pythonfromaws_solutions_constructs.aws_fargate_stepfunctionsimportFargateToStepfunctions,FargateToStepfunctionsPropsfromaws_cdkimport(aws_stepfunctionsasstepfunctions,Stack)fromconstructsimportConstructstart_state=stepfunctions.Pass(self,'start_state')FargateToStepfunctions(self,'test_construct',public_api=True,ecr_repository_arn="arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",state_machine_props=stepfunctions.StateMachineProps(definition=start_state))Javaimportsoftware.constructs.Construct;importsoftware.amazon.awscdk.Stack;importsoftware.amazon.awscdk.StackProps;importsoftware.amazon.awsconstructs.services.fargatestepfunctions.*;importsoftware.amazon.awscdk.services.stepfunctions.*;start_state=stepfunctions.Pass(self,'start_state')newFargateToStepfunctions(this,"test-construct",newFargateToStepfunctionsProps.Builder().publicApi(true).ecrRepositoryArn("arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo").stateMachineProps(newStateMachineProps.Builder().definition(startState).build().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 existingFargateServiceObjectstateMachinePropssfn.StateMachinePropsUser provided props to override the default props for sfn.StateMachine.createCloudWatchAlarms?booleanWhether to create recommended CloudWatch alarms. Default is true.logGroupProps?logs.LogGroupPropsOptional user provided props to override the default props for for the CloudWatchLogs LogGroup.stateMachineEnvironmentVariableName?stringOptional Name for the container environment variable set to the ARN of the state machine. Default: STATE_MACHINE_ARNPattern 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.stateMachinesfn.StateMachineReturns an instance ofsfn.StateMachinecreated by the construct.stateMachineLogGrouplogs.ILogGroupReturns an instance of thelogs.ILogGroupcreated by the construct for StateMachine.cloudwatchAlarms?cloudwatch.Alarm[]Returns a list ofcloudwatch.Alarmcreated by the construct.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 an environment variable to the container containing the ARN of the state machineDefault name isSTATE_MACHINE_ARNAdd permissions to the container IAM role allowing it to start the execution of a state machineAWS Step FunctionsSets up an AWS Step Functions state machineUses an existing state machine if one is provided, otherwise creates a new oneAdds an Interface Endpoint to the VPC for Step Functions (the service by default runs in Isolated or Private subnets)Enables CloudWatch loggingArchitecture© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.