cdktf-metaflow v0.0.7
API Reference
Constructs
Common
Initializer
import { Common } from 'cdktf-metaflow'
new Common(scope: Construct, id: string, options?: CommonOptions)scopeRequired
- Type:
constructs.Construct
idRequired
- Type:
string
optionsOptional
Properties
appOutputRequired
- Type:
string
awsRegionsOutputRequired
- Type:
string
envOutputRequired
- Type:
string
tagsOutputRequired
- Type:
string
workspaceSuffixOutputRequired
- Type:
string
appRequired
- Type:
any
envRequired
- Type:
any
tagsRequired
- Type:
any
Metaflow
Initializer
import { Metaflow } from 'cdktf-metaflow'
new Metaflow(scope: Construct, id: string, options: MetaflowOptions)scopeRequired
- Type:
constructs.Construct
idRequired
- Type:
string
optionsRequired
Properties
apiGatewayRestApiIdKeyIdOutputRequired
- Type:
string
datastoreS3BucketKmsKeyArnOutputRequired
- Type:
string
metadataSvcEcsTaskRoleArnOutputRequired
- Type:
string
metaflowApiGatewayRestApiIdOutputRequired
- Type:
string
metaflowBatchContainerImageOutputRequired
- Type:
string
metaflowBatchJobQueueOutputRequired
- Type:
string
metaflowDatastoreSysrootS3OutputRequired
- Type:
string
metaflowDatatoolsS3RootOutputRequired
- Type:
string
metaflowEcsS3AccessIamRoleOutputRequired
- Type:
string
metaflowEventsSfnAccessIamRoleOutputRequired
- Type:
string
metaflowProfileJsonOutputRequired
- Type:
string
metaflowS3BucketArnOutputRequired
- Type:
string
metaflowS3BucketNameOutputRequired
- Type:
string
metaflowServiceInternalUrlOutputRequired
- Type:
string
metaflowServiceUrlOutputRequired
- Type:
string
metaflowSfnDynamoDbTableOutputRequired
- Type:
string
metaflowSfnIamRoleOutputRequired
- Type:
string
migrationFunctionArnOutputRequired
- Type:
string
enableStepFunctionsRequired
- Type:
boolean
resourcePrefixRequired
- Type:
any
resourceSuffixRequired
- Type:
any
subnet1IdRequired
- Type:
string
subnet2IdRequired
- Type:
string
tagsRequired
- Type: { key: string :
string}
vpcCidrBlockRequired
- Type:
string
vpcIdRequired
- Type:
string
accessListCidrBlocksOptional
- Type:
string[]
apiBasicAuthOptional
- Type:
boolean
batchTypeOptional
- Type:
string
computeEnvironmentDesiredVcpusOptional
- Type:
number
computeEnvironmentInstanceTypesOptional
- Type:
string[]
computeEnvironmentMaxVcpusOptional
- Type:
number
computeEnvironmentMinVcpusOptional
- Type:
number
enableCustomBatchContainerRegistryOptional
- Type:
boolean
iamPartitionOptional
- Type:
string
Structs
CommonOptions
Initializer
import { CommonOptions } from 'cdktf-metaflow'
const commonOptions: CommonOptions = { ... }appOptional
- Type:
any - Default: metaflow
undefined.
envOptional
- Type:
any - Default: dev
undefined.
tagsOptional
- Type:
any - Default: object Object
undefined.
MetaflowOptions
Initializer
import { MetaflowOptions } from 'cdktf-metaflow'
const metaflowOptions: MetaflowOptions = { ... }enableStepFunctionsRequired
- Type:
boolean
Provisions infrastructure for step functions if enabled.
subnet1IdRequired
- Type:
string
First subnet used for availability zone redundancy.
subnet2IdRequired
- Type:
string
Second subnet used for availability zone redundancy.
tagsRequired
- Type: { key: string :
string}
aws tags.
vpcCidrBlockRequired
- Type:
string
The VPC CIDR block that we'll access list on our Metadata Service API to allow all internal communications.
vpcIdRequired
- Type:
string
The id of the single VPC we stood up for all Metaflow resources to exist in.
accessListCidrBlocksOptional
- Type:
string[]
List of CIDRs we want to grant access to our Metaflow Metadata Service.
Usually this is our VPN's CIDR blocks.
apiBasicAuthOptional
- Type:
boolean - Default: true
Enable basic auth for API Gateway?
(requires key export)
batchTypeOptional
- Type:
string - Default: ec2
AWS Batch Compute Type ('ec2', 'fargate').
computeEnvironmentDesiredVcpusOptional
- Type:
number - Default: 8
Desired Starting VCPUs for Batch Compute Environment 0-16 for EC2 Batch Compute Environment (ignored for Fargate).
computeEnvironmentInstanceTypesOptional
- Type:
string[] - Default: c4.large,c4.xlarge,c4.2xlarge,c4.4xlarge,c4.8xlarge
The instance types for the compute environment.
computeEnvironmentMaxVcpusOptional
- Type:
number - Default: 64
Maximum VCPUs for Batch Compute Environment 16-96.
computeEnvironmentMinVcpusOptional
- Type:
number - Default: 8
Minimum VCPUs for Batch Compute Environment 0-16 for EC2 Batch Compute Environment (ignored for Fargate).
enableCustomBatchContainerRegistryOptional
- Type:
boolean
Provisions infrastructure for custom Amazon ECR container registry if enabled.
iamPartitionOptional
- Type:
string - Default: aws
IAM Partition (Select aws-us-gov for AWS GovCloud, otherwise leave as is).
resourcePrefixOptional
- Type:
any - Default: metaflow
string prefix for all resources.
resourceSuffixOptional
- Type:
any
string suffix for all resources.