UNPKG

@cdklabs/cdk-ecs-codedeploy

Version:

CDK Constructs for performing ECS Deployments with CodeDeploy

1 lines 19.9 kB
{"version":"2","toolVersion":"5.8.10","snippets":{"9c33177d4808857a56d386ea98f72b7ed3b5370642b3f85920274df5aa84c6c9":{"translations":{"python":{"source":"# deployment_group: codeDeploy.IEcsDeploymentGroup\n# task_definition: ecs.ITaskDefinition\n\n\nEcsDeployment(\n deployment_group=deployment_group,\n target_service=TargetService(\n task_definition=task_definition,\n container_name=\"mycontainer\",\n container_port=80\n )\n)","version":"2"},"csharp":{"source":"IEcsDeploymentGroup deploymentGroup;\nITaskDefinition taskDefinition;\n\n\nnew EcsDeployment(new EcsDeploymentProps {\n DeploymentGroup = deploymentGroup,\n TargetService = new TargetService {\n TaskDefinition = taskDefinition,\n ContainerName = \"mycontainer\",\n ContainerPort = 80\n }\n});","version":"1"},"java":{"source":"IEcsDeploymentGroup deploymentGroup;\nITaskDefinition taskDefinition;\n\n\nEcsDeployment.Builder.create()\n .deploymentGroup(deploymentGroup)\n .targetService(TargetService.builder()\n .taskDefinition(taskDefinition)\n .containerName(\"mycontainer\")\n .containerPort(80)\n .build())\n .build();","version":"1"},"go":{"source":"var deploymentGroup iEcsDeploymentGroup\nvar taskDefinition iTaskDefinition\n\n\ncdklabscdkecscodedeploy.NewEcsDeployment(&EcsDeploymentProps{\n\tDeploymentGroup: DeploymentGroup,\n\tTargetService: &TargetService{\n\t\tTaskDefinition: *TaskDefinition,\n\t\tContainerName: jsii.String(\"mycontainer\"),\n\t\tContainerPort: jsii.Number(80),\n\t},\n})","version":"1"},"$":{"source":"declare const deploymentGroup: codeDeploy.IEcsDeploymentGroup;\ndeclare const taskDefinition: ecs.ITaskDefinition;\n\nnew EcsDeployment({\n deploymentGroup,\n targetService: {\n taskDefinition,\n containerName: 'mycontainer',\n containerPort: 80,\n },\n});","version":"0"}},"location":{"api":{"api":"moduleReadme","moduleFqn":"@cdklabs/cdk-ecs-codedeploy"},"field":{"field":"markdown","line":42}},"didCompile":true,"fqnsReferenced":["@cdklabs/cdk-ecs-codedeploy.EcsDeployment","@cdklabs/cdk-ecs-codedeploy.EcsDeploymentProps","@cdklabs/cdk-ecs-codedeploy.TargetService","aws-cdk-lib.aws_codedeploy.IEcsDeploymentGroup","aws-cdk-lib.aws_ecs.ITaskDefinition"],"fullSource":"// Hoisted imports begin after !show marker below\n/// !show\ndeclare const deploymentGroup: codeDeploy.IEcsDeploymentGroup;\ndeclare const taskDefinition: ecs.ITaskDefinition;\n/// !hide\n// Hoisted imports ended before !hide marker above\n// Fixture with packages imported, but nothing else\nimport { Construct } from 'constructs';\nimport {\n Duration,\n Stack,\n aws_ecs as ecs,\n aws_codedeploy as codeDeploy,\n} from 'aws-cdk-lib';\nimport {\n ApiCanary,\n ApplicationLoadBalancedCodeDeployedFargateService, \n EcsDeployment,\n} from '@cdklabs/cdk-ecs-codedeploy';\n\nclass Fixture extends Stack {\n constructor(scope: Construct, id: string) {\n super(scope, id);\n\n const stack = this;\n\n // Code snippet begins after !show marker below\n/// !show\n\n\nnew EcsDeployment({\n deploymentGroup,\n targetService: {\n taskDefinition,\n containerName: 'mycontainer',\n containerPort: 80,\n },\n});\n/// !hide\n// Code snippet ended before !hide marker above\n }\n}","syntaxKindCounter":{"9":1,"11":1,"80":12,"138":2,"166":2,"183":2,"210":2,"214":1,"243":2,"244":1,"260":2,"261":2,"303":3,"304":2,"307":1},"fqnsFingerprint":"4cc1fe2132c907ed1a780d103458ac65563dbefc9114977fe16f8bbea49af65e"},"c88c4fb9870561df67310ffff4486257b0239f75789251fbc4ea19dd3da9074e":{"translations":{"python":{"source":"# deployment_group: codeDeploy.IEcsDeploymentGroup\n# task_definition: ecs.ITaskDefinition\n\n\nEcsDeployment(\n deployment_group=deployment_group,\n target_service=TargetService(\n task_definition=task_definition,\n container_name=\"mycontainer\",\n container_port=80\n ),\n auto_rollback=codeDeploy.AutoRollbackConfig(\n failed_deployment=True,\n deployment_in_alarm=True,\n stopped_deployment=False\n )\n)","version":"2"},"csharp":{"source":"IEcsDeploymentGroup deploymentGroup;\nITaskDefinition taskDefinition;\n\n\nnew EcsDeployment(new EcsDeploymentProps {\n DeploymentGroup = deploymentGroup,\n TargetService = new TargetService {\n TaskDefinition = taskDefinition,\n ContainerName = \"mycontainer\",\n ContainerPort = 80\n },\n AutoRollback = new AutoRollbackConfig {\n FailedDeployment = true,\n DeploymentInAlarm = true,\n StoppedDeployment = false\n }\n});","version":"1"},"java":{"source":"IEcsDeploymentGroup deploymentGroup;\nITaskDefinition taskDefinition;\n\n\nEcsDeployment.Builder.create()\n .deploymentGroup(deploymentGroup)\n .targetService(TargetService.builder()\n .taskDefinition(taskDefinition)\n .containerName(\"mycontainer\")\n .containerPort(80)\n .build())\n .autoRollback(AutoRollbackConfig.builder()\n .failedDeployment(true)\n .deploymentInAlarm(true)\n .stoppedDeployment(false)\n .build())\n .build();","version":"1"},"go":{"source":"var deploymentGroup iEcsDeploymentGroup\nvar taskDefinition iTaskDefinition\n\n\ncdklabscdkecscodedeploy.NewEcsDeployment(&EcsDeploymentProps{\n\tDeploymentGroup: DeploymentGroup,\n\tTargetService: &TargetService{\n\t\tTaskDefinition: *TaskDefinition,\n\t\tContainerName: jsii.String(\"mycontainer\"),\n\t\tContainerPort: jsii.Number(80),\n\t},\n\tAutoRollback: &AutoRollbackConfig{\n\t\tFailedDeployment: jsii.Boolean(true),\n\t\tDeploymentInAlarm: jsii.Boolean(true),\n\t\tStoppedDeployment: jsii.Boolean(false),\n\t},\n})","version":"1"},"$":{"source":"declare const deploymentGroup: codeDeploy.IEcsDeploymentGroup;\ndeclare const taskDefinition: ecs.ITaskDefinition;\n\nnew EcsDeployment({\n deploymentGroup,\n targetService: {\n taskDefinition,\n containerName: 'mycontainer',\n containerPort: 80,\n },\n autoRollback: {\n failedDeployment: true,\n deploymentInAlarm: true,\n stoppedDeployment: false,\n },\n});","version":"0"}},"location":{"api":{"api":"moduleReadme","moduleFqn":"@cdklabs/cdk-ecs-codedeploy"},"field":{"field":"markdown","line":58}},"didCompile":true,"fqnsReferenced":["@cdklabs/cdk-ecs-codedeploy.EcsDeployment","@cdklabs/cdk-ecs-codedeploy.EcsDeploymentProps","@cdklabs/cdk-ecs-codedeploy.TargetService","aws-cdk-lib.aws_codedeploy.AutoRollbackConfig","aws-cdk-lib.aws_codedeploy.IEcsDeploymentGroup","aws-cdk-lib.aws_ecs.ITaskDefinition"],"fullSource":"// Hoisted imports begin after !show marker below\n/// !show\ndeclare const deploymentGroup: codeDeploy.IEcsDeploymentGroup;\ndeclare const taskDefinition: ecs.ITaskDefinition;\n/// !hide\n// Hoisted imports ended before !hide marker above\n// Fixture with packages imported, but nothing else\nimport { Construct } from 'constructs';\nimport {\n Duration,\n Stack,\n aws_ecs as ecs,\n aws_codedeploy as codeDeploy,\n} from 'aws-cdk-lib';\nimport {\n ApiCanary,\n ApplicationLoadBalancedCodeDeployedFargateService, \n EcsDeployment,\n} from '@cdklabs/cdk-ecs-codedeploy';\n\nclass Fixture extends Stack {\n constructor(scope: Construct, id: string) {\n super(scope, id);\n\n const stack = this;\n\n // Code snippet begins after !show marker below\n/// !show\n\n\nnew EcsDeployment({\n deploymentGroup,\n targetService: {\n taskDefinition,\n containerName: 'mycontainer',\n containerPort: 80,\n },\n autoRollback: {\n failedDeployment: true,\n deploymentInAlarm: true,\n stoppedDeployment: false,\n },\n});\n/// !hide\n// Code snippet ended before !hide marker above\n }\n}","syntaxKindCounter":{"9":1,"11":1,"80":16,"97":1,"112":2,"138":2,"166":2,"183":2,"210":3,"214":1,"243":2,"244":1,"260":2,"261":2,"303":7,"304":2,"307":1},"fqnsFingerprint":"7a862ee8b98bc315ae7036190bbeba244bbf7564e60b268dc7e130bdd4f8ab0d"},"b03026dd25eb764b5f7c6c17413fc2f4322e3f9ba4eb0cc2352d139306468039":{"translations":{"python":{"source":"# deployment_group: codeDeploy.IEcsDeploymentGroup\n# task_definition: ecs.ITaskDefinition\n\n\nEcsDeployment(\n deployment_group=deployment_group,\n target_service=TargetService(\n task_definition=task_definition,\n container_name=\"mycontainer\",\n container_port=80\n ),\n timeout=Duration.minutes(60)\n)","version":"2"},"csharp":{"source":"IEcsDeploymentGroup deploymentGroup;\nITaskDefinition taskDefinition;\n\n\nnew EcsDeployment(new EcsDeploymentProps {\n DeploymentGroup = deploymentGroup,\n TargetService = new TargetService {\n TaskDefinition = taskDefinition,\n ContainerName = \"mycontainer\",\n ContainerPort = 80\n },\n Timeout = Duration.Minutes(60)\n});","version":"1"},"java":{"source":"IEcsDeploymentGroup deploymentGroup;\nITaskDefinition taskDefinition;\n\n\nEcsDeployment.Builder.create()\n .deploymentGroup(deploymentGroup)\n .targetService(TargetService.builder()\n .taskDefinition(taskDefinition)\n .containerName(\"mycontainer\")\n .containerPort(80)\n .build())\n .timeout(Duration.minutes(60))\n .build();","version":"1"},"go":{"source":"var deploymentGroup iEcsDeploymentGroup\nvar taskDefinition iTaskDefinition\n\n\ncdklabscdkecscodedeploy.NewEcsDeployment(&EcsDeploymentProps{\n\tDeploymentGroup: DeploymentGroup,\n\tTargetService: &TargetService{\n\t\tTaskDefinition: *TaskDefinition,\n\t\tContainerName: jsii.String(\"mycontainer\"),\n\t\tContainerPort: jsii.Number(80),\n\t},\n\tTimeout: awscdk.Duration_Minutes(jsii.Number(60)),\n})","version":"1"},"$":{"source":"declare const deploymentGroup: codeDeploy.IEcsDeploymentGroup;\ndeclare const taskDefinition: ecs.ITaskDefinition;\n\nnew EcsDeployment({\n deploymentGroup,\n targetService: {\n taskDefinition,\n containerName: 'mycontainer',\n containerPort: 80,\n },\n timeout: Duration.minutes(60),\n});","version":"0"}},"location":{"api":{"api":"moduleReadme","moduleFqn":"@cdklabs/cdk-ecs-codedeploy"},"field":{"field":"markdown","line":79}},"didCompile":true,"fqnsReferenced":["@cdklabs/cdk-ecs-codedeploy.EcsDeployment","@cdklabs/cdk-ecs-codedeploy.EcsDeploymentProps","@cdklabs/cdk-ecs-codedeploy.TargetService","aws-cdk-lib.Duration","aws-cdk-lib.Duration#minutes","aws-cdk-lib.aws_codedeploy.IEcsDeploymentGroup","aws-cdk-lib.aws_ecs.ITaskDefinition"],"fullSource":"// Hoisted imports begin after !show marker below\n/// !show\ndeclare const deploymentGroup: codeDeploy.IEcsDeploymentGroup;\ndeclare const taskDefinition: ecs.ITaskDefinition;\n/// !hide\n// Hoisted imports ended before !hide marker above\n// Fixture with packages imported, but nothing else\nimport { Construct } from 'constructs';\nimport {\n Duration,\n Stack,\n aws_ecs as ecs,\n aws_codedeploy as codeDeploy,\n} from 'aws-cdk-lib';\nimport {\n ApiCanary,\n ApplicationLoadBalancedCodeDeployedFargateService, \n EcsDeployment,\n} from '@cdklabs/cdk-ecs-codedeploy';\n\nclass Fixture extends Stack {\n constructor(scope: Construct, id: string) {\n super(scope, id);\n\n const stack = this;\n\n // Code snippet begins after !show marker below\n/// !show\n\n\nnew EcsDeployment({\n deploymentGroup,\n targetService: {\n taskDefinition,\n containerName: 'mycontainer',\n containerPort: 80,\n },\n timeout: Duration.minutes(60),\n});\n/// !hide\n// Code snippet ended before !hide marker above\n }\n}","syntaxKindCounter":{"9":2,"11":1,"80":15,"138":2,"166":2,"183":2,"210":2,"211":1,"213":1,"214":1,"243":2,"244":1,"260":2,"261":2,"303":4,"304":2,"307":1},"fqnsFingerprint":"6d1cfeed10e3a90361dfb3ddf69be1fcf61e2e8e557183b8e30e5c3d3b0aadf6"},"ffa758784d5582df1fbee84f992fcca1ed9d13cf05b13cb0a160a745d3f18bad":{"translations":{"python":{"source":"canary = ApiCanary(stack, \"Canary\",\n base_url=\"https://xkcd.com\",\n duration_alarm_threshold=Duration.seconds(5),\n thread_count=5,\n steps=[ApiTestStep(\n name=\"info\",\n path=\"/908/info.0.json\",\n jmes_path=\"safe_title\",\n expected_value=\"The Cloud\"\n )\n ]\n)","version":"2"},"csharp":{"source":"var canary = new ApiCanary(stack, \"Canary\", new ApiCanaryProps {\n BaseUrl = \"https://xkcd.com\",\n DurationAlarmThreshold = Duration.Seconds(5),\n ThreadCount = 5,\n Steps = new [] { new ApiTestStep {\n Name = \"info\",\n Path = \"/908/info.0.json\",\n JmesPath = \"safe_title\",\n ExpectedValue = \"The Cloud\"\n } }\n});","version":"1"},"java":{"source":"ApiCanary canary = ApiCanary.Builder.create(stack, \"Canary\")\n .baseUrl(\"https://xkcd.com\")\n .durationAlarmThreshold(Duration.seconds(5))\n .threadCount(5)\n .steps(List.of(ApiTestStep.builder()\n .name(\"info\")\n .path(\"/908/info.0.json\")\n .jmesPath(\"safe_title\")\n .expectedValue(\"The Cloud\")\n .build()))\n .build();","version":"1"},"go":{"source":"canary := cdklabscdkecscodedeploy.NewApiCanary(stack, jsii.String(\"Canary\"), &ApiCanaryProps{\n\tBaseUrl: jsii.String(\"https://xkcd.com\"),\n\tDurationAlarmThreshold: awscdk.Duration_Seconds(jsii.Number(5)),\n\tThreadCount: jsii.Number(5),\n\tSteps: []apiTestStep{\n\t\t&apiTestStep{\n\t\t\tName: jsii.String(\"info\"),\n\t\t\tPath: jsii.String(\"/908/info.0.json\"),\n\t\t\tJmesPath: jsii.String(\"safe_title\"),\n\t\t\tExpectedValue: jsii.String(\"The Cloud\"),\n\t\t},\n\t},\n})","version":"1"},"$":{"source":"const canary = new ApiCanary(stack, 'Canary', {\n baseUrl: 'https://xkcd.com',\n durationAlarmThreshold: Duration.seconds(5),\n threadCount: 5,\n steps: [\n {\n name: 'info',\n path: '/908/info.0.json',\n jmesPath: 'safe_title',\n expectedValue: 'The Cloud',\n },\n ],\n});","version":"0"}},"location":{"api":{"api":"moduleReadme","moduleFqn":"@cdklabs/cdk-ecs-codedeploy"},"field":{"field":"markdown","line":98}},"didCompile":true,"fqnsReferenced":["@cdklabs/cdk-ecs-codedeploy.ApiCanary","@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps","aws-cdk-lib.Duration","aws-cdk-lib.Duration#seconds"],"fullSource":"// Fixture with packages imported, but nothing else\nimport { Construct } from 'constructs';\nimport {\n Duration,\n Stack,\n aws_ecs as ecs,\n aws_codedeploy as codeDeploy,\n} from 'aws-cdk-lib';\nimport {\n ApiCanary,\n ApplicationLoadBalancedCodeDeployedFargateService, \n EcsDeployment,\n} from '@cdklabs/cdk-ecs-codedeploy';\n\nclass Fixture extends Stack {\n constructor(scope: Construct, id: string) {\n super(scope, id);\n\n const stack = this;\n\n // Code snippet begins after !show marker below\n/// !show\nconst canary = new ApiCanary(stack, 'Canary', {\n baseUrl: 'https://xkcd.com',\n durationAlarmThreshold: Duration.seconds(5),\n threadCount: 5,\n steps: [\n {\n name: 'info',\n path: '/908/info.0.json',\n jmesPath: 'safe_title',\n expectedValue: 'The Cloud',\n },\n ],\n});\n/// !hide\n// Code snippet ended before !hide marker above\n }\n}","syntaxKindCounter":{"9":2,"11":6,"80":13,"209":1,"210":2,"211":1,"213":1,"214":1,"243":1,"260":1,"261":1,"303":8},"fqnsFingerprint":"ef23954b775532fdc97524633deefd3193a84be035327b97873bb39a0bbaddad"},"9aaeba1eff6cbd0e531e8d77fd479be273e205d964ee5ed26afd9bcdbc020412":{"translations":{"python":{"source":"# cluster: ecs.ICluster\n# image: ecs.ContainerImage\n\nservice = ApplicationLoadBalancedCodeDeployedFargateService(stack, \"Service\",\n cluster=cluster,\n task_image_options=ApplicationLoadBalancedTaskImageOptions(\n image=image\n ),\n api_test_steps=[ApiTestStep(\n name=\"health\",\n path=\"/health\",\n jmes_path=\"status\",\n expected_value=\"ok\"\n )]\n)","version":"2"},"csharp":{"source":"ICluster cluster;\nContainerImage image;\n\nvar service = new ApplicationLoadBalancedCodeDeployedFargateService(stack, \"Service\", new ApplicationLoadBalancedCodeDeployedFargateServiceProps {\n Cluster = cluster,\n TaskImageOptions = new ApplicationLoadBalancedTaskImageOptions {\n Image = image\n },\n ApiTestSteps = new [] { new ApiTestStep {\n Name = \"health\",\n Path = \"/health\",\n JmesPath = \"status\",\n ExpectedValue = \"ok\"\n } }\n});","version":"1"},"java":{"source":"ICluster cluster;\nContainerImage image;\n\nApplicationLoadBalancedCodeDeployedFargateService service = ApplicationLoadBalancedCodeDeployedFargateService.Builder.create(stack, \"Service\")\n .cluster(cluster)\n .taskImageOptions(ApplicationLoadBalancedTaskImageOptions.builder()\n .image(image)\n .build())\n .apiTestSteps(List.of(ApiTestStep.builder()\n .name(\"health\")\n .path(\"/health\")\n .jmesPath(\"status\")\n .expectedValue(\"ok\")\n .build()))\n .build();","version":"1"},"go":{"source":"var cluster iCluster\nvar image containerImage\n\nservice := cdklabscdkecscodedeploy.NewApplicationLoadBalancedCodeDeployedFargateService(stack, jsii.String(\"Service\"), &ApplicationLoadBalancedCodeDeployedFargateServiceProps{\n\tCluster: Cluster,\n\tTaskImageOptions: &ApplicationLoadBalancedTaskImageOptions{\n\t\tImage: *Image,\n\t},\n\tApiTestSteps: []apiTestStep{\n\t\t&apiTestStep{\n\t\t\tName: jsii.String(\"health\"),\n\t\t\tPath: jsii.String(\"/health\"),\n\t\t\tJmesPath: jsii.String(\"status\"),\n\t\t\tExpectedValue: jsii.String(\"ok\"),\n\t\t},\n\t},\n})","version":"1"},"$":{"source":"declare const cluster: ecs.ICluster;\ndeclare const image: ecs.ContainerImage;\nconst service = new ApplicationLoadBalancedCodeDeployedFargateService(stack, 'Service', {\n cluster,\n taskImageOptions: {\n image,\n },\n apiTestSteps: [{\n name: 'health',\n path: '/health',\n jmesPath: 'status',\n expectedValue: 'ok',\n }],\n});","version":"0"}},"location":{"api":{"api":"moduleReadme","moduleFqn":"@cdklabs/cdk-ecs-codedeploy"},"field":{"field":"markdown","line":118}},"didCompile":true,"fqnsReferenced":["@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService","@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps","aws-cdk-lib.aws_ecs.ContainerImage","aws-cdk-lib.aws_ecs.ICluster","aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedTaskImageOptions"],"fullSource":"// Hoisted imports begin after !show marker below\n/// !show\ndeclare const cluster: ecs.ICluster;\ndeclare const image: ecs.ContainerImage;\n/// !hide\n// Hoisted imports ended before !hide marker above\n// Fixture with packages imported, but nothing else\nimport { Construct } from 'constructs';\nimport {\n Duration,\n Stack,\n aws_ecs as ecs,\n aws_codedeploy as codeDeploy,\n} from 'aws-cdk-lib';\nimport {\n ApiCanary,\n ApplicationLoadBalancedCodeDeployedFargateService, \n EcsDeployment,\n} from '@cdklabs/cdk-ecs-codedeploy';\n\nclass Fixture extends Stack {\n constructor(scope: Construct, id: string) {\n super(scope, id);\n\n const stack = this;\n\n // Code snippet begins after !show marker below\n/// !show\n\nconst service = new ApplicationLoadBalancedCodeDeployedFargateService(stack, 'Service', {\n cluster,\n taskImageOptions: {\n image,\n },\n apiTestSteps: [{\n name: 'health',\n path: '/health',\n jmesPath: 'status',\n expectedValue: 'ok',\n }],\n});\n/// !hide\n// Code snippet ended before !hide marker above\n }\n}","syntaxKindCounter":{"11":5,"80":17,"138":2,"166":2,"183":2,"209":1,"210":3,"214":1,"243":3,"260":3,"261":3,"303":6,"304":2,"307":1},"fqnsFingerprint":"12bcb233da14b440794db06393d667134a065b8ebdcb8cd4540bcc8be5967f3d"}}}