aws-ddk-core
Version:
The AWS DataOps Development Kit is an open source development framework for customers that build data workflows and modern data architecture on AWS.
1 lines • 14.5 kB
JavaScript
Search.setIndex({docnames:["cli/aws_ddk","core/aws_ddk_core","core/stubs/aws_ddk_core.base.BaseStack","core/stubs/aws_ddk_core.cicd.CICDPipelineStack","core/stubs/aws_ddk_core.config.Config","core/stubs/aws_ddk_core.config.JSONConfigStrategy","core/stubs/aws_ddk_core.pipelines.Pipeline","core/stubs/aws_ddk_core.pipelines.Stage","core/stubs/aws_ddk_core.resources.KMSFactory","core/stubs/aws_ddk_core.resources.LambdaFactory","core/stubs/aws_ddk_core.resources.S3Factory","core/stubs/aws_ddk_core.resources.SQSFactory","core/stubs/aws_ddk_core.stages.GlueTransformStage","core/stubs/aws_ddk_core.stages.S3EventStage","core/stubs/aws_ddk_core.stages.SqsToLambdaStage","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["cli/aws_ddk.rst","core/aws_ddk_core.rst","core/stubs/aws_ddk_core.base.BaseStack.rst","core/stubs/aws_ddk_core.cicd.CICDPipelineStack.rst","core/stubs/aws_ddk_core.config.Config.rst","core/stubs/aws_ddk_core.config.JSONConfigStrategy.rst","core/stubs/aws_ddk_core.pipelines.Pipeline.rst","core/stubs/aws_ddk_core.pipelines.Stage.rst","core/stubs/aws_ddk_core.resources.KMSFactory.rst","core/stubs/aws_ddk_core.resources.LambdaFactory.rst","core/stubs/aws_ddk_core.resources.S3Factory.rst","core/stubs/aws_ddk_core.resources.SQSFactory.rst","core/stubs/aws_ddk_core.stages.GlueTransformStage.rst","core/stubs/aws_ddk_core.stages.S3EventStage.rst","core/stubs/aws_ddk_core.stages.SqsToLambdaStage.rst","index.rst"],objects:{"aws_ddk_core.base":[[2,0,1,"","BaseStack"]],"aws_ddk_core.base.BaseStack":[[2,1,1,"","__init__"]],"aws_ddk_core.cicd":[[3,0,1,"","CICDPipelineStack"]],"aws_ddk_core.cicd.CICDPipelineStack":[[3,1,1,"","__init__"],[3,1,1,"","add_source_action"],[3,1,1,"","add_stage"],[3,1,1,"","add_synth_action"],[3,1,1,"","build"],[3,1,1,"","synth"]],"aws_ddk_core.config":[[4,0,1,"","Config"],[5,0,1,"","JSONConfigStrategy"]],"aws_ddk_core.config.Config":[[4,1,1,"","__init__"],[4,1,1,"","get_cdk_version"],[4,1,1,"","get_env"],[4,1,1,"","get_env_config"],[4,1,1,"","get_resource_config"],[4,1,1,"","get_tags"]],"aws_ddk_core.config.JSONConfigStrategy":[[5,1,1,"","__init__"],[5,1,1,"","get_config"]],"aws_ddk_core.pipelines":[[6,0,1,"","Pipeline"],[7,0,1,"","Stage"]],"aws_ddk_core.pipelines.Pipeline":[[6,1,1,"","__init__"],[6,1,1,"","add_rule"],[6,1,1,"","add_stage"]],"aws_ddk_core.pipelines.Stage":[[7,1,1,"","__init__"],[7,1,1,"","get_event_pattern"],[7,1,1,"","get_targets"]],"aws_ddk_core.resources":[[8,0,1,"","KMSFactory"],[9,0,1,"","LambdaFactory"],[10,0,1,"","S3Factory"],[11,0,1,"","SQSFactory"]],"aws_ddk_core.resources.KMSFactory":[[8,1,1,"","__init__"],[8,1,1,"","key"]],"aws_ddk_core.resources.LambdaFactory":[[9,1,1,"","__init__"],[9,1,1,"","function"]],"aws_ddk_core.resources.S3Factory":[[10,1,1,"","__init__"],[10,1,1,"","bucket"]],"aws_ddk_core.resources.SQSFactory":[[11,1,1,"","__init__"],[11,1,1,"","queue"]],"aws_ddk_core.stages":[[12,0,1,"","GlueTransformStage"],[13,0,1,"","S3EventStage"],[14,0,1,"","SqsToLambdaStage"]],"aws_ddk_core.stages.GlueTransformStage":[[12,1,1,"","__init__"],[12,1,1,"","get_event_pattern"],[12,1,1,"","get_targets"],[12,2,1,"","state_machine"]],"aws_ddk_core.stages.S3EventStage":[[13,1,1,"","__init__"],[13,2,1,"","event_pattern"],[13,1,1,"","get_event_pattern"],[13,1,1,"","get_targets"],[13,2,1,"","trail"],[13,2,1,"","trail_bucket"]],"aws_ddk_core.stages.SqsToLambdaStage":[[14,1,1,"","__init__"],[14,2,1,"","dlq"],[14,2,1,"","function"],[14,1,1,"","get_event_pattern"],[14,1,1,"","get_targets"],[14,2,1,"","queue"]],"ddk-bootstrap":[[0,3,1,"cmdoption-ddk-bootstrap-e","--environment"],[0,3,1,"cmdoption-ddk-bootstrap-i","--iam-policies"],[0,3,1,"cmdoption-ddk-bootstrap-permissions-boundary","--permissions-boundary"],[0,3,1,"cmdoption-ddk-bootstrap-prefix","--prefix"],[0,3,1,"cmdoption-ddk-bootstrap-p","--profile"],[0,3,1,"cmdoption-ddk-bootstrap-qualifier","--qualifier"],[0,3,1,"cmdoption-ddk-bootstrap-r","--region"],[0,3,1,"cmdoption-ddk-bootstrap-t","--tags"],[0,3,1,"cmdoption-ddk-bootstrap-a","--trusted-accounts"],[0,3,1,"cmdoption-ddk-bootstrap-a","-a"],[0,3,1,"cmdoption-ddk-bootstrap-e","-e"],[0,3,1,"cmdoption-ddk-bootstrap-i","-i"],[0,3,1,"cmdoption-ddk-bootstrap-p","-p"],[0,3,1,"cmdoption-ddk-bootstrap-r","-r"],[0,3,1,"cmdoption-ddk-bootstrap-t","-t"]],"ddk-create-repository":[[0,3,1,"cmdoption-ddk-create-repository-d","--description"],[0,3,1,"cmdoption-ddk-create-repository-p","--profile"],[0,3,1,"cmdoption-ddk-create-repository-r","--region"],[0,3,1,"cmdoption-ddk-create-repository-t","--tags"],[0,3,1,"cmdoption-ddk-create-repository-d","-d"],[0,3,1,"cmdoption-ddk-create-repository-p","-p"],[0,3,1,"cmdoption-ddk-create-repository-r","-r"],[0,3,1,"cmdoption-ddk-create-repository-t","-t"],[0,3,1,"cmdoption-ddk-create-repository-arg-NAME","NAME"]],"ddk-deploy":[[0,3,1,"cmdoption-ddk-deploy-f","--force"],[0,3,1,"cmdoption-ddk-deploy-o","--output-dir"],[0,3,1,"cmdoption-ddk-deploy-p","--profile"],[0,3,1,"cmdoption-ddk-deploy-require-approval","--require-approval"],[0,3,1,"cmdoption-ddk-deploy-f","-f"],[0,3,1,"cmdoption-ddk-deploy-o","-o"],[0,3,1,"cmdoption-ddk-deploy-p","-p"]],"ddk-init":[[0,3,1,"cmdoption-ddk-init-e","--environment"],[0,3,1,"cmdoption-ddk-init-t","--template"],[0,3,1,"cmdoption-ddk-init-e","-e"],[0,3,1,"cmdoption-ddk-init-t","-t"],[0,3,1,"cmdoption-ddk-init-arg-NAME","NAME"]],ddk:[[0,3,1,"cmdoption-ddk-debug","--debug"],[0,3,1,"cmdoption-ddk-debug","--no-debug"],[0,3,1,"cmdoption-ddk-version","--version"]]},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"],"2":["py","property","Python property"],"3":["std","cmdoption","program option"]},objtypes:{"0":"py:class","1":"py:method","2":"py:property","3":"std:cmdoption"},terms:{"1":[0,8,9,14],"10":14,"111111111111":0,"120":[9,14],"1984":0,"2":[8,9],"222222222222":0,"256":[9,14],"3":[8,9],"30":8,"abstract":7,"class":[2,3,4,5,6,7,8,9,10,11,12,13,14],"default":[0,3,4,5,6,8,9,10,11,13,14],"function":[9,10,11,12,14],"int":[9,14],"new":0,"public":10,"return":[3,4,5,6,7,8,9,10,11,12,13,14],"static":[8,9,10,11],"true":[8,10],A:[0,13],By:6,For:[6,7,8,9,10,11],If:0,It:[3,13,14],The:[0,3,7,8,9,10,12,13,14],To:7,__init__:[2,3,4,5,6,7,8,9,10,11,12,13,14],_queue:7,abil:3,abl:3,access:10,access_control:10,account:[0,3,4],acl:10,action:3,add:[3,6,7],add_rul:6,add_source_act:3,add_stag:[3,6],add_synth_act:3,addit:[2,3,8,9,10,11],after:[3,9,14],afterward:12,alia:8,alloc:[9,14],allow:[8,9,10,11],allow_all_outbound:9,allow_public_subnet:9,alwai:[0,8,9],amazon:[2,8,9,10,11,13,14],amazons3:13,amount:[9,14],an:[6,7,12,13,14],ani:[0,2,3,4,5,6,7,8,9,10,11,12,13,14],api:[8,9,10,11],app:3,appli:[0,10,11],applic:[2,3],approv:[0,3],ar:[0,3,7,8,9,10,11,12,13,14],arg:[0,2,3,6,7,12,13,14],argument:[0,2,8,9,12],arn1:0,arn2:0,arn:[0,2],artifact:3,artifactori:3,assembl:0,associ:13,attach:0,attribut:[2,3,6,7,12,13,14],auto_delete_object:10,avoid:3,aw:[0,2,4,8,9,10,11,13,14],aws_cdk:[2,3,4,6,7,8,9,10,11,12,13,14],aws_cloudtrail:13,aws_ddk:15,aws_ddk_cor:15,aws_ev:[6,7,12,13,14],aws_iam:[3,9,14],aws_km:8,aws_lambda:[9,14],aws_s3:[10,13],aws_sq:[9,11,14],aws_stepfunct:12,base:[3,13,15],batch_siz:14,been:8,befor:[8,14],being:14,best:3,block:[3,10],block_public_access:10,blockpublicaccess:10,bool:[2,3,6,8,9,10,14],bootstrap:2,both:12,boundari:[0,2],branch:3,broaden:0,bucket:[3,10,11,13],bucket_nam:[10,13],bucket_owner_full_control:10,bucket_prop:10,bucketaccesscontrol:10,bucketencrypt:10,build:3,builder:3,call:[3,9,14],can:[3,5,10,14],captur:13,cd:3,cdk:[0,2,3,4,8,9,10,11],cdk_version:4,chang:0,chunki:3,ci:3,cicd:15,cli:0,cloud:0,cloudform:8,cloudtrail:13,cmk:8,code:[0,3,9,14],codeartifact:3,codeartifact_domain:3,codeartifact_domain_own:3,codeartifact_repositori:3,codebuildstep:3,codecommit:3,codepipelinesourc:3,com:[2,8,9,10,11,13],command:0,complet:[8,9,10,11],config:[3,15],config_strategi:4,configstrategi:4,configur:[2,3,4,5,8,9,10,11],connect:[3,14],construct:[2,3,6,7,8,9,10,11,12,13,14],constructor:3,contain:[0,3,4,5,12],content:11,content_based_dedupl:11,continu:3,costcent:0,crawler:12,crawler_nam:12,creat:[2,3,4,6,7,8,9,10,11,12,13],creation:6,credenti:0,custom:6,d:0,dai:8,data:[6,7],data_key_reus:11,ddk:[3,5,8,9,10,11,12,13,14],dead:14,dead_letter_queu:[9,11],dead_letter_queue_en:[9,14],deadletterqueu:[11,14],debug:0,def:7,defaultstacksynthes:2,defin:[2,3,6,7,8,9,10,11,12,13,14],delet:8,deliveri:3,delivery_delai:11,depend:[8,9,10,11],deploi:3,deploy:0,dequeu:[11,14],describ:[7,12,13,14],descript:[0,6,7,9],detail:7,detail_typ:7,determin:[4,9,14],dev:[0,3],devstag:3,dict:[4,12],dictionari:[4,5],differ:5,dir:0,directori:0,dlq:[9,14],doc:[2,8,9,10,11,13],document:[8,9,10,11],domain:3,durat:[8,9,14],dure:3,e:[0,3],east:0,enabl:[9,13,14],enable_key_rot:8,encrypt:[3,8,10,11],enforc:10,enforce_ssl:10,ensur:3,env:[3,4],env_config:4,environ:[0,2,3,4,8,9,10,11,12,13,14],environment_id:[2,3,4,7,8,9,10,11,12,13,14],even:0,event:[6,7,12,13,14],event_nam:13,event_pattern:[6,7,12,13,14],event_target:6,eventpattern:[6,7,12,13,14],exampl:[3,6,7],execut:[9,14],exit:0,explicit:[8,9],f:0,factori:[8,9,10,11],fals:[0,3,6,9,14],featur:3,file:[0,5,8,9,10,11],fn:9,follow:[8,9],forc:0,form:4,framework:0,from:[0,2,3,4,5,7,8,9,10,11,14],function_nam:9,function_prop:9,g:[0,3],get:[4,5,7,12,13,14],get_cdk_vers:4,get_config:5,get_env:4,get_env_config:4,get_event_pattern:[7,12,13,14],get_resource_config:4,get_tag:4,get_target:[6,7,12,13,14],git:0,given:[4,5],glue:12,grant:10,guid:2,ha:8,handler:[9,14],have:10,he:14,hope:3,how:4,html:[2,8,9,10,11,13],http:[2,8,9,10,11,13],i:0,iam:0,iam_polici:0,ibucket:[10,13],id:[0,2,3,4,6,7,8,9,10,11,12,13,14],ident:0,identifi:[2,3,4,6,7,8,9,10,11,12,13,14],ifunct:[9,14],ikei:8,implement:[7,13,14],includ:[2,3,8,9,10,11],index:15,indic:8,infer:0,info:13,infrastructur:[3,7],inherit:[2,7],input:[7,12,13,14],instanc:[3,4,6],integr:3,interfac:3,invoc:14,invok:[7,12,13,14],iqueu:[9,11,14],irol:[9,14],iruletarget:[6,7,12,13,14],job:12,job_arg:12,job_nam:12,json:[3,4,5,8,9,10,11],jsonconfigstrategi:4,kei:[3,5,8,11,13],key_prefix:13,key_prop:8,kind:10,km:[3,8],kms_manag:11,kwarg:[2,3,6,7,12,13,14],lambda:[9,14],latest:13,letter:14,level:[2,13],list:[0,3,6,7,8,9,10,11,12,13,14],load:5,loc:3,local:0,log:[0,13],machin:12,main:3,manag:[0,2,8],manual:[0,3],manual_approv:3,match:[6,7,12,13,14],max_event_ag:9,max_message_size_byt:11,max_receive_count:14,maximum:14,mb:[9,14],memori:[9,14],memory_s:[9,14],messag:[11,14],method:[2,3,4,5,6,7,8,9,10,11,12,13,14],modifi:3,modul:15,move:14,multi:2,multipl:3,must:12,mutat:3,my:[3,6,7],my_glue_stag:6,my_lambda_stag:6,mypipelin:3,mystag:7,name:[0,3,6,7,9,10,11,12,13,14],need:0,never:0,next:6,non:3,none:[0,2,3,4,5,6,7,8,9,10,11,12,13,14],number:[8,11,14],o:0,object:[9,13,14],off:0,one:6,option:[0,2,3,4,6,7,8,9,10,11,12,13,14],order:[8,9],otherwis:[8,9],output:[0,6,7,12,13,14],output_dir:0,overrid:[3,6],override_rul:6,owner:3,p:0,page:15,paramet:[2,3,4,5,6,7,8,9,10,11,12,13,14],path:5,pattern:[6,7,12,13,14],pending_window:8,perform:0,period:8,permiss:[0,2,10],permissions_boundari:0,permissions_boundary_arn:2,pipelin:[3,15],pipeline_nam:3,polici:[0,2,3,10,11],policystat:3,possibl:3,practic:3,pre:12,predefin:10,prefer:[8,9],prefix:[0,13],previou:6,previous_stag:6,privat:3,process:14,produc:[7,12,13,14],profil:[0,9],project:0,properti:[3,7,8,9,10,11,12,13,14],protect:2,provid:[0,4],pull:3,python:[0,8,9,10,11],python_3_9:14,qualifi:0,queue:[7,9,11,14],queue_nam:11,queue_prop:11,queueencrypt:11,r:0,read:[4,5],receive_message_wait_tim:11,record:14,refer:[8,9,10,11],region:[0,4],remov:[8,10,11],removal_polici:[8,10,11],removalpolici:[8,10,11],repo:[3,4,5],repositori:3,repository_nam:3,repres:[4,6,7,12,13,14],request:10,requir:[0,7],require_approv:0,reserved_concurrent_execut:9,resourc:[0,4,15],respect:[8,9],retain:[8,10,11],retention_period:11,retriev:14,retry_attempt:9,reus:3,role:[0,3,9,14],role_policy_stat:3,root:[4,5,13],rotat:[3,8],rout:[7,12,13,14],rule:[6,7,12,13,14],run:12,runtim:[9,14],s3:[10,13],s3_manag:10,s:[7,12,13,14],save:3,scm:3,scope:[2,3,6,7,8,9,10,11,12,13,14],search:15,second:[9,14],secur:[0,3],select:[7,12,13,14],self:[3,6,7],send:11,sensit:0,server:10,servic:[8,10,11],set:2,sever:3,should:[0,3,4,7,8,10,12,13,14],show:0,side:10,simpl:[10,11],singl:14,skip:6,skip_rul:6,some:3,sourc:[0,3,9,14],source_act:3,specif:[0,3,6],specifi:[5,6,8,10],sq:[7,9,11,14],sqsfactori:7,sqsqueue:7,ssl:[3,10],stack:[0,2,3,8,10,11],stage:[3,6,15],stage_id:3,start:3,state:12,state_machin:12,state_machine_input:12,statemachin:12,step:12,storag:10,str:[2,3,4,5,6,7,8,9,10,11,12,13,14],strategi:4,structur:[0,3,7,12,13,14],support:[8,9,10,11],synth:3,synth_act:3,synthes:[0,2,3],system:0,t:0,tag:[0,2,4],tag_kei:4,target:[6,7,12,13,14],templat:0,termin:[2,9,14],termination_protect:2,thei:11,them:[3,7,12,13,14],thi:[2,3,6,7,8,9,10,11,12,13,14],time:[9,11,14],timeout:[9,14],trace:9,track:13,trail:13,trail_bucket:13,transform:[12,14],trust:0,trusted_account:0,turn:[0,10],type:[3,4,5,6,7,8,9,10,11,12,13,14],unsuccessfulli:[11,14],url:0,us:[0,4,5,6,7,8,9,10,11,12,13,14],user:3,userguid:13,usual:6,v2:[2,8,9,10,11],valu:[4,8,9],version:[0,4,10],via:[3,6],visibility_timeout:[11,14],wait:8,were:11,what:[0,7,11,12,13,14],when:[7,8,10,11,12,13,14],where:[0,4],whether:[8,10,11],which:[2,3,6,7,8,9,10,11,12,13,14],wire:6,within:[2,3,6,7,8,9,10,11,12,13,14],your:[0,3]},titles:["aws_ddk package","aws_ddk_core package","aws_ddk_core.base.BaseStack","aws_ddk_core.cicd.CICDPipelineStack","aws_ddk_core.config.Config","aws_ddk_core.config.JSONConfigStrategy","aws_ddk_core.pipelines.Pipeline","aws_ddk_core.pipelines.Stage","aws_ddk_core.resources.KMSFactory","aws_ddk_core.resources.LambdaFactory","aws_ddk_core.resources.S3Factory","aws_ddk_core.resources.SQSFactory","aws_ddk_core.stages.GlueTransformStage","aws_ddk_core.stages.S3EventStage","aws_ddk_core.stages.SqsToLambdaStage","AWS DDK API Documentation"],titleterms:{api:15,aw:15,aws_ddk:0,aws_ddk_cor:[1,2,3,4,5,6,7,8,9,10,11,12,13,14],base:[1,2],basestack:2,bootstrap:0,cicd:[1,3],cicdpipelinestack:3,config:[1,4,5],creat:0,ddk:[0,15],deploi:0,document:15,gluetransformstag:12,indic:15,init:0,jsonconfigstrategi:5,kmsfactori:8,lambdafactori:9,packag:[0,1,15],pipelin:[1,6,7],repositori:0,resourc:[1,8,9,10,11],s3eventstag:13,s3factori:10,sqsfactori:11,sqstolambdastag:14,stage:[1,7,12,13,14],tabl:15}})